#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< Self >	Pointer

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< double, 2, 2 >
typedef itk::SmartPointer< const Self >	ConstPointer

typedef itk::SmartPointer< Self >	Pointer

typedef Transform	Self

typedef itk::Transform< double, NInputDimensions, NOutputDimensions >	Superclass

enum	TransformDirection

typedef double	ScalarType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef Superclass::NumberOfParametersType	NumberOfParametersType

typedef itk::Array2D< double >	JacobianType

typedef itk::Vector< double, NInputDimensions >	InputVectorType

typedef itk::Vector< double, NOutputDimensions >	OutputVectorType

typedef itk::CovariantVector< double, NInputDimensions >	InputCovariantVectorType

typedef itk::CovariantVector< double, NOutputDimensions >	OutputCovariantVectorType

typedef vnl_vector_fixed< double, NInputDimensions >	InputVnlVectorType

typedef vnl_vector_fixed< double, NOutputDimensions >	OutputVnlVectorType

typedef itk::Point< double, NInputDimensions >	InputPointType

typedef itk::Point< double, NOutputDimensions >	OutputPointType

typedef Superclass::InverseTransformBaseType	InverseTransformBaseType

typedef Superclass::InverseTransformBasePointer	InverseTransformBasePointer

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from otb::Transform< double, 2, 2 >
virtual const char *	GetNameOfClass () const

unsigned int	GetInputSpaceDimension (void) const override

unsigned int	GetOutputSpaceDimension (void) const override

OutputPointType	TransformPoint (const InputPointType &) const override

OutputVectorType	TransformVector (const InputVectorType &) const override

OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const override

OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const override

void	SetParameters (const ParametersType &) override

void	ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &) const override

void	SetParametersByValue (const ParametersType &p) override

const ParametersType &	GetParameters (void) const override

void	SetFixedParameters (const ParametersType &) override

const ParametersType &	GetFixedParameters (void) const override

virtual const JacobianType &	GetJacobian (const InputPointType &) const

NumberOfParametersType	GetNumberOfParameters (void) const override

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	SpaceDimension = Dimension

Static Public Attributes inherited from otb::Transform< double, 2, 2 >
static const unsigned int	InputSpaceDimension

static const unsigned int	OutputSpaceDimension

unsigned int	m_NumeratorDegree

unsigned int	m_DenominatorDegree

void	SetNumeratorDegree (unsigned int value)

virtual unsigned int	GetNumeratorDegree () const

void	SetDenominatorDegree (unsigned int value)

virtual unsigned int	GetDenominatorDegree () const

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< double, 2, 2 >
	Transform ()

	Transform (NumberOfParametersType numberOfParameters)

	~Transform () override

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

Protected Attributes inherited from otb::Transform< double, 2, 2 >
ParametersType	m_Parameters

ParametersType	m_FixedParameters

JacobianType	m_Jacobian

Detailed Description

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

This class implements a rational transform.

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 51 of file otbRationalTransform.h.

Member Typedef Documentation

◆ ConstPointer

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

typedef itk::SmartPointer<const Self> otb::RationalTransform< TScalarType, Dimension >::ConstPointer

Definition at line 58 of file otbRationalTransform.h.

◆ InputPointType

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

typedef itk::Point<ScalarType, Dimension> otb::RationalTransform< TScalarType, Dimension >::InputPointType

Definition at line 61 of file otbRationalTransform.h.

◆ InverseTransformBasePointer

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

typedef Superclass::InverseTransformBasePointer otb::RationalTransform< TScalarType, Dimension >::InverseTransformBasePointer

Definition at line 67 of file otbRationalTransform.h.

◆ NumberOfParametersType

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

typedef Superclass::NumberOfParametersType otb::RationalTransform< TScalarType, Dimension >::NumberOfParametersType

Definition at line 71 of file otbRationalTransform.h.

◆ OriginType

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

typedef itk::Point<double, Dimension> otb::RationalTransform< TScalarType, Dimension >::OriginType

Definition at line 65 of file otbRationalTransform.h.

◆ OutputPointType

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

typedef itk::Point<ScalarType, Dimension> otb::RationalTransform< TScalarType, Dimension >::OutputPointType

Definition at line 62 of file otbRationalTransform.h.

◆ ParametersType

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

typedef Superclass::ParametersType otb::RationalTransform< TScalarType, Dimension >::ParametersType

Definition at line 68 of file otbRationalTransform.h.

◆ ParametersValueType

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

typedef Superclass::ParametersValueType otb::RationalTransform< TScalarType, Dimension >::ParametersValueType

Definition at line 70 of file otbRationalTransform.h.

◆ Pointer

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

typedef itk::SmartPointer<Self> otb::RationalTransform< TScalarType, Dimension >::Pointer

Definition at line 57 of file otbRationalTransform.h.

◆ ScalarType

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

typedef Superclass::ScalarType otb::RationalTransform< TScalarType, Dimension >::ScalarType

Definition at line 60 of file otbRationalTransform.h.

