OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::ImageSeriesFileReaderBase< TImage, TInternalImage > Class Template Reference
Group Core » Module OTBImageIO

#include <otbImageSeriesFileReaderBase.h>

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

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType
 
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< 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 * GetFileName () const
 
std::string GetFileName (unsigned int i) const
 
virtual const char * GetNameOfClass () const
 
virtual void SetFileName (const std::string &file)
 
- Public Member Functions inherited from otb::ImageListSource< TImage >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from otb::ImageListSource< TImage >
static Pointer New ()
 
enum  FileType {
  kFileName = 0,
  kImageFileName,
  kAnyFileName
}
 
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
 
 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
 
 ImageSeriesFileReaderBase ()
 
 ~ImageSeriesFileReaderBase () override=default
 
virtual void TestFileExistenceAndReadability (std::string &file, FileType fileType)
 
virtual void TestBandSelection (std::vector< unsigned int > &)
 
void GenerateData (void) override
 
virtual void GenerateData (DataObjectPointerArraySizeType idx)
 
virtual void ReadMetaFile ()
 
virtual void AllocateListOfComponents (void)
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ImageSeriesFileReaderBase (const Self &)
 
void operator= (const Self &)
 

Additional Inherited Members

- Protected Member Functions inherited from otb::ImageListSource< TImage >
 ImageListSource ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~ImageListSource () override
 

Detailed Description

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

See also
ImageSeriesFileReader

Definition at line 68 of file otbImageSeriesFileReaderBase.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 75 of file otbImageSeriesFileReaderBase.h.

◆ DataObjectPointerArraySizeType

template<class TImage , class TInternalImage = TImage>
typedef itk::ProcessObject::DataObjectPointerArraySizeType otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::DataObjectPointerArraySizeType

Definition at line 109 of file otbImageSeriesFileReaderBase.h.

◆ IndexType

template<class TImage , class TInternalImage = TImage>
typedef OutputImageType::IndexType otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::IndexType

Definition at line 87 of file otbImageSeriesFileReaderBase.h.

◆ InternalImagePointerType

template<class TImage , class TInternalImage = TImage>
typedef InternalImageType::Pointer otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::InternalImagePointerType

Definition at line 96 of file otbImageSeriesFileReaderBase.h.

◆ InternalImageType

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

Definition at line 95 of file otbImageSeriesFileReaderBase.h.

◆ InternalIndexType

template<class TImage , class TInternalImage = TImage>
typedef InternalImageType::IndexType otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::InternalIndexType

Definition at line 99 of file otbImageSeriesFileReaderBase.h.

◆ InternalPixelType

template<class TImage , class TInternalImage = TImage>
typedef InternalImageType::InternalPixelType otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::InternalPixelType

Definition at line 97 of file otbImageSeriesFileReaderBase.h.

◆ InternalRegionType

template<class TImage , class TInternalImage = TImage>
typedef InternalImageType::RegionType otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::InternalRegionType

Definition at line 101 of file otbImageSeriesFileReaderBase.h.

◆ InternalSizeType

template<class TImage , class TInternalImage = TImage>
typedef InternalImageType::SizeType otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::InternalSizeType

Definition at line 100 of file otbImageSeriesFileReaderBase.h.

◆ InternalValueType

template<class TImage , class TInternalImage = TImage>
typedef InternalImageType::ValueType otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::InternalValueType

Definition at line 98 of file otbImageSeriesFileReaderBase.h.

◆ OutputImageListConstPointerType

template<class TImage , class TInternalImage = TImage>
typedef OutputImageListType::ConstPointer otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::OutputImageListConstPointerType

Definition at line 93 of file otbImageSeriesFileReaderBase.h.

◆ OutputImageListPointerType

template<class TImage , class TInternalImage = TImage>
typedef OutputImageListType::Pointer otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::OutputImageListPointerType

Definition at line 92 of file otbImageSeriesFileReaderBase.h.

◆ OutputImageListType

template<class TImage , class TInternalImage = TImage>
typedef ImageList<OutputImageType> otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::OutputImageListType

Definition at line 91 of file otbImageSeriesFileReaderBase.h.

◆ OutputImagePointerType

template<class TImage , class TInternalImage = TImage>
typedef OutputImageType::Pointer otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::OutputImagePointerType

Definition at line 84 of file otbImageSeriesFileReaderBase.h.

◆ OutputImageType

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

Definition at line 81 of file otbImageSeriesFileReaderBase.h.

◆ PixelType

template<class TImage , class TInternalImage = TImage>
typedef OutputImageType::InternalPixelType otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::PixelType

Definition at line 85 of file otbImageSeriesFileReaderBase.h.

◆ Pointer

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

Definition at line 74 of file otbImageSeriesFileReaderBase.h.

◆ ReaderListPointerType

template<class TImage , class TInternalImage = TImage>
typedef ReaderListType::Pointer otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::ReaderListPointerType

Definition at line 107 of file otbImageSeriesFileReaderBase.h.

◆ ReaderListType

template<class TImage , class TInternalImage = TImage>
typedef ObjectList<ReaderType> otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::ReaderListType

Definition at line 106 of file otbImageSeriesFileReaderBase.h.

◆ ReaderPointerType

template<class TImage , class TInternalImage = TImage>
typedef ReaderType::Pointer otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::ReaderPointerType

Definition at line 104 of file otbImageSeriesFileReaderBase.h.

◆ ReaderType

template<class TImage , class TInternalImage = TImage>
typedef ImageFileReader<InternalImageType> otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::ReaderType

Definition at line 103 of file otbImageSeriesFileReaderBase.h.

◆ RegionType

template<class TImage , class TInternalImage = TImage>
typedef OutputImageType::RegionType otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::RegionType

Definition at line 89 of file otbImageSeriesFileReaderBase.h.

◆ Self

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

Standard typedefs

Definition at line 72 of file otbImageSeriesFileReaderBase.h.

◆ SizeType

template<class TImage , class TInternalImage = TImage>
typedef OutputImageType::SizeType otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::SizeType

Definition at line 88 of file otbImageSeriesFileReaderBase.h.

◆ Superclass

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

Definition at line 73 of file otbImageSeriesFileReaderBase.h.

◆ ValueType

template<class TImage , class TInternalImage = TImage>
typedef OutputImageType::ValueType otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::ValueType

Definition at line 86 of file otbImageSeriesFileReaderBase.h.

Member Enumeration Documentation

◆ FileType

template<class TImage , class TInternalImage = TImage>
enum otb::ImageSeriesFileReaderBase::FileType
protected

Get the readers

Enumerator
kFileName 
kImageFileName 
kAnyFileName 

Definition at line 159 of file otbImageSeriesFileReaderBase.h.

Constructor & Destructor Documentation

◆ ImageSeriesFileReaderBase() [1/2]

template<class TImage , class TInternalImage >
otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::ImageSeriesFileReaderBase
protected

Get the readers

Definition at line 31 of file otbImageSeriesFileReaderBase.hxx.

◆ ~ImageSeriesFileReaderBase()

template<class TImage , class TInternalImage = TImage>
otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::~ImageSeriesFileReaderBase ( )
overrideprotecteddefault

Get the readers

◆ ImageSeriesFileReaderBase() [2/2]

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

Get the readers

Member Function Documentation

◆ AllocateListOfComponents()

template<class TImage , class TInternalImage >
void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::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 ).

Reimplemented in otb::ImageSeriesFileReader< VectorImage< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >, otb::ImageSeriesFileReader< Image< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >, otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >, and otb::ImageSeriesFileReader< TImage, TInternalImage >.

Definition at line 292 of file otbImageSeriesFileReaderBase.hxx.

◆ CreateAnother()

template<class TImage , class TInternalImage = TImage>
virtual::itk::LightObject::Pointer otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::CreateAnother ( void  ) const

◆ GenerateData() [1/2]

template<class TImage , class TInternalImage >
void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::GenerateData ( DataObjectPointerArraySizeType  idx)
protectedvirtual

GenerateData This method will be specialised if template definitions follow:

GenerateData

Reimplemented in otb::ImageSeriesFileReader< VectorImage< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >, otb::ImageSeriesFileReader< Image< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >, otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >, and otb::ImageSeriesFileReader< TImage, TInternalImage >.

Definition at line 305 of file otbImageSeriesFileReaderBase.hxx.

◆ GenerateData() [2/2]

template<class TImage , class TInternalImage >
void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::GenerateData ( void  )
overrideprotected

Get the readers

Definition at line 316 of file otbImageSeriesFileReaderBase.hxx.

Referenced by otb::ImageSeriesFileReaderBase< TImage, TImage >::Update().

◆ GenerateOutput() [1/2]

template<class TImage , class TInternalImage >
ImageSeriesFileReaderBase< TImage, TInternalImage >::OutputImageType * otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::GenerateOutput ( DataObjectPointerArraySizeType  idx)
virtual

Get the readers

Definition at line 335 of file otbImageSeriesFileReaderBase.hxx.

◆ GenerateOutput() [2/2]

template<class TImage , class TInternalImage >
ImageSeriesFileReaderBase< TImage, TInternalImage >::OutputImageListType * otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::GenerateOutput ( void  )
virtual

Performs selective file extraction

GenerateOutput

Definition at line 326 of file otbImageSeriesFileReaderBase.hxx.

◆ GetFileName() [1/2]

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

Get the file to be read

◆ GetFileName() [2/2]

template<class TImage , class TInternalImage = TImage>
std::string otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::GetFileName ( unsigned int  i) const
inline

get the Filenames

Definition at line 122 of file otbImageSeriesFileReaderBase.h.

◆ GetImageFileReader()

template<class TImage , class TInternalImage = TImage>
ReaderType* otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::GetImageFileReader ( unsigned int  i) const
inline

Get the readers

Definition at line 129 of file otbImageSeriesFileReaderBase.h.

