OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
otb::RationalTransform< TScalarType, Dimension > Class Template Reference

#include <otbRationalTransform.h>

+ Inheritance diagram for otb::RationalTransform< TScalarType, Dimension >:
+ Collaboration diagram for otb::RationalTransform< TScalarType, Dimension >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::Point< ScalarType,
Dimension > 
InputPointType
 
typedef
Superclass::InverseTransformBasePointer 
InverseTransformBasePointer
 
typedef
Superclass::NumberOfParametersType 
NumberOfParametersType
 
typedef itk::Point< double,
Dimension > 
OriginType
 
typedef itk::Point< ScalarType,
Dimension > 
OutputPointType
 
typedef Superclass::ParametersType ParametersType
 
typedef
Superclass::ParametersValueType 
ParametersValueType
 
typedef itk::SmartPointer< SelfPointer
 
typedef Superclass::ScalarType ScalarType
 
typedef RationalTransform Self
 
typedef itk::Vector< double,
Dimension > 
SpacingType
 
typedef Transform< TScalarType,
Dimension, Dimension > 
Superclass
 
- Public Types inherited from otb::Transform< TScalarType, Dimension, Dimension >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::CovariantVector
< TScalarType,
NInputDimensions > 
InputCovariantVectorType
 
typedef itk::Point
< TScalarType,
NInputDimensions > 
InputPointType
 
typedef itk::Vector
< TScalarType,
NInputDimensions > 
InputVectorType
 
typedef vnl_vector_fixed
< TScalarType,
NInputDimensions > 
InputVnlVectorType
 
typedef
Superclass::InverseTransformBasePointer 
InverseTransformBasePointer
 
typedef
Superclass::InverseTransformBaseType 
InverseTransformBaseType
 
typedef itk::Array2D< double > JacobianType
 
typedef
Superclass::NumberOfParametersType 
NumberOfParametersType
 
typedef itk::CovariantVector
< TScalarType,
NOutputDimensions > 
OutputCovariantVectorType
 
typedef itk::Point
< TScalarType,
NOutputDimensions > 
OutputPointType
 
typedef itk::Vector
< TScalarType,
NOutputDimensions > 
OutputVectorType
 
typedef vnl_vector_fixed
< TScalarType,
NOutputDimensions > 
OutputVnlVectorType
 
typedef Superclass::ParametersType ParametersType
 
typedef
Superclass::ParametersValueType 
ParametersValueType
 
typedef itk::SmartPointer< SelfPointer
 
typedef TScalarType ScalarType
 
typedef Transform Self
 
typedef itk::Transform
< TScalarType,
NInputDimensions,
NOutputDimensions > 
Superclass
 
enum  TransformDirection
 
- Public Types inherited from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >
typedef SmartPointer< const SelfConstPointer
 
typedef Array
< ParametersValueType
DerivativeType
 
typedef Matrix< double,
itkGetStaticConstMacro(OutputSpaceDimension),
itkGetStaticConstMacro(InputSpaceDimension)> 
DirectionChangeMatrix
 
typedef
Superclass::FixedParametersType 
FixedParametersType
 
typedef
Superclass::FixedParametersValueType 
FixedParametersValueType
 
typedef CovariantVector
< TScalarType,
NInputDimensions > 
InputCovariantVectorType
 
typedef DiffusionTensor3D
< TScalarType > 
InputDiffusionTensor3DType
 
typedef Matrix< double,
itkGetStaticConstMacro(InputSpaceDimension),
itkGetStaticConstMacro(InputSpaceDimension)> 
InputDirectionMatrix
 
typedef Point< TScalarType,
NInputDimensions > 
InputPointType
 
typedef
SymmetricSecondRankTensor
< TScalarType,
NInputDimensions > 
InputSymmetricSecondRankTensorType
 
typedef VariableLengthVector
< TScalarType > 
InputVectorPixelType
 
typedef Vector< TScalarType,
NInputDimensions > 
InputVectorType
 
typedef vnl_vector_fixed
< TScalarType,
NInputDimensions > 
InputVnlVectorType
 
typedef
InverseTransformBaseType::Pointer 
InverseTransformBasePointer
 
typedef Transform< TScalarType,
NOutputDimensions,
NInputDimensions > 
InverseTransformBaseType
 
