#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< Self >	Pointer

typedef ImageType::PointType	PointType

typedef ImageToGenericRSOutputParameters	Self

typedef ImageType::SizeType	SizeType

typedef ImageType::SpacingType	SpacingType

typedef itk::Object	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual const char *	GetNameOfClass () const

Static Public Member Functions
static Pointer	New ()

ImageType::ConstPointer	m_Input

PointType	m_OutputOrigin {0.0}

SpacingType	m_OutputSpacing {0.0}

SizeType	m_OutputSize {0,0}

OutputImageExtentType	m_OutputExtent

GenericRSTransformPointerType	m_Transform

bool	m_ForceSpacing

bool	m_ForceSize

bool	m_EstimateIsotropicSpacing

virtual void	SetInput (const ImageType *_arg)

virtual const ImageType *	GetInput () 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)

std::string	GetInputProjectionRef () const

void	SetInputImageMetadata (ImageMetadata *imd)

const ImageMetadata *	GetInputImageMetadata ()

void	Compute ()

	ImageToGenericRSOutputParameters ()

	~ImageToGenericRSOutputParameters () override

	ImageToGenericRSOutputParameters (const Self &)=delete

void	operator= (const Self &)=delete

void	UpdateTransform ()

void	EstimateOutputImageExtent ()

void	EstimateOutputSpacing ()

void	EstimateOutputSize ()

void	EstimateOutputOrigin ()

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

Member Typedef Documentation

◆ ConstPointer

template<class TImage >

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

Definition at line 64 of file otbImageToGenericRSOutputParameters.h.

◆ GenericRSTransformPointerType

template<class TImage >

typedef GenericRSTransformType::Pointer otb::ImageToGenericRSOutputParameters< TImage >::GenericRSTransformPointerType

Definition at line 81 of file otbImageToGenericRSOutputParameters.h.

◆ GenericRSTransformType

template<class TImage >

typedef GenericRSTransform otb::ImageToGenericRSOutputParameters< TImage >::GenericRSTransformType

GenericRSTransform typedef

Definition at line 80 of file otbImageToGenericRSOutputParameters.h.

◆ ImageType

template<class TImage >

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

InputImage typedefs

Definition at line 70 of file otbImageToGenericRSOutputParameters.h.

◆ IndexType

template<class TImage >

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

Definition at line 75 of file otbImageToGenericRSOutputParameters.h.

◆ Pointer

template<class TImage >

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

Definition at line 63 of file otbImageToGenericRSOutputParameters.h.

◆ PointType

template<class TImage >

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

Definition at line 77 of file otbImageToGenericRSOutputParameters.h.

◆ Self

template<class TImage >

typedef ImageToGenericRSOutputParameters otb::ImageToGenericRSOutputParameters< TImage >::Self

Standard class typedefs

Definition at line 61 of file otbImageToGenericRSOutputParameters.h.

◆ SizeType

template<class TImage >

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

Definition at line 74 of file otbImageToGenericRSOutputParameters.h.

◆ SpacingType

template<class TImage >

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

Definition at line 76 of file otbImageToGenericRSOutputParameters.h.

◆ Superclass

template<class TImage >

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

Definition at line 62 of file otbImageToGenericRSOutputParameters.h.

Constructor & Destructor Documentation

◆ ImageToGenericRSOutputParameters() [1/2]

template<class TImage >

otb::ImageToGenericRSOutputParameters< TImage >::ImageToGenericRSOutputParameters

protected

Method to Set/Get the input

Definition at line 33 of file otbImageToGenericRSOutputParameters.hxx.

◆ ~ImageToGenericRSOutputParameters()

template<class TImage >

otb::ImageToGenericRSOutputParameters< TImage >::~ImageToGenericRSOutputParameters ( )

inlineoverrideprotected

Method to Set/Get the input

Definition at line 179 of file otbImageToGenericRSOutputParameters.h.

◆ ImageToGenericRSOutputParameters() [2/2]

template<class TImage >

otb::ImageToGenericRSOutputParameters< TImage >::ImageToGenericRSOutputParameters ( const Self & )

privatedelete

Method to Set/Get the input

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.

◆ 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

Method to Set/Get the input

◆ EstimateIsotropicSpacingOn()

template<class TImage >

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

virtual

Method to Set/Get the input

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

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

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

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

◆ 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 135 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 124 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

Method to Set/Get the input

◆ GetInput()

template<class TImage >

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

virtual

Method to Set/Get the input

◆ GetInputImageMetadata()

template<class TImage >

const ImageMetadata* otb::ImageToGenericRSOutputParameters< TImage >::GetInputImageMetadata ( )

inline

Method to Set/Get the input

Definition at line 169 of file otbImageToGenericRSOutputParameters.h.

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

◆ GetInputProjectionRef()

template<class TImage >

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

inline

Method to Set/Get the input

Definition at line 155 of file otbImageToGenericRSOutputParameters.h.

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

◆ 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

Method to Set/Get the input

◆ GetOutputSize()

template<class TImage >

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

virtual

Method to Set/Get the input

◆ GetOutputSpacing()

template<class TImage >

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

virtual

Method to Set/Get the input

◆ 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

Method to Set/Get the input

◆ 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

◆ SetInputImageMetadata()

template<class TImage >

void otb::ImageToGenericRSOutputParameters< TImage >::SetInputImageMetadata ( ImageMetadata * imd )

inline

Set/Get Input ImageMetadata

Definition at line 162 of file otbImageToGenericRSOutputParameters.h.

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

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

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