OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Attributes | List of all members
otb::SubsampledImageRegionIterator< TImage > Class Template Reference

#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 Member Functions

virtual const char * GetNameOfClass () const
 
void Set (const PixelType &value) const
 
 SubsampledImageRegionIterator ()
 
 SubsampledImageRegionIterator (const ImageType *ptr, const RegionType &region)
 
 SubsampledImageRegionIterator (const itk::ImageConstIterator< TImage > &it)
 
 SubsampledImageRegionIterator (const itk::ImageIterator< TImage > &it)
 
PixelTypeValue (void)
 
- Public Member Functions inherited from otb::SubsampledImageRegionConstIterator< TImage >
IndexType GetIndex () const
 
const IndexTypeGetSubsampleFactor () const
 
void GoToBegin ()
 
void GoToEnd ()
 
bool IsAtBegin (void) const
 
bool IsAtEnd (void) const
 
void SetIndex (const IndexType &ind) override
 
void SetSubsampleFactor (const IndexType &factor)
 
void SetSubsampleFactor (IndexValueType factor)
 
 SubsampledImageRegionConstIterator ()
 
 SubsampledImageRegionConstIterator (const ImageType *ptr, const RegionType &region)
 
 SubsampledImageRegionConstIterator (const itk::ImageConstIterator< TImage > &it)
 
 SubsampledImageRegionConstIterator (const itk::ImageIterator< TImage > &it)
 
Selfoperator++ ()
 
Selfoperator-- ()
 
void SetOffset (const OffsetType &offset)
 
OffsetType GetOffset () const
 
RegionType GenerateOutputInformation () 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
 

Additional Inherited Members

- Protected Attributes inherited from otb::SubsampledImageRegionConstIterator< TImage >
IndexType m_SubsampleFactor
 
unsigned long m_SubSampledBeginOffset
 
long m_SubSampledEndOffset
 
IndexType m_FirstUsableIndex
 
IndexType m_LastUsableIndex
 

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 46 of file otbSubsampledImageRegionIterator.h.

Member Typedef Documentation

◆ AccessorType

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

Definition at line 68 of file otbSubsampledImageRegionIterator.h.

◆ ImageType

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

Definition at line 63 of file otbSubsampledImageRegionIterator.h.

◆ IndexType

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

Definition at line 59 of file otbSubsampledImageRegionIterator.h.

◆ IndexValueType

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

Definition at line 69 of file otbSubsampledImageRegionIterator.h.

◆ InternalPixelType

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

Definition at line 66 of file otbSubsampledImageRegionIterator.h.

◆ OffsetType

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

Definition at line 62 of file otbSubsampledImageRegionIterator.h.

◆ PixelContainer

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

Definition at line 64 of file otbSubsampledImageRegionIterator.h.

◆ PixelContainerPointer

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

Definition at line 65 of file otbSubsampledImageRegionIterator.h.

◆ PixelType

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

Definition at line 67 of file otbSubsampledImageRegionIterator.h.

◆ RegionType

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

Definition at line 61 of file otbSubsampledImageRegionIterator.h.

◆ Self

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

Standard typedef.

Definition at line 50 of file otbSubsampledImageRegionIterator.h.

◆ SizeType

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

Definition at line 60 of file otbSubsampledImageRegionIterator.h.

◆ Superclass

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

Definition at line 51 of file otbSubsampledImageRegionIterator.h.

Constructor & Destructor Documentation

◆ SubsampledImageRegionIterator() [1/4]

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

Definition at line 72 of file otbSubsampledImageRegionIterator.h.

◆ SubsampledImageRegionIterator() [2/4]

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

Definition at line 76 of file otbSubsampledImageRegionIterator.h.

◆ SubsampledImageRegionIterator() [3/4]

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

Definition at line 80 of file otbSubsampledImageRegionIterator.h.

◆ SubsampledImageRegionIterator() [4/4]

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

Definition at line 84 of file otbSubsampledImageRegionIterator.h.

Member Function Documentation

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from otb::SubsampledImageRegionConstIterator< TImage >.

◆ Set()

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

◆ Value()

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

Definition at line 94 of file otbSubsampledImageRegionIterator.h.

Member Data Documentation

◆ ImageIteratorDimension

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

Definition at line 56 of file otbSubsampledImageRegionIterator.h.


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