 |
ITK
4.4.0
Insight Segmentation and Registration Toolkit
|
|
ITK
4.4.0
Insight Segmentation and Registration Toolkit
|
#include <itkSingleValuedCostFunctionv4.h>
Inheritance diagram for itk::SingleValuedCostFunctionv4: Collaboration diagram for itk::SingleValuedCostFunctionv4:This class is a base for a CostFunction that returns a single value.
This class differs from the SingleValuedCostFunction in that it is fine tunned for managing very large numbers of parameters. For example, to be used in conditions where the number of parameters is in the range of thousands or even millions. Due to the large number of parameters, the API of this class avoids any copying of the parameters array, and of the classes that have dimensionality related to the size of the parameters array.
As you look at the code of this class, keep in mind that the types ParametersType and DerivativeType will be some sort of array-like type with millions of elements.
Derived classes must provide implementations for: GetValue GetValueAndDerivative
Definition at line 48 of file itkSingleValuedCostFunctionv4.h.
Public Types | |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef Array < ParametersValueType > | DerivativeType |
| typedef double | MeasureType |
| typedef Superclass::ParametersType | ParametersType |
| typedef Superclass::ParametersValueType | ParametersValueType |
| typedef SmartPointer< Self > | Pointer |
| typedef SingleValuedCostFunctionv4 | Self |
| typedef CostFunction | Superclass |
| Public Types inherited from itk::CostFunction | |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef OptimizerParameters < ParametersValueType > | ParametersType |
| typedef double | ParametersValueType |
| typedef SmartPointer< Self > | Pointer |
| typedef CostFunction | Self |
| typedef Object | Superclass |
| Public Types inherited from itk::Object | |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef SmartPointer< Self > | Pointer |
| typedef Object | Self |
| typedef LightObject | Superclass |
| Public Types inherited from itk::LightObject | |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef SmartPointer< Self > | Pointer |
| typedef LightObject | Self |
Public Member Functions | |
| virtual const char * | GetNameOfClass () const |
| virtual MeasureType | GetValue () const =0 |
| virtual void | GetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const =0 |
| Public Member Functions inherited from itk::CostFunction | |
| virtual unsigned int | GetNumberOfParameters (void) const =0 |
| Public Member Functions inherited from itk::Object | |
| unsigned long | AddObserver (const EventObject &event, Command *) |
| unsigned long | AddObserver (const EventObject &event, Command *) const |
| virtual LightObject::Pointer | CreateAnother () const |
| virtual void | DebugOff () const |
| virtual void | DebugOn () const |
| Command * | GetCommand (unsigned long tag) |
| bool | GetDebug () const |
| MetaDataDictionary & | GetMetaDataDictionary (void) |
| const MetaDataDictionary & | GetMetaDataDictionary (void) const |
| virtual ModifiedTimeType | GetMTime () const |
| virtual const TimeStamp & | GetTimeStamp () const |
| bool | HasObserver (const EventObject &event) const |
| void | InvokeEvent (const EventObject &) |
| void | InvokeEvent (const EventObject &) const |
| virtual void | Modified () const |
| virtual void | Register () const |
| void | RemoveAllObservers () |
| void | RemoveObserver (unsigned long tag) |
| void | SetDebug (bool debugFlag) const |
| void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
| virtual void | SetReferenceCount (int) |
| virtual void | UnRegister () 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 |
Protected Member Functions | |
| SingleValuedCostFunctionv4 () | |
| virtual | ~SingleValuedCostFunctionv4 () |
| Protected Member Functions inherited from itk::CostFunction | |
| CostFunction () | |
| void | PrintSelf (std::ostream &os, Indent indent) const |
| virtual | ~CostFunction () |
| 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 () |
Private Member Functions | |
| void | operator= (const Self &) |
| SingleValuedCostFunctionv4 (const Self &) | |
Additional Inherited Members | |
| 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) |
| Protected Types inherited from itk::LightObject | |
| typedef int | InternalReferenceCountType |
| Protected Attributes inherited from itk::LightObject | |
| InternalReferenceCountType | m_ReferenceCount |
| SimpleFastMutexLock | m_ReferenceCountLock |
| typedef SmartPointer< const Self > itk::SingleValuedCostFunctionv4::ConstPointer |
Definition at line 56 of file itkSingleValuedCostFunctionv4.h.
DerivativeType typedef. It defines a type used to return the cost function derivative.
Definition at line 72 of file itkSingleValuedCostFunctionv4.h.
| typedef double itk::SingleValuedCostFunctionv4::MeasureType |
MeasureType typedef. It defines a type used to return the cost function value.
Definition at line 59 of file itkSingleValuedCostFunctionv4.h.
| typedef Superclass::ParametersType itk::SingleValuedCostFunctionv4::ParametersType |
ParametersType typedef. It defines a position in the optimization search space.
Definition at line 67 of file itkSingleValuedCostFunctionv4.h.
| typedef Superclass::ParametersValueType itk::SingleValuedCostFunctionv4::ParametersValueType |
Definition at line 68 of file itkSingleValuedCostFunctionv4.h.
Definition at line 55 of file itkSingleValuedCostFunctionv4.h.
Standard class typedefs.
Definition at line 53 of file itkSingleValuedCostFunctionv4.h.
Definition at line 54 of file itkSingleValuedCostFunctionv4.h.
|
inlineprotected |
Definition at line 85 of file itkSingleValuedCostFunctionv4.h.
|
inlineprotectedvirtual |
Definition at line 86 of file itkSingleValuedCostFunctionv4.h.
|
private |
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::CostFunction.
Reimplemented in itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TMetricTraits >, itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage >, itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage >, itk::ObjectToObjectMetric< TFixedImage::ImageDimension, TMovingImage::ImageDimension, TVirtualImage >, itk::ObjectToObjectMetric< TPointSet::PointDimension, TPointSet::PointDimension >, itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension >, itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet >, itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::PointSetToPointSetMetricv4< TPointSet, TPointSet >, itk::DemonsImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::LabeledPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::JointHistogramMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::ObjectToObjectMetricBase, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::MeanSquaresImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TMetricTraits >, and itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >.
|
pure virtual |
This method returns the value of the cost function corresponding to the specified parameters.
Implemented in itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TMetricTraits >, itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >, itk::PointSetToPointSetMetricv4< TPointSet, TPointSet >, itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage >, itk::JointHistogramMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage >, and itk::ObjectToObjectMetricBase.
|
pure virtual |
This method returns the value and derivative of the cost function. derivative will be sized and allocated as needed by metric. If it's already proper size, no new allocation is done.
|
private |
1.8.3.1