◆ Self

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

typedef RationalTransform otb::RationalTransform< TScalarType, Dimension >::Self

Definition at line 56 of file otbRationalTransform.h.

◆ SpacingType

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

typedef itk::Vector<double, Dimension> otb::RationalTransform< TScalarType, Dimension >::SpacingType

Definition at line 64 of file otbRationalTransform.h.

◆ Superclass

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

typedef Transform<TScalarType, Dimension, Dimension> otb::RationalTransform< TScalarType, Dimension >::Superclass

Standard class typedefs.

Definition at line 55 of file otbRationalTransform.h.

Constructor & Destructor Documentation

◆ RationalTransform() [1/2]

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

otb::RationalTransform< TScalarType, Dimension >::RationalTransform ( )

inlineprotected

Set the numerator degree

Definition at line 186 of file otbRationalTransform.h.

◆ ~RationalTransform()

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

otb::RationalTransform< TScalarType, Dimension >::~RationalTransform ( )

inlineoverrideprotected

Set the numerator degree

Definition at line 192 of file otbRationalTransform.h.

◆ RationalTransform() [2/2]

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

otb::RationalTransform< TScalarType, Dimension >::RationalTransform ( const Self & )

privatedelete

Set the numerator degree

Member Function Documentation

◆ CreateAnother()

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

virtual::itk::LightObject::Pointer otb::RationalTransform< TScalarType, Dimension >::CreateAnother ( void ) const

◆ GetDenominatorDegree()

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

virtual unsigned int otb::RationalTransform< TScalarType, Dimension >::GetDenominatorDegree ( ) const

virtual

Get the denominator degree

◆ GetNameOfClass()

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

◆ GetNumberOfParameters()

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

NumberOfParametersType otb::RationalTransform< TScalarType, Dimension >::GetNumberOfParameters ( ) const

inlineoverride

Get the number of parameters

Definition at line 152 of file otbRationalTransform.h.

◆ GetNumeratorDegree()

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

virtual unsigned int otb::RationalTransform< TScalarType, Dimension >::GetNumeratorDegree ( ) const

virtual

Get the numerator degree

◆ InitializeParameters()

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

void otb::RationalTransform< TScalarType, Dimension >::InitializeParameters ( )

inline

Initialize Parameters size

Definition at line 171 of file otbRationalTransform.h.

◆ New()

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

static Pointer otb::RationalTransform< TScalarType, Dimension >::New ( )

static

Method for creation through the object factory.

◆ operator=()

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

void otb::RationalTransform< TScalarType, Dimension >::operator= ( const Self & )

privatedelete

Set the numerator degree

◆ PrintSelf()

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

void otb::RationalTransform< TScalarType, Dimension >::PrintSelf	(	std::ostream &	os,
		itk::Indent	indent
	)		const

inlineoverrideprotected

Set the numerator degree

Definition at line 196 of file otbRationalTransform.h.

◆ SetDenominatorDegree()

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 93 of file otbRationalTransform.h.

◆ SetNumeratorDegree()

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 82 of file otbRationalTransform.h.

◆ SetParameters()

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

void otb::RationalTransform< TScalarType, Dimension >::SetParameters ( const typename Superclass::ParametersType & params )

inlineoverride

Set the numerator degree

Definition at line 158 of file otbRationalTransform.h.

◆ TransformPoint()

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 104 of file otbRationalTransform.h.

Member Data Documentation

◆ m_DenominatorDegree

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

unsigned int otb::RationalTransform< TScalarType, Dimension >::m_DenominatorDegree

private

Set the numerator degree

Definition at line 211 of file otbRationalTransform.h.

◆ m_NumeratorDegree

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

unsigned int otb::RationalTransform< TScalarType, Dimension >::m_NumeratorDegree

private

Set the numerator degree

Definition at line 208 of file otbRationalTransform.h.

◆ SpaceDimension

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

const unsigned int otb::RationalTransform< TScalarType, Dimension >::SpaceDimension = Dimension

static

Definition at line 79 of file otbRationalTransform.h.

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

otbRationalTransform.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ InputPointType

◆ InverseTransformBasePointer

◆ NumberOfParametersType

◆ OriginType

◆ OutputPointType

◆ ParametersType

◆ ParametersValueType

◆ Pointer

◆ ScalarType

◆ Self

◆ SpacingType

◆ Superclass

Constructor & Destructor Documentation

◆ RationalTransform() [1/2]

◆ ~RationalTransform()

◆ RationalTransform() [2/2]

Member Function Documentation

◆ CreateAnother()

◆ GetDenominatorDegree()

◆ GetNameOfClass()

◆ GetNumberOfParameters()

◆ GetNumeratorDegree()

◆ InitializeParameters()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ SetDenominatorDegree()

◆ SetNumeratorDegree()

◆ SetParameters()

◆ TransformPoint()

Member Data Documentation

◆ m_DenominatorDegree

◆ m_NumeratorDegree

◆ SpaceDimension

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