otb::ImageSeriesFileReader< TImage, TInternalImage > Class Template Reference

#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 itk::ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
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< Self >	Pointer
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, TImage >
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::IndexType	IndexType
typedef InternalImageType::Pointer	InternalImagePointerType
typedef TImage	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< Self >	Pointer
typedef ReaderListType::Pointer	ReaderListPointerType
typedef ObjectList< ReaderType >	ReaderListType
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< Self >	Pointer
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, TImage >
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetFileName () const
std::string	GetFileName (unsigned int i) const
virtual const char *	GetNameOfClass () const
virtual void	SetFileName (const std::string &file)
	itkGetObjectMacro (ImageFileReaderList, ReaderListType)
ReaderType *	GetImageFileReader (unsigned int i) const
virtual unsigned int	GetNumberOfOutputs () const
OutputImageListType *	GetOutput (void) override
virtual OutputImageType *	GetOutput (DataObjectPointerArraySizeType idx)
virtual OutputImageListType *	GenerateOutput (void)
virtual OutputImageType *	GenerateOutput (DataObjectPointerArraySizeType idx)
void	Update () override
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, TImage >
static Pointer	New ()
Static Public Member Functions inherited from otb::ImageListSource< TImage >
static Pointer	New ()

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

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

Private Member Functions
	ImageSeriesFileReader (const Self &)
void	operator= (const Self &)

Additional Inherited Members
Protected Types inherited from otb::ImageSeriesFileReaderBase< TImage, TImage >
enum	FileType

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 52 of file otbImageSeriesFileReader.h.

Member Typedef Documentation

ConstPointer

template<class TImage , class TInternalImage = TImage>

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

Definition at line 60 of file otbImageSeriesFileReader.h.

DataObjectPointerArraySizeType

template<class TImage , class TInternalImage = TImage>

typedef itk::ProcessObject::DataObjectPointerArraySizeType otb::ImageSeriesFileReader< TImage, TInternalImage >::DataObjectPointerArraySizeType

Definition at line 109 of file otbImageSeriesFileReader.h.

ExtractSelectionListPointerType

template<class TImage , class TInternalImage = TImage>

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

Definition at line 107 of file otbImageSeriesFileReader.h.

ExtractSelectionListType

template<class TImage , class TInternalImage = TImage>

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

Definition at line 106 of file otbImageSeriesFileReader.h.

ExtractSelectionPointerType

template<class TImage , class TInternalImage = TImage>

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

Definition at line 104 of file otbImageSeriesFileReader.h.

ExtractSelectionType

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:

• MultiChannelExtractROI if TImage is a VectorImage
• MultiToMonoChannelExtractROI if TImage is an Image and TInteranalImage is a VectorImage
• ExtractROI if TImage and TInternalImage are of Image type.

Definition at line 103 of file otbImageSeriesFileReader.h.

IndexType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::IndexType otb::ImageSeriesFileReader< TImage, TInternalImage >::IndexType

Definition at line 72 of file otbImageSeriesFileReader.h.

InternalImagePointerType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::InternalImagePointerType otb::ImageSeriesFileReader< TImage, TInternalImage >::InternalImagePointerType

Definition at line 81 of file otbImageSeriesFileReader.h.

InternalImageType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::InternalImageType otb::ImageSeriesFileReader< TImage, TInternalImage >::InternalImageType

Definition at line 80 of file otbImageSeriesFileReader.h.

InternalIndexType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::InternalIndexType otb::ImageSeriesFileReader< TImage, TInternalImage >::InternalIndexType

Definition at line 84 of file otbImageSeriesFileReader.h.

InternalPixelType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::InternalPixelType otb::ImageSeriesFileReader< TImage, TInternalImage >::InternalPixelType

Definition at line 82 of file otbImageSeriesFileReader.h.

InternalRegionType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::InternalRegionType otb::ImageSeriesFileReader< TImage, TInternalImage >::InternalRegionType

Definition at line 86 of file otbImageSeriesFileReader.h.

InternalSizeType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::InternalSizeType otb::ImageSeriesFileReader< TImage, TInternalImage >::InternalSizeType

Definition at line 85 of file otbImageSeriesFileReader.h.

InternalValueType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::InternalValueType otb::ImageSeriesFileReader< TImage, TInternalImage >::InternalValueType

Definition at line 83 of file otbImageSeriesFileReader.h.

OutputImageListConstPointerType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::OutputImageListConstPointerType otb::ImageSeriesFileReader< TImage, TInternalImage >::OutputImageListConstPointerType

Definition at line 78 of file otbImageSeriesFileReader.h.

OutputImageListPointerType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::OutputImageListPointerType otb::ImageSeriesFileReader< TImage, TInternalImage >::OutputImageListPointerType

Definition at line 77 of file otbImageSeriesFileReader.h.

OutputImageListType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::OutputImageListType otb::ImageSeriesFileReader< TImage, TInternalImage >::OutputImageListType

Definition at line 76 of file otbImageSeriesFileReader.h.

OutputImagePointerType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::OutputImagePointerType otb::ImageSeriesFileReader< TImage, TInternalImage >::OutputImagePointerType

Definition at line 69 of file otbImageSeriesFileReader.h.

OutputImageType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::OutputImageType otb::ImageSeriesFileReader< TImage, TInternalImage >::OutputImageType

Definition at line 66 of file otbImageSeriesFileReader.h.

PixelType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::PixelType otb::ImageSeriesFileReader< TImage, TInternalImage >::PixelType

Definition at line 70 of file otbImageSeriesFileReader.h.

