Orfeo Toolbox  3.16
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions
itk::VersorRigid3DTransformOptimizer Class Reference

Implement a gradient descent optimizer for the VersorRigid3DTransform parameter space. More...

#include <itkVersorRigid3DTransformOptimizer.h>

+ Inheritance diagram for itk::VersorRigid3DTransformOptimizer:
+ Collaboration diagram for itk::VersorRigid3DTransformOptimizer:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef CostFunctionType::Pointer CostFunctionPointer
typedef SingleValuedCostFunction CostFunctionType
typedef
CostFunctionType::DerivativeType 
DerivativeType
typedef
CostFunctionType::MeasureType 
MeasureType
typedef Superclass::ParametersType ParametersType
typedef SmartPointer< SelfPointer
typedef Superclass::ScalesType ScalesType
typedef
VersorRigid3DTransformOptimizer 
Self
enum  StopConditionType {
  GradientMagnitudeTolerance = 1,
  StepTooSmall = 2,
  ImageNotAvailable = 3,
  CostFunctionError = 4,
  MaximumNumberOfIterations = 5,
  Unknown = 6
}
typedef
RegularStepGradientDescentBaseOptimizer 
Superclass
typedef VersorType::VectorType VectorType
typedef Versor< double > VersorType

Public Member Functions

unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
CommandGetCommand (unsigned long tag)
virtual const CostFunctionTypeGetCostFunction ()
virtual unsigned int GetCurrentIteration () const
virtual const ParametersTypeGetCurrentPosition ()
virtual const double & GetCurrentStepLength ()
bool GetDebug () const
virtual const DerivativeTypeGetGradient ()
virtual const double & GetGradientMagnitudeTolerance ()
virtual const ParametersTypeGetInitialPosition ()
virtual const bool & GetMaximize ()
virtual const double & GetMaximumStepLength ()
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
bool GetMinimize () const
virtual const double & GetMinimumStepLength ()
virtual unsigned long GetMTime () const
virtual const char * GetNameOfClass () const
virtual const unsigned long & GetNumberOfIterations ()
virtual int GetReferenceCount () const
virtual const double & GetRelaxationFactor ()
virtual const ScalesTypeGetScales ()
virtual const StopConditionTypeGetStopCondition ()
virtual const std::string GetStopConditionDescription () const
MeasureType GetValue (const ParametersType &parameters) const
virtual const MeasureTypeGetValue ()
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void MaximizeOff ()
virtual void MaximizeOn ()
void MinimizeOff (void)
void MinimizeOn (void)
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 ResumeOptimization (void)
virtual void SetCostFunction (CostFunctionType *costFunction)
void SetDebug (bool debugFlag) const
virtual void SetGradientMagnitudeTolerance (double _arg)
virtual void SetInitialPosition (const ParametersType &param)
virtual void SetMaximize (bool _arg)
virtual void SetMaximumStepLength (double _arg)
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
void SetMinimize (bool v)
virtual void SetMinimumStepLength (double _arg)
virtual void SetNumberOfIterations (unsigned long _arg)
virtual void SetReferenceCount (int)
virtual void SetRelaxationFactor (double _arg)
void SetScales (const ScalesType &scales)
void StartOptimization (void)
virtual void StepAlongGradient (double factor, const DerivativeType &transformedGradient)
void StopOptimization (void)
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)

Static Public Attributes

static const unsigned int SpaceDimension = 6

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

 VersorRigid3DTransformOptimizer ()
virtual ~VersorRigid3DTransformOptimizer ()
virtual void AdvanceOneStep (void)
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
virtual void SetCurrentPosition (const ParametersType &param)
virtual void StepAlongGradient (double, const DerivativeType &)

Protected Attributes

CostFunctionPointer m_CostFunction
unsigned long m_CurrentIteration
ParametersType m_CurrentPosition
double m_CurrentStepLength
DerivativeType m_Gradient
double m_GradientMagnitudeTolerance
bool m_Maximize
double m_MaximumStepLength
double m_MinimumStepLength
unsigned long m_NumberOfIterations
DerivativeType m_PreviousGradient
InternalReferenceCountType m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
double m_RelaxationFactor
bool m_ScalesInitialized
bool m_Stop
StopConditionType m_StopCondition
OStringStream m_StopConditionDescription
MeasureType m_Value

