OTB  6.3.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::ImageFileReader< TOutputImage, ConvertPixelTraits > Class Template Reference

#include <otbImageFileReader.h>

+ Inheritance diagram for otb::ImageFileReader< TOutputImage, ConvertPixelTraits >:
+ Collaboration diagram for otb::ImageFileReader< TOutputImage, ConvertPixelTraits >:

Public Types

typedef
ExtendedFilenameToReaderOptions 
FNameHelperType
 
typedef TOutputImage::RegionType ImageRegionType
 
typedef TOutputImage::IndexType IndexType
 
typedef
TOutputImage::InternalPixelType 
OutputImagePixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ImageFileReader Self
 
typedef TOutputImage::SizeType SizeType
 
typedef itk::ImageSource
< TOutputImage > 
Superclass
 
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
void EnlargeOutputRequestedRegion (itk::DataObject *output) ITK_OVERRIDE
 
void GenerateData () ITK_OVERRIDE
 
void GenerateOutputInformation (void) ITK_OVERRIDE
 
virtual const char * GetFileName () const
 
virtual const char * GetNameOfClass () const
 
unsigned int GetOverviewsCount ()
 
std::vector< std::string > GetOverviewsInfo ()
 
bool GetResolutionsInfo (std::vector< unsigned int > &res, std::vector< std::string > &desc)
 
virtual void SetFileName (const char *extendedFileName)
 
virtual void SetFileName (std::string extendedFileName)
 
void SetImageIO (otb::ImageIOBase *imageIO)
 
 itkGetObjectMacro (ImageIO, otb::ImageIOBase)
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual bool GetReleaseDataFlag () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
void ReleaseDataFlagOff ()
 
void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void DoConvertBuffer (void *buffer, vcl_size_t numberOfPixels)
 
 ImageFileReader ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const ITK_OVERRIDE
 
 ~ImageFileReader () ITK_OVERRIDE
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual ~ImageSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual const char * GetPrimaryOutputName (void) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

std::string GetDerivedDatasetSourceFileName (const std::string &filename) const
 
bool GetGdalReadImageFileName (const std::string &filename, std::string &GdalFileName)
 
 ImageFileReader (const Self &)
 
void operator= (const Self &)
 
void TestValidImageIO ()
 

Private Attributes

itk::ImageIORegion m_ActualIORegion
 
unsigned int m_AdditionalNumber
 
std::vector< unsigned int > m_BandList
 
std::string m_FileName
 
FNameHelperType::Pointer m_FilenameHelper
 
otb::ImageIOBase::Pointer m_ImageIO
 
unsigned int m_IOComponents
 
bool m_KeywordListUpToDate
 
bool m_UserSpecifiedImageIO
 
bool m_UseStreaming
 

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int OutputImageDimension
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
class otb::ImageFileReader< TOutputImage, ConvertPixelTraits >

Reads image data.

ImageFileReader reads its output data from a single output file. It interfaces with an ImageIO class to read in the data and supports streaming (partial reading) if the source dataset does so.

ImageFileReader supports extended filenames, which allow controlling how the source dataset is read. See http://wiki.orfeo-toolbox.org/index.php/ExtendedFileName for more information.

See Also
ExtendedFilenameToReaderOptions
ImageSeriesReader
ImageIOBase
Examples:
ChangeDetection/ChangeDetectionFrameworkExample.cxx, DisparityMap/FineRegistrationImageFilterExample.cxx, DisparityMap/NCCRegistrationFilterExample.cxx, FeatureExtraction/CloudDetectionExample.cxx, FeatureExtraction/ExtractRoadByStepsExample.cxx, FeatureExtraction/ExtractRoadExample.cxx, Fusion/BayesianFusionImageFilter.cxx, Fusion/PanSharpeningExample.cxx, Markov/MarkovClassification1Example.cxx, Markov/MarkovClassification2Example.cxx, Markov/MarkovRegularizationExample.cxx, Markov/MarkovRestorationExample.cxx, Patented/SIFTExample.cxx, Patented/SIFTFastExample.cxx, Projections/OrthoRectificationExample.cxx, Projections/VectorDataExtractROIExample.cxx, Projections/VectorDataProjectionExample.cxx, and Radiometry/AtmosphericCorrectionSequencement.cxx.

Definition at line 91 of file otbImageFileReader.h.

Member Typedef Documentation

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
typedef ExtendedFilenameToReaderOptions otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::FNameHelperType

The Filename Helper.

Definition at line 118 of file otbImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
typedef TOutputImage::RegionType otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::ImageRegionType

The region of the output image.

Definition at line 112 of file otbImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
typedef TOutputImage::IndexType otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::IndexType

The size of the output image.

Definition at line 109 of file otbImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
typedef TOutputImage::InternalPixelType otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::OutputImagePixelType

The pixel type of the output image.

Definition at line 115 of file otbImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
typedef itk::SmartPointer<Self> otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::Pointer

Definition at line 97 of file otbImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
typedef ImageFileReader otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::Self

Standard class typedefs.

Definition at line 95 of file otbImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
typedef TOutputImage::SizeType otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::SizeType

The size of the output image.

Definition at line 103 of file otbImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
typedef itk::ImageSource<TOutputImage> otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::Superclass

Definition at line 96 of file otbImageFileReader.h.

Constructor & Destructor Documentation

template<class TOutputImage , class ConvertPixelTraits >
otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::ImageFileReader ( )
protected

Definition at line 63 of file otbImageFileReader.txx.

template<class TOutputImage , class ConvertPixelTraits >
otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::~ImageFileReader ( )
protected

Definition at line 78 of file otbImageFileReader.txx.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::ImageFileReader ( const Self )
private