typedef Array2D
< ParametersValueType
JacobianType
 
typedef Matrix< TScalarType,
itkGetStaticConstMacro(OutputSpaceDimension),
itkGetStaticConstMacro(InputSpaceDimension)> 
MatrixType
 
typedef
Superclass::NumberOfParametersType 
NumberOfParametersType
 
typedef CovariantVector
< TScalarType,
NOutputDimensions > 
OutputCovariantVectorType
 
typedef DiffusionTensor3D
< TScalarType > 
OutputDiffusionTensor3DType
 
typedef Matrix< double,
itkGetStaticConstMacro(OutputSpaceDimension),
itkGetStaticConstMacro(OutputSpaceDimension)> 
OutputDirectionMatrix
 
typedef Point< TScalarType,
NOutputDimensions > 
OutputPointType
 
typedef
SymmetricSecondRankTensor
< TScalarType,
NOutputDimensions > 
OutputSymmetricSecondRankTensorType
 
typedef VariableLengthVector
< TScalarType > 
OutputVectorPixelType
 
typedef Vector< TScalarType,
NOutputDimensions > 
OutputVectorType
 
typedef vnl_vector_fixed
< TScalarType,
NOutputDimensions > 
OutputVnlVectorType
 
typedef Superclass::ParametersType ParametersType
 
typedef
Superclass::ParametersValueType 
ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef ParametersValueType ScalarType
 
typedef Transform Self
 
typedef TransformBaseTemplate
< TScalarType > 
Superclass
 
typedef
Superclass::TransformCategoryType 
TransformCategoryType
 
- Public Types inherited from itk::TransformBaseTemplate< TParametersValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef OptimizerParameters
< FixedParametersValueType
FixedParametersType
 
typedef double FixedParametersValueType
 
typedef IdentifierType NumberOfParametersType
 
typedef OptimizerParameters
< ParametersValueType
ParametersType
 
typedef TParametersValueType ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef TransformBaseTemplate Self
 
typedef Object Superclass
 
enum  TransformCategoryType
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual unsigned int GetDenominatorDegree () const
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetNumeratorDegree () const
 
void SetNumeratorDegree (unsigned int value)
 
void SetDenominatorDegree (unsigned int value)
 
- Public Member Functions inherited from otb::Transform< TScalarType, Dimension, Dimension >
void ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const override
 
unsigned int GetInputSpaceDimension (void) const override
 
NumberOfParametersType GetNumberOfParameters (void) const override
 
unsigned int GetOutputSpaceDimension (void) const override
 
const ParametersTypeGetParameters (void) const override
 
void SetFixedParameters (const ParametersType &) override
 
void SetParameters (const ParametersType &) override
 
void SetParametersByValue (const ParametersType &p) override
 
OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &) const override
 
OutputPointType TransformPoint (const InputPointType &) const override
 
OutputVectorType TransformVector (const InputVectorType &) const override
 
OutputVnlVectorType TransformVector (const InputVnlVectorType &) const override
 
const ParametersTypeGetFixedParameters (void) const override
 
virtual const JacobianTypeGetJacobian (const InputPointType &) const
 
- Public Member Functions inherited from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >
virtual void ComputeInverseJacobianWithRespectToPosition (const InputPointType &x, JacobianType &jacobian) const
 
virtual void ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &) const
 
virtual void ComputeJacobianWithRespectToPosition (const InputPointType &, JacobianType &) const
 
virtual void CopyInFixedParameters (const FixedParametersValueType *const begin, const FixedParametersValueType *const end) override
 
virtual void CopyInParameters (const ParametersValueType *const begin, const ParametersValueType *const end) override
 
bool GetInverse (Self *) const
 
virtual InverseTransformBasePointer GetInverseTransform () const
 
virtual NumberOfParametersType GetNumberOfFixedParameters () const
 
virtual NumberOfParametersType GetNumberOfLocalParameters (void) const
 
virtual TransformCategoryType GetTransformCategory () const override
 
virtual std::string GetTransformTypeAsString () const override
 
virtual bool IsLinear () const
 
 itkCloneMacro (Self)
 
virtual void SetFixedParameters (const FixedParametersType &) override=0
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &tensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &tensor, const InputPointType &point) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &tensor, const InputPointType &point) const
 
