Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Attributes | List of all members
otb::SubsampledImageRegionIterator< TImage > Class Template Reference

Regular subsample iterator over an image. More...

#include <otbSubsampledImageRegionIterator.h>

+ Inheritance diagram for otb::SubsampledImageRegionIterator< TImage >:
+ Collaboration diagram for otb::SubsampledImageRegionIterator< TImage >:

Public Types

typedef Superclass::AccessorType AccessorType
 
typedef Superclass::ImageType ImageType
 
typedef Superclass::IndexType IndexType
 
typedef Superclass::IndexValueType IndexValueType
 
typedef
Superclass::InternalPixelType 
InternalPixelType
 
typedef Superclass::OffsetType OffsetType
 
typedef Superclass::PixelContainer PixelContainer
 
typedef
Superclass::PixelContainerPointer 
PixelContainerPointer
 
typedef Superclass::PixelType PixelType
 
typedef Superclass::RegionType RegionType
 
typedef
SubsampledImageRegionIterator 
Self
 
typedef Superclass::SizeType SizeType
 
typedef
SubsampledImageRegionConstIterator
< TImage > 
Superclass
 
- Public Types inherited from otb::SubsampledImageRegionConstIterator< TImage >
typedef Superclass::AccessorType AccessorType
 
typedef Superclass::ImageType ImageType
 
typedef Superclass::IndexType IndexType
 
typedef IndexType::IndexValueType IndexValueType
 
typedef
Superclass::InternalPixelType 
InternalPixelType
 
typedef unsigned long OffsetType
 
typedef Superclass::PixelContainer PixelContainer
 
typedef
Superclass::PixelContainerPointer 
PixelContainerPointer
 
typedef Superclass::PixelType PixelType
 
typedef Superclass::RegionType RegionType
 
typedef
SubsampledImageRegionConstIterator 
Self
 
typedef Superclass::SizeType SizeType
 
typedef
itk::ImageRegionConstIterator
< TImage > 
Superclass
 
- Public Types inherited from itk::ImageRegionConstIterator< TImage >
typedef Superclass::AccessorType AccessorType
 
typedef Superclass::ImageType ImageType
 
typedef Superclass::IndexType IndexType
 
typedef
Superclass::InternalPixelType 
InternalPixelType
 
typedef Superclass::OffsetType OffsetType
 
typedef Superclass::PixelContainer PixelContainer
 
typedef
Superclass::PixelContainerPointer 
PixelContainerPointer
 
typedef Superclass::PixelType PixelType
 
typedef Superclass::RegionType RegionType
 
typedef ImageRegionConstIterator Self
 
typedef Superclass::SizeType SizeType
 
typedef ImageConstIterator
< TImage > 
Superclass
 
- Public Types inherited from itk::ImageConstIterator< TImage >
typedef TImage::AccessorFunctorType AccessorFunctorType
 
typedef TImage::AccessorType AccessorType
 
typedef TImage ImageType
 
typedef TImage::IndexType IndexType
 
typedef TImage::InternalPixelType InternalPixelType
 
typedef TImage::OffsetType OffsetType
 
typedef TImage::PixelContainer PixelContainer
 
typedef PixelContainer::Pointer PixelContainerPointer
 
typedef TImage::PixelType PixelType
 
typedef TImage::RegionType RegionType
 
typedef ImageConstIterator Self
 
typedef TImage::SizeType SizeType
 

Public Member Functions

 SubsampledImageRegionIterator ()
 
 SubsampledImageRegionIterator (const ImageType *ptr, const RegionType &region)
 
 SubsampledImageRegionIterator (const itk::ImageIterator< TImage > &it)
 
 SubsampledImageRegionIterator (const itk::ImageConstIterator< TImage > &it)
 
virtual const char * GetNameOfClass () const
 
void Set (const PixelType &value) const
 
PixelTypeValue (void)
 
- Public Member Functions inherited from otb::SubsampledImageRegionConstIterator< TImage >
 SubsampledImageRegionConstIterator ()
 
 SubsampledImageRegionConstIterator (const ImageType *ptr, const RegionType &region)
 
 SubsampledImageRegionConstIterator (const itk::ImageIterator< TImage > &it)
 
 SubsampledImageRegionConstIterator (const itk::ImageConstIterator< TImage > &it)
 
