OTB  7.2.0
Orfeo Toolbox
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::ImageToGenericRSOutputParameters< TImage > Class Template Reference

#include <otbImageToGenericRSOutputParameters.h>

+ Inheritance diagram for otb::ImageToGenericRSOutputParameters< TImage >:
+ Collaboration diagram for otb::ImageToGenericRSOutputParameters< TImage >:

Classes

struct  OutputImageExtentType
 

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef GenericRSTransformType::Pointer GenericRSTransformPointerType
 
typedef GenericRSTransform GenericRSTransformType
 
typedef TImage ImageType
 
typedef ImageType::IndexType IndexType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ImageType::PointType PointType
 
typedef ImageToGenericRSOutputParameters Self
 
typedef ImageType::SizeType SizeType
 
typedef ImageType::SpacingType SpacingType
 
typedef itk::Object Superclass
 

Public Member Functions

void Compute ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
const ImageKeywordlist GetInputKeywordList ()
 
std::string GetInputProjectionRef () const
 
virtual const char * GetNameOfClass () const
 
virtual void SetInput (const ImageType *_arg)
 
virtual const ImageTypeGetInput () const
 
virtual void SetOutputOrigin (PointType _arg)
 
virtual PointType GetOutputOrigin ()
 
virtual void SetOutputSpacing (SpacingType _arg)
 
virtual SpacingType GetOutputSpacing ()
 
virtual void SetOutputSize (SizeType _arg)
 
virtual SizeType GetOutputSize ()
 
virtual void SetEstimateIsotropicSpacing (bool _arg)
 
virtual bool GetEstimateIsotropicSpacing ()
 
virtual void EstimateIsotropicSpacingOn ()
 
virtual void EstimateIsotropicSpacingOff ()
 
void ForceSpacingTo (const SpacingType &spacing)
 
void ForceSizeTo (const SizeType &size)
 
void SetOutputProjectionRef (const std::string &ref)
 
void SetInputKeywordList (const ImageKeywordlist &kwl)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 ImageToGenericRSOutputParameters ()
 
 ~ImageToGenericRSOutputParameters () override
 

Private Member Functions

 ImageToGenericRSOutputParameters (const Self &)=delete
 
void operator= (const Self &)=delete
 
void UpdateTransform ()
 
void EstimateOutputImageExtent ()
 
void EstimateOutputOrigin ()
 
void EstimateOutputSpacing ()
 
void EstimateOutputSize ()
 

Private Attributes

bool m_EstimateIsotropicSpacing
 
bool m_ForceSize
 
bool m_ForceSpacing
 
ImageType::ConstPointer m_Input
 
OutputImageExtentType m_OutputExtent
 
PointType m_OutputOrigin {0.0}
 
SizeType m_OutputSize {0,0}
 
SpacingType m_OutputSpacing {0.0}
 
GenericRSTransformPointerType m_Transform
 

Detailed Description

template<class TImage>
class otb::ImageToGenericRSOutputParameters< TImage >

This class is a helper class to estimate the output parameters of an image after projection in a target SRS (defined here using its projectionRef).

This class allow the computation of the output Origin|Spacing|Size when projecting an image in a target SRS. The user can set the target projectionRef via SetOutputProjectionRef(std::string).

This class allows forcing use of a desired spacing. For instance, if one need to compute the output Size of an image in the UTM srs with a spacing of 5 m, it can be set via the method ForceSpacingTo(spacing).

In the same way, one can force the image to have a final size using ForceSizeTo(size). The spacing is then computed to get all the pixels of the image in the output image.

See also
GenericRSTransform

Definition at line 56 of file otbImageToGenericRSOutputParameters.h.

Member Typedef Documentation

◆ ConstPointer

template<class TImage >
typedef itk::SmartPointer<const Self> otb::ImageToGenericRSOutputParameters< TImage >::ConstPointer