Member Function Documentation

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
virtual::itk::LightObject::Pointer otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

template<class TOutputImage , class ConvertPixelTraits >
void otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::DoConvertBuffer ( void *  buffer,
vcl_size_t  numberOfPixels 
)
protected

Convert a block of pixels from one type to another.

Definition at line 727 of file otbImageFileReader.txx.

References OTB_CONVERT_BUFFER_IF_BLOCK, OTB_CONVERT_CBUFFER_IF_BLOCK, itk::ExceptionObject::SetDescription(), and itk::ExceptionObject::SetLocation().

template<class TOutputImage , class ConvertPixelTraits >
void otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::EnlargeOutputRequestedRegion ( itk::DataObject output)
virtual

Give the reader a chance to indicate that it will produce more output than it was requested to produce. ImageFileReader cannot currently read a portion of an image (since the ImageIO objects cannot read a portion of an image), so the ImageFileReader must enlarge the RequestedRegion to the size of the image on disk.

Reimplemented from itk::ProcessObject.

Definition at line 230 of file otbImageFileReader.txx.

template<class TOutputImage , class ConvertPixelTraits >
void otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::GenerateData ( void  )
virtual
template<class TOutputImage , class ConvertPixelTraits >
void otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::GenerateOutputInformation ( void  )
virtual
template<class TOutputImage , class ConvertPixelTraits >
std::string otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetDerivedDatasetSourceFileName ( const std::string &  filename) const
private
template<class TOutputImage , class ConvertPixelTraits >
const char * otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetFileName ( ) const
virtual

Definition at line 698 of file otbImageFileReader.txx.

template<class TOutputImage , class ConvertPixelTraits >
bool otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetGdalReadImageFileName ( const std::string &  filename,
std::string &  GdalFileName 
)
private

Generate the filename (for GDALImageI for example). If filename is a directory, look if is a CEOS product (file "DAT...") In this case, the GdalFileName contain the open image file.

Definition at line 575 of file otbImageFileReader.txx.

References otb::System::GetRootName(), otbMsgDevMacro, and otb::System::Readdir().

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
virtual const char* otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TOutputImage , class ConvertPixelTraits >
unsigned int otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetOverviewsCount ( )

Get the number of overviews available into the file specified Returns: overview count, zero if none.

Definition at line 706 of file otbImageFileReader.txx.

template<class TOutputImage , class ConvertPixelTraits >
std::vector< std::string > otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetOverviewsInfo ( )

Get description about overviews available into the file specified Returns: overview info, empty if none.

Definition at line 717 of file otbImageFileReader.txx.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
bool otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetResolutionsInfo ( std::vector< unsigned int > &  res,
std::vector< std::string > &  desc 
)

Get the resolution information from the file

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::itkGetObjectMacro ( ImageIO  ,
otb::ImageIOBase   
)

Set/Get the ImageIO helper class. Often this is created via the object factory mechanism that determines whether a particular ImageIO can read a certain file. This method provides a way to get the ImageIO instance that is created. Or you can directly specify the ImageIO to use to read a particular file in case the factory mechanism will not work properly (e.g., unknown or unusual extension).

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
static Pointer otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::New ( )
static

Method for creation through the object factory.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
void otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::operator= ( const Self )
private
template<class TOutputImage , class ConvertPixelTraits >
void otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual

Reimplemented from itk::ProcessObject.

Definition at line 84 of file otbImageFileReader.txx.

template<class TOutputImage , class ConvertPixelTraits >
void otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::SetFileName ( const char *  extendedFileName)
virtual

Definition at line 643 of file otbImageFileReader.txx.

template<class TOutputImage , class ConvertPixelTraits >
void otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::SetFileName ( std::string  extendedFileName)
virtual

Definition at line 635 of file otbImageFileReader.txx.

template<class TOutputImage , class ConvertPixelTraits >
void otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::SetImageIO ( otb::ImageIOBase imageIO)

Set/Get the ImageIO helper class. Often this is created via the object factory mechanism that determines whether a particular ImageIO can read a certain file. This method provides a way to get the ImageIO instance that is created. Or you can directly specify the ImageIO to use to read a particular file in case the factory mechanism will not work properly (e.g., unknown or unusual extension).

Definition at line 108 of file otbImageFileReader.txx.

template<class TOutputImage , class ConvertPixelTraits >
void otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::TestValidImageIO ( )
private

Test whether m_ImageIO is valid (not NULL). This is intended to be called after trying to create it via an ImageIOFactory. Throws an exception with an appropriate message otherwise.

Definition at line 554 of file otbImageFileReader.txx.

Member Data Documentation

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
itk::ImageIORegion otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_ActualIORegion
private

Definition at line 195 of file otbImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
unsigned int otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_AdditionalNumber
private

Definition at line 199 of file otbImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
std::vector<unsigned int> otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_BandList
private

Mapping between origin components and output components (before any conversion)

Definition at line 205 of file otbImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
std::string otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_FileName
private

Definition at line 189 of file otbImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
FNameHelperType::Pointer otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_FilenameHelper
private

Definition at line 197 of file otbImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
otb::ImageIOBase::Pointer otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_ImageIO
private

Definition at line 185 of file otbImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
unsigned int otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_IOComponents
private

Store the number of components to be exported to the output image This variable can be the number of components in m_ImageIO or the number of components in the m_BandList (if used)

Definition at line 210 of file otbImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
bool otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_KeywordListUpToDate
private

Definition at line 201 of file otbImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
bool otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_UserSpecifiedImageIO
private

Definition at line 186 of file otbImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
bool otb::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_UseStreaming
private

Definition at line 191 of file otbImageFileReader.h.


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