Orfeo Toolbox  4.0
Public Types | Public Member Functions | Private Attributes | List of all members
otb::ogr::ImageReference< TPrecision > Class Template Reference

#include <otbImageReference.h>

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

Public Types

enum  { Dimension = 2 }
 
typedef TPrecision PrecisionType
 
Template-parameters typedefs
typedef itk::Vector
< PrecisionType, 2 > 
SpacingType
 
typedef itk::Point
< PrecisionType, 2 > 
OriginType
 
typedef itk::Point
< PrecisionType, 2 > 
PointType
 

Public Member Functions

 ImageReference (itk::Object const &holder)
 
 ImageReference (SpacingType const &spacing, OriginType const &origin, itk::Object const &holder)
 
void Modified () const
 
ImageReferenceoperator= (ImageReference const &rhs)
 
void TransformPointToPhysicalPoint (const PointType &point, PointType &physicalPoint) const
 
void TransformPointToPhysicalPoint (const PointType &point) const
 
Standard ITK typedefs
virtual const char * GetNameOfClass () const
 
bool GetDebug () const
 
Origin property

Represents the origin of the geometries in the image coordinates system.

virtual const OriginTypeGetOrigin ()
 Origin getter. More...
 
virtual void SetOrigin (OriginType _arg)
 Origin getter. More...
 
void SetOrigin (const TPrecision origin[Dimension])
 Origin setter. More...
 
Spacing property

Spacing of the geometries to put in the corresponding image coordinates.

virtual const SpacingTypeGetSpacing ()
 Spacing getter. More...
 
void SetSpacing (const SpacingType &spacing)
 Spacing getter. More...
 
void SetSpacing (const TPrecision spacing[Dimension])
 Spacing getter. More...
 

Private Attributes

itk::Object const & m_Holder
 
OriginType m_Origin
 
SpacingType m_Spacing
 

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 35 of file otbImageReference.h.

Member Typedef Documentation

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

Definition at line 51 of file otbImageReference.h.

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

Definition at line 52 of file otbImageReference.h.

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

Definition at line 38 of file otbImageReference.h.

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

Definition at line 50 of file otbImageReference.h.

Member Enumeration Documentation

template<typename TPrecision>
anonymous enum
Enumerator
Dimension 

Definition at line 39 of file otbImageReference.h.

Constructor & Destructor Documentation

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 59 of file otbImageReference.h.

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 69 of file otbImageReference.h.

Member Function Documentation

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

Definition at line 43 of file otbImageReference.h.

template<typename TPrecision>
virtual const char* otb::ogr::ImageReference< TPrecision >::GetNameOfClass ( ) const
virtual
template<typename TPrecision>
virtual const OriginType& otb::ogr::ImageReference< TPrecision >::GetOrigin ( )
virtual

Origin getter.

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

Spacing getter.

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

Definition at line 74 of file otbImageReference.h.

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

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

Assignment operator.

Parameters
[in]rhssource data to be copied.
Exceptions
None

Definition at line 150 of file otbImageReference.h.

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

Origin getter.

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

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

Origin setter.

Parameters
originOrigin setter.

Definition at line 85 of file otbImageReference.h.

template<typename TPrecision>
void otb::ogr::ImageReference< TPrecision >::SetSpacing ( const SpacingType spacing)
inline

Spacing getter.

Parameters
spacingSpacing setter.

Definition at line 97 of file otbImageReference.h.

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

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

Spacing getter.

Parameters
spacingSpacing setter.

Definition at line 106 of file otbImageReference.h.

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]pointpoint in Data Source coordinates system
[out]physicalPointpoint in the image coordinates system.
Exceptions
None

Definition at line 120 of file otbImageReference.h.

template<typename TPrecision>
void 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]pointpoint in Data Source coordinates system
Returns
the point projected in the image coordinates system.
Exceptions
None

Definition at line 133 of file otbImageReference.h.

Member Data Documentation

template<typename TPrecision>
itk::Object const& otb::ogr::ImageReference< TPrecision >::m_Holder
private
template<typename TPrecision>
OriginType otb::ogr::ImageReference< TPrecision >::m_Origin
private
template<typename TPrecision>
SpacingType otb::ogr::ImageReference< TPrecision >::m_Spacing
private

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

Generated at Sat Mar 8 2014 19:09:06 for Orfeo Toolbox with doxygen 1.8.3.1