#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

typedef otb::RemoteSensingRegion< TType >	Self

typedef itk::ContinuousIndex< Type >	SizeType

typedef itk::Region	Superclass

typedef TType	Type

Public Member Functions
virtual const char *	GetNameOfClass () const

Superclass::RegionType	GetRegionType () const override

IndexType	m_Index

SizeType	m_Size

std::string	m_InputProjectionRef

ImageMetadata	m_ImageMetadata

	RemoteSensingRegion ()

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

const ImageRegionType	GetImageRegion ()

void	SetOrigin (const IndexType &index)

void	SetOrigin (const PointType &index)

const IndexType &	GetOrigin () const

void	SetIndex (const IndexType &index)

const IndexType &	GetIndex () const

void	SetSize (const SizeType &size)

const SizeType &	GetSize () const

Type	GetSize (unsigned int i) const

Type	GetOrigin (unsigned int i) const

void	SetSize (const unsigned int i, Type size)

void	SetOrigin (const unsigned int i, Type idx)

const ImageMetadata &	GetImageMetadata () const

void	SetImageMetadata (const ImageMetadata &imd)

bool	operator== (const Self &region) const

bool	operator!= (const Self &region) const

bool	IsInside (const IndexType &index) const

void	SetRegionProjection (const std::string &projection)

std::string	GetRegionProjection ()

bool	Crop (const Self &region)

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

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 59 of file otbRemoteSensingRegion.h.

Member Typedef Documentation

◆ ConstPointer

template<class TType >

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

Definition at line 66 of file otbRemoteSensingRegion.h.

◆ ImageRegionType

template<class TType >

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

ImageRegion typedef needed by the GetImageRegion() method

Definition at line 83 of file otbRemoteSensingRegion.h.

◆ IndexType

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 75 of file otbRemoteSensingRegion.h.

◆ Pointer

template<class TType >

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

Definition at line 65 of file otbRemoteSensingRegion.h.

◆ PointType

template<class TType >

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

Definition at line 76 of file otbRemoteSensingRegion.h.

◆ Self

template<class TType >

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

Standard class typedefs.

Definition at line 63 of file otbRemoteSensingRegion.h.

◆ SizeType

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 79 of file otbRemoteSensingRegion.h.

◆ Superclass

template<class TType >

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

Definition at line 64 of file otbRemoteSensingRegion.h.

◆ Type

template<class TType >

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

Typedef Support

Definition at line 69 of file otbRemoteSensingRegion.h.

Constructor & Destructor Documentation

◆ RemoteSensingRegion() [1/2]

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 92 of file otbRemoteSensingRegion.h.

◆ RemoteSensingRegion() [2/2]

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 101 of file otbRemoteSensingRegion.h.

Member Function Documentation

◆ Crop()

template<class TType >

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

inline

Crop

Definition at line 270 of file otbRemoteSensingRegion.h.

Referenced by otb::VectorDataExtractROI< TVectorData >::IsLineIntersectionNotNull().

◆ GetImageMetadata()

template<class TType >

const ImageMetadata& otb::RemoteSensingRegion< TType >::GetImageMetadata ( ) const

inline

Get the image metadata

Deprecated:

Definition at line 205 of file otbRemoteSensingRegion.h.

◆ GetImageRegion()

template<class TType >

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

inline

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

Definition at line 114 of file otbRemoteSensingRegion.h.

◆ GetIndex()

template<class TType >

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

inline

Get index defining the corner of the region.

Definition at line 157 of file otbRemoteSensingRegion.h.

◆ GetNameOfClass()

template<class TType >

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

virtual

Standard part of all itk objects.

◆ GetOrigin() [1/2]

template<class TType >

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

inline

Get index defining the corner of the region.

Definition at line 145 of file otbRemoteSensingRegion.h.

Referenced by otb::RemoteSensingRegion< typename VertexType::CoordRepType >::Crop().

◆ GetOrigin() [2/2]

template<class TType >

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

inline

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

Definition at line 188 of file otbRemoteSensingRegion.h.

◆ GetRegionProjection()

template<class TType >

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

inline

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

Definition at line 262 of file otbRemoteSensingRegion.h.

◆ GetRegionType()

template<class TType >

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

inlineoverride

Definition at line 85 of file otbRemoteSensingRegion.h.

◆ GetSize() [1/2]

template<class TType >

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

inline

Get the size of the region.

Definition at line 176 of file otbRemoteSensingRegion.h.

Referenced by otb::RemoteSensingRegion< typename VertexType::CoordRepType >::Crop().

◆ GetSize() [2/2]

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 184 of file otbRemoteSensingRegion.h.

◆ IsInside()

template<class TType >

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

inline

Test if an index is inside

Definition at line 239 of file otbRemoteSensingRegion.h.