Private Member Functions

 VersorRigid3DTransformOptimizer (const Self &)
void operator= (const Self &)

Detailed Description

Implement a gradient descent optimizer for the VersorRigid3DTransform parameter space.

VersorRigid3DTransformOptimizer is a variant of the gradient descent optimizer implmented in RegularStepGradientDescentOptimizer.

Versors are not in a vector space, for that reason, the classical gradient descent algorithm has to be modified in order to be applicable to Versors (unit quaternions) that form the group SO(3).

The Versor space has only three degrees of freedom, even though Versors are represented using four values.

This optimizer assumes that the CostFunction to be optimized has an itk::Versor and an itk::Vector as parameters.

See also:
RegularStepGradientDescentOptimizer
Versor
VersorRigid3DTransform

Definition at line 49 of file itkVersorRigid3DTransformOptimizer.h.


Member Typedef Documentation

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

Definition at line 64 of file itkSingleValuedNonLinearOptimizer.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.

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

Definition at line 60 of file itkSingleValuedNonLinearOptimizer.h.

typedef Superclass::ParametersType itk::SingleValuedNonLinearOptimizer::ParametersType
inherited

Parameters type. It defines a position in the optimization search space.

Reimplemented from itk::NonLinearOptimizer.

Reimplemented in itk::PowellOptimizer, itk::QuaternionRigidTransformGradientDescentOptimizer, itk::AmoebaOptimizer, and itk::FRPROptimizer.

Definition at line 48 of file itkSingleValuedNonLinearOptimizer.h.

typedef Superclass::ScalesType itk::NonLinearOptimizer::ScalesType
inherited

Scale type. This array defines scale to be applied to parameters before being evaluated in the cost function. This allows to map to a more convenient space. In particular this is used to normalize parameter spaces in which some parameters have a different dynamic range.

Reimplemented from itk::Optimizer.

Definition at line 52 of file itkNonLinearOptimizer.h.

Standard class typedefs.

Reimplemented from itk::RegularStepGradientDescentBaseOptimizer.

Definition at line 54 of file itkVersorRigid3DTransformOptimizer.h.

Definition at line 71 of file itkVersorRigid3DTransformOptimizer.h.

Versor Type

Definition at line 70 of file itkVersorRigid3DTransformOptimizer.h.


Member Enumeration Documentation

Codes of stopping conditions.

Enumerator:
GradientMagnitudeTolerance 
StepTooSmall 
ImageNotAvailable 
CostFunctionError 
MaximumNumberOfIterations 
Unknown 

Definition at line 49 of file itkRegularStepGradientDescentBaseOptimizer.h.


Constructor & Destructor Documentation

itk::VersorRigid3DTransformOptimizer::VersorRigid3DTransformOptimizer ( )
inlineprotected

Definition at line 79 of file itkVersorRigid3DTransformOptimizer.h.

virtual itk::VersorRigid3DTransformOptimizer::~VersorRigid3DTransformOptimizer ( )
inlineprotectedvirtual

Definition at line 80 of file itkVersorRigid3DTransformOptimizer.h.

