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

#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< Self > Pointer
 
typedef OutputImageType::PointType PointType
 
typedef DEMToImageGenerator Self
 
typedef OutputImageType::SizeType SizeType
 
typedef OutputImageType::SpacingType SpacingType
 
typedef itk::ImageSource< DEMImageType > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 

Static Public Member Functions

static Pointer New ()
 
PointType m_OutputOrigin {0.0}
 
SpacingType m_OutputSpacing {0.0}
 
SizeType m_OutputSize {0,0}
 
PixelType m_DefaultUnknownValue
 
bool m_AboveEllipsoid
 
GenericRSTransformPointerType m_Transform
 
virtual void SetOutputOrigin (PointType _arg)
 
virtual const PointType & GetOutputOrigin () const
 
virtual void SetOutputSize (SizeType _arg)
 
virtual const SizeType & GetOutputSize () const
 
virtual void SetOutputSpacing (SpacingType _arg)
 
virtual const SpacingType & GetOutputSpacing () const
 
virtual void SetTransform (GenericRSTransformType *_arg)
 
virtual const GenericRSTransformType * GetTransform () const
 
virtual void SetAboveEllipsoid (bool _arg)
 
virtual bool GetAboveEllipsoid ()
 
virtual void AboveEllipsoidOn ()
 
virtual void AboveEllipsoidOff ()
 
void InstantiateTransform ()
 
void SetInputProjectionRef (const std::string &ref)
 
std::string GetInputProjectionRef () const
 
void SetOutputProjectionRef (const std::string &ref)
 
std::string GetOutputProjectionRef () const
 
const ImageMetadata * GetInputImageMetadata () const
 
void SetInputImageMetadata (const ImageMetadata *imd)
 
const ImageMetadata * GetOutputImageMetadata () const
 
void SetOutputImageMetadata (const ImageMetadata *imd)
 
template<class TImageType >
void SetOutputParametersFromImage (const TImageType *image)
 
 DEMToImageGenerator ()
 
 ~DEMToImageGenerator () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void BeforeThreadedGenerateData () override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
void GenerateOutputInformation () override
 
 DEMToImageGenerator (const Self &)=delete
 
void operator= (const Self &)=delete
 

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

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 62 of file otbDEMToImageGenerator.h.

◆ DEMHandlerType

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

Definition at line 73 of file otbDEMToImageGenerator.h.

◆ DEMImagePointerType

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

Definition at line 56 of file otbDEMToImageGenerator.h.

◆ DEMImageType

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

Standard class typedefs.

Definition at line 55 of file otbDEMToImageGenerator.h.

◆ GenericRSTransformPointerType

template<class TDEMImage >
typedef GenericRSTransformType::Pointer otb::DEMToImageGenerator< TDEMImage >::GenericRSTransformPointerType

Definition at line 79 of file otbDEMToImageGenerator.h.

◆ GenericRSTransformType

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

Specialisation of OptResampleFilter with a remote sensing transform

Definition at line 78 of file otbDEMToImageGenerator.h.

◆ ImageIteratorType

template<class TDEMImage >
typedef itk::ImageRegionIteratorWithIndex<DEMImageType> otb::DEMToImageGenerator< TDEMImage >::ImageIteratorType

Definition at line 71 of file otbDEMToImageGenerator.h.

◆ IndexType

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

Definition at line 69 of file otbDEMToImageGenerator.h.

◆ OutputImagePointer

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

Definition at line 65 of file otbDEMToImageGenerator.h.

◆ OutputImageRegionType

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

Definition at line 70 of file otbDEMToImageGenerator.h.

◆ OutputImageType

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

Definition at line 63 of file otbDEMToImageGenerator.h.

◆ PixelType

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

Definition at line 57 of file otbDEMToImageGenerator.h.

◆ Pointer

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

Definition at line 61 of file otbDEMToImageGenerator.h.

◆ PointType

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

Definition at line 68 of file otbDEMToImageGenerator.h.

◆ Self

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

Definition at line 59 of file otbDEMToImageGenerator.h.

◆ SizeType

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

Definition at line 67 of file otbDEMToImageGenerator.h.

◆ SpacingType

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

Definition at line 66 of file otbDEMToImageGenerator.h.

◆ Superclass

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

Definition at line 60 of file otbDEMToImageGenerator.h.

Constructor & Destructor Documentation

◆ DEMToImageGenerator() [1/2]

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

Set/Get the Output Origin coordinates.

Definition at line 32 of file otbDEMToImageGenerator.hxx.

◆ ~DEMToImageGenerator()

template<class TDEMImage >
otb::DEMToImageGenerator< TDEMImage >::~DEMToImageGenerator ( )
inlineoverrideprotected

Set/Get the Output Origin coordinates.

Definition at line 185 of file otbDEMToImageGenerator.h.

◆ DEMToImageGenerator() [2/2]

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

Set/Get the Output Origin coordinates.

Member Function Documentation

◆ AboveEllipsoidOff()

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

Set/Get the Output Origin coordinates.

◆ AboveEllipsoidOn()

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

Set/Get the Output Origin coordinates.

◆ BeforeThreadedGenerateData()

template<class TDEMImage >
void otb::DEMToImageGenerator< TDEMImage >::BeforeThreadedGenerateData
overrideprotected

Set/Get the Output Origin coordinates.

Definition at line 79 of file otbDEMToImageGenerator.hxx.

◆ CreateAnother()

template<class TDEMImage >
virtual::itk::LightObject::Pointer otb::DEMToImageGenerator< TDEMImage >::CreateAnother ( void  ) const

◆ GenerateOutputInformation()

template<class TDEMImage >
void otb::DEMToImageGenerator< TDEMImage >::GenerateOutputInformation
overrideprotected