◆ operator!=()

template<class TType >

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

inline

Compare two regions.

Definition at line 229 of file otbRemoteSensingRegion.h.

◆ operator==()

template<class TType >

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

inline

Compare two regions.

Definition at line 219 of file otbRemoteSensingRegion.h.

◆ PrintSelf()

template<class TType >

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

inlineoverrideprotected

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

Definition at line 318 of file otbRemoteSensingRegion.h.

◆ SetImageMetadata()

template<class TType >

void otb::RemoteSensingRegion< TType >::SetImageMetadata ( const ImageMetadata & imd )

inline

Set the image metadata

Deprecated:

Definition at line 213 of file otbRemoteSensingRegion.h.

Referenced by otb::VectorDataIntoImageProjectionFilter< TInputVectorData, TInputImage >::GenerateData().

◆ SetIndex()

template<class TType >

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

inline

Set the index defining the corner of the region.

Definition at line 151 of file otbRemoteSensingRegion.h.

◆ SetOrigin() [1/3]

template<class TType >

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

inline

Set the index defining the corner of the region.

Definition at line 132 of file otbRemoteSensingRegion.h.

Referenced by otb::VectorDataExtractROI< TVectorData >::ComputeVertexListBoundingRegion(), and otb::VectorDataIntoImageProjectionFilter< TInputVectorData, TInputImage >::GenerateData().

◆ SetOrigin() [2/3]

template<class TType >

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

inline

Set the index defining the corner of the region.

Definition at line 138 of file otbRemoteSensingRegion.h.

◆ SetOrigin() [3/3]

template<class TType >

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

inline

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

Definition at line 196 of file otbRemoteSensingRegion.h.

◆ SetRegionProjection()

template<class TType >

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

inline

Get/Set InputProjectionRef std::string

Definition at line 257 of file otbRemoteSensingRegion.h.

Referenced by otb::VectorDataIntoImageProjectionFilter< TInputVectorData, TInputImage >::GenerateData().

◆ SetSize() [1/2]

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 164 of file otbRemoteSensingRegion.h.

Referenced by otb::VectorDataExtractROI< TVectorData >::ComputeVertexListBoundingRegion(), and otb::VectorDataIntoImageProjectionFilter< TInputVectorData, TInputImage >::GenerateData().

◆ SetSize() [2/2]

template<class TType >

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

inline

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

Definition at line 192 of file otbRemoteSensingRegion.h.

Member Data Documentation

◆ m_ImageMetadata

template<class TType >

ImageMetadata otb::RemoteSensingRegion< TType >::m_ImageMetadata

private

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

Definition at line 333 of file otbRemoteSensingRegion.h.

◆ m_Index

template<class TType >

IndexType otb::RemoteSensingRegion< TType >::m_Index

private

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

Definition at line 329 of file otbRemoteSensingRegion.h.

Referenced by otb::RemoteSensingRegion< typename VertexType::CoordRepType >::operator!=(), and otb::RemoteSensingRegion< typename VertexType::CoordRepType >::operator==().

◆ m_InputProjectionRef

template<class TType >

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

private

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

Definition at line 332 of file otbRemoteSensingRegion.h.

◆ m_Size

template<class TType >

SizeType otb::RemoteSensingRegion< TType >::m_Size

private

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

Definition at line 330 of file otbRemoteSensingRegion.h.

Referenced by otb::RemoteSensingRegion< typename VertexType::CoordRepType >::operator!=(), and otb::RemoteSensingRegion< typename VertexType::CoordRepType >::operator==().

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

otbRemoteSensingRegion.h

Public Types

Public Member Functions

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ ImageRegionType

◆ IndexType

◆ Pointer

◆ PointType

◆ Self

◆ SizeType

◆ Superclass

◆ Type

Constructor & Destructor Documentation

◆ RemoteSensingRegion() [1/2]

◆ RemoteSensingRegion() [2/2]

Member Function Documentation

◆ Crop()

◆ GetImageMetadata()

◆ GetImageRegion()

◆ GetIndex()

◆ GetNameOfClass()

◆ GetOrigin() [1/2]

◆ GetOrigin() [2/2]

◆ GetRegionProjection()

◆ GetRegionType()

◆ GetSize() [1/2]

◆ GetSize() [2/2]

◆ IsInside()

◆ operator!=()

◆ operator==()

◆ PrintSelf()

◆ SetImageMetadata()

◆ SetIndex()

◆ SetOrigin() [1/3]

◆ SetOrigin() [2/3]

◆ SetOrigin() [3/3]

◆ SetRegionProjection()

◆ SetSize() [1/2]

◆ SetSize() [2/2]

Member Data Documentation

◆ m_ImageMetadata

◆ m_Index

◆ m_InputProjectionRef

◆ m_Size

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