OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::LogPolarTransform< TScalarType > Class Template Reference

#include <otbLogPolarTransform.h>

+ Inheritance diagram for otb::LogPolarTransform< TScalarType >:
+ Collaboration diagram for otb::LogPolarTransform< TScalarType >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::InputPointType InputPointType
 
typedef Superclass::InputVectorType InputVectorType
 
typedef Superclass::InputVnlVectorType InputVnlVectorType
 
typedef Superclass::OutputPointType OutputPointType
 
typedef Superclass::OutputVectorType OutputVectorType
 
typedef Superclass::OutputVnlVectorType OutputVnlVectorType
 
typedef Superclass::ParametersType ParametersType
 
typedef itk::SmartPointer< SelfPointer
 
typedef TScalarType ScalarType
 
typedef itk::FixedArray< TScalarType, 2 > ScaleType
 
typedef LogPolarTransform Self
 
typedef Transform< TScalarType, 2, 2 > Superclass
 
- Public Types inherited from otb::Transform< TScalarType, 2, 2 >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef Transform Self
 
typedef itk::Transform< TScalarType, NInputDimensions, NOutputDimensions > Superclass
 
enum  TransformDirection
 
typedef TScalarType ScalarType
 
typedef Superclass::ParametersType ParametersType
 
typedef Superclass::ParametersValueType ParametersValueType
 
typedef Superclass::NumberOfParametersType NumberOfParametersType
 
typedef itk::Array2D< double > JacobianType
 
typedef itk::Vector< TScalarType, NInputDimensions > InputVectorType
 
typedef itk::Vector< TScalarType, NOutputDimensions > OutputVectorType
 
typedef itk::CovariantVector< TScalarType, NInputDimensions > InputCovariantVectorType
 
typedef itk::CovariantVector< TScalarType, NOutputDimensions > OutputCovariantVectorType
 
typedef vnl_vector_fixed< TScalarType, NInputDimensions > InputVnlVectorType
 
typedef vnl_vector_fixed< TScalarType, NOutputDimensions > OutputVnlVectorType
 
typedef itk::Point< TScalarType, NInputDimensions > InputPointType
 
typedef itk::Point< TScalarType, 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< TScalarType, 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 ParametersTypeGetParameters (void) const override
 
void SetFixedParameters (const ParametersType &) override
 
const ParametersTypeGetFixedParameters (void) const override
 
virtual const JacobianTypeGetJacobian (const InputPointType &) const
 
NumberOfParametersType GetNumberOfParameters (void) const override
 

Static Public Member Functions

static Pointer New ()
 
InputPointType m_Center
 
ScaleType m_Scale
 
virtual void SetCenter (InputPointType _arg)
 
virtual const InputPointTypeGetCenter () const
 
virtual void SetScale (ScaleType _arg)
 
virtual const ScaleTypeGetScale () const
 
void SetParameters (const ParametersType &parameters) override
 
ParametersTypeGetParameters (void) const override
 
void SetFixedParameters (const ParametersType &param) override
 
const ParametersTypeGetFixedParameters (void) const override
 
OutputPointType TransformPoint (const InputPointType &point) const override
 
OutputVectorType TransformVector (const InputVectorType &vector) const override
 
OutputVnlVectorType TransformVector (const InputVnlVectorType &vector) const override
 
 LogPolarTransform ()
 
 ~LogPolarTransform () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 LogPolarTransform (const Self &)=delete
 
void operator= (const Self &)=delete
 

Additional Inherited Members

- Static Public Attributes inherited from otb::Transform< TScalarType, 2, 2 >
static const unsigned int InputSpaceDimension
 
static const unsigned int OutputSpaceDimension
 
- Protected Member Functions inherited from otb::Transform< TScalarType, 2, 2 >
 Transform ()
 
 Transform (NumberOfParametersType numberOfParameters)
 
 ~Transform () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Attributes inherited from otb::Transform< TScalarType, 2, 2 >
ParametersType m_Parameters
 
ParametersType m_FixedParameters
 
JacobianType m_Jacobian
 

Detailed Description

template<class TScalarType>
class otb::LogPolarTransform< TScalarType >

Implement the log-polar coordinate transform.

The log-polar coordinate system is a polar system where the radial coordinate has a logarithmic scale.

Given $(\rho,\theta)$ the coordinate in the log-polar system, the corresponding cartesian coordinates are

$ x-xc=exp(\rho)*cos(\theta) $ $ y-yc=exp(\rho)*sin(\theta) $

Where (xc, yc) is the center of the log-polar transform in the cartesian space. Please note that this center can NOT be represented in log-polar.

See also
InverseLogPolarTransform

Definition at line 49 of file otbLogPolarTransform.h.

Member Typedef Documentation

◆ ConstPointer

template<class TScalarType >
typedef itk::SmartPointer<const Self> otb::LogPolarTransform< TScalarType >::ConstPointer

Definition at line 56 of file otbLogPolarTransform.h.

◆ InputPointType

template<class TScalarType >
typedef Superclass::InputPointType otb::LogPolarTransform< TScalarType >::InputPointType

Superclass related typedefs

Definition at line 68 of file otbLogPolarTransform.h.

◆ InputVectorType

template<class TScalarType >
typedef Superclass::InputVectorType otb::LogPolarTransform< TScalarType >::InputVectorType

Definition at line 70 of file otbLogPolarTransform.h.

◆ InputVnlVectorType

template<class TScalarType >
typedef Superclass::InputVnlVectorType otb::LogPolarTransform< TScalarType >::InputVnlVectorType

Definition at line 72 of file otbLogPolarTransform.h.

◆ OutputPointType

template<class TScalarType >
typedef Superclass::OutputPointType otb::LogPolarTransform< TScalarType >::OutputPointType

Definition at line 69 of file otbLogPolarTransform.h.

◆ OutputVectorType

template<class TScalarType >
typedef Superclass::OutputVectorType otb::LogPolarTransform< TScalarType >::OutputVectorType

Definition at line 71 of file otbLogPolarTransform.h.

◆ OutputVnlVectorType

template<class TScalarType >
typedef Superclass::OutputVnlVectorType otb::LogPolarTransform< TScalarType >::OutputVnlVectorType

Definition at line 73 of file otbLogPolarTransform.h.

◆ ParametersType

template<class TScalarType >
typedef Superclass::ParametersType otb::LogPolarTransform< TScalarType >::ParametersType

Definition at line 74 of file otbLogPolarTransform.h.

◆ Pointer

template<class TScalarType >
typedef itk::SmartPointer<Self> otb::LogPolarTransform< TScalarType >::Pointer

Definition at line 55 of file otbLogPolarTransform.h.

◆ ScalarType

template<class TScalarType >
typedef TScalarType otb::LogPolarTransform< TScalarType >::ScalarType

Template related typedefs

Definition at line 62 of file otbLogPolarTransform.h.

◆ ScaleType

template<class TScalarType >
typedef itk::FixedArray<TScalarType, 2> otb::LogPolarTransform< TScalarType >::ScaleType

Definition at line 75 of file otbLogPolarTransform.h.

◆ Self

template<class TScalarType >
typedef LogPolarTransform otb::LogPolarTransform< TScalarType >::Self

Standard typedef

Definition at line 53 of file otbLogPolarTransform.h.

◆ Superclass

template<class TScalarType >
typedef Transform<TScalarType, 2, 2> otb::LogPolarTransform< TScalarType >::Superclass

Definition at line 54 of file otbLogPolarTransform.h.

Constructor & Destructor Documentation

◆ LogPolarTransform() [1/2]

template<class TScalarType >
otb::LogPolarTransform< TScalarType >::LogPolarTransform
protected

◆ ~LogPolarTransform()

template<class TScalarType >
otb::LogPolarTransform< TScalarType >::~LogPolarTransform
overrideprotected

Destructor

Destructor.

Definition at line 46 of file otbLogPolarTransform.hxx.

◆ LogPolarTransform() [2/2]

template<class TScalarType >
otb::LogPolarTransform< TScalarType >::LogPolarTransform ( const Self )
privatedelete

Set/Get the origin

Member Function Documentation

◆ CreateAnother()

template<class TScalarType >
virtual::itk::LightObject::Pointer otb::LogPolarTransform< TScalarType >::CreateAnother ( void  ) const

◆ GetCenter()

template<class TScalarType >
virtual const InputPointType& otb::LogPolarTransform< TScalarType >::GetCenter ( ) const
virtual

Set/Get the origin

◆ GetFixedParameters()

