Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
otb::DEMToImageGenerator< TDEMImage > Class Template Reference

Class to generate an image from DEM data. More...

#include <otbDEMToImageGenerator.h>

+ Inheritance diagram for otb::DEMToImageGenerator< TDEMImage >:
+ Collaboration diagram for otb::DEMToImageGenerator< TDEMImage >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef otb::DEMHandler DEMHandlerType
 
typedef DEMImageType::Pointer DEMImagePointerType
 
typedef TDEMImage DEMImageType
 
typedef
GenericRSTransformType::Pointer 
GenericRSTransformPointerType
 
typedef GenericRSTransform GenericRSTransformType
 
typedef
itk::ImageRegionIteratorWithIndex
< DEMImageType
ImageIteratorType
 
typedef OutputImageType::IndexType IndexType
 
typedef Superclass::Pointer OutputImagePointer
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef DEMImageType OutputImageType
 
typedef DEMImageType::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef OutputImageType::PointType PointType
 
typedef DEMToImageGenerator Self
 
typedef OutputImageType::SizeType SizeType
 
typedef
OutputImageType::SpacingType 
SpacingType
 
typedef itk::ImageSource
< DEMImageType
Superclass
 

Public Member Functions

virtual void AboveEllipsoidOff ()
 
virtual void AboveEllipsoidOn ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual bool GetAboveEllipsoid ()
 
const ImageKeywordlist GetInputKeywordList ()
 
std::string GetInputProjectionRef () const
 
virtual const char * GetNameOfClass () const
 
const ImageKeywordlist GetOutputKeywordList ()
 
virtual const PointTypeGetOutputOrigin ()
 
std::string GetOutputProjectionRef () const
 
virtual const SizeTypeGetOutputSize ()
 
virtual const SpacingTypeGetOutputSpacing ()
 
virtual const
GenericRSTransformType
GetTransform ()
 
void InstanciateTransform ()
 
virtual void SetAboveEllipsoid (bool _arg)
 
void SetInputKeywordList (const ImageKeywordlist &kwl)
 
void SetInputProjectionRef (const std::string &ref)
 
void SetOutputKeywordList (const ImageKeywordlist &kwl)
 
virtual void SetOutputOrigin (PointType _arg)
 
template<class TImageType >
void SetOutputParametersFromImage (const TImageType *image)
 
void SetOutputProjectionRef (const std::string &ref)
 
virtual void SetOutputSize (SizeType _arg)
 
virtual void SetOutputSpacing (SpacingType _arg)
 
virtual void SetTransform (GenericRSTransformType *_arg)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageSource< TDEMImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter (void)
 

Protected Member Functions

 DEMToImageGenerator ()
 
virtual ~DEMToImageGenerator ()
 
void BeforeThreadedGenerateData ()
 
virtual void GenerateOutputInformation ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 

Protected Attributes

bool m_AboveEllipsoid
 
PixelType m_DefaultUnknownValue
 
DEMHandlerType::Pointer m_DEMHandler
 
PointType m_OutputOrigin
 
SizeType m_OutputSize
 
SpacingType m_OutputSpacing
 

Private Member Functions

 DEMToImageGenerator (const Self &)
 
void operator= (const Self &)
 

Private Attributes

GenericRSTransformPointerType m_Transform
 

Detailed Description

template<class TDEMImage>
class otb::DEMToImageGenerator< TDEMImage >

Class to generate an image from DEM data.

This class is based on DEMHandler. It takes in input the upper left longitude and latitude, the spacing and the output image size. Handle DTED and SRTM formats.

Examples:
BasicFilters/DEMToRainbowExample.cxx, BasicFilters/HillShadingExample.cxx, and IO/DEMToImageGenerator.cxx.

Definition at line 47 of file otbDEMToImageGenerator.h.

Member Typedef Documentation

template<class TDEMImage >
typedef itk::SmartPointer<const Self> otb::DEMToImageGenerator< TDEMImage >::ConstPointer

Definition at line 59 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
typedef otb::DEMHandler otb::DEMToImageGenerator< TDEMImage >::DEMHandlerType

Definition at line 70 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
typedef DEMImageType::Pointer otb::DEMToImageGenerator< TDEMImage >::DEMImagePointerType

