This class is a base for the CostFunctions returning a single value. More...

#include <itkSingleValuedCostFunction.h>

Inheritance diagram for itk::SingleValuedCostFunction:

Collaboration diagram for itk::SingleValuedCostFunction:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Array< double >	DerivativeType
typedef double	MeasureType
typedef Superclass::ParametersType	ParametersType
typedef double	ParametersValueType
typedef SmartPointer< Self >	Pointer
typedef SingleValuedCostFunction	Self
typedef CostFunction	Superclass

Public Member Functions
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
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetNumberOfParameters (void) const =0
virtual int	GetReferenceCount () const
virtual MeasureType	GetValue (const ParametersType &parameters) const =0
virtual void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) 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

Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	SingleValuedCostFunction ()
virtual	~SingleValuedCostFunction ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const

Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Private Member Functions
	SingleValuedCostFunction (const Self &)
void	operator= (const Self &)

Detailed Description

This class is a base for the CostFunctions returning a single value.

Definition at line 35 of file itkSingleValuedCostFunction.h.

Member Typedef Documentation

typedef SmartPointer<const Self> itk::SingleValuedCostFunction::ConstPointer

Reimplemented from itk::CostFunction.

Definition at line 43 of file itkSingleValuedCostFunction.h.

typedef Array<double> itk::SingleValuedCostFunction::DerivativeType

DerivativeType typedef. It defines a type used to return the cost function derivative.

Definition at line 54 of file itkSingleValuedCostFunction.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

typedef double itk::SingleValuedCostFunction::MeasureType

MeasureType typedef. It defines a type used to return the cost function value.

Definition at line 46 of file itkSingleValuedCostFunction.h.

typedef Superclass::ParametersType itk::SingleValuedCostFunction::ParametersType

ParametersType typedef. It defines a position in the optimization search space.

Reimplemented from itk::CostFunction.

Reimplemented in itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::MutualInformationImageToImageMetric< TFixedImage, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, otb::StandardDSCostFunction< TDSValidationFilter >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, otb::SVMCrossValidationCostFunction< TModel >, itk::ShapePriorMAPCostFunction< TFeatureImage, TOutputPixel >, and itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 58 of file itkSingleValuedCostFunction.h.

typedef double itk::CostFunction::ParametersValueType

inherited

ParametersType typedef. It defines a position in the optimization search space.

Reimplemented in otb::SVMCrossValidationCostFunction< TModel >.

Definition at line 46 of file itkCostFunction.h.

typedef SmartPointer<Self> itk::SingleValuedCostFunction::Pointer

Reimplemented from itk::CostFunction.

Definition at line 42 of file itkSingleValuedCostFunction.h.

typedef SingleValuedCostFunction itk::SingleValuedCostFunction::Self

Standard class typedefs.

Reimplemented from itk::CostFunction.

Definition at line 40 of file itkSingleValuedCostFunction.h.

typedef CostFunction itk::SingleValuedCostFunction::Superclass

Reimplemented from itk::CostFunction.

Definition at line 41 of file itkSingleValuedCostFunction.h.

Constructor & Destructor Documentation

itk::SingleValuedCostFunction::SingleValuedCostFunction ( )

inlineprotected

Definition at line 80 of file itkSingleValuedCostFunction.h.

virtual itk::SingleValuedCostFunction::~SingleValuedCostFunction ( )

inlineprotectedvirtual

Definition at line 81 of file itkSingleValuedCostFunction.h.

itk::SingleValuedCostFunction::SingleValuedCostFunction ( const Self & )

private

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

inherited

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::LightObject::BreakOnError ( )

staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

LightObject::Pointer itk::Object::CreateAnother ( void ) const

virtualinherited

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.

Definition at line 231 of file itkObject.cxx.

References itk::SmartPointer< TObjectType >::GetPointer(), and itk::Object::New().

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 88 of file itkLightObject.cxx.

Command * itk::Object::GetCommand ( unsigned long tag )

inherited

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

virtual void itk::SingleValuedCostFunction::GetDerivative	(	const ParametersType &	parameters,
		DerivativeType &	derivative
	)		const

