OTB  7.2.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::ImageRegionAdaptativeSplitter< VImageDimension > Class Template Reference

#include <otbImageRegionAdaptativeSplitter.h>

+ Inheritance diagram for otb::ImageRegionAdaptativeSplitter< VImageDimension >:
+ Collaboration diagram for otb::ImageRegionAdaptativeSplitter< VImageDimension >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::Index< VImageDimension > IndexType
 
typedef IndexType::IndexValueType IndexValueType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::ImageRegion< VImageDimension > RegionType
 
typedef ImageRegionAdaptativeSplitter Self
 
typedef itk::Size< VImageDimension > SizeType
 
typedef SizeType::SizeValueType SizeValueType
 
typedef std::vector< RegionTypeStreamVectorType
 
typedef itk::ImageRegionSplitter< VImageDimension > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const RegionTypeGetImageRegion () const
 
virtual const char * GetNameOfClass () const
 
unsigned int GetNumberOfSplits (const RegionType &region, unsigned int requestedNumber) override
 
virtual const unsigned int & GetRequestedNumberOfSplits () const
 
RegionType GetSplit (unsigned int i, unsigned int numberOfPieces, const RegionType &region) override
 
virtual const SizeTypeGetTileHint () const
 
void Modified () const override
 
virtual void SetImageRegion (RegionType _arg)
 
virtual void SetRequestedNumberOfSplits (unsigned int _arg)
 
virtual void SetTileHint (SizeType _arg)
 

Static Public Member Functions

static unsigned int GetImageDimension ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = VImageDimension
 

Protected Member Functions

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

Private Member Functions

void EstimateSplitMap ()
 
 ImageRegionAdaptativeSplitter (const ImageRegionAdaptativeSplitter &)=delete
 
void operator= (const ImageRegionAdaptativeSplitter &)=delete
 

Private Attributes

RegionType m_ImageRegion
 
bool m_IsUpToDate
 
itk::SimpleFastMutexLock m_Lock
 
unsigned int m_RequestedNumberOfSplits
 
StreamVectorType m_StreamVector
 
SizeType m_TileHint {0,0}
 

Detailed Description

template<unsigned int VImageDimension>
class otb::ImageRegionAdaptativeSplitter< VImageDimension >

Definition at line 65 of file otbImageRegionAdaptativeSplitter.h.

Member Typedef Documentation

◆ ConstPointer

template<unsigned int VImageDimension>
typedef itk::SmartPointer<const Self> otb::ImageRegionAdaptativeSplitter< VImageDimension >::ConstPointer

Definition at line 72 of file otbImageRegionAdaptativeSplitter.h.

◆ IndexType

template<unsigned int VImageDimension>
typedef itk::Index<VImageDimension> otb::ImageRegionAdaptativeSplitter< VImageDimension >::IndexType

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

Definition at line 90 of file otbImageRegionAdaptativeSplitter.h.

◆ IndexValueType

template<unsigned int VImageDimension>
typedef IndexType::IndexValueType otb::ImageRegionAdaptativeSplitter< VImageDimension >::IndexValueType

Definition at line 91 of file otbImageRegionAdaptativeSplitter.h.

◆ Pointer

template<unsigned int VImageDimension>
typedef itk::SmartPointer<Self> otb::ImageRegionAdaptativeSplitter< VImageDimension >::Pointer

Definition at line 71 of file otbImageRegionAdaptativeSplitter.h.

◆ RegionType

template<unsigned int VImageDimension>
typedef itk::ImageRegion<VImageDimension> otb::ImageRegionAdaptativeSplitter< VImageDimension >::RegionType

Region typedef support.

Definition at line 98 of file otbImageRegionAdaptativeSplitter.h.

◆ Self

template<unsigned int VImageDimension>
typedef ImageRegionAdaptativeSplitter otb::ImageRegionAdaptativeSplitter< VImageDimension >::Self

Standard class typedefs.

Definition at line 69 of file otbImageRegionAdaptativeSplitter.h.

◆ SizeType

template<unsigned int VImageDimension>
typedef itk::Size<VImageDimension> otb::ImageRegionAdaptativeSplitter< VImageDimension >::SizeType

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

Definition at line 94 of file otbImageRegionAdaptativeSplitter.h.

◆ SizeValueType

template<unsigned int VImageDimension>
typedef SizeType::SizeValueType otb::ImageRegionAdaptativeSplitter< VImageDimension >::SizeValueType

Definition at line 95 of file otbImageRegionAdaptativeSplitter.h.

◆ StreamVectorType

template<unsigned int VImageDimension>
typedef std::vector<RegionType> otb::ImageRegionAdaptativeSplitter< VImageDimension >::StreamVectorType

Definition at line 100 of file otbImageRegionAdaptativeSplitter.h.

◆ Superclass

template<unsigned int VImageDimension>
typedef itk::ImageRegionSplitter<VImageDimension> otb::ImageRegionAdaptativeSplitter< VImageDimension >::Superclass

Definition at line 70 of file otbImageRegionAdaptativeSplitter.h.

Constructor & Destructor Documentation

◆ ImageRegionAdaptativeSplitter() [1/2]

template<unsigned int VImageDimension>
otb::ImageRegionAdaptativeSplitter< VImageDimension >::ImageRegionAdaptativeSplitter ( )
inlineprotected

Definition at line 143 of file otbImageRegionAdaptativeSplitter.h.

◆ ~ImageRegionAdaptativeSplitter()

template<unsigned int VImageDimension>
otb::ImageRegionAdaptativeSplitter< VImageDimension >::~ImageRegionAdaptativeSplitter ( )
inlineoverrideprotected

Definition at line 147 of file otbImageRegionAdaptativeSplitter.h.

◆ ImageRegionAdaptativeSplitter() [2/2]

template<unsigned int VImageDimension>
otb::ImageRegionAdaptativeSplitter< VImageDimension >::ImageRegionAdaptativeSplitter ( const ImageRegionAdaptativeSplitter< VImageDimension > &  )
privatedelete

Member Function Documentation

◆ CreateAnother()

template<unsigned int VImageDimension>
virtual::itk::LightObject::Pointer otb::ImageRegionAdaptativeSplitter< VImageDimension >::CreateAnother ( void  ) const

◆ EstimateSplitMap()

template<unsigned int VImageDimension>
void otb::ImageRegionAdaptativeSplitter< VImageDimension >::EstimateSplitMap ( )
private

◆ GetImageDimension()

template<unsigned int VImageDimension>
static unsigned int otb::ImageRegionAdaptativeSplitter< VImageDimension >::GetImageDimension ( )
inlinestatic

Dimension of the image available at run time.

Definition at line 84 of file otbImageRegionAdaptativeSplitter.h.

◆ GetImageRegion()

template<unsigned int VImageDimension>
virtual const RegionType& otb::ImageRegionAdaptativeSplitter< VImageDimension >::GetImageRegion ( ) const
virtual

Get the ImageRegion parameter

◆ GetNameOfClass()

template<unsigned int VImageDimension>
virtual const char* otb::ImageRegionAdaptativeSplitter< VImageDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ GetNumberOfSplits()

template<unsigned int VImageDimension>
unsigned int otb::ImageRegionAdaptativeSplitter< VImageDimension >::GetNumberOfSplits ( const RegionType region,
unsigned int  requestedNumber 
)
override

Calling this method will set the image region and the requested number of splits, and call the EstimateSplitMap() method if necessary.

Definition at line 35 of file otbImageRegionAdaptativeSplitter.hxx.

◆ GetRequestedNumberOfSplits()

template<unsigned int VImageDimension>
virtual const unsigned int& otb::ImageRegionAdaptativeSplitter< VImageDimension >::GetRequestedNumberOfSplits ( ) const
virtual

Get the requested number of splits parameter

◆ GetSplit()

template<unsigned int VImageDimension>
itk::ImageRegion< VImageDimension > otb::ImageRegionAdaptativeSplitter< VImageDimension >::GetSplit ( unsigned int  i,
unsigned int  numberOfPieces,
const RegionType region 
)
override

Calling this method will set the image region and the requested number of splits, and call the EstimateSplitMap() method if necessary.

Definition at line 55 of file otbImageRegionAdaptativeSplitter.hxx.

◆ GetTileHint()

template<unsigned int VImageDimension>
virtual const SizeType& otb::ImageRegionAdaptativeSplitter< VImageDimension >::GetTileHint ( ) const
virtual

Get the TileHint parameter

◆ Modified()

template<unsigned int VImageDimension>
void otb::ImageRegionAdaptativeSplitter< VImageDimension >::Modified ( ) const
inlineoverride

Make the Modified() method update the IsUpToDate flag

Definition at line 133 of file otbImageRegionAdaptativeSplitter.h.

◆ New()

template<unsigned int VImageDimension>
static Pointer otb::ImageRegionAdaptativeSplitter< VImageDimension >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<unsigned int VImageDimension>
void otb::ImageRegionAdaptativeSplitter< VImageDimension >::operator= ( const ImageRegionAdaptativeSplitter< VImageDimension > &  )
privatedelete

◆ PrintSelf()

template<unsigned int VImageDimension>
void otb::ImageRegionAdaptativeSplitter< VImageDimension >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Definition at line 252 of file otbImageRegionAdaptativeSplitter.hxx.

◆ SetImageRegion()

template<unsigned int VImageDimension>
virtual void otb::ImageRegionAdaptativeSplitter< VImageDimension >::SetImageRegion ( RegionType  _arg)
virtual

Set the ImageRegion parameter

◆ SetRequestedNumberOfSplits()

template<unsigned int VImageDimension>
virtual void otb::ImageRegionAdaptativeSplitter< VImageDimension >::SetRequestedNumberOfSplits ( unsigned int  _arg)
virtual

Set the requested number of splits parameter

◆ SetTileHint()

template<unsigned int VImageDimension>
virtual void otb::ImageRegionAdaptativeSplitter< VImageDimension >::SetTileHint ( SizeType  _arg)
virtual

Member Data Documentation

◆ ImageDimension

template<unsigned int VImageDimension>
const unsigned int otb::ImageRegionAdaptativeSplitter< VImageDimension >::ImageDimension = VImageDimension
static

Dimension of the image available at compile time.

Definition at line 81 of file otbImageRegionAdaptativeSplitter.h.

◆ m_ImageRegion

template<unsigned int VImageDimension>
RegionType otb::ImageRegionAdaptativeSplitter< VImageDimension >::m_ImageRegion
private

Definition at line 164 of file otbImageRegionAdaptativeSplitter.h.

◆ m_IsUpToDate

template<unsigned int VImageDimension>
bool otb::ImageRegionAdaptativeSplitter< VImageDimension >::m_IsUpToDate
mutableprivate

Definition at line 173 of file otbImageRegionAdaptativeSplitter.h.

◆ m_Lock

template<unsigned int VImageDimension>
itk::SimpleFastMutexLock otb::ImageRegionAdaptativeSplitter< VImageDimension >::m_Lock
private

Definition at line 176 of file otbImageRegionAdaptativeSplitter.h.

◆ m_RequestedNumberOfSplits

template<unsigned int VImageDimension>
unsigned int otb::ImageRegionAdaptativeSplitter< VImageDimension >::m_RequestedNumberOfSplits
private

Definition at line 167 of file otbImageRegionAdaptativeSplitter.h.

◆ m_StreamVector

template<unsigned int VImageDimension>
StreamVectorType otb::ImageRegionAdaptativeSplitter< VImageDimension >::m_StreamVector
private

Definition at line 170 of file otbImageRegionAdaptativeSplitter.h.

◆ m_TileHint

template<unsigned int VImageDimension>
SizeType otb::ImageRegionAdaptativeSplitter< VImageDimension >::m_TileHint {0,0}
private

Definition at line 161 of file otbImageRegionAdaptativeSplitter.h.


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