Definition at line 53 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
typedef TDEMImage otb::DEMToImageGenerator< TDEMImage >::DEMImageType

Standard class typedefs.

Definition at line 52 of file otbDEMToImageGenerator.h.

Definition at line 76 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
typedef GenericRSTransform otb::DEMToImageGenerator< TDEMImage >::GenericRSTransformType

Specialisation of OptResampleFilter with a remote sensing transform

Definition at line 75 of file otbDEMToImageGenerator.h.

Definition at line 68 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
typedef OutputImageType::IndexType otb::DEMToImageGenerator< TDEMImage >::IndexType

Definition at line 66 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
typedef Superclass::Pointer otb::DEMToImageGenerator< TDEMImage >::OutputImagePointer

Definition at line 62 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
typedef Superclass::OutputImageRegionType otb::DEMToImageGenerator< TDEMImage >::OutputImageRegionType

Definition at line 67 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
typedef DEMImageType otb::DEMToImageGenerator< TDEMImage >::OutputImageType

Definition at line 60 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
typedef DEMImageType::PixelType otb::DEMToImageGenerator< TDEMImage >::PixelType

Definition at line 54 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
typedef itk::SmartPointer<Self> otb::DEMToImageGenerator< TDEMImage >::Pointer

Definition at line 58 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
typedef OutputImageType::PointType otb::DEMToImageGenerator< TDEMImage >::PointType

Definition at line 65 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
typedef DEMToImageGenerator otb::DEMToImageGenerator< TDEMImage >::Self

Definition at line 56 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
typedef OutputImageType::SizeType otb::DEMToImageGenerator< TDEMImage >::SizeType

Definition at line 64 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
typedef OutputImageType::SpacingType otb::DEMToImageGenerator< TDEMImage >::SpacingType

Definition at line 63 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
typedef itk::ImageSource<DEMImageType> otb::DEMToImageGenerator< TDEMImage >::Superclass

Definition at line 57 of file otbDEMToImageGenerator.h.

Constructor & Destructor Documentation

template<class TDEMImage >
otb::DEMToImageGenerator< TDEMImage >::DEMToImageGenerator ( )
protected

Definition at line 30 of file otbDEMToImageGenerator.txx.

template<class TDEMImage >
virtual otb::DEMToImageGenerator< TDEMImage >::~DEMToImageGenerator ( )
inlineprotectedvirtual

Definition at line 175 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
otb::DEMToImageGenerator< TDEMImage >::DEMToImageGenerator ( const Self )
private

Member Function Documentation

template<class TDEMImage >
virtual void otb::DEMToImageGenerator< TDEMImage >::AboveEllipsoidOff ( )
virtual
template<class TDEMImage >
virtual void otb::DEMToImageGenerator< TDEMImage >::AboveEllipsoidOn ( )
virtual
template<class TDEMImage >
void otb::DEMToImageGenerator< TDEMImage >::BeforeThreadedGenerateData ( void  )
protected

Definition at line 90 of file otbDEMToImageGenerator.txx.

template<class TDEMImage >
virtual::itk::LightObject::Pointer otb::DEMToImageGenerator< TDEMImage >::CreateAnother ( void  ) const
template<class TDEMImage >
void otb::DEMToImageGenerator< TDEMImage >::GenerateOutputInformation ( void  )
protectedvirtual
template<class TDEMImage >
virtual bool otb::DEMToImageGenerator< TDEMImage >::GetAboveEllipsoid ( )
virtual
template<class TDEMImage >
const ImageKeywordlist otb::DEMToImageGenerator< TDEMImage >::GetInputKeywordList ( )
inline

Definition at line 143 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
std::string otb::DEMToImageGenerator< TDEMImage >::GetInputProjectionRef ( ) const
inline

Definition at line 121 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
virtual const char* otb::DEMToImageGenerator< TDEMImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TDEMImage >.

template<class TDEMImage >
const ImageKeywordlist otb::DEMToImageGenerator< TDEMImage >::GetOutputKeywordList ( )
inline

Definition at line 155 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
virtual const PointType& otb::DEMToImageGenerator< TDEMImage >::GetOutputOrigin ( )
virtual
template<class TDEMImage >
std::string otb::DEMToImageGenerator< TDEMImage >::GetOutputProjectionRef ( ) const
inline

