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). More...

#include <otbImageToGenericRSOutputParameters.h>

Inheritance diagram for otb::ImageToGenericRSOutputParameters< TImage >:

Collaboration diagram for otb::ImageToGenericRSOutputParameters< TImage >:

List of all members.

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
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
void	Compute ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual void	EstimateIsotropicSpacingOff ()
virtual void	EstimateIsotropicSpacingOn ()
void	ForceSizeTo (const SizeType &size)
void	ForceSpacingTo (const SpacingType &spacing)
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual bool	GetEstimateIsotropicSpacing ()
virtual const ImageType *	GetInput ()
const ImageKeywordlist	GetInputKeywordList ()
std::string	GetInputProjectionRef () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual PointType	GetOutputOrigin ()
virtual SizeType	GetOutputSize ()
virtual SpacingType	GetOutputSpacing ()
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
virtual void	SetEstimateIsotropicSpacing (bool _arg)
virtual void	SetInput (const ImageType *_arg)
void	SetInputKeywordList (const ImageKeywordlist &kwl)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetOutputOrigin (PointType _arg)
void	SetOutputProjectionRef (const std::string &ref)
virtual void	SetOutputSize (SizeType _arg)
virtual void	SetOutputSpacing (SpacingType _arg)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const

Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	ImageToGenericRSOutputParameters ()
virtual	~ImageToGenericRSOutputParameters ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const

Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Private Member Functions
	ImageToGenericRSOutputParameters (const Self &)
void	EstimateOutputImageExtent ()
void	EstimateOutputOrigin ()
void	EstimateOutputSize ()
void	EstimateOutputSpacing ()
void	operator= (const Self &)
void	UpdateTransform ()

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

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 allow to force using 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 49 of file otbImageToGenericRSOutputParameters.h.

Member Typedef Documentation

template<class TImage >

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

Reimplemented from itk::Object.

Definition at line 57 of file otbImageToGenericRSOutputParameters.h.

template<class TImage >

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

Definition at line 74 of file otbImageToGenericRSOutputParameters.h.

template<class TImage >

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

GenericRSTransform typedef

Definition at line 73 of file otbImageToGenericRSOutputParameters.h.

template<class TImage >

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

InputImage typedefs

Definition at line 63 of file otbImageToGenericRSOutputParameters.h.

template<class TImage >

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

Definition at line 68 of file otbImageToGenericRSOutputParameters.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

template<class TImage >

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

Reimplemented from itk::Object.

Definition at line 56 of file otbImageToGenericRSOutputParameters.h.

template<class TImage >

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

Definition at line 70 of file otbImageToGenericRSOutputParameters.h.

template<class TImage >

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

Standard class typedefs

Reimplemented from itk::Object.

Definition at line 54 of file otbImageToGenericRSOutputParameters.h.

template<class TImage >

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

Definition at line 67 of file otbImageToGenericRSOutputParameters.h.

template<class TImage >

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

Definition at line 69 of file otbImageToGenericRSOutputParameters.h.

template<class TImage >

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

Reimplemented from itk::Object.

Definition at line 55 of file otbImageToGenericRSOutputParameters.h.

Constructor & Destructor Documentation

template<class TImage >

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

protected

Definition at line 29 of file otbImageToGenericRSOutputParameters.txx.

template<class TImage >

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

inlineprotectedvirtual

Definition at line 161 of file otbImageToGenericRSOutputParameters.h.

template<class TImage >

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

private

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

inherited

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::LightObject::BreakOnError ( )

staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

template<class TImage >

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

Method to trigger the output parameters

Trigger the output image information computation

Definition at line 43 of file otbImageToGenericRSOutputParameters.txx.

template<class TImage >

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

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 88 of file itkLightObject.cxx.

template<class TImage >

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

virtual

template<class TImage >

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

virtual

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 90 of file otbImageToGenericRSOutputParameters.txx.

template<class TImage >

void otb::ImageToGenericRSOutputParameters< TImage >::EstimateOutputOrigin ( )

private

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

Definition at line 166 of file otbImageToGenericRSOutputParameters.txx.

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 245 of file otbImageToGenericRSOutputParameters.txx.

template<class TImage >

void otb::ImageToGenericRSOutputParameters< TImage >::EstimateOutputSpacing ( )

private

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

Definition at line 183 of file otbImageToGenericRSOutputParameters.txx.

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

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

Command * itk::Object::GetCommand ( unsigned long tag )

inherited

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

template<class TImage >

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

virtual

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

template<class TImage >

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

virtual

template<class TImage >

const ImageKeywordlist otb::ImageToGenericRSOutputParameters< TImage >::GetInputKeywordList ( )

inline

Definition at line 151 of file otbImageToGenericRSOutputParameters.h.

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

template<class TImage >

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

inline

Definition at line 139 of file otbImageToGenericRSOutputParameters.h.

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

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns:: A constant reference to this objects MetaDataDictionary.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

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

template<class TImage >

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

virtual

template<class TImage >

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

virtual

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const

inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

void itk::Object::Modified ( void ) const

virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

template<class TImage >

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

static

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TImage >

void otb::ImageToGenericRSOutputParameters< TImage >::operator= ( const Self & )

private

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)		const

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)		const

protectedinherited

Definition at line 478 of file itkObject.cxx.

void itk::Object::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::LightObject.

Definition at line 517 of file itkObject.cxx.

References itk::Indent::GetNextIndent().

void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::Object::Register ( ) const

virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::Object::RemoveObserver ( unsigned long tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

void itk::Object::SetDebug ( bool debugFlag ) const

inherited

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 275 of file itkObject.cxx.

template<class TImage >

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

virtual

Isotropic spacing flag

void itk::Object::SetGlobalWarningDisplay ( bool val )

staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

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

Set/Get Input Keywordlist

Definition at line 145 of file otbImageToGenericRSOutputParameters.h.

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

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

inherited

Returns:: Set the MetaDataDictionary

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

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 133 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

Output Size

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

template<class TImage >

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

virtual

Output Spacing

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