Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet > Class Template Reference

This class performs an estimation of the local displacement modelled by a given transform between the fixed and the moving image, at each point of the given point set. More...

#include <otbDisparityMapEstimationMethod.h>

+ Inheritance diagram for otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >:
+ Collaboration diagram for otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef FixedImageType::Pointer FixedImagePointerType
 
typedef
MetricType::FixedImageRegionType 
FixedImageRegionType
 
typedef TFixedImage FixedImageType
 
typedef FixedImageType::PixelType FixedPixelType
 
typedef InterpolatorType::Pointer InterpolatorPointerType
 
typedef
MetricType::InterpolatorType 
InterpolatorType
 
typedef MetricType::Pointer MetricPointerType
 
typedef
itk::ImageToImageMetric
< FixedImageType,
MovingImageType
MetricType
 
typedef MovingImageType::Pointer MovingImagePointerType
 
typedef TMovingImage MovingImageType
 
typedef MovingImageType::PixelType MovingPixelType
 
typedef OptimizerType::Pointer OptimizerPointerType
 
typedef
itk::SingleValuedNonLinearOptimizer 
OptimizerType
 
typedef
MetricType::TransformParametersType 
ParametersType
 
typedef itk::SmartPointer< SelfPointer
 
typedef PointSetType::Pointer PointSetPointerType
 
typedef TPointSet PointSetType
 
typedef
DisparityMapEstimationMethod 
Self
 
typedef FixedImageType::SizeType SizeType
 
typedef PointSetSource< TPointSet > Superclass
 
typedef
TransformOutputType::ConstPointer 
TransformOutputConstPointerType
 
typedef
TransformOutputType::Pointer 
TransformOutputPointerType
 
typedef
itk::DataObjectDecorator
< TransformType
TransformOutputType
 
typedef TransformType::Pointer TransformPointerType
 
typedef MetricType::TransformType TransformType
 
- Public Types inherited from otb::PointSetSource< TPointSet >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef OutputPointSetType::Pointer OutputPointSetPointer
 
typedef TPointSet OutputPointSetType
 
typedef
OutputPointSetType::PointDataContainer 
PointDataContainerType
 
typedef itk::SmartPointer< SelfPointer
 
typedef
OutputPointSetType::PointsContainer 
PointsContainerType
 
typedef PointSetSource Self
 
typedef itk::ProcessObject Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual SizeType GetExploSize ()
 
const TFixedImage * GetFixedImage (void)
 
virtual const ParametersTypeGetInitialTransformParameters ()
 
virtual InterpolatorTypeGetInterpolator ()
 
virtual MetricTypeGetMetric ()
 
const TMovingImage * GetMovingImage (void)
 
virtual const char * GetNameOfClass () const
 
virtual OptimizerTypeGetOptimizer ()
 
const TPointSet * GetPointSet (void)
 
virtual TransformTypeGetTransform ()
 
virtual SizeType GetWinSize ()
 
virtual void SetExploSize (SizeType _arg)
 
void SetFixedImage (const TFixedImage *image)
 
virtual void SetInitialTransformParameters (ParametersType _arg)
 
virtual void SetInterpolator (InterpolatorType *_arg)
 
virtual void SetMetric (MetricType *_arg)
 
void SetMovingImage (const TMovingImage *image)
 
virtual void SetOptimizer (OptimizerType *_arg)
 
void SetPointSet (const TPointSet *pointset)
 
virtual void SetTransform (TransformType *_arg)
 
virtual void SetWinSize (SizeType _arg)
 
- Public Member Functions inherited from otb::PointSetSource< TPointSet >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
OutputPointSetTypeGetOutput (void)
 
OutputPointSetTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, itk::DataObject *output)
 
virtual void GraftOutput (itk::DataObject *output)
 
virtual DataObjectPointer MakeOutput (unsigned int idx)
 
void SetOutput (OutputPointSetType *output)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::PointSetSource< TPointSet >
static Pointer New ()
 

Protected Member Functions

 DisparityMapEstimationMethod ()
 
virtual ~DisparityMapEstimationMethod ()
 
void GenerateData ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
- Protected Member Functions inherited from otb::PointSetSource< TPointSet >
 PointSetSource ()
 
virtual ~PointSetSource ()
 
void GenerateInputRequestedRegion ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 

Private Member Functions

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

Private Attributes

SizeType m_ExploSize
 
ParametersType m_InitialTransformParameters
 
InterpolatorPointerType m_Interpolator
 
MetricPointerType m_Metric
 
OptimizerPointerType m_Optimizer
 
TransformPointerType m_Transform
 
SizeType m_WinSize
 

Detailed Description

template<class TFixedImage, class TMovingImage, class TPointSet>
class otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >

This class performs an estimation of the local displacement modelled by a given transform between the fixed and the moving image, at each point of the given point set.

