itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType > Class Template Reference

#include <itkGradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader.h>

Detailed Description

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

Modify the gradient by the learning rate for GradientDescentOptimizerBasev4.

Definition at line 37 of file itkGradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader.h.

Inheritance diagram for itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >:

Collaboration diagram for itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >:

Public Types
using	ConstPointer = SmartPointer<const Self>
using	IndexRangeType = DomainType
using	Pointer = SmartPointer<Self>
using	Self = GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate
using	Superclass
Public Types inherited from itk::DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >
using	AssociateType
using	ConstPointer
using	DomainPartitionerType
using	DomainType
using	Pointer
using	Self
using	Superclass
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
virtual::itk::LightObject::Pointer	CreateAnother () const
const char *	GetNameOfClass () const override
Public Member Functions inherited from itk::DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >
void	Execute (AssociateType *enclosingClass, const DomainType &completeDomain)
void	Execute (AssociateType *enclosingClass, const DomainType &completeDomain)
MultiThreaderBase *	GetMultiThreader () const
MultiThreaderBase *	GetMultiThreader () const
virtual ThreadIdType	GetNumberOfWorkUnitsUsed () const
virtual ThreadIdType	GetNumberOfWorkUnitsUsed () const
virtual void	SetDomainPartitioner (DomainPartitionerType *_arg)
virtual DomainPartitionerType *	GetModifiableDomainPartitioner ()
virtual const DomainPartitionerType *	GetDomainPartitioner () const
virtual void	SetDomainPartitioner (DomainPartitionerType *_arg)
virtual DomainPartitionerType *	GetModifiableDomainPartitioner ()
virtual const DomainPartitionerType *	GetDomainPartitioner () const
virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)
virtual ThreadIdType	GetNumberOfWorkUnits () const
virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)
virtual ThreadIdType	GetNumberOfWorkUnits () const
ThreadIdType	GetMaximumNumberOfThreads () const
void	SetMaximumNumberOfThreads (const ThreadIdType threads)
ThreadIdType	GetMaximumNumberOfThreads () const
void	SetMaximumNumberOfThreads (const ThreadIdType threads)
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) 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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
const char *	GetNameOfClass () const override
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag) const
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
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
	GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate ()=default
void	ThreadedExecution (const IndexRangeType &subrange, const ThreadIdType threadId) override
	~GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate () override=default
Protected Member Functions inherited from itk::DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >
virtual void	AfterThreadedExecution ()
virtual void	AfterThreadedExecution ()
virtual void	BeforeThreadedExecution ()
virtual void	BeforeThreadedExecution ()
virtual void	DetermineNumberOfWorkUnitsUsed ()
virtual void	DetermineNumberOfWorkUnitsUsed ()
	DomainThreader ()
	DomainThreader ()
virtual void	SetMultiThreader (MultiThreaderBase *_arg)
virtual void	SetMultiThreader (MultiThreaderBase *_arg)
	~DomainThreader () override=default
	~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)
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)
Protected Attributes inherited from itk::DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >
AssociateType *	m_Associate
AssociateType *	m_Associate
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

ConstPointer

template<typename TInternalComputationValueType>

using itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 49 of file itkGradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader.h.

IndexRangeType

template<typename TInternalComputationValueType>

using itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::IndexRangeType = DomainType

Definition at line 57 of file itkGradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader.h.

Pointer

template<typename TInternalComputationValueType>

using itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::Pointer = SmartPointer<Self>

Definition at line 48 of file itkGradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader.h.

Self

template<typename TInternalComputationValueType>

using itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::Self = GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate

Standard class type aliases.

Definition at line 45 of file itkGradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader.h.

Superclass

template<typename TInternalComputationValueType>

using itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::Superclass

Initial value:

 DomainThreader<ThreadedIndexedContainerPartitioner,
                                    GradientDescentOptimizerBasev4Template<TInternalComputationValueType>>

Definition at line 46 of file itkGradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader.h.

Constructor & Destructor Documentation

GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate()

template<typename TInternalComputationValueType>

itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate ( )

protecteddefault

~GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate()

template<typename TInternalComputationValueType>

itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::~GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate ( )

overrideprotecteddefault

Member Function Documentation

CreateAnother()

template<typename TInternalComputationValueType>

virtual::itk::LightObject::Pointer itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

GetNameOfClass()

template<typename TInternalComputationValueType>

const char * itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::GetNameOfClass ( ) const

overridevirtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::DomainThreader< ThreadedIndexedContainerPartitioner, GradientDescentOptimizerBasev4Template< TInternalComputationValueType > >.

New()

template<typename TInternalComputationValueType>

static Pointer itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::New ( )

static

ThreadedExecution()

template<typename TInternalComputationValueType>

void itk::GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreaderTemplate< TInternalComputationValueType >::ThreadedExecution ( const IndexRangeType & subdomain, const ThreadIdType threadId )

overrideprotectedvirtual

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

Parameters

subdomain	The subdomain to operate on.
threadId	The 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:

• itkGradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader.h