itk::VersorRigid3DTransformOptimizer::VersorRigid3DTransformOptimizer ( 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::RegularStepGradientDescentBaseOptimizer::AdvanceOneStep ( void  )
protectedvirtualinherited

Advance one step following the gradient direction This method verifies if a change in direction is required and if a reduction in steplength is required.

Advance one Step following the gradient direction

Definition at line 166 of file itkRegularStepGradientDescentBaseOptimizer.cxx.

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.

virtual::itk::LightObject::Pointer itk::VersorRigid3DTransformOptimizer::CreateAnother ( void  ) 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::RegularStepGradientDescentBaseOptimizer.

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().

virtual const CostFunctionType* itk::SingleValuedNonLinearOptimizer::GetCostFunction ( )
virtualinherited

Get the cost function.

virtual unsigned int itk::RegularStepGradientDescentBaseOptimizer::GetCurrentIteration ( ) const
virtualinherited
virtual const ParametersType& itk::Optimizer::GetCurrentPosition ( )
virtualinherited

Get current position of the optimization.

Referenced by CommandIterationUpdate::Execute().

virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetCurrentStepLength ( )
virtualinherited
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().

bool itk::Object::GetGlobalWarningDisplay ( )
staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

virtual const DerivativeType& itk::RegularStepGradientDescentBaseOptimizer::GetGradient ( )
virtualinherited
virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetGradientMagnitudeTolerance ( )
virtualinherited
virtual const ParametersType& itk::Optimizer::GetInitialPosition ( )
virtualinherited

Get the position to initialize the optimization.

Referenced by itk::SPSAOptimizer::GuessParameters().

virtual const bool& itk::RegularStepGradientDescentBaseOptimizer::GetMaximize ( )
virtualinherited
virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetMaximumStepLength ( )
virtualinherited
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.

Referenced by otb::RenderingImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData(), itk::Brains2MaskImageIO::CanReadFile(), otb::DataNode< TPrecision, VDimension, TValuePrecision >::CopyFieldList(), otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), otb::Image< TPixel, VImageDimension >::CopyInformation(), itk::GDCMImageIO::GetBodyPart(), itk::GDCMImageIO::GetInstitution(), itk::GDCMImageIO::GetManufacturer(), itk::GDCMImageIO::GetModality(), itk::GDCMImageIO::GetModel(), itk::GDCMImageIO::GetNumberOfSeriesInStudy(), itk::GDCMImageIO::GetNumberOfStudyRelatedSeries(), itk::GDCMImageIO::GetPatientAge(), itk::GDCMImageIO::GetPatientDOB(), itk::GDCMImageIO::GetPatientID(), itk::GDCMImageIO::GetPatientName(), itk::GDCMImageIO::GetPatientSex(), itk::GDCMImageIO::GetScanOptions(), itk::GDCMImageIO::GetStudyDate(), itk::GDCMImageIO::GetStudyDescription(), itk::GDCMImageIO::GetStudyID(), itk::GDCMImageIO::GetValueFromTag(), otb::GDALImageIO::InternalReadImageInformation(), itk::GDCMImageIO::InternalReadImageInformation(), otb::GDALImageIO::InternalWriteImageInformation(), otb::RAMDrivenAdaptativeStreamingManager< TImage >::PrepareStreaming(), itk::DICOMImageIO2::Read(), itk::DICOMImageIO2::ReadImageInformation(), itk::NrrdImageIO::ReadImageInformation(), otb::JPEG2000ImageIO::ReadImageInformation(), itk::MetaImageIO::ReadImageInformation(), itk::VoxBoCUBImageIO::ReadImageInformation(), itk::MRCImageIO::ReadImageInformation(), itk::IPLCommonImageIO::ReadImageInformation(), itk::PhilipsRECImageIO::ReadImageInformation(), itk::AnalyzeImageIO::ReadImageInformation(), itk::Bruker2DSEQImageIO::ReadImageInformation(), otb::ImageMetadataInterfaceBase::SetImage(), itk::NiftiImageIO::SetImageIOMetadataFromNIfTI(), otb::VectorDataToLabelImageFilter< TVectorData, TOutputImage >::SetOutputParametersFromImage(), itk::NrrdImageIO::Write(), itk::GDCMImageIO::Write(), and itk::PolygonGroupSpatialObjectXMLFileWriter::WriteFile().

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.

bool itk::RegularStepGradientDescentBaseOptimizer::GetMinimize ( ) const
inlineinherited

Definition at line 62 of file itkRegularStepGradientDescentBaseOptimizer.h.

virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetMinimumStepLength ( )
virtualinherited
unsigned long itk::Object::GetMTime ( void  ) const
virtualinherited

Return this objects modified time.

Return the modification for this object.

Reimplemented in itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ShiftScalePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::SpatialObject< TDimension >, itk::SpatialObject< 3 >, itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::MeshSpatialObject< TMesh >, and itk::SceneSpatialObject< TSpaceDimension >.

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::VersorRigid3DTransformOptimizer::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::RegularStepGradientDescentBaseOptimizer.

virtual const unsigned long& itk::RegularStepGradientDescentBaseOptimizer::GetNumberOfIterations ( )
virtualinherited
virtual int itk::LightObject::GetReferenceCount ( ) const
inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

virtual const double& itk::RegularStepGradientDescentBaseOptimizer::GetRelaxationFactor ( )
virtualinherited
virtual const ScalesType& itk::Optimizer::GetScales ( )
virtualinherited