Set/Get the Output Origin coordinates.

Definition at line 48 of file otbDEMToImageGenerator.hxx.

References otb::ProjectionProj.

◆ GetAboveEllipsoid()

template<class TDEMImage >
virtual bool otb::DEMToImageGenerator< TDEMImage >::GetAboveEllipsoid ( )
virtual

Set/Get the Output Origin coordinates.

◆ GetInputImageMetadata()

template<class TDEMImage >
const ImageMetadata* otb::DEMToImageGenerator< TDEMImage >::GetInputImageMetadata ( ) const
inline

Set/Get ImageMetadata

Definition at line 146 of file otbDEMToImageGenerator.h.

◆ GetInputProjectionRef()

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

Set/Get the Output Origin coordinates.

Definition at line 129 of file otbDEMToImageGenerator.h.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

◆ GetOutputImageMetadata()

template<class TDEMImage >
const ImageMetadata* otb::DEMToImageGenerator< TDEMImage >::GetOutputImageMetadata ( ) const
inline

Set/Get the Output Origin coordinates.

Definition at line 157 of file otbDEMToImageGenerator.h.

◆ GetOutputOrigin()

template<class TDEMImage >
virtual const PointType& otb::DEMToImageGenerator< TDEMImage >::GetOutputOrigin ( ) const
virtual

Set/Get the Output Origin coordinates.

◆ GetOutputProjectionRef()

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

Set/Get the Output Origin coordinates.

Definition at line 140 of file otbDEMToImageGenerator.h.

◆ GetOutputSize()

template<class TDEMImage >
virtual const SizeType& otb::DEMToImageGenerator< TDEMImage >::GetOutputSize ( ) const
virtual

Set/Get the Output Origin coordinates.

◆ GetOutputSpacing()

template<class TDEMImage >
virtual const SpacingType& otb::DEMToImageGenerator< TDEMImage >::GetOutputSpacing ( ) const
virtual

Set/Get the Output Origin coordinates.

◆ GetTransform()

template<class TDEMImage >
virtual const GenericRSTransformType* otb::DEMToImageGenerator< TDEMImage >::GetTransform ( ) const
virtual

Set/Get the Output Origin coordinates.

◆ InstantiateTransform()

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

Set/Get the Output Origin coordinates.

Definition at line 73 of file otbDEMToImageGenerator.hxx.

◆ New()

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

Method for creation through the object factory.

◆ operator=()

template<class TDEMImage >
void otb::DEMToImageGenerator< TDEMImage >::operator= ( const Self &  )
privatedelete

Set/Get the Output Origin coordinates.

◆ PrintSelf()

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

Set/Get the Output Origin coordinates.

Definition at line 162 of file otbDEMToImageGenerator.hxx.

◆ SetAboveEllipsoid()

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

◆ SetInputImageMetadata()

template<class TDEMImage >
void otb::DEMToImageGenerator< TDEMImage >::SetInputImageMetadata ( const ImageMetadata *  imd)
inline

Set/Get the Output Origin coordinates.

Definition at line 151 of file otbDEMToImageGenerator.h.

◆ SetInputProjectionRef()

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

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

Definition at line 122 of file otbDEMToImageGenerator.h.

◆ SetOutputImageMetadata()

template<class TDEMImage >
void otb::DEMToImageGenerator< TDEMImage >::SetOutputImageMetadata ( const ImageMetadata *  imd)
inline

Set/Get the Output Origin coordinates.

Definition at line 161 of file otbDEMToImageGenerator.h.

◆ SetOutputOrigin()

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

Set/Get the Output Origin coordinates.

◆ SetOutputParametersFromImage()

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 170 of file otbDEMToImageGenerator.h.

◆ SetOutputProjectionRef()

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

Set/Get the Output Origin coordinates.

Definition at line 134 of file otbDEMToImageGenerator.h.

◆ SetOutputSize()

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

Set/Get the Output Size.

◆ SetOutputSpacing()

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

Set/Get the Output Spacing.

◆ SetTransform()

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

Set/Get the Default Unknown Value.

◆ ThreadedGenerateData()

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

Set/Get the Output Origin coordinates.

Definition at line 92 of file otbDEMToImageGenerator.hxx.

References otb::DEMHandler::GetHeightAboveEllipsoid(), otb::DEMHandler::GetHeightAboveMSL(), and otb::DEMHandler::GetInstance().

Member Data Documentation

◆ m_AboveEllipsoid

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

Set/Get the Output Origin coordinates.

Definition at line 198 of file otbDEMToImageGenerator.h.

◆ m_DefaultUnknownValue

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

Set/Get the Output Origin coordinates.

Definition at line 197 of file otbDEMToImageGenerator.h.

◆ m_OutputOrigin

template<class TDEMImage >
PointType otb::DEMToImageGenerator< TDEMImage >::m_OutputOrigin {0.0}
protected

Set/Get the Output Origin coordinates.

Definition at line 194 of file otbDEMToImageGenerator.h.

◆ m_OutputSize

template<class TDEMImage >
SizeType otb::DEMToImageGenerator< TDEMImage >::m_OutputSize {0,0}
protected

Set/Get the Output Origin coordinates.

Definition at line 196 of file otbDEMToImageGenerator.h.

◆ m_OutputSpacing

template<class TDEMImage >
SpacingType otb::DEMToImageGenerator< TDEMImage >::m_OutputSpacing {0.0}
protected

Set/Get the Output Origin coordinates.

Definition at line 195 of file otbDEMToImageGenerator.h.

◆ m_Transform

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

Set/Get the Output Origin coordinates.

Definition at line 204 of file otbDEMToImageGenerator.h.

The documentation for this class was generated from the following files:
Generated at Wed Feb 28 2024 15:24:57 for OTB with   doxygen 1.8.17