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

#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 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 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 const char * GetNameOfClass () const
 
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::ImageListSource< TImage >
static Pointer New ()
 

Protected Types

enum  FileType {
  kFileName = 0,
  kImageFileName,
  kAnyFileName
}
 

Protected Member Functions

 ImageSeriesFileReaderBase ()
 
virtual ~ImageSeriesFileReaderBase ()
 
virtual void AllocateListOfComponents (void)
 
virtual void GenerateData (void)
 
virtual void GenerateData (unsigned int idx)
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 
virtual void ReadMetaFile ()
 
virtual void TestBandSelection (std::vector< unsigned int > &)
 
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

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

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

Detailed Description

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

See Also
ImageSeriesFileReader

Definition at line 62 of file otbImageSeriesFileReaderBase.h.

Member Typedef Documentation

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

Definition at line 70 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 81 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 90 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 89 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 93 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 91 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 95 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 94 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 92 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 87 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 86 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 85 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 78 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 75 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 79 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 69 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 101 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 100 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 98 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 97 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 83 of file otbImageSeriesFileReaderBase.h.

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

Standart typedefs

Definition at line 67 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 82 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 68 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 80 of file otbImageSeriesFileReaderBase.h.

Member Enumeration Documentation

template<class TImage, class TInternalImage = TImage>
enum otb::ImageSeriesFileReaderBase::FileType
protected
Enumerator
kFileName 
kImageFileName 
kAnyFileName 

Definition at line 149 of file otbImageSeriesFileReaderBase.h.

Constructor & Destructor Documentation

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

Definition at line 29 of file otbImageSeriesFileReaderBase.txx.

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

Definition at line 147 of file otbImageSeriesFileReaderBase.h.

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

Member Function Documentation

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 throught 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 320 of file otbImageSeriesFileReaderBase.txx.

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

Definition at line 347 of file otbImageSeriesFileReaderBase.txx.

template<class TImage , class TInternalImage >
void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::GenerateData ( unsigned int  idx)
protectedvirtual
template<class TImage , class TInternalImage >
ImageSeriesFileReaderBase< TImage, TInternalImage >::OutputImageListType * otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::GenerateOutput ( void  )
virtual

Performs selective file extraction

GenerateOutput

Definition at line 359 of file otbImageSeriesFileReaderBase.txx.

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

Definition at line 368 of file otbImageSeriesFileReaderBase.txx.

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

Get the file to be read

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

get the Filenames

Definition at line 115 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 122 of file otbImageSeriesFileReaderBase.h.

template<class TImage, class TInternalImage = TImage>
virtual ReaderListType* otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::GetImageFileReaderList ( )
virtual

Get the readers

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

Get the output list

Definition at line 128 of file otbImageSeriesFileReaderBase.h.

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

Overiding of the GetOutput() method

Get the output image list

Returns
The image list produced.

Reimplemented from otb::ImageListSource< TImage >.

Definition at line 68 of file otbImageSeriesFileReaderBase.txx.

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

Definition at line 82 of file otbImageSeriesFileReaderBase.txx.

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

Creation through object factory macro

template<class TImage, class TInternalImage = TImage>
void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::operator= ( const Self )
private
template<class TImage , class TInternalImage >
void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual
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 102 of file otbImageSeriesFileReaderBase.txx.

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 42 of file otbImageSeriesFileReaderBase.txx.

template<class TImage , class TInternalImage >
void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::SetFileName ( const char *  file)
virtual

Definition at line 50 of file otbImageSeriesFileReaderBase.txx.

template<class TImage, class TInternalImage = TImage>
virtual void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::TestBandSelection ( std::vector< unsigned int > &  )
inlineprotectedvirtual
template<class TImage , class TInternalImage >
void otb::ImageSeriesFileReaderBase< TImage, TInternalImage >::TestFileExistanceAndReadability ( 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 412 of file otbImageSeriesFileReaderBase.txx.

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

Synchronization

Definition at line 140 of file otbImageSeriesFileReaderBase.h.

Member Data Documentation

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

Definition at line 182 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 189 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 186 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 185 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 187 of file otbImageSeriesFileReaderBase.h.

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

Definition at line 183 of file otbImageSeriesFileReaderBase.h.


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