Get current parameters scaling.

Referenced by itk::SPSAOptimizer::ComputeGradient().

virtual const StopConditionType& itk::RegularStepGradientDescentBaseOptimizer::GetStopCondition ( )
virtualinherited
const std::string itk::RegularStepGradientDescentBaseOptimizer::GetStopConditionDescription ( ) const
virtualinherited

Get the reason for termination

Reimplemented from itk::Optimizer.

Definition at line 282 of file itkRegularStepGradientDescentBaseOptimizer.cxx.

SingleValuedNonLinearOptimizer::MeasureType itk::SingleValuedNonLinearOptimizer::GetValue ( const ParametersType parameters) const
inherited

Get the cost function value at the given parameters.

Get the cost function value at the given parameters

Reimplemented in itk::SPSAOptimizer.

Definition at line 67 of file itkSingleValuedNonLinearOptimizer.cxx.

References itk::ExceptionObject::SetDescription(), and itk::ExceptionObject::SetLocation().

virtual const MeasureType& itk::RegularStepGradientDescentBaseOptimizer::GetValue ( )
virtualinherited
static void itk::Object::GlobalWarningDisplayOff ( )
inlinestaticinherited
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
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.

virtual void itk::RegularStepGradientDescentBaseOptimizer::MaximizeOff ( )
virtualinherited
virtual void itk::RegularStepGradientDescentBaseOptimizer::MaximizeOn ( )
virtualinherited
void itk::RegularStepGradientDescentBaseOptimizer::MinimizeOff ( void  )
inlineinherited

Definition at line 68 of file itkRegularStepGradientDescentBaseOptimizer.h.

void itk::RegularStepGradientDescentBaseOptimizer::MinimizeOn ( void  )
inlineinherited

Definition at line 66 of file itkRegularStepGradientDescentBaseOptimizer.h.

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.

Reimplemented in otb::SVMModel< TValue, TLabel >, otb::SurfaceAdjacencyEffect6SCorrectionSchemeFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ShiftScalePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, otb::GenericRSTransform< TScalarType, NInputDimensions, NOutputDimensions >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, TBufferConverter >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, MeanShift::VectorBufferConverter >, otb::GCPsToRPCSensorModelImageFilter< TImage >, otb::Polygon< TValue >, otb::ImageRegionAdaptativeSplitter< VImageDimension >, otb::GenericInterpolateImageFunction< TInputImage, TFunction, TBoundaryCondition, TCoordRep >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, otb::PolyLineParametricPathWithValue< TValue, VDimension >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, otb::PolyLineParametricPathWithValue< TValue, 2 >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, otb::PhysicalToRPCSensorModelImageFilter< TImage >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >, itk::NormalizeImageFilter< TInputImage, TOutputImage >, and otb::StatisticsXMLFileReader< TMeasurementVector >.

Definition at line 297 of file itkObject.cxx.

