ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType > Class Template Reference

#include <itkTrainingFunctionBase.h>

+ Inheritance diagram for itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >:
+ Collaboration diagram for itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >:

Detailed Description

template<typename TSample, typename TTargetVector, typename ScalarType>
class itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >

This is the itkTrainingFunctionBase class.

Definition at line 37 of file itkTrainingFunctionBase.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
SquaredDifferenceErrorFunction
< InternalVectorType,
ScalarType > 
DefaultPerformanceType
 
typedef std::vector< VectorTypeInputSampleVectorType
 
typedef Array< ValueTypeInternalVectorType
 
typedef NeuralNetworkObject
< VectorType, OutputVectorType
NetworkType
 
typedef std::vector
< OutputVectorType
OutputSampleVectorType
 
typedef
TTargetVector::MeasurementVectorType 
OutputVectorType
 
typedef ErrorFunctionBase
< InternalVectorType,
ScalarType > 
PerformanceFunctionType
 
typedef SmartPointer< SelfPointer
 
typedef TrainingFunctionBase Self
 
typedef LightProcessObject Superclass
 
typedef ScalarType ValueType
 
typedef
TSample::MeasurementVectorType 
VectorType
 
- Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
VectorType defaultconverter (typename TSample::MeasurementVectorType v)
 
virtual const SizeValueTypeGetIterations () const
 
ValueType GetLearningRate ()
 
virtual const char * GetNameOfClass () const
 
virtual void SetIterations (SizeValueType _arg)
 
void SetLearningRate (ValueType)
 
void SetPerformanceFunction (PerformanceFunctionType *f)
 
void SetTargetValues (TTargetVector *targets)
 
void SetTrainingSamples (TSample *samples)
 
OutputVectorType targetconverter (typename TTargetVector::MeasurementVectorType v)
 
virtual void Train (NetworkType *, TSample *, TTargetVector *)
 
- Public Member Functions inherited from itk::LightProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void UpdateOutputData ()
 
void UpdateProgress (float amount)
 
virtual void SetProgress (float _arg)
 
virtual const float & GetProgress () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
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
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::LightProcessObject
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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 TrainingFunctionBase ()
 
 ~TrainingFunctionBase ()
 
- Protected Member Functions inherited from itk::LightProcessObject
virtual void GenerateData ()
 
 LightProcessObject ()
 
 ~LightProcessObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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 ()
 

Protected Attributes

InputSampleVectorType m_InputSamples
 
SizeValueType m_Iterations
 
ValueType m_LearningRate
 
PerformanceFunctionType::Pointer m_PerformanceFunction
 
TTargetVector * m_SampleTargets
 
OutputSampleVectorType m_Targets
 
TSample * m_TrainingSamples
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TSample , typename TTargetVector , typename ScalarType >
typedef SmartPointer<const Self> itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::ConstPointer

Definition at line 43 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
typedef SquaredDifferenceErrorFunction<InternalVectorType, ScalarType> itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::DefaultPerformanceType

Definition at line 61 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
typedef std::vector<VectorType> itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::InputSampleVectorType

Definition at line 56 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
typedef Array<ValueType> itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::InternalVectorType

Definition at line 54 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
typedef NeuralNetworkObject<VectorType, OutputVectorType> itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::NetworkType

Definition at line 58 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
typedef std::vector<OutputVectorType> itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::OutputSampleVectorType

Definition at line 57 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
typedef TTargetVector::MeasurementVectorType itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::OutputVectorType

Definition at line 53 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
typedef ErrorFunctionBase<InternalVectorType, ScalarType> itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::PerformanceFunctionType

Definition at line 59 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
typedef SmartPointer<Self> itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::Pointer

Definition at line 42 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
typedef TrainingFunctionBase itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::Self

Definition at line 40 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
typedef LightProcessObject itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::Superclass

Definition at line 41 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
typedef ScalarType itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::ValueType

Definition at line 49 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
typedef TSample::MeasurementVectorType itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::VectorType

Definition at line 52 of file itkTrainingFunctionBase.h.

Constructor & Destructor Documentation

template<typename TSample , typename TTargetVector , typename ScalarType >
itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::TrainingFunctionBase ( )
protected
template<typename TSample , typename TTargetVector , typename ScalarType >
itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::~TrainingFunctionBase ( )
inlineprotected

Definition at line 105 of file itkTrainingFunctionBase.h.

Member Function Documentation

template<typename TSample , typename TTargetVector , typename ScalarType >
virtual::itk::LightObject::Pointer itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::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::LightProcessObject.

template<typename TSample , typename TTargetVector , typename ScalarType >
VectorType itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::defaultconverter ( typename TSample::MeasurementVectorType  v)
inline

Definition at line 80 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
virtual const SizeValueType& itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::GetIterations ( ) const
virtual
template<typename TSample , typename TTargetVector , typename ScalarType >
ValueType itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::GetLearningRate ( )
template<typename TSample , typename TTargetVector , typename ScalarType >
virtual const char* itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::GetNameOfClass ( ) const
virtual
template<typename TSample , typename TTargetVector , typename ScalarType >
static Pointer itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::New ( )
static

Method for creation through the object factory.

template<typename TSample , typename TTargetVector , typename ScalarType >
virtual void itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual
template<typename TSample , typename TTargetVector , typename ScalarType >
virtual void itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::SetIterations ( SizeValueType  _arg)
virtual
template<typename TSample , typename TTargetVector , typename ScalarType >
void itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::SetLearningRate ( ValueType  )
template<typename TSample , typename TTargetVector , typename ScalarType >
void itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::SetPerformanceFunction ( PerformanceFunctionType f)
template<typename TSample , typename TTargetVector , typename ScalarType >
void itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::SetTargetValues ( TTargetVector *  targets)
template<typename TSample , typename TTargetVector , typename ScalarType >
void itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::SetTrainingSamples ( TSample *  samples)
template<typename TSample , typename TTargetVector , typename ScalarType >
OutputVectorType itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::targetconverter ( typename TTargetVector::MeasurementVectorType  v)
inline

Definition at line 91 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
virtual void itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::Train ( NetworkType ,
TSample *  ,
TTargetVector *   
)
inlinevirtual

Definition at line 74 of file itkTrainingFunctionBase.h.

Member Data Documentation

template<typename TSample , typename TTargetVector , typename ScalarType >
InputSampleVectorType itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::m_InputSamples
protected

Definition at line 112 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
SizeValueType itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::m_Iterations
protected

Definition at line 114 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
ValueType itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::m_LearningRate
protected

Definition at line 115 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
PerformanceFunctionType::Pointer itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::m_PerformanceFunction
protected

Definition at line 117 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
TTargetVector* itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::m_SampleTargets
protected

Definition at line 111 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
OutputSampleVectorType itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::m_Targets
protected

Definition at line 113 of file itkTrainingFunctionBase.h.

template<typename TSample , typename TTargetVector , typename ScalarType >
TSample* itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >::m_TrainingSamples
protected

Definition at line 110 of file itkTrainingFunctionBase.h.


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