Definition at line 63 of file otbImageToGenericRSOutputParameters.h.

◆ GenericRSTransformPointerType

Definition at line 80 of file otbImageToGenericRSOutputParameters.h.

◆ GenericRSTransformType

GenericRSTransform typedef

Definition at line 79 of file otbImageToGenericRSOutputParameters.h.

◆ ImageType

template<class TImage >
typedef TImage otb::ImageToGenericRSOutputParameters< TImage >::ImageType

InputImage typedefs

Definition at line 69 of file otbImageToGenericRSOutputParameters.h.

◆ IndexType

template<class TImage >
typedef ImageType::IndexType otb::ImageToGenericRSOutputParameters< TImage >::IndexType

Definition at line 74 of file otbImageToGenericRSOutputParameters.h.

◆ Pointer

template<class TImage >
typedef itk::SmartPointer<Self> otb::ImageToGenericRSOutputParameters< TImage >::Pointer

Definition at line 62 of file otbImageToGenericRSOutputParameters.h.

◆ PointType

template<class TImage >
typedef ImageType::PointType otb::ImageToGenericRSOutputParameters< TImage >::PointType

Definition at line 76 of file otbImageToGenericRSOutputParameters.h.

◆ Self

Standard class typedefs

Definition at line 60 of file otbImageToGenericRSOutputParameters.h.

◆ SizeType

template<class TImage >
typedef ImageType::SizeType otb::ImageToGenericRSOutputParameters< TImage >::SizeType

Definition at line 73 of file otbImageToGenericRSOutputParameters.h.

◆ SpacingType

template<class TImage >
typedef ImageType::SpacingType otb::ImageToGenericRSOutputParameters< TImage >::SpacingType

Definition at line 75 of file otbImageToGenericRSOutputParameters.h.

◆ Superclass

template<class TImage >
typedef itk::Object otb::ImageToGenericRSOutputParameters< TImage >::Superclass

Definition at line 61 of file otbImageToGenericRSOutputParameters.h.

Constructor & Destructor Documentation

◆ ImageToGenericRSOutputParameters() [1/2]

template<class TImage >
otb::ImageToGenericRSOutputParameters< TImage >::ImageToGenericRSOutputParameters ( )
protected

◆ ~ImageToGenericRSOutputParameters()

template<class TImage >
otb::ImageToGenericRSOutputParameters< TImage >::~ImageToGenericRSOutputParameters ( )
inlineoverrideprotected

◆ ImageToGenericRSOutputParameters() [2/2]

template<class TImage >
otb::ImageToGenericRSOutputParameters< TImage >::ImageToGenericRSOutputParameters ( const Self )
privatedelete

Member Function Documentation

◆ Compute()

template<class TImage >
void otb::ImageToGenericRSOutputParameters< TImage >::Compute ( )

Method to trigger the output parameters

Trigger the output image information computation

Definition at line 45 of file otbImageToGenericRSOutputParameters.hxx.

Referenced by otb::ImageToGenericRSOutputParameters< TImage >::GetInputKeywordList().

◆ CreateAnother()

template<class TImage >
virtual::itk::LightObject::Pointer otb::ImageToGenericRSOutputParameters< TImage >::CreateAnother ( void  ) const

◆ EstimateIsotropicSpacingOff()

template<class TImage >
virtual void otb::ImageToGenericRSOutputParameters< TImage >::EstimateIsotropicSpacingOff ( )
virtual

Isotropic spacing flag

◆ EstimateIsotropicSpacingOn()

template<class TImage >
virtual void otb::ImageToGenericRSOutputParameters< TImage >::EstimateIsotropicSpacingOn ( )
virtual

Isotropic spacing flag

◆ EstimateOutputImageExtent()

template<class TImage >
void otb::ImageToGenericRSOutputParameters< TImage >::EstimateOutputImageExtent ( )
private

The extent is the projection of the 4 image corner in the final projection system.

Definition at line 88 of file otbImageToGenericRSOutputParameters.hxx.

Referenced by otb::ImageToGenericRSOutputParameters< TImage >::~ImageToGenericRSOutputParameters().

◆ EstimateOutputOrigin()

template<class TImage >
void otb::ImageToGenericRSOutputParameters< TImage >::EstimateOutputOrigin ( )
private

Method used to estimate the Origin using the extent of the image

Definition at line 162 of file otbImageToGenericRSOutputParameters.hxx.

Referenced by otb::ImageToGenericRSOutputParameters< TImage >::~ImageToGenericRSOutputParameters().

◆ EstimateOutputSize()

template<class TImage >
void otb::ImageToGenericRSOutputParameters< TImage >::EstimateOutputSize ( )
private

Method used to estimate the size using the output size of the image

Definition at line 237 of file otbImageToGenericRSOutputParameters.hxx.

Referenced by otb::ImageToGenericRSOutputParameters< TImage >::~ImageToGenericRSOutputParameters().

◆ EstimateOutputSpacing()

template<class TImage >
void otb::ImageToGenericRSOutputParameters< TImage >::EstimateOutputSpacing ( )
private

Method used to estimate the spacing using the extent of the image

Definition at line 178 of file otbImageToGenericRSOutputParameters.hxx.

Referenced by otb::ImageToGenericRSOutputParameters< TImage >::~ImageToGenericRSOutputParameters().

◆ ForceSizeTo()

template<class TImage >
void otb::ImageToGenericRSOutputParameters< TImage >::ForceSizeTo ( const SizeType size)
inline

Method to Force the use of the size selected by the user, the output spacing is computed using this one

Definition at line 134 of file otbImageToGenericRSOutputParameters.h.

References otb::ImageToGenericRSOutputParameters< TImage >::m_ForceSize, and otb::ImageToGenericRSOutputParameters< TImage >::SetOutputSize().

◆ ForceSpacingTo()

template<class TImage >
void otb::ImageToGenericRSOutputParameters< TImage >::ForceSpacingTo ( const SpacingType spacing)
inline

Method to Force the use of the spacing selected by the user The output size is computed using this spacing

Definition at line 123 of file otbImageToGenericRSOutputParameters.h.

References otb::ImageToGenericRSOutputParameters< TImage >::m_ForceSpacing, and otb::ImageToGenericRSOutputParameters< TImage >::SetOutputSpacing().

◆ GetEstimateIsotropicSpacing()

template<class TImage >
virtual bool otb::ImageToGenericRSOutputParameters< TImage >::GetEstimateIsotropicSpacing ( )
virtual

Isotropic spacing flag

◆ GetInput()

template<class TImage >
virtual const ImageType* otb::ImageToGenericRSOutputParameters< TImage >::GetInput ( ) const
virtual

Method to Set/Get the input

◆ GetInputKeywordList()

template<class TImage >
const ImageKeywordlist otb::ImageToGenericRSOutputParameters< TImage >::GetInputKeywordList ( )
inline

◆ GetInputProjectionRef()

template<class TImage >
std::string otb::ImageToGenericRSOutputParameters< TImage >::GetInputProjectionRef ( ) const
inline

◆ GetNameOfClass()

template<class TImage >
virtual const char* otb::ImageToGenericRSOutputParameters< TImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ GetOutputOrigin()

template<class TImage >
virtual PointType otb::ImageToGenericRSOutputParameters< TImage >::GetOutputOrigin ( )
virtual

Output Origin

◆ GetOutputSize()

template<class TImage >
virtual SizeType otb::ImageToGenericRSOutputParameters< TImage >::GetOutputSize ( )
virtual

Output Size

◆ GetOutputSpacing()

template<class TImage >
virtual SpacingType otb::ImageToGenericRSOutputParameters< TImage >::GetOutputSpacing ( )
virtual

Output Spacing

