ITK
6.0.0
Insight Toolkit
|
#include <itkSingleValuedCostFunction.h>
This class is a base for the CostFunctions returning a single value.
Definition at line 34 of file itkSingleValuedCostFunction.h.
Public Types | |
using | ConstPointer = SmartPointer< const Self > |
using | DerivativeType = Array< ParametersValueType > |
using | MeasureType = double |
using | ParametersType = Superclass::ParametersType |
using | ParametersValueType = Superclass::ParametersValueType |
using | Pointer = SmartPointer< Self > |
using | Self = SingleValuedCostFunction |
using | Superclass = CostFunction |
Public Types inherited from itk::CostFunctionTemplate< double > | |
using | ConstPointer = SmartPointer< const Self > |
using | ParametersType = OptimizerParameters< double > |
using | ParametersValueType = double |
using | Pointer = SmartPointer< Self > |
using | Self = CostFunctionTemplate |
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 | |
virtual void | GetDerivative (const ParametersType ¶meters, DerivativeType &derivative) const =0 |
const char * | GetNameOfClass () const override |
virtual MeasureType | GetValue (const ParametersType ¶meters) const =0 |
virtual void | GetValueAndDerivative (const ParametersType ¶meters, MeasureType &value, DerivativeType &derivative) const |
Public Member Functions inherited from itk::CostFunctionTemplate< double > | |
const char * | GetNameOfClass () const override |
virtual unsigned int | GetNumberOfParameters () const=0 |
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 Pointer | CreateAnother () const |
virtual void | Delete () |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const noexcept |
Protected Member Functions | |
SingleValuedCostFunction ()=default | |
~SingleValuedCostFunction () override | |
Protected Member Functions inherited from itk::CostFunctionTemplate< double > | |
CostFunctionTemplate ()=default | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~CostFunctionTemplate () 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 | PrintSelf (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
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 val) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Protected Attributes inherited from itk::LightObject | |
std::atomic< int > | m_ReferenceCount {} |
using itk::SingleValuedCostFunction::ConstPointer = SmartPointer<const Self> |
Definition at line 43 of file itkSingleValuedCostFunction.h.
DerivativeType type alias. It defines a type used to return the cost function derivative.
Definition at line 59 of file itkSingleValuedCostFunction.h.
using itk::SingleValuedCostFunction::MeasureType = double |
MeasureType type alias. It defines a type used to return the cost function value.
Definition at line 50 of file itkSingleValuedCostFunction.h.
using itk::SingleValuedCostFunction::ParametersType = Superclass::ParametersType |
ParametersType type alias. It defines a position in the optimization search space.
Definition at line 54 of file itkSingleValuedCostFunction.h.
using itk::SingleValuedCostFunction::ParametersValueType = Superclass::ParametersValueType |
Definition at line 55 of file itkSingleValuedCostFunction.h.
Definition at line 42 of file itkSingleValuedCostFunction.h.
Standard class type aliases.
Definition at line 40 of file itkSingleValuedCostFunction.h.
Definition at line 41 of file itkSingleValuedCostFunction.h.
|
protecteddefault |
|
overrideprotected |
|
pure virtual |
This method returns the derivative of the cost function corresponding to the specified parameters.
Implemented in itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, and itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >.
|
overridevirtual |
Reimplemented from itk::Object.
Reimplemented in itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::CorrelationCoefficientHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::GradientDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferenceImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanReciprocalSquareDifferencePointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MeanSquaresHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >, itk::NormalizedCorrelationPointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::NormalizedMutualInformationHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, and itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >.
|
pure virtual |
This method returns the value of the cost function corresponding to the specified parameters.
Implemented in itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, and itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >.
|
virtual |
This method returns the value and derivative of the cost function corresponding to the specified parameters
Reimplemented in itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, and itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >.