otb::ogr::ImageReference< TPrecision > Class Template Reference

#include <otbImageReference.h>

Inheritance diagram for otb::ogr::ImageReference< TPrecision >:

Public Types
enum	{ Dimension = 2 }
typedef TPrecision	PrecisionType

Public Member Functions
Standard ITK typedefs
bool	GetDebug () const
Origin property
Represents the origin of the geometries in the image coordinates system.
virtual const OriginType &	GetOrigin () const
virtual void	SetOrigin (OriginType _arg)
void	SetOrigin (const TPrecision origin[Dimension])

Template-parameters typedefs
typedef itk::Vector< PrecisionType, 2 >	SpacingType
typedef itk::Point< PrecisionType, 2 >	OriginType
typedef itk::Point< PrecisionType, 2 >	PointType
const char *	GetNameOfClass ()
	ImageReference (itk::Object const &holder)
	ImageReference (SpacingType const &spacing, OriginType const &origin, itk::Object const &holder)
void	Modified () const

Spacing property
Spacing of the geometries to put in the corresponding image coordinates.
itk::Object const &	m_Holder
SpacingType	m_Spacing
OriginType	m_Origin
virtual const SpacingType &	GetSpacing () const
void	SetSpacing (const SpacingType &spacing)
void	SetSpacing (const TPrecision spacing[Dimension])
void	TransformPointToPhysicalPoint (const PointType &point, PointType &physicalPoint) const
PointType	TransformPointToPhysicalPoint (const PointType &point) const
ImageReference &	operator= (ImageReference const &rhs)

Detailed Description

template<typename TPrecision>
class otb::ogr::ImageReference< TPrecision >

Todo:

See how mix it with the otb::ogr::DataSource wrapper as it was with VectorData.

Since

OTB v 3.14.0

Definition at line 39 of file otbImageReference.h.

Member Typedef Documentation

OriginType

template<typename TPrecision >

typedef itk::Point<PrecisionType, 2> otb::ogr::ImageReference< TPrecision >::OriginType

Default constructor.

Postcondition

m_Spacing = {1,1}

m_Origin = {0,0}

Definition at line 59 of file otbImageReference.h.

PointType

template<typename TPrecision >

typedef itk::Point<PrecisionType, 2> otb::ogr::ImageReference< TPrecision >::PointType

Default constructor.

Postcondition

m_Spacing = {1,1}

m_Origin = {0,0}

Definition at line 60 of file otbImageReference.h.

PrecisionType

template<typename TPrecision >

typedef TPrecision otb::ogr::ImageReference< TPrecision >::PrecisionType

Definition at line 42 of file otbImageReference.h.

SpacingType

template<typename TPrecision >

typedef itk::Vector<PrecisionType, 2> otb::ogr::ImageReference< TPrecision >::SpacingType

Default constructor.

Postcondition

m_Spacing = {1,1}

m_Origin = {0,0}

Definition at line 58 of file otbImageReference.h.

Member Enumeration Documentation

anonymous enum

template<typename TPrecision >

anonymous enum

Enumerator
Dimension

Definition at line 43 of file otbImageReference.h.

Constructor & Destructor Documentation

ImageReference() [1/2]

template<typename TPrecision >

otb::ogr::ImageReference< TPrecision >::ImageReference ( itk::Object const &  holder )

inline

Default constructor.

Postcondition

m_Spacing = {1,1}

m_Origin = {0,0}

Definition at line 72 of file otbImageReference.h.

ImageReference() [2/2]

template<typename TPrecision >

otb::ogr::ImageReference< TPrecision >::ImageReference ( SpacingType const &  spacing, OriginType const &  origin, itk::Object const &  holder  )

inline

Init constructor.

Postcondition

m_Spacing = spacing

m_Origin = origin

Definition at line 82 of file otbImageReference.h.

Member Function Documentation

GetDebug()

template<typename TPrecision >

bool otb::ogr::ImageReference< TPrecision >::GetDebug ( ) const

inline

Definition at line 51 of file otbImageReference.h.

GetNameOfClass()

template<typename TPrecision >

const char* otb::ogr::ImageReference< TPrecision >::GetNameOfClass ( )

inline

Default constructor.

Postcondition

m_Spacing = {1,1}

m_Origin = {0,0}

Definition at line 63 of file otbImageReference.h.

GetOrigin()

template<typename TPrecision >

virtual const OriginType& otb::ogr::ImageReference< TPrecision >::GetOrigin ( ) const

virtual

Origin getter.

GetSpacing()

template<typename TPrecision >

virtual const SpacingType& otb::ogr::ImageReference< TPrecision >::GetSpacing ( ) const

virtual

Spacing getter.

Modified()

template<typename TPrecision >

void otb::ogr::ImageReference< TPrecision >::Modified ( ) const

inline

Default constructor.

Postcondition

m_Spacing = {1,1}

m_Origin = {0,0}

Definition at line 86 of file otbImageReference.h.

Referenced by otb::ogr::ImageReference< double >::SetSpacing().

operator=()

template<typename TPrecision >

ImageReference& otb::ogr::ImageReference< TPrecision >::operator= ( ImageReference< TPrecision > const &  rhs )

inline

Assignment operator.

Parameters

[in]

rhs

source data to be copied.

Exceptions

None

Definition at line 166 of file otbImageReference.h.

SetOrigin() [1/2]

template<typename TPrecision >

void otb::ogr::ImageReference< TPrecision >::SetOrigin ( const TPrecision  origin[Dimension] )

inline

Origin setter.

Parameters

origin

Origin setter.

Definition at line 97 of file otbImageReference.h.

SetOrigin() [2/2]

template<typename TPrecision >

virtual void otb::ogr::ImageReference< TPrecision >::SetOrigin ( OriginType  _arg )

virtual

Origin getter.

Referenced by otb::ogr::ImageReference< double >::SetOrigin().

SetSpacing() [1/2]

template<typename TPrecision >

void otb::ogr::ImageReference< TPrecision >::SetSpacing ( const SpacingType &  spacing )

inline

Spacing getter.

Parameters

spacing

Spacing setter.

Definition at line 110 of file otbImageReference.h.

Referenced by otb::ogr::ImageReference< double >::SetSpacing().

SetSpacing() [2/2]

template<typename TPrecision >

void otb::ogr::ImageReference< TPrecision >::SetSpacing ( const TPrecision  spacing[Dimension] )

inline

Spacing getter.

Parameters

spacing

Spacing setter.

Definition at line 119 of file otbImageReference.h.

TransformPointToPhysicalPoint() [1/2]

template<typename TPrecision >

PointType otb::ogr::ImageReference< TPrecision >::TransformPointToPhysicalPoint ( const PointType &  point ) const

inline

Projects a point from the Data Source coordinates system to the image coordinates system.

Parameters

[in]

point

point in Data Source coordinates system

Returns

the point projected in the image coordinates system.

Exceptions

None

Definition at line 148 of file otbImageReference.h.

TransformPointToPhysicalPoint() [2/2]

template<typename TPrecision >

void otb::ogr::ImageReference< TPrecision >::TransformPointToPhysicalPoint ( const PointType &  point, PointType &  physicalPoint  ) const

inline

Projects a point from the Data Source coordinates system to the image coordinates system.

Parameters

[in]	point	point in Data Source coordinates system
[out]	physicalPoint	point in the image coordinates system.

Exceptions

None

Definition at line 134 of file otbImageReference.h.

Member Data Documentation

m_Holder

template<typename TPrecision >

itk::Object const& otb::ogr::ImageReference< TPrecision >::m_Holder

private

Spacing getter.

Definition at line 175 of file otbImageReference.h.

Referenced by otb::ogr::ImageReference< double >::GetDebug(), and otb::ogr::ImageReference< double >::Modified().

m_Origin

template<typename TPrecision >

OriginType otb::ogr::ImageReference< TPrecision >::m_Origin

private

Spacing getter.

Definition at line 177 of file otbImageReference.h.

Referenced by otb::ogr::ImageReference< double >::ImageReference(), otb::ogr::ImageReference< double >::operator=(), and otb::ogr::ImageReference< double >::TransformPointToPhysicalPoint().

m_Spacing

template<typename TPrecision >

SpacingType otb::ogr::ImageReference< TPrecision >::m_Spacing

private

Spacing getter.

Definition at line 176 of file otbImageReference.h.

Referenced by otb::ogr::ImageReference< double >::ImageReference(), otb::ogr::ImageReference< double >::operator=(), otb::ogr::ImageReference< double >::SetSpacing(), and otb::ogr::ImageReference< double >::TransformPointToPhysicalPoint().

---

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

• otbImageReference.h