RegionType GenerateOutputInformation () const
 
IndexType GetIndex () const
 
OffsetType GetOffset () const
 
const IndexTypeGetSubsampleFactor () const
 
void GoToBegin ()
 
void GoToEnd ()
 
bool IsAtBegin (void) const
 
bool IsAtEnd (void) const
 
Selfoperator++ ()
 
Selfoperator-- ()
 
void SetIndex (const IndexType &ind)
 
void SetOffset (const OffsetType &offset)
 
void SetSubsampleFactor (IndexValueType factor)
 
void SetSubsampleFactor (const IndexType &factor)
 
- Public Member Functions inherited from itk::ImageRegionConstIterator< TImage >
 ImageRegionConstIterator ()
 
 ImageRegionConstIterator (const ImageIterator< TImage > &it)
 
 ImageRegionConstIterator (const ImageType *ptr, const RegionType &region)
 
 ImageRegionConstIterator (const ImageConstIterator< TImage > &it)
 
void GoToBegin ()
 
void GoToEnd ()
 
 itkLegacyMacro (Self End(void) const)
 
 itkLegacyMacro (Self Begin(void) const)
 
Selfoperator++ ()
 
Selfoperator-- ()
 
- Public Member Functions inherited from itk::ImageConstIterator< TImage >
 ImageConstIterator (const Self &it)
 
 ImageConstIterator (const ImageType *ptr, const RegionType &region)
 
 ImageConstIterator ()
 
virtual ~ImageConstIterator ()
 
PixelType Get (void) const
 
const ImageTypeGetImage () const
 
const IndexType GetIndex () const
 
const RegionTypeGetRegion () const
 
void GoToBegin ()
 
void GoToEnd ()
 
bool IsAtBegin (void) const
 
bool IsAtEnd (void) const
 
 itkLegacyMacro (Self Begin(void) const)
 
 itkLegacyMacro (Self End(void) const)
 
bool operator!= (const Self &it) const
 
bool operator< (const Self &it) const
 
bool operator<= (const Self &it) const
 
Selfoperator= (const Self &it)
 
bool operator== (const Self &it) const
 
bool operator> (const Self &it) const
 
bool operator>= (const Self &it) const
 
virtual void SetRegion (const RegionType &region)
 
const PixelTypeValue (void) const
 

Static Public Attributes

static const unsigned int ImageIteratorDimension = Superclass::ImageIteratorDimension
 
- Static Public Attributes inherited from otb::SubsampledImageRegionConstIterator< TImage >
static const unsigned int ImageIteratorDimension = Superclass::ImageIteratorDimension
 
- Static Public Attributes inherited from itk::ImageRegionConstIterator< TImage >
static const unsigned int ImageIteratorDimension
 
- Static Public Attributes inherited from itk::ImageConstIterator< TImage >
static const unsigned int ImageIteratorDimension
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageConstIterator< TImage >
static unsigned int GetImageIteratorDimension ()
 
- Protected Attributes inherited from otb::SubsampledImageRegionConstIterator< TImage >
IndexType m_FirstUsableIndex
 
IndexType m_LastUsableIndex
 
unsigned long m_SubSampledBeginOffset
 
long m_SubSampledEndOffset
 
IndexType m_SubsampleFactor
 
- Protected Attributes inherited from itk::ImageRegionConstIterator< TImage >
OffsetValueType m_SpanBeginOffset
 
OffsetValueType m_SpanEndOffset
 
- Protected Attributes inherited from itk::ImageConstIterator< TImage >
OffsetValueType m_BeginOffset
 
const InternalPixelTypem_Buffer
 
OffsetValueType m_EndOffset
 
TImage::ConstWeakPointer m_Image
 
OffsetValueType m_Offset
 
AccessorType m_PixelAccessor
 
AccessorFunctorType m_PixelAccessorFunctor
 
RegionType m_Region
 

Detailed Description

template<class TImage>
class otb::SubsampledImageRegionIterator< TImage >

Regular subsample iterator over an image.