template<class TScalarType >
const ParametersType& otb::LogPolarTransform< TScalarType >::GetFixedParameters ( void  ) const
inlineoverride

Get the Fixed Parameters

Returns
The Fixed parameters of the transform.

Definition at line 111 of file otbLogPolarTransform.h.

◆ GetNameOfClass()

template<class TScalarType >
virtual const char* otb::LogPolarTransform< TScalarType >::GetNameOfClass ( ) const
virtual

Runtime information

◆ GetParameters()

template<class TScalarType >
LogPolarTransform< TScalarType >::ParametersType & otb::LogPolarTransform< TScalarType >::GetParameters ( void  ) const
override

Get the transform parameters through the standard interface.

Returns
The parameters of the transform.

Definition at line 71 of file otbLogPolarTransform.hxx.

◆ GetScale()

template<class TScalarType >
virtual const ScaleType& otb::LogPolarTransform< TScalarType >::GetScale ( ) const
virtual

Set/Get the origin

◆ New()

template<class TScalarType >
static Pointer otb::LogPolarTransform< TScalarType >::New ( )
static

Creation through object factory

◆ operator=()

template<class TScalarType >
void otb::LogPolarTransform< TScalarType >::operator= ( const Self )
privatedelete

Set/Get the origin

◆ PrintSelf()

template<class TScalarType >
void otb::LogPolarTransform< TScalarType >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

PrintSelf method

PrintSelf method.

Definition at line 141 of file otbLogPolarTransform.hxx.

◆ SetCenter()

template<class TScalarType >
virtual void otb::LogPolarTransform< TScalarType >::SetCenter ( InputPointType  _arg)
virtual

Set/Get the origin

◆ SetFixedParameters()

template<class TScalarType >
void otb::LogPolarTransform< TScalarType >::SetFixedParameters ( const ParametersType param)
inlineoverride

Set the Fixed Parameters

Parameters
paramThe fixed parameters of the transform.

Definition at line 102 of file otbLogPolarTransform.h.

◆ SetParameters()

template<class TScalarType >
void otb::LogPolarTransform< TScalarType >::SetParameters ( const ParametersType parameters)
override

Set the transform parameters through the standard interface.

Parameters
parametersThe parameters of the transform.

Definition at line 55 of file otbLogPolarTransform.hxx.

References otbMsgDebugMacro.

◆ SetScale()

template<class TScalarType >
virtual void otb::LogPolarTransform< TScalarType >::SetScale ( ScaleType  _arg)
virtual

Set/Get the scales

◆ TransformPoint()

template<class TScalarType >
LogPolarTransform< TScalarType >::OutputPointType otb::LogPolarTransform< TScalarType >::TransformPoint ( const InputPointType point) const
override

Transform a point.

Parameters
pointThe point to transform.
Returns
The transformed point.

Definition at line 87 of file otbLogPolarTransform.hxx.

References otb::CONST_PI_180.

◆ TransformVector() [1/2]

template<class TScalarType >
LogPolarTransform< TScalarType >::OutputVectorType otb::LogPolarTransform< TScalarType >::TransformVector ( const InputVectorType vector) const
override

Transform a vector representing a point.

Parameters
vectorThe point to transform.
Returns
The transformed point.

Definition at line 105 of file otbLogPolarTransform.hxx.

References otb::CONST_PI_180.

◆ TransformVector() [2/2]

template<class TScalarType >
LogPolarTransform< TScalarType >::OutputVnlVectorType otb::LogPolarTransform< TScalarType >::TransformVector ( const InputVnlVectorType vector) const
override

Transform a vnl vector representing a point.

Parameters
vectorThe point to transform.
Returns
The transformed point.

Definition at line 124 of file otbLogPolarTransform.hxx.

References otb::CONST_PI_180.

Member Data Documentation

◆ m_Center

template<class TScalarType >
InputPointType otb::LogPolarTransform< TScalarType >::m_Center
private

Set/Get the origin

Definition at line 152 of file otbLogPolarTransform.h.

Referenced by otb::LogPolarTransform< TScalarType >::LogPolarTransform().

◆ m_Scale

template<class TScalarType >
ScaleType otb::LogPolarTransform< TScalarType >::m_Scale
private

Set/Get the origin

Definition at line 153 of file otbLogPolarTransform.h.

Referenced by otb::LogPolarTransform< TScalarType >::LogPolarTransform().


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