Definition at line 132 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
virtual const SizeType& otb::DEMToImageGenerator< TDEMImage >::GetOutputSize ( )
virtual
template<class TDEMImage >
virtual const SpacingType& otb::DEMToImageGenerator< TDEMImage >::GetOutputSpacing ( )
virtual
template<class TDEMImage >
virtual const GenericRSTransformType* otb::DEMToImageGenerator< TDEMImage >::GetTransform ( )
virtual
template<class TDEMImage >
void otb::DEMToImageGenerator< TDEMImage >::InstanciateTransform ( )

Definition at line 83 of file otbDEMToImageGenerator.txx.

template<class TDEMImage >
static Pointer otb::DEMToImageGenerator< TDEMImage >::New ( )
static

Method for creation through the object factory.

template<class TDEMImage >
void otb::DEMToImageGenerator< TDEMImage >::operator= ( const Self )
private
template<class TDEMImage >
void otb::DEMToImageGenerator< TDEMImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protected

Definition at line 179 of file otbDEMToImageGenerator.txx.

template<class TDEMImage >
virtual void otb::DEMToImageGenerator< TDEMImage >::SetAboveEllipsoid ( bool  _arg)
virtual

Set/Get the above ellipsoid flag. If false, height is given above MSL

template<class TDEMImage >
void otb::DEMToImageGenerator< TDEMImage >::SetInputKeywordList ( const ImageKeywordlist kwl)
inline

Set/Get Input Keywordlist

Definition at line 138 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
void otb::DEMToImageGenerator< TDEMImage >::SetInputProjectionRef ( const std::string &  ref)
inline

Set/Get input & output projections. Set/Get input & output keywordlist The macro are not used here cause the input and the output are inversed.

Definition at line 115 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
void otb::DEMToImageGenerator< TDEMImage >::SetOutputKeywordList ( const ImageKeywordlist kwl)
inline

Set/Get output Keywordlist

Definition at line 149 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
virtual void otb::DEMToImageGenerator< TDEMImage >::SetOutputOrigin ( PointType  _arg)
virtual

Set/Get the Output Origin coordinates.

template<class TDEMImage >
template<class TImageType >
void otb::DEMToImageGenerator< TDEMImage >::SetOutputParametersFromImage ( const TImageType *  image)
inline

Useful to set the output parameters from an existing image

Definition at line 161 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
void otb::DEMToImageGenerator< TDEMImage >::SetOutputProjectionRef ( const std::string &  ref)
inline

Definition at line 126 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
virtual void otb::DEMToImageGenerator< TDEMImage >::SetOutputSize ( SizeType  _arg)
virtual

Set/Get the Output Size.

template<class TDEMImage >
virtual void otb::DEMToImageGenerator< TDEMImage >::SetOutputSpacing ( SpacingType  _arg)
virtual

Set/Get the Output Spacing.

template<class TDEMImage >
virtual void otb::DEMToImageGenerator< TDEMImage >::SetTransform ( GenericRSTransformType _arg)
virtual

Set/Get the Default Unknown Value.

template<class TDEMImage >
void otb::DEMToImageGenerator< TDEMImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
itk::ThreadIdType  threadId 
)
protected

Member Data Documentation

template<class TDEMImage >
bool otb::DEMToImageGenerator< TDEMImage >::m_AboveEllipsoid
protected

Definition at line 188 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
PixelType otb::DEMToImageGenerator< TDEMImage >::m_DefaultUnknownValue
protected

Definition at line 187 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
DEMHandlerType::Pointer otb::DEMToImageGenerator< TDEMImage >::m_DEMHandler
protected

Definition at line 183 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
PointType otb::DEMToImageGenerator< TDEMImage >::m_OutputOrigin
protected

Definition at line 184 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
SizeType otb::DEMToImageGenerator< TDEMImage >::m_OutputSize
protected

Definition at line 186 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
SpacingType otb::DEMToImageGenerator< TDEMImage >::m_OutputSpacing
protected

Definition at line 185 of file otbDEMToImageGenerator.h.

template<class TDEMImage >
GenericRSTransformPointerType otb::DEMToImageGenerator< TDEMImage >::m_Transform
private

Definition at line 194 of file otbDEMToImageGenerator.h.


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