An RemoteSensingRegion represents a structured region of data. More...

#include <otbRemoteSensingRegion.h>

Inheritance diagram for otb::RemoteSensingRegion< TType >:

Collaboration diagram for otb::RemoteSensingRegion< TType >:

Public Types
typedef itk::SmartPointer < const Self >	ConstPointer

typedef itk::ImageRegion< 2 >	ImageRegionType

typedef itk::ContinuousIndex < Type >	IndexType

typedef itk::SmartPointer< Self >	Pointer

typedef itk::Point< Type, 2 >	PointType

enum	RegionType { ITK_UNSTRUCTURED_REGION, ITK_STRUCTURED_REGION }

typedef otb::RemoteSensingRegion < TType >	Self

typedef itk::ContinuousIndex < Type >	SizeType

typedef itk::Region	Superclass

typedef TType	Type

Public Member Functions
	RemoteSensingRegion (unsigned int dimension)

	RemoteSensingRegion ()

	RemoteSensingRegion (const itk::ImageRegion< 2 > &region)

virtual	~RemoteSensingRegion ()

bool	Crop (const Self &region)

const ImageRegionType	GetImageRegion ()

const IndexType &	GetIndex () const

const ImageKeywordlist &	GetKeywordList () const

virtual const char *	GetNameOfClass () const

const IndexType &	GetOrigin () const

Type	GetOrigin (unsigned int i) const

std::string	GetRegionProjection ()

virtual Superclass::RegionType	GetRegionType () const

const SizeType &	GetSize () const

Type	GetSize (unsigned int i) const

bool	IsInside (const IndexType &index) const

bool	operator!= (const Self &region) const

void	operator= (const Self &region)

bool	operator== (const Self &region) const

virtual void	Print (std::ostream &os, Indent indent=0) const

void	SetIndex (const IndexType &index)

void	SetKeywordList (const ImageKeywordlist &kwl)

void	SetOrigin (const IndexType &index)

void	SetOrigin (const PointType &index)

void	SetOrigin (const unsigned int i, Type idx)

void	SetRegionProjection (const std::string &projection)

void	SetSize (const SizeType &size)

void	SetSize (const unsigned int i, Type size)

Protected Member Functions
virtual void	PrintHeader (std::ostream &os, Indent indent) const

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

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

Private Attributes
IndexType	m_Index

std::string	m_InputProjectionRef

ImageKeywordlist	m_KeywordList

SizeType	m_Size

Detailed Description

template<class TType>
class otb::RemoteSensingRegion< TType >

An RemoteSensingRegion represents a structured region of data.

RemoteSensingRegion is an class that represents some structured portion or piece of an Image. The RemoteSensingRegion is represented with an index and a size in each of the n-dimensions of the image. (The index is the corner of the image, the size is the lengths of the image in each of the topological directions. For this class, the notion of index and origin are the same.)

As the size and origin can be given in various system coordinates, they contain double values (through the use of an itk::ContinuousIndex).

To be flexible enough, the region also contain information about the projection in which this information is given. It can be a cartographic projection, but also a sensor model projection (hence making it useful also with non-orthorectified images).

See Also: VectorDataExtractROI

Examples:: Projections/VectorDataExtractROIExample.cxx.

Definition at line 56 of file otbRemoteSensingRegion.h.

Member Typedef Documentation

template<class TType>

typedef itk::SmartPointer<const Self> otb::RemoteSensingRegion< TType >::ConstPointer

Definition at line 63 of file otbRemoteSensingRegion.h.

template<class TType>

typedef itk::ImageRegion<2> otb::RemoteSensingRegion< TType >::ImageRegionType

ImageRegion typedef needed by the GetImageRegion() method

Definition at line 80 of file otbRemoteSensingRegion.h.

template<class TType>

typedef itk::ContinuousIndex<Type> otb::RemoteSensingRegion< TType >::IndexType

Index typedef support. An index is used to access pixel values.

Definition at line 72 of file otbRemoteSensingRegion.h.

template<class TType>

typedef itk::SmartPointer<Self> otb::RemoteSensingRegion< TType >::Pointer

Definition at line 62 of file otbRemoteSensingRegion.h.

template<class TType>

typedef itk::Point<Type, 2> otb::RemoteSensingRegion< TType >::PointType

Definition at line 73 of file otbRemoteSensingRegion.h.

template<class TType>

typedef otb::RemoteSensingRegion<TType> otb::RemoteSensingRegion< TType >::Self

Standard class typedefs.

Definition at line 60 of file otbRemoteSensingRegion.h.

template<class TType>

typedef itk::ContinuousIndex<Type> otb::RemoteSensingRegion< TType >::SizeType

Size typedef support. A size is used to define region bounds.

Definition at line 76 of file otbRemoteSensingRegion.h.

template<class TType>

typedef itk::Region otb::RemoteSensingRegion< TType >::Superclass

Definition at line 61 of file otbRemoteSensingRegion.h.

template<class TType>