It uses the ITK registration framework locally for each point and thus provides the flexibility of this framework. The parameters of each transform are stored in the ouptut point set associated data. Optimizer, metric, interpolator and transform fixed parameters have to be set by the user.

This filters returns the pointset enriched with a set of value as PointData, in order of apparition :

This class is derived from the MAECENAS code provided by Jordi Inglada, from CNES.

See Also
FineRegistrationImageFilter, FastCorrelationImageFilter

Definition at line 52 of file otbDisparityMapEstimationMethod.h.

Member Typedef Documentation

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef itk::SmartPointer<const Self> otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::ConstPointer

Definition at line 60 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef itk::DataObject::Pointer otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::DataObjectPointer

Smart Pointer type to a DataObject.

Definition at line 110 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef FixedImageType::Pointer otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::FixedImagePointerType

Definition at line 70 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef MetricType::FixedImageRegionType otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::FixedImageRegionType

Definition at line 86 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef TFixedImage otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::FixedImageType

Typedef for the Fixed image.

Definition at line 66 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef FixedImageType::PixelType otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::FixedPixelType

Definition at line 71 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef InterpolatorType::Pointer otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::InterpolatorPointerType

Definition at line 99 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef MetricType::InterpolatorType otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::InterpolatorType

Typedef for the generic interpolator.

Definition at line 98 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef MetricType::Pointer otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::MetricPointerType

Definition at line 85 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef itk::ImageToImageMetric<FixedImageType, MovingImageType> otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::MetricType

Typedef for the generic metric.

Definition at line 84 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef MovingImageType::Pointer otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::MovingImagePointerType

Definition at line 76 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef TMovingImage otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::MovingImageType

Typedef for the Moving image.

Definition at line 75 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef MovingImageType::PixelType otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::MovingPixelType

Definition at line 77 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef OptimizerType::Pointer otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::OptimizerPointerType

Definition at line 103 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef itk::SingleValuedNonLinearOptimizer otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::OptimizerType

Typedef for the generic optimizer.

Definition at line 102 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef MetricType::TransformParametersType otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::ParametersType

Type of the Transformation parameters This is the same type used to represent the search space of the optimization algorithm

Definition at line 107 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef itk::SmartPointer<Self> otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::Pointer

Definition at line 59 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef PointSetType::Pointer otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::PointSetPointerType

Definition at line 81 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef TPointSet otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::PointSetType

Typedef for the input and ouptut point set

Definition at line 80 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef DisparityMapEstimationMethod otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::Self

Standard class typedefs.

Definition at line 57 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef FixedImageType::SizeType otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::SizeType

Definition at line 72 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef PointSetSource<TPointSet> otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::Superclass

Definition at line 58 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef TransformOutputType::ConstPointer otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::TransformOutputConstPointerType

Definition at line 95 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef TransformOutputType::Pointer otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::TransformOutputPointerType

Definition at line 94 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef itk::DataObjectDecorator<TransformType> otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::TransformOutputType

Using Decorator pattern for enabling the Transform to be passed in the data pipeline

Definition at line 93 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef TransformType::Pointer otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::TransformPointerType

Definition at line 90 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
typedef MetricType::TransformType otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::TransformType

Typedef for the generic transform .

Definition at line 89 of file otbDisparityMapEstimationMethod.h.

Constructor & Destructor Documentation

template<typename TFixedImage , typename TMovingImage , class TPointSet >
otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::DisparityMapEstimationMethod ( )
protected

Constructor.

Definition at line 36 of file otbDisparityMapEstimationMethod.txx.

template<class TFixedImage , class TMovingImage , class TPointSet >
otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::~DisparityMapEstimationMethod ( )
protectedvirtual

Destructor.

Definition at line 56 of file otbDisparityMapEstimationMethod.txx.

template<class TFixedImage , class TMovingImage , class TPointSet >
otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::DisparityMapEstimationMethod ( const Self )
private

Member Function Documentation

template<class TFixedImage , class TMovingImage , class TPointSet >
virtual::itk::LightObject::Pointer otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::CreateAnother ( void  ) const
template<class TFixedImage , class TMovingImage , class TPointSet >
void otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::GenerateData ( void  )
protected

Main computation method.

Iterate through the point set

Definition at line 131 of file otbDisparityMapEstimationMethod.txx.

References otbMsgDevMacro.

template<class TFixedImage , class TMovingImage , class TPointSet >
virtual SizeType otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::GetExploSize ( )
virtual
template<class TFixedImage , class TMovingImage , class TPointSet >
const TFixedImage * otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::GetFixedImage ( void  )

Get the fixed image.

Returns
The fixed image.

Definition at line 98 of file otbDisparityMapEstimationMethod.txx.

