OTB  6.7.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 Self
ConstPointer
 
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 Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

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)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 ImageToGenericRSOutputParameters ()
 
 ~ImageToGenericRSOutputParameters () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

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
 
SizeType m_OutputSize
 
SpacingType m_OutputSpacing
 
GenericRSTransformPointerType m_Transform
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

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 55 of file otbImageToGenericRSOutputParameters.h.

Member Typedef Documentation

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

Definition at line 63 of file otbImageToGenericRSOutputParameters.h.

Definition at line 80 of file otbImageToGenericRSOutputParameters.h.

GenericRSTransform typedef

Definition at line 79 of file otbImageToGenericRSOutputParameters.h.

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

InputImage typedefs

Definition at line 69 of file otbImageToGenericRSOutputParameters.h.

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

Definition at line 74 of file otbImageToGenericRSOutputParameters.h.

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

Definition at line 62 of file otbImageToGenericRSOutputParameters.h.

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

Definition at line 76 of file otbImageToGenericRSOutputParameters.h.

Standard class typedefs

Definition at line 60 of file otbImageToGenericRSOutputParameters.h.

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

Definition at line 73 of file otbImageToGenericRSOutputParameters.h.

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

Definition at line 75 of file otbImageToGenericRSOutputParameters.h.

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

Definition at line 61 of file otbImageToGenericRSOutputParameters.h.

Constructor & Destructor Documentation

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

Definition at line 33 of file otbImageToGenericRSOutputParameters.hxx.

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

Definition at line 176 of file otbImageToGenericRSOutputParameters.h.

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

Member Function Documentation

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

Method to trigger the output parameters

Trigger the output image information computation

Definition at line 47 of file otbImageToGenericRSOutputParameters.hxx.

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

Reimplemented from itk::Object.

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

Isotropic spacing flag

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

Isotropic spacing flag

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 94 of file otbImageToGenericRSOutputParameters.hxx.

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

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

Definition at line 170 of file otbImageToGenericRSOutputParameters.hxx.

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 251 of file otbImageToGenericRSOutputParameters.hxx.

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

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

Definition at line 188 of file otbImageToGenericRSOutputParameters.hxx.

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 133 of file otbImageToGenericRSOutputParameters.h.

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

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 122 of file otbImageToGenericRSOutputParameters.h.

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

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

Isotropic spacing flag

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

Method to Set/Get the input

template<class TImage >
const ImageKeywordlist otb::ImageToGenericRSOutputParameters< TImage >::GetInputKeywordList ( )
inline
template<class TImage >
std::string otb::ImageToGenericRSOutputParameters< TImage >::GetInputProjectionRef ( ) const
inline
template<class TImage >
virtual const char* otb::ImageToGenericRSOutputParameters< TImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

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

Output Origin

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

Output Size

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

Output Spacing

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

Method for creation through the object factory.

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

Isotropic spacing flag

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

Method to Set/Get the input

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

Output Origin

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 146 of file otbImageToGenericRSOutputParameters.h.

References otb::ImageToGenericRSOutputParameters< TImage >::m_Transform, and itk::Object::Modified().

template<class TImage >
virtual void otb::ImageToGenericRSOutputParameters< TImage >::SetOutputSize ( SizeType  _arg)
virtual
template<class TImage >
virtual void otb::ImageToGenericRSOutputParameters< TImage >::SetOutputSpacing ( SpacingType  _arg)
virtual
template<class TImage >
void otb::ImageToGenericRSOutputParameters< TImage >::UpdateTransform ( )
private

Definition at line 78 of file otbImageToGenericRSOutputParameters.hxx.

Member Data Documentation

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

Definition at line 198 of file otbImageToGenericRSOutputParameters.h.

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

Definition at line 188 of file otbImageToGenericRSOutputParameters.h.

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

Definition at line 192 of file otbImageToGenericRSOutputParameters.h.

template<class TImage >
PointType otb::ImageToGenericRSOutputParameters< TImage >::m_OutputOrigin
private

Definition at line 189 of file otbImageToGenericRSOutputParameters.h.

template<class TImage >
SizeType otb::ImageToGenericRSOutputParameters< TImage >::m_OutputSize
private

Definition at line 191 of file otbImageToGenericRSOutputParameters.h.

template<class TImage >
SpacingType otb::ImageToGenericRSOutputParameters< TImage >::m_OutputSpacing
private

Definition at line 190 of file otbImageToGenericRSOutputParameters.h.

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

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