virtual
OutputSymmetricSecondRankTensorType 
TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &) const
 
virtual
OutputSymmetricSecondRankTensorType 
TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &tensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &) const
 
virtual OutputVectorType TransformVector (const InputVectorType &vector, const InputPointType &point) const
 
virtual void UpdateTransformParameters (const DerivativeType &update, ParametersValueType factor=1.0)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int SpaceDimension = Dimension
 
- Static Public Attributes inherited from otb::Transform< TScalarType, Dimension, Dimension >
static const unsigned int InputSpaceDimension
 
static const unsigned int OutputSpaceDimension
 
- Static Public Attributes inherited from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >
static const unsigned int InputSpaceDimension
 
static const unsigned int OutputSpaceDimension
 
unsigned int m_NumeratorDegree
 
unsigned int m_DenominatorDegree
 
OutputPointType TransformPoint (const InputPointType &point) const override
 
NumberOfParametersType GetNumberOfParameters () const override
 
void SetParameters (const typename Superclass::ParametersType &params) override
 
void InitializeParameters ()
 
 RationalTransform ()
 
 ~RationalTransform () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 RationalTransform (const Self &)=delete
 
void operator= (const Self &)=delete
 

Additional Inherited Members

- Protected Member Functions inherited from otb::Transform< TScalarType, Dimension, Dimension >
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 Transform ()
 
 Transform (NumberOfParametersType numberOfParameters)
 
 ~Transform () override
 
- Protected Member Functions inherited from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >
virtual LightObject::Pointer InternalClone () const override
 
OutputDiffusionTensor3DType PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType, const JacobianType) const
 
 Transform (NumberOfParametersType NumberOfParameters)
 
 Transform ()
 
- Protected Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
 TransformBaseTemplate ()
 
virtual ~TransformBaseTemplate ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 
- Protected Attributes inherited from otb::Transform< TScalarType, Dimension, Dimension >
ParametersType m_FixedParameters
 
JacobianType m_Jacobian
 
ParametersType m_Parameters
 
- Protected Attributes inherited from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >
DirectionChangeMatrix m_DirectionChange
 
FixedParametersType m_FixedParameters
 
ParametersType m_Parameters
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

template<class TScalarType = double, unsigned int Dimension = 2>
class otb::RationalTransform< TScalarType, Dimension >

This class implements a rational transfom.

A rational transform is a quotient of two polynomial functions.

The degree of the numerator and denominator polynomial functions can be set using the appropriate setters.

The number of parameters is then the number of dimensions times the numerator degree plus one times the denominator degree plus one.

Parameters in the parameters vector are in the following order: dim0num0 dim0num1 ... dim0numN dim0denom0 dim0denom1 ... dim0denomM ... dim1num0 ... dimDdenomM.

Definition at line 52 of file otbRationalTransform.h.

Member Typedef Documentation

template<class TScalarType = double, unsigned int Dimension = 2>
typedef itk::SmartPointer<const Self> otb::RationalTransform< TScalarType, Dimension >::ConstPointer

Definition at line 60 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
typedef itk::Point<ScalarType, Dimension> otb::RationalTransform< TScalarType, Dimension >::InputPointType

Definition at line 63 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
typedef Superclass::InverseTransformBasePointer otb::RationalTransform< TScalarType, Dimension >::InverseTransformBasePointer

Definition at line 69 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
typedef Superclass::NumberOfParametersType otb::RationalTransform< TScalarType, Dimension >::NumberOfParametersType

Definition at line 73 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
typedef itk::Point<double, Dimension> otb::RationalTransform< TScalarType, Dimension >::OriginType

Definition at line 67 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
typedef itk::Point<ScalarType, Dimension> otb::RationalTransform< TScalarType, Dimension >::OutputPointType

Definition at line 64 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
typedef Superclass::ParametersType otb::RationalTransform< TScalarType, Dimension >::ParametersType

Definition at line 70 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
typedef Superclass::ParametersValueType otb::RationalTransform< TScalarType, Dimension >::ParametersValueType

Definition at line 72 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
typedef itk::SmartPointer<Self> otb::RationalTransform< TScalarType, Dimension >::Pointer