◆ New()

template<class TImage >
static Pointer otb::ImageToGenericRSOutputParameters< TImage >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TImage >
void otb::ImageToGenericRSOutputParameters< TImage >::operator= ( const Self )
privatedelete

◆ SetEstimateIsotropicSpacing()

template<class TImage >
virtual void otb::ImageToGenericRSOutputParameters< TImage >::SetEstimateIsotropicSpacing ( bool  _arg)
virtual

Isotropic spacing flag

◆ SetInput()

template<class TImage >
virtual void otb::ImageToGenericRSOutputParameters< TImage >::SetInput ( const ImageType _arg)
virtual

Method to Set/Get the input

◆ SetInputKeywordList()

template<class TImage >
void otb::ImageToGenericRSOutputParameters< TImage >::SetInputKeywordList ( const ImageKeywordlist kwl)
inline

◆ SetOutputOrigin()

template<class TImage >
virtual void otb::ImageToGenericRSOutputParameters< TImage >::SetOutputOrigin ( PointType  _arg)
virtual

Output Origin

◆ SetOutputProjectionRef()

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

Method to Set/Get the output projectionRef We cannot use the macro otbGetObjectMemberConstMacro cause the SetOutputProjectionRef calls actually the method SetInputProjectionRef of the GenericRSTransform class.

Definition at line 147 of file otbImageToGenericRSOutputParameters.h.

References otb::ImageToGenericRSOutputParameters< TImage >::m_Transform.

◆ SetOutputSize()

template<class TImage >
virtual void otb::ImageToGenericRSOutputParameters< TImage >::SetOutputSize ( SizeType  _arg)
virtual

◆ SetOutputSpacing()

template<class TImage >
virtual void otb::ImageToGenericRSOutputParameters< TImage >::SetOutputSpacing ( SpacingType  _arg)
virtual

◆ UpdateTransform()

template<class TImage >
void otb::ImageToGenericRSOutputParameters< TImage >::UpdateTransform ( )
private

Member Data Documentation

◆ m_EstimateIsotropicSpacing

template<class TImage >
bool otb::ImageToGenericRSOutputParameters< TImage >::m_EstimateIsotropicSpacing
private

Definition at line 203 of file otbImageToGenericRSOutputParameters.h.

◆ m_ForceSize

template<class TImage >
bool otb::ImageToGenericRSOutputParameters< TImage >::m_ForceSize
private

◆ m_ForceSpacing

template<class TImage >
bool otb::ImageToGenericRSOutputParameters< TImage >::m_ForceSpacing
private

◆ m_Input

template<class TImage >
ImageType::ConstPointer otb::ImageToGenericRSOutputParameters< TImage >::m_Input
private

Definition at line 193 of file otbImageToGenericRSOutputParameters.h.

◆ m_OutputExtent

template<class TImage >
OutputImageExtentType otb::ImageToGenericRSOutputParameters< TImage >::m_OutputExtent
private

Definition at line 197 of file otbImageToGenericRSOutputParameters.h.

◆ m_OutputOrigin

template<class TImage >
PointType otb::ImageToGenericRSOutputParameters< TImage >::m_OutputOrigin {0.0}
private

Definition at line 194 of file otbImageToGenericRSOutputParameters.h.

◆ m_OutputSize

template<class TImage >
SizeType otb::ImageToGenericRSOutputParameters< TImage >::m_OutputSize {0,0}
private

Definition at line 196 of file otbImageToGenericRSOutputParameters.h.

◆ m_OutputSpacing

template<class TImage >
SpacingType otb::ImageToGenericRSOutputParameters< TImage >::m_OutputSpacing {0.0}
private

Definition at line 195 of file otbImageToGenericRSOutputParameters.h.

◆ m_Transform

template<class TImage >
GenericRSTransformPointerType otb::ImageToGenericRSOutputParameters< TImage >::m_Transform
private

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