typedef TType otb::RemoteSensingRegion< TType >::Type

Typedef Support

Definition at line 66 of file otbRemoteSensingRegion.h.

Member Enumeration Documentation

enum itk::Region::RegionType

inherited

Enums used to describe the extent types.

Enumerator
ITK_UNSTRUCTURED_REGION
ITK_STRUCTURED_REGION

Definition at line 63 of file itkRegion.h.

Constructor & Destructor Documentation

template<class TType>

otb::RemoteSensingRegion< TType >::RemoteSensingRegion ( unsigned int dimension )

inline

Constructor. RemoteSensingRegion is a lightweight object that is not reference counted, so the constructor is public.

Definition at line 87 of file otbRemoteSensingRegion.h.

template<class TType>

otb::RemoteSensingRegion< TType >::RemoteSensingRegion ( )

inline

Constructor. RemoteSensingRegion is a lightweight object that is not reference counted, so the constructor is public. Default dimension is 2.

Definition at line 96 of file otbRemoteSensingRegion.h.

template<class TType>

otb::RemoteSensingRegion< TType >::RemoteSensingRegion ( const itk::ImageRegion< 2 > & region )

inline

Constructor. RemoteSensingRegion is a lightweight object that is not reference counted, so the constructor is public. Default dimension is 2.

Definition at line 105 of file otbRemoteSensingRegion.h.

template<class TType>

virtual otb::RemoteSensingRegion< TType >::~RemoteSensingRegion ( )

inlinevirtual

Destructor. RemoteSensingRegion is a lightweight object that is not reference counted, so the destructor is public.

Definition at line 116 of file otbRemoteSensingRegion.h.

Member Function Documentation

template<class TType>

bool otb::RemoteSensingRegion< TType >::Crop ( const Self & region )

inline

Crop

Definition at line 283 of file otbRemoteSensingRegion.h.

template<class TType>

const ImageRegionType otb::RemoteSensingRegion< TType >::GetImageRegion ( )

inline

This method provides explicit conversion to itk::ImageRegion<2>, so as to allow to use RemoteSensingRegion to specify requested region for images or images iterators.

Definition at line 132 of file otbRemoteSensingRegion.h.

template<class TType>

const IndexType& otb::RemoteSensingRegion< TType >::GetIndex ( ) const

inline

Get index defining the corner of the region.

Definition at line 175 of file otbRemoteSensingRegion.h.

template<class TType>

const ImageKeywordlist& otb::RemoteSensingRegion< TType >::GetKeywordList ( ) const

inline

Definition at line 219 of file otbRemoteSensingRegion.h.

template<class TType>

virtual const char* otb::RemoteSensingRegion< TType >::GetNameOfClass ( ) const

virtual

Standard part of all itk objects.

Reimplemented from itk::Region.

template<class TType>

const IndexType& otb::RemoteSensingRegion< TType >::GetOrigin ( ) const

inline

Get index defining the corner of the region.

Definition at line 163 of file otbRemoteSensingRegion.h.

template<class TType>

Type otb::RemoteSensingRegion< TType >::GetOrigin ( unsigned int i ) const

inline

Definition at line 206 of file otbRemoteSensingRegion.h.

template<class TType>

std::string otb::RemoteSensingRegion< TType >::GetRegionProjection ( )

inline

Definition at line 274 of file otbRemoteSensingRegion.h.

template<class TType>

virtual Superclass::RegionType otb::RemoteSensingRegion< TType >::GetRegionType ( ) const

inlinevirtual

Subclasses must return a region type describing whether the region is structured or unstructured.

Implements itk::Region.

Definition at line 82 of file otbRemoteSensingRegion.h.

template<class TType>

const SizeType& otb::RemoteSensingRegion< TType >::GetSize ( ) const

inline

Get the size of the region.

Definition at line 194 of file otbRemoteSensingRegion.h.

Referenced by main().

template<class TType>

Type otb::RemoteSensingRegion< TType >::GetSize ( unsigned int i ) const

inline

Convenience methods to get the size of the image in a particular coordinate direction i. Do not try to access image sizes beyond the the ImageDimension.

Definition at line 202 of file otbRemoteSensingRegion.h.

template<class TType>

bool otb::RemoteSensingRegion< TType >::IsInside ( const IndexType & index ) const

inline

Test if an index is inside

Definition at line 251 of file otbRemoteSensingRegion.h.

template<class TType>

bool otb::RemoteSensingRegion< TType >::operator!= ( const Self & region ) const

inline

Compare two regions.

Definition at line 241 of file otbRemoteSensingRegion.h.

template<class TType>

void otb::RemoteSensingRegion< TType >::operator= ( const Self & region )

inline

operator=. RemoteSensingRegion is a lightweight object that is not reference counted, so operator= is public.

Definition at line 120 of file otbRemoteSensingRegion.h.

template<class TType>

bool otb::RemoteSensingRegion< TType >::operator== ( const Self & region ) const

inline

Compare two regions.