Definition at line 59 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
typedef Superclass::ScalarType otb::RationalTransform< TScalarType, Dimension >::ScalarType

Definition at line 62 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
typedef RationalTransform otb::RationalTransform< TScalarType, Dimension >::Self

Definition at line 58 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
typedef itk::Vector<double, Dimension> otb::RationalTransform< TScalarType, Dimension >::SpacingType

Definition at line 66 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
typedef Transform<TScalarType, Dimension, Dimension> otb::RationalTransform< TScalarType, Dimension >::Superclass

Standard class typedefs.

Definition at line 57 of file otbRationalTransform.h.

Constructor & Destructor Documentation

template<class TScalarType = double, unsigned int Dimension = 2>
otb::RationalTransform< TScalarType, Dimension >::RationalTransform ( )
inlineprotected

The transform point method

Definition at line 188 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
otb::RationalTransform< TScalarType, Dimension >::~RationalTransform ( )
inlineoverrideprotected

The transform point method

Definition at line 194 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
otb::RationalTransform< TScalarType, Dimension >::RationalTransform ( const Self )
privatedelete

The transform point method

Member Function Documentation

template<class TScalarType = double, unsigned int Dimension = 2>
virtual::itk::LightObject::Pointer otb::RationalTransform< TScalarType, Dimension >::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

template<class TScalarType = double, unsigned int Dimension = 2>
virtual unsigned int otb::RationalTransform< TScalarType, Dimension >::GetDenominatorDegree ( ) const
virtual

Get the denominator degree

template<class TScalarType = double, unsigned int Dimension = 2>
virtual const char* otb::RationalTransform< TScalarType, Dimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from otb::Transform< TScalarType, Dimension, Dimension >.

template<class TScalarType = double, unsigned int Dimension = 2>
NumberOfParametersType otb::RationalTransform< TScalarType, Dimension >::GetNumberOfParameters ( void  ) const
inlineoverridevirtual

Get the number of parameters

Reimplemented from itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >.

Definition at line 154 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
virtual unsigned int otb::RationalTransform< TScalarType, Dimension >::GetNumeratorDegree ( ) const
virtual

Get the numerator degree

template<class TScalarType = double, unsigned int Dimension = 2>
void otb::RationalTransform< TScalarType, Dimension >::InitializeParameters ( )
inline

Initialize Parameters size

Definition at line 173 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
static Pointer otb::RationalTransform< TScalarType, Dimension >::New ( )
static

Method for creation through the object factory.

template<class TScalarType = double, unsigned int Dimension = 2>
void otb::RationalTransform< TScalarType, Dimension >::operator= ( const Self )
privatedelete

The transform point method

template<class TScalarType = double, unsigned int Dimension = 2>
void otb::RationalTransform< TScalarType, Dimension >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
inlineoverrideprotectedvirtual

The transform point method

Reimplemented from itk::Object.

Definition at line 196 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
void otb::RationalTransform< TScalarType, Dimension >::SetDenominatorDegree ( unsigned int  value)
inline

Set the numerator degree

Definition at line 95 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
void otb::RationalTransform< TScalarType, Dimension >::SetNumeratorDegree ( unsigned int  value)
inline

Set the numerator degree

Definition at line 84 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
void otb::RationalTransform< TScalarType, Dimension >::SetParameters ( const typename Superclass::ParametersType params)
inlineoverride

The transform point method

Definition at line 160 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
OutputPointType otb::RationalTransform< TScalarType, Dimension >::TransformPoint ( const InputPointType point) const
inlineoverride

The transform point method

Definition at line 106 of file otbRationalTransform.h.

Member Data Documentation

template<class TScalarType = double, unsigned int Dimension = 2>
unsigned int otb::RationalTransform< TScalarType, Dimension >::m_DenominatorDegree
private

The transform point method

Definition at line 212 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
unsigned int otb::RationalTransform< TScalarType, Dimension >::m_NumeratorDegree
private

The transform point method

Definition at line 209 of file otbRationalTransform.h.

template<class TScalarType = double, unsigned int Dimension = 2>
const unsigned int otb::RationalTransform< TScalarType, Dimension >::SpaceDimension = Dimension
static

Definition at line 81 of file otbRationalTransform.h.


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