◆ GetNameOfClass()

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

Runtime information macro

◆ GetNumberOfOutputs()

template<class TImage , class TInternalImage = TImage>
virtual unsigned int otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::GetNumberOfOutputs ( ) const
inlinevirtual

Get the output list

Definition at line 136 of file otbImageSeriesFileReaderBase.h.

◆ GetOutput() [1/2]

template<class TImage , class TInternalImage >
ImageSeriesFileReaderBase< TImage, TInternalImage >::OutputImageType * otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::GetOutput ( DataObjectPointerArraySizeType  idx)
virtual

Get the readers

Definition at line 66 of file otbImageSeriesFileReaderBase.hxx.

◆ GetOutput() [2/2]

template<class TImage , class TInternalImage >
ImageSeriesFileReaderBase< TImage, TInternalImage >::OutputImageListType * otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::GetOutput ( void  )
overridevirtual

Get the readers

Reimplemented from otb::ImageListSource< TImage >.

Definition at line 56 of file otbImageSeriesFileReaderBase.hxx.

◆ itkGetObjectMacro()

template<class TImage , class TInternalImage = TImage>
otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::itkGetObjectMacro ( ImageFileReaderList  ,
ReaderListType   
)

Get the readers

◆ New()

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

Creation through object factory macro

◆ operator=()

template<class TImage , class TInternalImage = TImage>
void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::operator= ( const Self &  )
private

Get the readers

◆ PrintSelf()

template<class TImage , class TInternalImage >
void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

PrintSelf method

Definition at line 342 of file otbImageSeriesFileReaderBase.hxx.

◆ ReadMetaFile()

template<class TImage , class TInternalImage >
void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::ReadMetaFile
protectedvirtual

Read the MetaFile and test its effectiveness once inputFileName is set.

Definition at line 78 of file otbImageSeriesFileReaderBase.hxx.

◆ SetFileName()

template<class TImage , class TInternalImage >
void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::SetFileName ( const std::string &  file)
virtual

Set the file to be read. Once the Filename is set, ReadMeatFile is called in order to get the number of image files to be read, the images file names, the band and region selection

Definition at line 43 of file otbImageSeriesFileReaderBase.hxx.

◆ TestBandSelection()

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

Get the readers

Reimplemented in otb::ImageSeriesFileReader< Image< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >, otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >, otb::ImageSeriesFileReader< VectorImage< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >, and otb::ImageSeriesFileReader< TImage, TInternalImage >.

Definition at line 171 of file otbImageSeriesFileReaderBase.h.

◆ TestFileExistenceAndReadability()

template<class TImage , class TInternalImage >
void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::TestFileExistenceAndReadability ( std::string &  file,
FileType  fileType 
)
protectedvirtual

Test files. If the filename to test is an imageFileName, the file name may be modified in order to add the appropriated path

Definition at line 373 of file otbImageSeriesFileReaderBase.hxx.

◆ Update()

template<class TImage , class TInternalImage = TImage>
void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::Update ( )
inlineoverride

Synchronization

Definition at line 150 of file otbImageSeriesFileReaderBase.h.

Member Data Documentation

◆ m_FileName

template<class TImage , class TInternalImage = TImage>
std::string otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::m_FileName
protected

Get the readers

Definition at line 200 of file otbImageSeriesFileReaderBase.h.

◆ m_ImageFileReaderList

template<class TImage , class TInternalImage = TImage>
ReaderListPointerType otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::m_ImageFileReaderList
protected

Get the readers

Definition at line 207 of file otbImageSeriesFileReaderBase.h.

Referenced by otb::ImageSeriesFileReaderBase< TImage, TImage >::GetImageFileReader().

◆ m_ListOfBandSelection

template<class TImage , class TInternalImage = TImage>
std::vector<std::vector<unsigned int> > otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::m_ListOfBandSelection
protected

Get the readers

Definition at line 204 of file otbImageSeriesFileReaderBase.h.

◆ m_ListOfFileNames

template<class TImage , class TInternalImage = TImage>
std::vector<std::string> otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::m_ListOfFileNames
protected

Get the readers

Definition at line 203 of file otbImageSeriesFileReaderBase.h.

Referenced by otb::ImageSeriesFileReaderBase< TImage, TImage >::GetFileName(), and otb::ImageSeriesFileReaderBase< TImage, TImage >::GetNumberOfOutputs().

◆ m_ListOfRegionSelection

template<class TImage , class TInternalImage = TImage>
std::vector<InternalRegionType> otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::m_ListOfRegionSelection
protected

Get the readers

Definition at line 205 of file otbImageSeriesFileReaderBase.h.

◆ m_OutputList

template<class TImage , class TInternalImage = TImage>
OutputImageListPointerType otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::m_OutputList
protected

Get the readers

Definition at line 201 of file otbImageSeriesFileReaderBase.h.

The documentation for this class was generated from the following files:
Generated at Wed Feb 28 2024 15:25:07 for OTB with   doxygen 1.8.17