This iterator is a itk::ImageRegionConstIterator that perform a subsampled scan over an image. It runs one pixel over X (in row, line, slice... dimensions), if X is the (integer) value of the SubsampleFactor.

It inherits from SubsampledImageRegionConstIterator and can modify the pixel values...

See Also
SubsampledImageRegionConstIterator

Definition at line 41 of file otbSubsampledImageRegionIterator.h.

Member Typedef Documentation

Definition at line 65 of file otbSubsampledImageRegionIterator.h.

template<class TImage>
typedef Superclass::ImageType otb::SubsampledImageRegionIterator< TImage >::ImageType

Definition at line 60 of file otbSubsampledImageRegionIterator.h.

template<class TImage>
typedef Superclass::IndexType otb::SubsampledImageRegionIterator< TImage >::IndexType

Definition at line 56 of file otbSubsampledImageRegionIterator.h.

template<class TImage>
typedef Superclass::IndexValueType otb::SubsampledImageRegionIterator< TImage >::IndexValueType

Definition at line 66 of file otbSubsampledImageRegionIterator.h.

Definition at line 63 of file otbSubsampledImageRegionIterator.h.

template<class TImage>
typedef Superclass::OffsetType otb::SubsampledImageRegionIterator< TImage >::OffsetType

Definition at line 59 of file otbSubsampledImageRegionIterator.h.

Definition at line 61 of file otbSubsampledImageRegionIterator.h.

Definition at line 62 of file otbSubsampledImageRegionIterator.h.

template<class TImage>
typedef Superclass::PixelType otb::SubsampledImageRegionIterator< TImage >::PixelType

Definition at line 64 of file otbSubsampledImageRegionIterator.h.

template<class TImage>
typedef Superclass::RegionType otb::SubsampledImageRegionIterator< TImage >::RegionType

Definition at line 58 of file otbSubsampledImageRegionIterator.h.

template<class TImage>
typedef SubsampledImageRegionIterator otb::SubsampledImageRegionIterator< TImage >::Self

Standard typedef.

Definition at line 46 of file otbSubsampledImageRegionIterator.h.

template<class TImage>
typedef Superclass::SizeType otb::SubsampledImageRegionIterator< TImage >::SizeType

Definition at line 57 of file otbSubsampledImageRegionIterator.h.

template<class TImage>
typedef SubsampledImageRegionConstIterator<TImage> otb::SubsampledImageRegionIterator< TImage >::Superclass

Definition at line 47 of file otbSubsampledImageRegionIterator.h.

Constructor & Destructor Documentation

template<class TImage>
otb::SubsampledImageRegionIterator< TImage >::SubsampledImageRegionIterator ( )
inline

Definition at line 69 of file otbSubsampledImageRegionIterator.h.

template<class TImage>
otb::SubsampledImageRegionIterator< TImage >::SubsampledImageRegionIterator ( const ImageType ptr,
const RegionType region 
)
inline

Definition at line 72 of file otbSubsampledImageRegionIterator.h.

template<class TImage>
otb::SubsampledImageRegionIterator< TImage >::SubsampledImageRegionIterator ( const itk::ImageIterator< TImage > &  it)
inline

Definition at line 75 of file otbSubsampledImageRegionIterator.h.

template<class TImage>
otb::SubsampledImageRegionIterator< TImage >::SubsampledImageRegionIterator ( const itk::ImageConstIterator< TImage > &  it)
inline

Definition at line 78 of file otbSubsampledImageRegionIterator.h.

Member Function Documentation

template<class TImage>
virtual const char* otb::SubsampledImageRegionIterator< TImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from otb::SubsampledImageRegionConstIterator< TImage >.

template<class TImage>
void otb::SubsampledImageRegionIterator< TImage >::Set ( const PixelType value) const
inline
template<class TImage>
PixelType& otb::SubsampledImageRegionIterator< TImage >::Value ( void  )
inline

Definition at line 88 of file otbSubsampledImageRegionIterator.h.

Member Data Documentation

template<class TImage>
const unsigned int otb::SubsampledImageRegionIterator< TImage >::ImageIteratorDimension = Superclass::ImageIteratorDimension
static

Definition at line 53 of file otbSubsampledImageRegionIterator.h.


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