Pointer

template<class TImage , class TInternalImage = TImage>

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

Definition at line 59 of file otbImageSeriesFileReader.h.

ReaderListPointerType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::ReaderListPointerType otb::ImageSeriesFileReader< TImage, TInternalImage >::ReaderListPointerType

Definition at line 92 of file otbImageSeriesFileReader.h.

ReaderListType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::ReaderListType otb::ImageSeriesFileReader< TImage, TInternalImage >::ReaderListType

Definition at line 91 of file otbImageSeriesFileReader.h.

ReaderPointerType

template<class TImage , class TInternalImage = TImage>

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

Definition at line 89 of file otbImageSeriesFileReader.h.

ReaderType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::ReaderType otb::ImageSeriesFileReader< TImage, TInternalImage >::ReaderType

Definition at line 88 of file otbImageSeriesFileReader.h.

RegionType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::RegionType otb::ImageSeriesFileReader< TImage, TInternalImage >::RegionType

Definition at line 74 of file otbImageSeriesFileReader.h.

Self

template<class TImage , class TInternalImage = TImage>

typedef ImageSeriesFileReader otb::ImageSeriesFileReader< TImage, TInternalImage >::Self

Standard typedefs

Definition at line 57 of file otbImageSeriesFileReader.h.

SizeType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::SizeType otb::ImageSeriesFileReader< TImage, TInternalImage >::SizeType

Definition at line 73 of file otbImageSeriesFileReader.h.

Superclass

template<class TImage , class TInternalImage = TImage>

typedef ImageSeriesFileReaderBase<TImage, TInternalImage> otb::ImageSeriesFileReader< TImage, TInternalImage >::Superclass

Definition at line 58 of file otbImageSeriesFileReader.h.

ValueType

template<class TImage , class TInternalImage = TImage>

typedef Superclass::ValueType otb::ImageSeriesFileReader< TImage, TInternalImage >::ValueType

Definition at line 71 of file otbImageSeriesFileReader.h.

Constructor & Destructor Documentation

ImageSeriesFileReader() [1/2]

template<class TImage , class TInternalImage >

otb::ImageSeriesFileReader< TImage, TInternalImage >::ImageSeriesFileReader

protected

Definition at line 31 of file otbImageSeriesFileReader.hxx.

~ImageSeriesFileReader()

template<class TImage , class TInternalImage = TImage>

otb::ImageSeriesFileReader< TImage, TInternalImage >::~ImageSeriesFileReader ( )

overrideprotecteddefault

ImageSeriesFileReader() [2/2]

template<class TImage , class TInternalImage = TImage>

otb::ImageSeriesFileReader< TImage, TInternalImage >::ImageSeriesFileReader ( const Self &  )

private

Member Function Documentation

AllocateListOfComponents()

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 through GenerateOutput() or GenerateOutput( idx ).

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

Definition at line 37 of file otbImageSeriesFileReader.hxx.

CreateAnother()

template<class TImage , class TInternalImage = TImage>

virtual::itk::LightObject::Pointer otb::ImageSeriesFileReader< TImage, TInternalImage >::CreateAnother

(

void

)

const

GenerateData() [1/3]

template<class TImage , class TInternalImage >

void otb::ImageSeriesFileReader< TImage, TInternalImage >::GenerateData ( DataObjectPointerArraySizeType  idx )

protectedvirtual

GenerateData This method will be specialised if template definitions follow:

• TImage is a VectorImage
• TImage is an Image and TInteranalImage is a VectorImage
• TImage and TInternalImage are of Image type.

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

Definition at line 48 of file otbImageSeriesFileReader.hxx.

GenerateData() [2/3]

template<class TImage , class TInternalImage = TImage>

void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::GenerateData

protected

GenerateData This method will be specialised if template definitions follow:

• TImage is a VectorImage
• TImage is an Image and TInteranalImage is a VectorImage
• TImage and TInternalImage are of Image type.

GenerateData

Definition at line 305 of file otbImageSeriesFileReaderBase.hxx.

GenerateData() [3/3]

template<class TImage , class TInternalImage = TImage>

void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::GenerateData

overrideprotected

Definition at line 316 of file otbImageSeriesFileReaderBase.hxx.

GetNameOfClass()

template<class TImage , class TInternalImage = TImage>

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

virtual

Runtime information macro

New()

template<class TImage , class TInternalImage = TImage>

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

static

Creation through object factory macro

operator=()

template<class TImage , class TInternalImage = TImage>

void otb::ImageSeriesFileReader< TImage, TInternalImage >::operator= ( const Self &  )

private

PrintSelf()

template<class TImage , class TInternalImage = TImage>

void otb::ImageSeriesFileReader< TImage, TInternalImage >::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

inlineprotected

PrintSelf method

Definition at line 139 of file otbImageSeriesFileReader.h.

TestBandSelection()

template<class TImage , class TInternalImage = TImage>

virtual void otb::ImageSeriesFileReader< TImage, TInternalImage >::TestBandSelection ( std::vector< unsigned int > &  )

inlineprotectedvirtual

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

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

Definition at line 118 of file otbImageSeriesFileReader.h.

Member Data Documentation

m_ExtractorList

template<class TImage , class TInternalImage = TImage>

ExtractSelectionListPointerType otb::ImageSeriesFileReader< TImage, TInternalImage >::m_ExtractorList

protected

Type of extractor to use

Definition at line 147 of file otbImageSeriesFileReader.h.

---

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

• otbImageSeriesFileReader.h
• otbImageSeriesFileReader.hxx