Referenced by otb::Wrapper::InputImageListParameter::AddFromFileName(), otb::Wrapper::InputVectorDataListParameter::AddFromFileName(), otb::Wrapper::InputImageListParameter::AddImage(), otb::Wrapper::InputImageListParameter::AddNullElement(), otb::Wrapper::InputVectorDataListParameter::AddNullElement(), otb::Wrapper::StringListParameter::AddNullElement(), otb::VectorDataModel::AddPointToGeometry(), otb::Wrapper::InputVectorDataListParameter::AddVectorData(), otb::Wrapper::InputImageListParameter::ClearValue(), otb::Wrapper::InputVectorDataListParameter::ClearValue(), otb::VectorDataModel::DeleteGeometry(), otb::VectorDataModel::EndGeometry(), otb::Wrapper::InputImageListParameter::Erase(), otb::Wrapper::InputVectorDataListParameter::Erase(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), otb::ImageWidget< TInputImage >::LinearInterpolationOff(), otb::ImageWidget< TInputImage >::LinearInterpolationOn(), itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >::MatrixOffsetTransformBase(), otb::ogr::ImageReference< double >::Modified(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetAutoMinMax(), otb::BlendingImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetBlendingFunction(), otb::ImageLayerGenerator< TImageLayer >::SetBlendingFunction(), otb::TileMapImageIO::SetCacheDirectory(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetChannelList(), itk::LBFGSBOptimizer::SetCostFunction(), itk::MINC2ImageIO::SetDimensionName(), itk::ImageIOBase::SetDimensions(), itk::ImageIOBase::SetDirection(), otb::Wrapper::InputImageListParameter::SetImageList(), itk::GDCMSeriesFileNames::SetInputDirectory(), otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::SetInputHistogram(), otb::ImageToGenericRSOutputParameters< TImage >::SetInputKeywordList(), otb::Wrapper::InputVectorDataListParameter::SetListFromFileName(), otb::Wrapper::InputImageListParameter::SetListFromFileName(), otb::Function::RenderingFunction< TPixel, TRGBPixel >::SetListSample(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), otb::Wrapper::InputImageListParameter::SetNthFileName(), otb::Wrapper::InputVectorDataListParameter::SetNthFileName(), itk::ImageIOBase::SetNumberOfDimensions(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ImageIOBase::SetOrigin(), otb::ImageToGenericRSOutputParameters< TImage >::SetOutputProjectionRef(), otb::MapProjectionAdapter::SetParameter(), otb::Function::GaussianRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetParameters(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetParameters(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), otb::ImageLayerGenerator< TImageLayer >::SetRenderingFunction(), otb::RenderingImageFilter< TInputImage, TOutputImage >::SetRenderingFunction(), itk::ImageIOBase::SetSpacing(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation(), otb::Wrapper::OutputFilenameParameter::SetValue(), otb::Wrapper::InputFilenameParameter::SetValue(), otb::Wrapper::ListViewParameter::SetValue(), otb::Wrapper::ChoiceParameter::SetValue(), otb::Wrapper::InputVectorDataListParameter::SetVectorDataList(), and otb::MapProjectionAdapter::SetWkt().

static Pointer itk::VersorRigid3DTransformOptimizer::New ( )
static

Method for creation through the object factory.

Reimplemented from itk::RegularStepGradientDescentBaseOptimizer.

void itk::VersorRigid3DTransformOptimizer::operator= ( const Self )
private
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::RegularStepGradientDescentBaseOptimizer::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Print Self method

Reimplemented from itk::SingleValuedNonLinearOptimizer.

Definition at line 290 of file itkRegularStepGradientDescentBaseOptimizer.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::RegularStepGradientDescentBaseOptimizer::ResumeOptimization ( void  )
inherited

Resume previously stopped optimization with current parameters.

See also:
StopOptimization

Resume the optimization

Definition at line 94 of file itkRegularStepGradientDescentBaseOptimizer.cxx.

References itk::ExceptionObject::GetDescription().

void itk::SingleValuedNonLinearOptimizer::SetCostFunction ( CostFunctionType costFunction)
virtualinherited

Set the cost function.

Connect a Cost Function

Definition at line 37 of file itkSingleValuedNonLinearOptimizer.cxx.

References itk::CostFunction::GetNumberOfParameters().

Referenced by itk::AmoebaOptimizer::SetCostFunction().

void itk::Optimizer::SetCurrentPosition ( const ParametersType param)
protectedvirtualinherited

Set the current position.

Set the current position

Definition at line 65 of file itkOptimizer.cxx.

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().

virtual void itk::RegularStepGradientDescentBaseOptimizer::SetGradientMagnitudeTolerance ( double  _arg)
virtualinherited
void itk::Optimizer::SetInitialPosition ( const ParametersType param)
virtualinherited

Set the position to initialize the optimization.

Set the initial position

Definition at line 53 of file itkOptimizer.cxx.

virtual void itk::RegularStepGradientDescentBaseOptimizer::SetMaximize ( bool  _arg)
virtualinherited

Specify whether to minimize or maximize the cost function.

virtual void itk::RegularStepGradientDescentBaseOptimizer::SetMaximumStepLength ( double  _arg)
virtualinherited

Set/Get parameters to control the optimization process.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary rhs)
inherited
void itk::RegularStepGradientDescentBaseOptimizer::SetMinimize ( bool  v)
inlineinherited

Definition at line 64 of file itkRegularStepGradientDescentBaseOptimizer.h.

virtual void itk::RegularStepGradientDescentBaseOptimizer::SetMinimumStepLength ( double  _arg)
virtualinherited
virtual void itk::RegularStepGradientDescentBaseOptimizer::SetNumberOfIterations ( unsigned long  _arg)
virtualinherited
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.

virtual void itk::RegularStepGradientDescentBaseOptimizer::SetRelaxationFactor ( double  _arg)
virtualinherited
void itk::Optimizer::SetScales ( const ScalesType scales)
inherited

Set current parameters scaling.

Set scaling as an array of factors

Definition at line 40 of file itkOptimizer.cxx.

void itk::RegularStepGradientDescentBaseOptimizer::StartOptimization ( void  )
virtualinherited

Start optimization.

Start the optimization

Reimplemented from itk::Optimizer.

Definition at line 58 of file itkRegularStepGradientDescentBaseOptimizer.cxx.

References itk::Unknown.

void itk::VersorRigid3DTransformOptimizer::StepAlongGradient ( double  factor,
const DerivativeType transformedGradient 
)
virtual

Advance one step following the gradient direction.

Advance one Step following the gradient direction This method will be overrided in non-vector spaces

Definition at line 33 of file itkVersorRigid3DTransformOptimizer.cxx.

References itk::Vector< T, NVectorDimension >::GetNorm(), itk::Versor< T >::GetX(), itk::Versor< T >::GetY(), itk::Versor< T >::GetZ(), and itk::Versor< T >::Set().

virtual void itk::RegularStepGradientDescentBaseOptimizer::StepAlongGradient ( double  ,
const DerivativeType  
)
inlineprotectedvirtualinherited

Advance one step along the corrected gradient taking into account the steplength represented by factor. This method is invoked by AdvanceOneStep. It is expected to be overrided by optimization methods in non-vector spaces

See also:
AdvanceOneStep

Definition at line 117 of file itkRegularStepGradientDescentBaseOptimizer.h.

References itk::ExceptionObject::SetDescription(), and itk::ExceptionObject::SetLocation().

void itk::RegularStepGradientDescentBaseOptimizer::StopOptimization ( void  )
inherited

Stop optimization.

See also:
ResumeOptimization

Stop optimization

Definition at line 152 of file itkRegularStepGradientDescentBaseOptimizer.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

CostFunctionPointer itk::SingleValuedNonLinearOptimizer::m_CostFunction
protectedinherited
unsigned long itk::RegularStepGradientDescentBaseOptimizer::m_CurrentIteration
protectedinherited
ParametersType itk::Optimizer::m_CurrentPosition
protectedinherited

Definition at line 98 of file itkOptimizer.h.

double itk::RegularStepGradientDescentBaseOptimizer::m_CurrentStepLength
protectedinherited
DerivativeType itk::RegularStepGradientDescentBaseOptimizer::m_Gradient
protectedinherited
double itk::RegularStepGradientDescentBaseOptimizer::m_GradientMagnitudeTolerance
protectedinherited
bool itk::RegularStepGradientDescentBaseOptimizer::m_Maximize
protectedinherited
double itk::RegularStepGradientDescentBaseOptimizer::m_MaximumStepLength
protectedinherited
double itk::RegularStepGradientDescentBaseOptimizer::m_MinimumStepLength
protectedinherited
unsigned long itk::RegularStepGradientDescentBaseOptimizer::m_NumberOfIterations
protectedinherited
DerivativeType itk::RegularStepGradientDescentBaseOptimizer::m_PreviousGradient
protectedinherited
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.

double itk::RegularStepGradientDescentBaseOptimizer::m_RelaxationFactor
protectedinherited
bool itk::Optimizer::m_ScalesInitialized
protectedinherited

Definition at line 93 of file itkOptimizer.h.

bool itk::RegularStepGradientDescentBaseOptimizer::m_Stop
protectedinherited
StopConditionType itk::RegularStepGradientDescentBaseOptimizer::m_StopCondition
protectedinherited
OStringStream itk::RegularStepGradientDescentBaseOptimizer::m_StopConditionDescription
protectedinherited
MeasureType itk::RegularStepGradientDescentBaseOptimizer::m_Value
protectedinherited
const unsigned int itk::VersorRigid3DTransformOptimizer::SpaceDimension = 6
static

This class is specialized for 3D

Definition at line 67 of file itkVersorRigid3DTransformOptimizer.h.


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

Generated at Sun Feb 3 2013 02:50:42 for Orfeo Toolbox with doxygen 1.8.1.1