pure virtual

This method returns the derivative of the cost function corresponding to the specified parameters.

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns:: A constant reference to this objects MetaDataDictionary.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

virtual const char* itk::SingleValuedCostFunction::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::CostFunction.

virtual unsigned int itk::CostFunction::GetNumberOfParameters ( void ) const

pure virtualinherited

Return the number of parameters required to compute this cost function. This method MUST be overloaded by derived classes.

Implemented in itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::ImageToImageMetric< TFixedImage, TMovingImage >, itk::PointSetToImageMetric< TFixedPointSet, TMovingImage >, itk::CompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::MRIBiasEnergyFunction< TImage, TImageMask, TBiasField >, itk::KullbackLeiblerCompareHistogramImageToImageMetric< TFixedImage, TMovingImage >, itk::Statistics::GoodnessOfFitMixtureModelCostFunction< TInputSample >, itk::PointSetToPointSetMetric< TFixedPointSet, TMovingPointSet >, itk::ShapePriorMAPCostFunctionBase< TFeatureImage, TOutputPixel >, otb::StandardDSCostFunction< TDSValidationFilter >, otb::SVMCrossValidationCostFunction< TModel >, and itk::CumulativeGaussianCostFunction.

Referenced by itk::LBFGSOptimizer::SetCostFunction(), itk::LevenbergMarquardtOptimizer::SetCostFunction(), itk::ConjugateGradientOptimizer::SetCostFunction(), itk::SingleValuedNonLinearOptimizer::SetCostFunction(), itk::MultipleValuedNonLinearOptimizer::SetCostFunction(), itk::AmoebaOptimizer::SetCostFunction(), and itk::LBFGSBOptimizer::SetCostFunction().

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

virtual MeasureType itk::SingleValuedCostFunction::GetValue ( const ParametersType & parameters ) const

pure virtual

This method returns the value of the cost function corresponding to the specified parameters.

virtual void itk::SingleValuedCostFunction::GetValueAndDerivative	(	const ParametersType &	parameters,
		MeasureType &	value,
		DerivativeType &	derivative
	)		const

inlinevirtual

This method returns the value and derivative of the cost function corresponding to the specified parameters

Reimplemented in itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >.

Definition at line 71 of file itkSingleValuedCostFunction.h.

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const

inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

void itk::Object::Modified ( void ) const

virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

Object::Pointer itk::Object::New ( void )

staticinherited

Method for creation through the object factory.

Reimplemented from itk::LightObject.

Definition at line 217 of file itkObject.cxx.

References NULL, itk::Object::Object(), and itk::Object::UnRegister().

Referenced by itk::Object::CreateAnother(), otb::ImageLayerBase< TOutputImage >::ImageLayerBase(), otb::Wrapper::Application::Init(), itk::LoggerBase::LoggerBase(), itk::ProcessObject::MakeOutput(), itk::MultipleValuedVnlCostFunctionAdaptor::MultipleValuedVnlCostFunctionAdaptor(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::NarrowBandImageFilterBase(), itk::QtProgressBar::QtProgressBar(), and itk::SingleValuedVnlCostFunctionAdaptor::SingleValuedVnlCostFunctionAdaptor().

void itk::SingleValuedCostFunction::operator= ( const Self & )

private

Reimplemented from itk::CostFunction.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)		const

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)		const

protectedinherited

Definition at line 478 of file itkObject.cxx.

void itk::CostFunction::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::Object.

Definition at line 23 of file itkCostFunction.cxx.

void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::Object::Register ( ) const

virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::Object::RemoveObserver ( unsigned long tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

void itk::Object::SetDebug ( bool debugFlag ) const

inherited

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 275 of file itkObject.cxx.

void itk::Object::SetGlobalWarningDisplay ( bool val )

staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

inherited

Returns:: Set the MetaDataDictionary

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

void itk::Object::SetReferenceCount ( int ref )

virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

void itk::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

Member Data Documentation

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

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

itkSingleValuedCostFunction.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation