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

Reader class dedicated to image series reading. More...

#include <otbImageSeriesFileReader.h>

+ Inheritance diagram for otb::ImageSeriesFileReader< TImage, TInternalImage >:
+ Collaboration diagram for otb::ImageSeriesFileReader< TImage, TInternalImage >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
ExtractSelectionListType::Pointer 
ExtractSelectionListPointerType
 
typedef ObjectList
< ExtractSelectionType
ExtractSelectionListType
 
typedef
ExtractSelectionType::Pointer 
ExtractSelectionPointerType
 
typedef
itk::ImageToImageFilter
< InternalImageType,
OutputImageType
ExtractSelectionType
 
typedef Superclass::IndexType IndexType
 
typedef
Superclass::InternalImagePointerType 
InternalImagePointerType
 
typedef
Superclass::InternalImageType 
InternalImageType
 
typedef
Superclass::InternalIndexType 
InternalIndexType
 
typedef
Superclass::InternalPixelType 
InternalPixelType
 
typedef
Superclass::InternalRegionType 
InternalRegionType
 
typedef
Superclass::InternalSizeType 
InternalSizeType
 
typedef
Superclass::InternalValueType 
InternalValueType
 
typedef
Superclass::OutputImageListConstPointerType 
OutputImageListConstPointerType
 
typedef
Superclass::OutputImageListPointerType 
OutputImageListPointerType
 
typedef
Superclass::OutputImageListType 
OutputImageListType
 
typedef
Superclass::OutputImagePointerType 
OutputImagePointerType
 
typedef Superclass::OutputImageType OutputImageType
 
typedef Superclass::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef
Superclass::ReaderListPointerType 
ReaderListPointerType
 
typedef Superclass::ReaderListType ReaderListType
 
typedef Superclass::ReaderType ReaderPointerType
 
typedef Superclass::ReaderType ReaderType
 
typedef Superclass::RegionType RegionType
 
typedef ImageSeriesFileReader Self
 
typedef Superclass::SizeType SizeType
 
typedef
ImageSeriesFileReaderBase
< TImage, TInternalImage > 
Superclass
 
typedef Superclass::ValueType ValueType
 
- Public Types inherited from otb::ImageSeriesFileReaderBase< TImage, TInternalImage >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef OutputImageType::IndexType IndexType
 
typedef InternalImageType::Pointer InternalImagePointerType
 
typedef TInternalImage InternalImageType
 
typedef
InternalImageType::IndexType 
InternalIndexType
 
typedef
InternalImageType::InternalPixelType 
InternalPixelType
 
typedef
InternalImageType::RegionType 
InternalRegionType
 
typedef InternalImageType::SizeType InternalSizeType
 
typedef
InternalImageType::ValueType 
InternalValueType
 
typedef
OutputImageListType::ConstPointer 
OutputImageListConstPointerType
 
typedef
OutputImageListType::Pointer 
OutputImageListPointerType
 
typedef ImageList
< OutputImageType
OutputImageListType
 
typedef OutputImageType::Pointer OutputImagePointerType
 
typedef TImage OutputImageType
 
typedef
OutputImageType::InternalPixelType 
PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ReaderListType::Pointer ReaderListPointerType
 
typedef ObjectList< ReaderTypeReaderListType
 
typedef ReaderType::Pointer ReaderPointerType
 
typedef ImageFileReader
< InternalImageType
ReaderType
 
typedef OutputImageType::RegionType RegionType
 
typedef ImageSeriesFileReaderBase Self
 
typedef OutputImageType::SizeType SizeType
 
typedef ImageListSource< TImage > Superclass
 
typedef OutputImageType::ValueType ValueType
 
- Public Types inherited from otb::ImageListSource< TImage >
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef
OutputImageListType::ConstPointer 
OutputImageListConstPointerType
 
typedef
OutputImageListType::Pointer 
OutputImageListPointerType
 
typedef ImageList
< OutputImageType
OutputImageListType
 
typedef OutputImageType::Pointer OutputImagePointerType
 
typedef TImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ImageListSource Self
 
typedef itk::ProcessObject Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from otb::ImageSeriesFileReaderBase< TImage, TInternalImage >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual OutputImageListTypeGenerateOutput (void)
 
virtual OutputImageTypeGenerateOutput (unsigned int idx)
 
virtual const char * GetFileName () const
 
std::string GetFileName (unsigned int i) const
 
ReaderTypeGetImageFileReader (unsigned int i) const
 
virtual ReaderListTypeGetImageFileReaderList ()
 
virtual unsigned int GetNumberOfOutputs () const
 
virtual OutputImageListTypeGetOutput (void)
 
virtual OutputImageTypeGetOutput (unsigned int idx)
 
virtual void SetFileName (const std::string &file)
 
virtual void SetFileName (const char *file)
 
void Update ()
 
- Public Member Functions inherited from otb::ImageListSource< TImage >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::ImageSeriesFileReaderBase< TImage, TInternalImage >
static Pointer New ()
 
- Static Public Member Functions inherited from otb::ImageListSource< TImage >
static Pointer New ()
 

Protected Member Functions

 ImageSeriesFileReader ()
 
virtual ~ImageSeriesFileReader ()
 
virtual void AllocateListOfComponents (void)
 
virtual void GenerateData (unsigned int idx)
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
virtual void TestBandSelection (std::vector< unsigned int > &bands)
 
- Protected Member Functions inherited from otb::ImageSeriesFileReaderBase< TImage, TInternalImage >
 ImageSeriesFileReaderBase ()
 
virtual ~ImageSeriesFileReaderBase ()
 
virtual void GenerateData (void)
 
virtual void ReadMetaFile ()
 
virtual void TestFileExistanceAndReadability (std::string &file, FileType fileType)
 
- Protected Member Functions inherited from otb::ImageListSource< TImage >
 ImageListSource ()
 
virtual ~ImageListSource ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 

Protected Attributes

ExtractSelectionListPointerType m_ExtractorList
 
- Protected Attributes inherited from otb::ImageSeriesFileReaderBase< TImage, TInternalImage >
std::string m_FileName
 
ReaderListPointerType m_ImageFileReaderList
 
std::vector< std::vector
< unsigned int > > 
m_ListOfBandSelection
 
std::vector< std::string > m_ListOfFileNames
 
std::vector< InternalRegionTypem_ListOfRegionSelection
 
OutputImageListPointerType m_OutputList
 

Private Member Functions

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

Additional Inherited Members

- Protected Types inherited from otb::ImageSeriesFileReaderBase< TImage, TInternalImage >
enum  FileType {
  kFileName = 0,
  kImageFileName,
  kAnyFileName
}
 

Detailed Description

template<class TImage, class TInternalImage = TImage>
class otb::ImageSeriesFileReader< TImage, TInternalImage >

Reader class dedicated to image series reading.

Specific definition for VectorImage in reading and output.

Specific definition for VectorImage in reading and Image type for output.

Specific definition for template Images.

Actually, this class is mostly dedicated to read ENVI META FILE. Specializations of the template are given relatively to the king of image (or vector image) used in input and/or output.

See Also
ImageFileReader

In the case where TImage and TInternalImage stand for otb::Image, the TExtractSelection must be of type ExtractROI.

GenerateData and TestBandSelection methods are specialised.

See Also
ImageSeriesFileReader

In the case where TImage stands for an otb::Image while TInternalImage stands for otb::VectorImage, the TExtractSelection must be of type MultiToMonoChannelExtractROI.

GenerateData and TestBandSelection methods are specialised.

See Also
ImageSeriesFileReader

In the case where TImage stands for an otb::VectorImage as well as TInternalImage, the TExtractSelection must be of type MultiChannelExtractROI.

GenerateData method is specialised.

See Also
ImageSeriesFileReader

Definition at line 48 of file otbImageSeriesFileReader.h.

Member Typedef Documentation

template<class TImage , class TInternalImage = TImage>
typedef itk::SmartPointer<const Self> otb::ImageSeriesFileReader< TImage, TInternalImage >::ConstPointer

Definition at line 56 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef ExtractSelectionListType::Pointer otb::ImageSeriesFileReader< TImage, TInternalImage >::ExtractSelectionListPointerType

Definition at line 102 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef ObjectList<ExtractSelectionType> otb::ImageSeriesFileReader< TImage, TInternalImage >::ExtractSelectionListType

Definition at line 101 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef ExtractSelectionType::Pointer otb::ImageSeriesFileReader< TImage, TInternalImage >::ExtractSelectionPointerType

Definition at line 99 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef itk::ImageToImageFilter<InternalImageType, OutputImageType> otb::ImageSeriesFileReader< TImage, TInternalImage >::ExtractSelectionType

This is a generic template definition of the ROI extraction procedure. In fact, it will be specialised with:

Definition at line 98 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::IndexType otb::ImageSeriesFileReader< TImage, TInternalImage >::IndexType

Definition at line 67 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::InternalImagePointerType otb::ImageSeriesFileReader< TImage, TInternalImage >::InternalImagePointerType

Definition at line 76 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::InternalImageType otb::ImageSeriesFileReader< TImage, TInternalImage >::InternalImageType

Definition at line 75 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::InternalIndexType otb::ImageSeriesFileReader< TImage, TInternalImage >::InternalIndexType

Definition at line 79 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::InternalPixelType otb::ImageSeriesFileReader< TImage, TInternalImage >::InternalPixelType

Definition at line 77 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::InternalRegionType otb::ImageSeriesFileReader< TImage, TInternalImage >::InternalRegionType

Definition at line 81 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::InternalSizeType otb::ImageSeriesFileReader< TImage, TInternalImage >::InternalSizeType

Definition at line 80 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::InternalValueType otb::ImageSeriesFileReader< TImage, TInternalImage >::InternalValueType

Definition at line 78 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::OutputImageListConstPointerType otb::ImageSeriesFileReader< TImage, TInternalImage >::OutputImageListConstPointerType

Definition at line 73 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::OutputImageListPointerType otb::ImageSeriesFileReader< TImage, TInternalImage >::OutputImageListPointerType

Definition at line 72 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::OutputImageListType otb::ImageSeriesFileReader< TImage, TInternalImage >::OutputImageListType

Definition at line 71 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::OutputImagePointerType otb::ImageSeriesFileReader< TImage, TInternalImage >::OutputImagePointerType

Definition at line 64 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::OutputImageType otb::ImageSeriesFileReader< TImage, TInternalImage >::OutputImageType

Definition at line 61 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::PixelType otb::ImageSeriesFileReader< TImage, TInternalImage >::PixelType

Definition at line 65 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef itk::SmartPointer<Self> otb::ImageSeriesFileReader< TImage, TInternalImage >::Pointer

Definition at line 55 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::ReaderListPointerType otb::ImageSeriesFileReader< TImage, TInternalImage >::ReaderListPointerType

Definition at line 87 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::ReaderListType otb::ImageSeriesFileReader< TImage, TInternalImage >::ReaderListType

Definition at line 86 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::ReaderType otb::ImageSeriesFileReader< TImage, TInternalImage >::ReaderPointerType

Definition at line 84 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::ReaderType otb::ImageSeriesFileReader< TImage, TInternalImage >::ReaderType

Definition at line 83 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::RegionType otb::ImageSeriesFileReader< TImage, TInternalImage >::RegionType

Definition at line 69 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef ImageSeriesFileReader otb::ImageSeriesFileReader< TImage, TInternalImage >::Self

Standart typedefs

Definition at line 53 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::SizeType otb::ImageSeriesFileReader< TImage, TInternalImage >::SizeType

Definition at line 68 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef ImageSeriesFileReaderBase<TImage, TInternalImage> otb::ImageSeriesFileReader< TImage, TInternalImage >::Superclass

Definition at line 54 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
typedef Superclass::ValueType otb::ImageSeriesFileReader< TImage, TInternalImage >::ValueType

Definition at line 66 of file otbImageSeriesFileReader.h.

Constructor & Destructor Documentation

template<class TImage , class TInternalImage >
otb::ImageSeriesFileReader< TImage, TInternalImage >::ImageSeriesFileReader ( )
protected

Definition at line 29 of file otbImageSeriesFileReader.txx.

template<class TImage , class TInternalImage = TImage>
virtual otb::ImageSeriesFileReader< TImage, TInternalImage >::~ImageSeriesFileReader ( )
inlineprotectedvirtual

Definition at line 106 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
otb::ImageSeriesFileReader< TImage, TInternalImage >::ImageSeriesFileReader ( const Self )
private

Member Function Documentation

template<class TImage , class TInternalImage >
void otb::ImageSeriesFileReader< TImage, TInternalImage >::AllocateListOfComponents ( void  )
protectedvirtual

AllocateListOfComponents Once MetaFile is read, allocation of lists are performed in SetFileName. This allows specific (or global) initialization in the GenerateData methods, that the user may invoke throught GenerateOutput() or GenerateOutput( idx ).

Reimplemented from otb::ImageSeriesFileReaderBase< TImage, TInternalImage >.

Definition at line 37 of file otbImageSeriesFileReader.txx.

template<class TImage , class TInternalImage = TImage>
virtual::itk::LightObject::Pointer otb::ImageSeriesFileReader< TImage, TInternalImage >::CreateAnother ( void  ) const
template<class TImage , class TInternalImage >
void otb::ImageSeriesFileReader< TImage, TInternalImage >::GenerateData ( unsigned int  idx)
protectedvirtual

GenerateData This method will be specialised if template definitions follow:

Reimplemented from otb::ImageSeriesFileReaderBase< TImage, TInternalImage >.

Definition at line 50 of file otbImageSeriesFileReader.txx.

template<class TImage , class TInternalImage = TImage>
virtual const char* otb::ImageSeriesFileReader< TImage, TInternalImage >::GetNameOfClass ( ) const
virtual

Runtime informations macro

Reimplemented from otb::ImageSeriesFileReaderBase< TImage, TInternalImage >.

template<class TImage , class TInternalImage = TImage>
static Pointer otb::ImageSeriesFileReader< TImage, TInternalImage >::New ( )
static

Creation through object factory macro

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

PrintSelf method

Reimplemented from otb::ImageSeriesFileReaderBase< TImage, TInternalImage >.

Definition at line 129 of file otbImageSeriesFileReader.h.

template<class TImage , class TInternalImage = TImage>
virtual void otb::ImageSeriesFileReader< TImage, TInternalImage >::TestBandSelection ( std::vector< unsigned int > &  bands)
inlineprotectedvirtual

TestBandSelection Tests the coherency of the Meta File (especifically band selection) with the image types

Reimplemented from otb::ImageSeriesFileReaderBase< TImage, TInternalImage >.

Definition at line 111 of file otbImageSeriesFileReader.h.

Member Data Documentation

template<class TImage , class TInternalImage = TImage>
ExtractSelectionListPointerType otb::ImageSeriesFileReader< TImage, TInternalImage >::m_ExtractorList
protected

Type of extractor to use

Definition at line 137 of file otbImageSeriesFileReader.h.


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