otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > > Class Template Reference

#include <otbImageSeriesFileReader.h>

Inheritance diagram for otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >:

Collaboration diagram for otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >:

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 ExtractROI< InternalPixelType, PixelType >	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< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >	Superclass
typedef Superclass::ValueType	ValueType
Public Types inherited from otb::ImageSeriesFileReaderBase< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::IndexType	IndexType
typedef InternalImageType::Pointer	InternalImagePointerType
typedef Image< TInternalPixel, 2 >	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 Image< TPixel, 2 >	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< Image< TPixel, 2 > >	Superclass
typedef OutputImageType::ValueType	ValueType
Public Types inherited from otb::ImageListSource< Image< TPixel, 2 > >
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 Image< TPixel, 2 >	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< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >
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< Image< TPixel, 2 > >
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from otb::ImageSeriesFileReaderBase< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >
static Pointer	New ()
Static Public Member Functions inherited from otb::ImageListSource< Image< TPixel, 2 > >
static Pointer	New ()

Protected Member Functions
	ImageSeriesFileReader ()
void	PrintSelf (std::ostream &os, itk::Indent indent) const
virtual	~ImageSeriesFileReader ()
virtual void	TestBandSelection (std::vector< unsigned int > &bands)
virtual void	GenerateData (DataObjectPointerArraySizeType idx)
virtual void	AllocateListOfComponents (void)
Protected Member Functions inherited from otb::ImageSeriesFileReaderBase< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >
	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< Image< TPixel, 2 > >
	ImageListSource ()
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	~ImageListSource () override

Protected Attributes
ExtractSelectionListPointerType	m_ExtractorList
Protected Attributes inherited from otb::ImageSeriesFileReaderBase< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >
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< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >
enum	FileType

Detailed Description

template<class TPixel, class TInternalPixel>
class otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >

Definition at line 168 of file otbImageSeriesFileReader.h.

Member Typedef Documentation

ConstPointer

template<class TPixel , class TInternalPixel >

typedef itk::SmartPointer<const Self> otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::ConstPointer

Definition at line 177 of file otbImageSeriesFileReader.h.

DataObjectPointerArraySizeType

template<class TPixel , class TInternalPixel >

typedef itk::ProcessObject::DataObjectPointerArraySizeType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::DataObjectPointerArraySizeType

Definition at line 220 of file otbImageSeriesFileReader.h.

ExtractSelectionListPointerType

template<class TPixel , class TInternalPixel >

typedef ExtractSelectionListType::Pointer otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::ExtractSelectionListPointerType

Definition at line 218 of file otbImageSeriesFileReader.h.

ExtractSelectionListType

template<class TPixel , class TInternalPixel >

typedef ObjectList<ExtractSelectionType> otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::ExtractSelectionListType

Definition at line 217 of file otbImageSeriesFileReader.h.

ExtractSelectionPointerType

template<class TPixel , class TInternalPixel >

typedef ExtractSelectionType::Pointer otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::ExtractSelectionPointerType

Definition at line 215 of file otbImageSeriesFileReader.h.

ExtractSelectionType

template<class TPixel , class TInternalPixel >

typedef ExtractROI<InternalPixelType, PixelType> otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::ExtractSelectionType

This is a specialised template definition of the ROI extraction procedure. Here TExtractSelection is a ExtractROI class since TImage and TInternalImage are of Image type.

Definition at line 214 of file otbImageSeriesFileReader.h.

IndexType

template<class TPixel , class TInternalPixel >

typedef Superclass::IndexType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::IndexType

Definition at line 189 of file otbImageSeriesFileReader.h.

InternalImagePointerType

template<class TPixel , class TInternalPixel >

typedef Superclass::InternalImagePointerType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::InternalImagePointerType

Definition at line 198 of file otbImageSeriesFileReader.h.

InternalImageType

template<class TPixel , class TInternalPixel >

typedef Superclass::InternalImageType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::InternalImageType

Definition at line 197 of file otbImageSeriesFileReader.h.

InternalIndexType

template<class TPixel , class TInternalPixel >

typedef Superclass::InternalIndexType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::InternalIndexType

Definition at line 201 of file otbImageSeriesFileReader.h.

InternalPixelType

template<class TPixel , class TInternalPixel >

typedef Superclass::InternalPixelType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::InternalPixelType

Definition at line 199 of file otbImageSeriesFileReader.h.

InternalRegionType

template<class TPixel , class TInternalPixel >

typedef Superclass::InternalRegionType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::InternalRegionType

Definition at line 203 of file otbImageSeriesFileReader.h.

InternalSizeType

template<class TPixel , class TInternalPixel >

typedef Superclass::InternalSizeType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::InternalSizeType

Definition at line 202 of file otbImageSeriesFileReader.h.

InternalValueType

template<class TPixel , class TInternalPixel >

typedef Superclass::InternalValueType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::InternalValueType

Definition at line 200 of file otbImageSeriesFileReader.h.

OutputImageListConstPointerType

template<class TPixel , class TInternalPixel >

typedef Superclass::OutputImageListConstPointerType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::OutputImageListConstPointerType

Definition at line 195 of file otbImageSeriesFileReader.h.

OutputImageListPointerType

template<class TPixel , class TInternalPixel >

typedef Superclass::OutputImageListPointerType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::OutputImageListPointerType

Definition at line 194 of file otbImageSeriesFileReader.h.

OutputImageListType

template<class TPixel , class TInternalPixel >

typedef Superclass::OutputImageListType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::OutputImageListType

Definition at line 193 of file otbImageSeriesFileReader.h.

OutputImagePointerType

template<class TPixel , class TInternalPixel >

typedef Superclass::OutputImagePointerType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::OutputImagePointerType

Definition at line 186 of file otbImageSeriesFileReader.h.

OutputImageType

template<class TPixel , class TInternalPixel >

typedef Superclass::OutputImageType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::OutputImageType

Definition at line 183 of file otbImageSeriesFileReader.h.

PixelType

template<class TPixel , class TInternalPixel >

typedef Superclass::PixelType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::PixelType

Definition at line 187 of file otbImageSeriesFileReader.h.

Pointer

template<class TPixel , class TInternalPixel >

typedef itk::SmartPointer<Self> otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::Pointer

Definition at line 176 of file otbImageSeriesFileReader.h.

ReaderListPointerType

template<class TPixel , class TInternalPixel >

typedef Superclass::ReaderListPointerType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::ReaderListPointerType

Definition at line 209 of file otbImageSeriesFileReader.h.

ReaderListType

template<class TPixel , class TInternalPixel >

typedef Superclass::ReaderListType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::ReaderListType

Definition at line 208 of file otbImageSeriesFileReader.h.

ReaderPointerType

template<class TPixel , class TInternalPixel >

typedef Superclass::ReaderType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::ReaderPointerType

Definition at line 206 of file otbImageSeriesFileReader.h.

ReaderType

template<class TPixel , class TInternalPixel >

typedef Superclass::ReaderType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::ReaderType

Definition at line 205 of file otbImageSeriesFileReader.h.

RegionType

template<class TPixel , class TInternalPixel >

typedef Superclass::RegionType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::RegionType

Definition at line 191 of file otbImageSeriesFileReader.h.

Self

template<class TPixel , class TInternalPixel >

typedef ImageSeriesFileReader otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::Self

Standard typedefs

Definition at line 174 of file otbImageSeriesFileReader.h.

SizeType

template<class TPixel , class TInternalPixel >

typedef Superclass::SizeType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::SizeType

Definition at line 190 of file otbImageSeriesFileReader.h.

Superclass

template<class TPixel , class TInternalPixel >

typedef ImageSeriesFileReaderBase<Image<TPixel, 2>, Image<TInternalPixel, 2> > otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::Superclass

Definition at line 175 of file otbImageSeriesFileReader.h.

ValueType

template<class TPixel , class TInternalPixel >

typedef Superclass::ValueType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::ValueType

Definition at line 188 of file otbImageSeriesFileReader.h.

Constructor & Destructor Documentation

ImageSeriesFileReader() [1/2]

template<class TPixel , class TInternalPixel >

otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::ImageSeriesFileReader

protected

Definition at line 63 of file otbImageSeriesFileReader.hxx.

~ImageSeriesFileReader()

template<class TPixel , class TInternalPixel >

virtual otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::~ImageSeriesFileReader ( )

inlineprotectedvirtual

Definition at line 224 of file otbImageSeriesFileReader.h.

ImageSeriesFileReader() [2/2]

template<class TPixel , class TInternalPixel >

otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::ImageSeriesFileReader ( const Self &  )

private

Member Function Documentation

AllocateListOfComponents()

template<class TPixel , class TInternalPixel >

void otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::AllocateListOfComponents ( void  )

protectedvirtual

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 ).

Allocation of the component... Here, based on ExtractROI

Reimplemented from otb::ImageSeriesFileReaderBase< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >.

Definition at line 72 of file otbImageSeriesFileReader.hxx.

CreateAnother()

template<class TPixel , class TInternalPixel >

virtual::itk::LightObject::Pointer otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::CreateAnother

(

void

)

const

GenerateData()

template<class TPixel , class TInternalPixel >

void otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::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.

GenerateData for Image type

Reimplemented from otb::ImageSeriesFileReaderBase< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >.

Definition at line 115 of file otbImageSeriesFileReader.hxx.

References otbMsgDebugMacro, otb::ExtractROIBase< TInputImage, TOutputImage >::SetExtractionRegion(), and otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::SetFileName().

GetNameOfClass()

template<class TPixel , class TInternalPixel >

virtual const char* otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::GetNameOfClass ( ) const

virtual

Runtime information macro

New()

template<class TPixel , class TInternalPixel >

static Pointer otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::New ( )

static

Creation through object factory macro

operator=()

template<class TPixel , class TInternalPixel >

void otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::operator= ( const Self &  )

private

PrintSelf()

template<class TPixel , class TInternalPixel >

void otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

inlineprotected

PrintSelf method

Definition at line 250 of file otbImageSeriesFileReader.h.

TestBandSelection()

template<class TPixel , class TInternalPixel >

void otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::TestBandSelection ( std::vector< unsigned int > &  bands )

protectedvirtual

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

TestBandSelection tests if the templated Image type is compatible with the bande selection provided in the Meta File

Reimplemented from otb::ImageSeriesFileReaderBase< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >.

Definition at line 88 of file otbImageSeriesFileReader.hxx.

Member Data Documentation

m_ExtractorList

template<class TPixel , class TInternalPixel >

ExtractSelectionListPointerType otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::m_ExtractorList

protected

Type of extractor to use

Definition at line 258 of file otbImageSeriesFileReader.h.

---

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

• otbImageSeriesFileReader.h
• otbImageSeriesFileReader.hxx