ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate< TInternalComputationValueType > Class Template Reference

#include <itkGradientDescentOptimizerBasev4ModifyGradientByScalesThreader.h>

Detailed Description

template<typename TInternalComputationValueType>
class itk::GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate< TInternalComputationValueType >

Modify the gradient by the parameter scales for GradientDescentOptimizerBasev4.

Definition at line 37 of file itkGradientDescentOptimizerBasev4ModifyGradientByScalesThreader.h.

+ Inheritance diagram for itk::GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate< TInternalComputationValueType >:
+ Collaboration diagram for itk::GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate< TInternalComputationValueType >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using IndexRangeType = DomainType
 
using Pointer = SmartPointer< Self >
 
using Self = GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate
 
using Superclass = DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >
 
- Public Types inherited from itk::DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >
using AssociateType = GradientDescentOptimizerBasev4Template< TInternalComputationValueType >
 
using ConstPointer = SmartPointer< const Self >
 
using DomainPartitionerType = ThreadedIndexedContainerPartitioner
 
using DomainType = typename DomainPartitionerType::DomainType
 
using Pointer = SmartPointer< Self >
 
using Self = DomainThreader
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

 itkOverrideGetNameOfClassMacro (GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate)
 
- Public Member Functions inherited from itk::DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >
void Execute (AssociateType *enclosingClass, const DomainType &completeDomain)
 
MultiThreaderBaseGetMultiThreader () const
 
virtual ThreadIdType GetNumberOfWorkUnitsUsed () const
 
 itkOverrideGetNameOfClassMacro (DomainThreader)
 
virtual void SetDomainPartitioner (DomainPartitionerType *_arg)
 
virtual DomainPartitionerTypeGetModifiableDomainPartitioner ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual ThreadIdType GetNumberOfWorkUnits () const
 
ThreadIdType GetMaximumNumberOfThreads () const
 
void SetMaximumNumberOfThreads (const ThreadIdType threads)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
 itkOverrideGetNameOfClassMacro (Object)
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate ()=default
 
void ThreadedExecution (const IndexRangeType &subrange, const ThreadIdType threadId) override
 
 ~GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate () override=default
 
- Protected Member Functions inherited from itk::DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >
virtual void AfterThreadedExecution ()
 
virtual void BeforeThreadedExecution ()
 
virtual void DetermineNumberOfWorkUnitsUsed ()
 
 DomainThreader ()
 
virtual void SetMultiThreader (MultiThreaderBase *_arg)
 
 ~DomainThreader () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >
AssociateTypem_Associate
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInternalComputationValueType >
using itk::GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate< TInternalComputationValueType >::ConstPointer = SmartPointer<const Self>

◆ IndexRangeType

template<typename TInternalComputationValueType >
using itk::GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate< TInternalComputationValueType >::IndexRangeType = DomainType

◆ Pointer

template<typename TInternalComputationValueType >
using itk::GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate< TInternalComputationValueType >::Pointer = SmartPointer<Self>

◆ Self

Standard class type aliases.

Definition at line 45 of file itkGradientDescentOptimizerBasev4ModifyGradientByScalesThreader.h.

◆ Superclass

template<typename TInternalComputationValueType >
using itk::GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate< TInternalComputationValueType >::Superclass = DomainThreader<ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template<TInternalComputationValueType> >

Constructor & Destructor Documentation

◆ GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate()

template<typename TInternalComputationValueType >
itk::GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate< TInternalComputationValueType >::GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate ( )
protecteddefault

◆ ~GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate()

template<typename TInternalComputationValueType >
itk::GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate< TInternalComputationValueType >::~GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate ( )
overrideprotecteddefault

Member Function Documentation

◆ itkOverrideGetNameOfClassMacro()

template<typename TInternalComputationValueType >
itk::GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate< TInternalComputationValueType >::itkOverrideGetNameOfClassMacro ( GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate< TInternalComputationValueType >  )

◆ New()

template<typename TInternalComputationValueType >
static Pointer itk::GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate< TInternalComputationValueType >::New ( )
static

◆ ThreadedExecution()

template<typename TInternalComputationValueType >
void itk::GradientDescentOptimizerBasev4ModifyGradientByScalesThreaderTemplate< TInternalComputationValueType >::ThreadedExecution ( const IndexRangeType subdomain,
const ThreadIdType  threadId 
)
overrideprotectedvirtual

Do the threaded operation, somewhat like ThreadedGenerateData in an ImageSource.

Parameters
subdomainThe subdomain to operate on.
threadIdThe identifier for the current thread. Data to perform the operation on can be accessed by dereferencing this->m_Associate, which has direct access to private and protected members the enclosing class.

Implements itk::DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >.


The documentation for this class was generated from the following file: