OTB  6.3.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
otb::ImageList< TImage > Class Template Reference

#include <otbImageList.h>

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

Public Types

typedef Superclass::ConstIterator ConstIterator
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
Superclass::ObjectPointerType 
ImagePointerType
 
typedef TImage ImageType
 
typedef Superclass::Iterator Iterator
 
typedef itk::SmartPointer< SelfPointer
 
typedef
Superclass::ReverseConstIterator 
ReverseConstIterator
 
typedef Superclass::ReverseIterator ReverseIterator
 
typedef ImageList Self
 
typedef ObjectList< TImage > Superclass
 
- Public Types inherited from otb::ObjectList< TImage >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
InternalContainerType::size_type 
InternalContainerSizeType
 
typedef std::vector
< ObjectPointerType
InternalContainerType
 
typedef itk::SmartPointer
< ObjectType
ObjectPointerType
 
typedef TImage ObjectType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ObjectList Self
 
typedef itk::DataObject Superclass
 
- Public Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

 itkNewMacro (Self)
 
 itkTypeMacro (ImageList, ObjectList)
 
void UpdateOutputInformation (void) ITK_OVERRIDE
 
void PropagateRequestedRegion (void) ITK_OVERRIDE throw (itk::InvalidRequestedRegionError)
 
void UpdateOutputData (void) ITK_OVERRIDE
 
- Public Member Functions inherited from otb::ObjectList< TImage >
ObjectPointerType Back (void)
 
Iterator Begin (void)
 
ConstIterator Begin (void) const
 
InternalContainerSizeType Capacity (void) const
 
void Clear (void)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
Iterator End (void)
 
ConstIterator End (void) const
 
void Erase (unsigned int index)
 
void Erase (Iterator begin, Iterator end)
 
void Erase (Iterator loc)
 
ObjectPointerType Front (void)
 
virtual const char * GetNameOfClass () const
 
ObjectPointerType GetNthElement (unsigned int index) const
 
Iterator Insert (Iterator position, ObjectPointerType element)
 
ReverseIterator Insert (ReverseIterator position, ObjectPointerType element)
 
void PopBack (void)
 
void PushBack (ObjectType *element)
 
void Reserve (InternalContainerSizeType size)
 
void Resize (InternalContainerSizeType size)
 
ReverseIterator ReverseBegin (void)
 
ReverseConstIterator ReverseBegin (void) const
 
ReverseIterator ReverseEnd (void)
 
ReverseConstIterator ReverseEnd (void) const
 
void SetNthElement (unsigned int index, ObjectPointerType element)
 
void SetNthElement (unsigned int index, const ObjectType *element)
 
InternalContainerSizeType Size (void) const
 
- Public Member Functions inherited from itk::DataObject
virtual void CopyInformation (const DataObject *)
 
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual const RealTimeStampGetRealTimeStamp () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void Graft (const DataObject *)
 
virtual void Initialize ()
 
virtual void PrepareForNewData ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
 
virtual void ResetPipeline ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
void SetReleaseDataFlag (bool flag)
 
virtual void SetRequestedRegion (const DataObject *)
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
virtual bool VerifyRequestedRegion ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 ImageList ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const ITK_OVERRIDE
 
 ~ImageList () ITK_OVERRIDE
 
- Protected Member Functions inherited from otb::ObjectList< TImage >
 ObjectList ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const ITK_OVERRIDE
 
 ~ObjectList () ITK_OVERRIDE
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

 ImageList (const Self &)
 
void operator= (const Self &)
 

Additional Inherited Members

- Static Public Member Functions inherited from otb::ObjectList< TImage >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

template<class TImage>
class otb::ImageList< TImage >

This class represent a list of images.

It is derived from the otbObjectList class, which allows manipulating an ITK/OTB object list with the appropriate formalism (iterators, accessors).

See Also
ObjectList

Definition at line 39 of file otbImageList.h.

Member Typedef Documentation

template<class TImage >
typedef Superclass::ConstIterator otb::ImageList< TImage >::ConstIterator

Definition at line 59 of file otbImageList.h.

template<class TImage >
typedef itk::SmartPointer<const Self> otb::ImageList< TImage >::ConstPointer

Definition at line 47 of file otbImageList.h.

template<class TImage >
typedef Superclass::ObjectPointerType otb::ImageList< TImage >::ImagePointerType

Definition at line 57 of file otbImageList.h.

template<class TImage >
typedef TImage otb::ImageList< TImage >::ImageType

Template parameter typedefs

Definition at line 56 of file otbImageList.h.

template<class TImage >
typedef Superclass::Iterator otb::ImageList< TImage >::Iterator

Definition at line 58 of file otbImageList.h.

template<class TImage >
typedef itk::SmartPointer<Self> otb::ImageList< TImage >::Pointer

Definition at line 46 of file otbImageList.h.

template<class TImage >
typedef Superclass::ReverseConstIterator otb::ImageList< TImage >::ReverseConstIterator

Definition at line 61 of file otbImageList.h.

template<class TImage >
typedef Superclass::ReverseIterator otb::ImageList< TImage >::ReverseIterator

Definition at line 60 of file otbImageList.h.

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

Standard typedefs

Definition at line 44 of file otbImageList.h.

template<class TImage >
typedef ObjectList<TImage> otb::ImageList< TImage >::Superclass

Definition at line 45 of file otbImageList.h.

Constructor & Destructor Documentation

template<class TImage >
otb::ImageList< TImage >::ImageList ( )
inlineprotected

Constructor

Definition at line 74 of file otbImageList.h.

template<class TImage >
otb::ImageList< TImage >::~ImageList ( )
inlineprotected

Destructor

Definition at line 77 of file otbImageList.h.

template<class TImage >
otb::ImageList< TImage >::ImageList ( const Self )
private

Member Function Documentation

template<class TImage >
otb::ImageList< TImage >::itkNewMacro ( Self  )

Creation through object factory macro

template<class TImage >
otb::ImageList< TImage >::itkTypeMacro ( ImageList< TImage >  ,
ObjectList   
)

Type macro

template<class TImage >
void otb::ImageList< TImage >::operator= ( const Self )
private
template<class TImage >
void otb::ImageList< TImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
inlineprotectedvirtual

PrintSelf method

Reimplemented from itk::DataObject.

Definition at line 80 of file otbImageList.h.

template<class TImage >
void otb::ImageList< TImage >::PropagateRequestedRegion ( void  )
throw (itk::InvalidRequestedRegionError
)
virtual

Update images in the list.

Reimplemented from itk::DataObject.

Definition at line 67 of file otbImageList.txx.

template<class TImage >
void otb::ImageList< TImage >::UpdateOutputData ( void  )
virtual

Update images in the list.

Reimplemented from itk::DataObject.

Definition at line 33 of file otbImageList.txx.

References itk::DataObjectError::SetDataObject(), itk::ExceptionObject::SetDescription(), and itk::ExceptionObject::SetLocation().

template<class TImage >
void otb::ImageList< TImage >::UpdateOutputInformation ( void  )
virtual

Update images in the list.

Reimplemented from itk::DataObject.

Definition at line 75 of file otbImageList.txx.


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