Definition at line 231 of file otbRemoteSensingRegion.h.

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

virtualinherited

Print the region.

Definition at line 27 of file itkRegion.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<(), otb::ImageIOBase::PrintSelf(), and itk::ImageIOBase::PrintSelf().

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

protectedvirtualinherited

Definition at line 36 of file itkRegion.cxx.

template<class TType>

void otb::RemoteSensingRegion< TType >::PrintSelf	(	std::ostream &	os,
		itk::Indent	indent
	)		const

inlineprotectedvirtual

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.

Reimplemented from itk::Region.

Definition at line 344 of file otbRemoteSensingRegion.h.

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

protectedvirtualinherited

Definition at line 43 of file itkRegion.cxx.

template<class TType>

void otb::RemoteSensingRegion< TType >::SetIndex ( const IndexType & index )

inline

Set the index defining the corner of the region.

Definition at line 169 of file otbRemoteSensingRegion.h.

template<class TType>

void otb::RemoteSensingRegion< TType >::SetKeywordList ( const ImageKeywordlist & kwl )

inline

Definition at line 224 of file otbRemoteSensingRegion.h.

Referenced by otb::VectorDataIntoImageProjectionFilter< TInputVectorData, TInputImage >::GenerateData(), and otb::StandardImageViewer< TImage, TVectorData, TWidgetManager >::Update().

template<class TType>

void otb::RemoteSensingRegion< TType >::SetOrigin ( const IndexType & index )

inline

Set the index defining the corner of the region.

Definition at line 150 of file otbRemoteSensingRegion.h.

Referenced by otb::VectorDataToImageFilter< TVectorData, TImage >::BeforeThreadedGenerateData(), otb::VectorDataToMapFilter< TVectorData, TImage >::BeforeThreadedGenerateData(), otb::VectorDataExtractROI< TVectorData >::ComputeVertexListBoundingRegion(), otb::VectorDataIntoImageProjectionFilter< TInputVectorData, TInputImage >::GenerateData(), and otb::StandardImageViewer< TImage, TVectorData, TWidgetManager >::Update().

template<class TType>

void otb::RemoteSensingRegion< TType >::SetOrigin ( const PointType & index )

inline

Set the index defining the corner of the region.

Definition at line 156 of file otbRemoteSensingRegion.h.

template<class TType>

void otb::RemoteSensingRegion< TType >::SetOrigin	(	const unsigned int	i,
		Type	idx
	)

inline

Definition at line 214 of file otbRemoteSensingRegion.h.

template<class TType>

void otb::RemoteSensingRegion< TType >::SetRegionProjection ( const std::string & projection )

inline

Get/Set InputProjectionRef std::string

Definition at line 270 of file otbRemoteSensingRegion.h.

Referenced by otb::VectorDataToImageFilter< TVectorData, TImage >::BeforeThreadedGenerateData(), otb::VectorDataToMapFilter< TVectorData, TImage >::BeforeThreadedGenerateData(), otb::VectorDataIntoImageProjectionFilter< TInputVectorData, TInputImage >::GenerateData(), and otb::StandardImageViewer< TImage, TVectorData, TWidgetManager >::Update().

template<class TType>

void otb::RemoteSensingRegion< TType >::SetSize ( const SizeType & size )

inline

Set the size of the region. This plus the index determines the rectangular shape, or extent, of the region.

Definition at line 182 of file otbRemoteSensingRegion.h.

Referenced by otb::VectorDataToImageFilter< TVectorData, TImage >::BeforeThreadedGenerateData(), otb::VectorDataToMapFilter< TVectorData, TImage >::BeforeThreadedGenerateData(), otb::VectorDataExtractROI< TVectorData >::ComputeVertexListBoundingRegion(), otb::VectorDataIntoImageProjectionFilter< TInputVectorData, TInputImage >::GenerateData(), main(), and otb::StandardImageViewer< TImage, TVectorData, TWidgetManager >::Update().

template<class TType>

void otb::RemoteSensingRegion< TType >::SetSize	(	const unsigned int	i,
		Type	size
	)

inline

Definition at line 210 of file otbRemoteSensingRegion.h.

Member Data Documentation

template<class TType>

IndexType otb::RemoteSensingRegion< TType >::m_Index

private

Definition at line 356 of file otbRemoteSensingRegion.h.

template<class TType>

std::string otb::RemoteSensingRegion< TType >::m_InputProjectionRef

private

Definition at line 359 of file otbRemoteSensingRegion.h.

template<class TType>

ImageKeywordlist otb::RemoteSensingRegion< TType >::m_KeywordList

private

Definition at line 360 of file otbRemoteSensingRegion.h.

template<class TType>

SizeType otb::RemoteSensingRegion< TType >::m_Size

private

Definition at line 357 of file otbRemoteSensingRegion.h.

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

otbRemoteSensingRegion.h

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

template<class TType> class otb::RemoteSensingRegion< TType >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TType>
class otb::RemoteSensingRegion< TType >