template<class TFixedImage , class TMovingImage , class TPointSet >
virtual const ParametersType& otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::GetInitialTransformParameters ( )
virtual
template<class TFixedImage , class TMovingImage , class TPointSet >
virtual InterpolatorType* otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::GetInterpolator ( )
virtual
template<class TFixedImage , class TMovingImage , class TPointSet >
virtual MetricType* otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::GetMetric ( )
virtual
template<class TFixedImage , class TMovingImage , class TPointSet >
const TMovingImage * otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::GetMovingImage ( void  )

Get the fixed image.

Returns
The fixed image.

Definition at line 120 of file otbDisparityMapEstimationMethod.txx.

template<class TFixedImage , class TMovingImage , class TPointSet >
virtual const char* otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from otb::PointSetSource< TPointSet >.

template<class TFixedImage , class TMovingImage , class TPointSet >
virtual OptimizerType* otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::GetOptimizer ( )
virtual
template<class TFixedImage , class TMovingImage , class TPointSet >
const TPointSet * otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::GetPointSet ( void  )

Get the source pointset.

Returns
The source pointset.

Definition at line 76 of file otbDisparityMapEstimationMethod.txx.

template<class TFixedImage , class TMovingImage , class TPointSet >
virtual TransformType* otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::GetTransform ( )
virtual
template<class TFixedImage , class TMovingImage , class TPointSet >
virtual SizeType otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::GetWinSize ( )
virtual
template<class TFixedImage , class TMovingImage , class TPointSet >
static Pointer otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::New ( )
static

Method for creation through the object factory.

template<class TFixedImage , class TMovingImage , class TPointSet >
void otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::operator= ( const Self )
private
template<class TFixedImage , class TMovingImage , class TPointSet >
void otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protected

Standard PrintSelf method.

Definition at line 275 of file otbDisparityMapEstimationMethod.txx.

template<class TFixedImage , class TMovingImage , class TPointSet >
virtual void otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::SetExploSize ( SizeType  _arg)
virtual

Set/Get the exploration area radius

template<class TFixedImage , class TMovingImage , class TPointSet >
void otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::SetFixedImage ( const TFixedImage *  image)

Set the fixed image.

Parameters
imageThe fixed image.

Definition at line 87 of file otbDisparityMapEstimationMethod.txx.

template<class TFixedImage , class TMovingImage , class TPointSet >
virtual void otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::SetInitialTransformParameters ( ParametersType  _arg)
virtual

Set/Get the initial transformation parameters.

template<class TFixedImage , class TMovingImage , class TPointSet >
virtual void otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::SetInterpolator ( InterpolatorType _arg)
virtual

Set/Get the Interpolator.

template<class TFixedImage , class TMovingImage , class TPointSet >
virtual void otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::SetMetric ( MetricType _arg)
virtual

Set/Get the Metric.

template<class TFixedImage , class TMovingImage , class TPointSet >
void otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::SetMovingImage ( const TMovingImage *  image)

Set the moving image.

Parameters
imageThe mobing image.

Definition at line 109 of file otbDisparityMapEstimationMethod.txx.

template<class TFixedImage , class TMovingImage , class TPointSet >
virtual void otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::SetOptimizer ( OptimizerType _arg)
virtual

Set/Get the Optimizer.

template<class TFixedImage , class TMovingImage , class TPointSet >
void otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::SetPointSet ( const TPointSet *  pointset)

Set the source pointset.

Parameters
pointsetThe source pointset.

Definition at line 65 of file otbDisparityMapEstimationMethod.txx.

template<class TFixedImage , class TMovingImage , class TPointSet >
virtual void otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::SetTransform ( TransformType _arg)
virtual

Set/Get the Transfrom.

template<class TFixedImage , class TMovingImage , class TPointSet >
virtual void otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::SetWinSize ( SizeType  _arg)
virtual

Set/Get the window radius

Member Data Documentation

template<class TFixedImage , class TMovingImage , class TPointSet >
SizeType otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::m_ExploSize
private

The size of the exploration area

Definition at line 219 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
ParametersType otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::m_InitialTransformParameters
private

The initial transform parameters.

Definition at line 215 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
InterpolatorPointerType otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::m_Interpolator
private

The interpolator used for local registration.

Definition at line 211 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
MetricPointerType otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::m_Metric
private

The metric used for local registration.

Definition at line 199 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
OptimizerPointerType otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::m_Optimizer
private

The optimizer used for local registration.

Definition at line 203 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
TransformPointerType otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::m_Transform
private

The transform used for local registration.

Definition at line 207 of file otbDisparityMapEstimationMethod.h.

template<class TFixedImage , class TMovingImage , class TPointSet >
SizeType otb::DisparityMapEstimationMethod< TFixedImage, TMovingImage, TPointSet >::m_WinSize
private

The size of the window

Definition at line 223 of file otbDisparityMapEstimationMethod.h.


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