OTB  5.0.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::RADImageIO Class Reference

#include <otbRADImageIO.h>

+ Inheritance diagram for otb::RADImageIO:
+ Collaboration diagram for otb::RADImageIO:

Public Types

typedef Superclass::ByteOrder ByteOrder
 
typedef itk::SmartPointer< SelfPointer
 
typedef RADImageIO Self
 
typedef otb::ImageIOBase Superclass
 
- Public Types inherited from otb::ImageIOBase
typedef std::vector< std::string > ArrayOfExtensionsType
 
typedef vcl_size_t BufferSizeType
 
enum  ByteOrder {
  BigEndian,
  LittleEndian,
  OrderNotApplicable
}
 
enum  FileType {
  ASCII,
  Binary,
  TypeNotApplicable
}
 
typedef long IndexValueType
 
enum  IOComponentType {
  UNKNOWNCOMPONENTTYPE,
  UCHAR,
  CHAR,
  USHORT,
  SHORT,
  UINT,
  INT,
  ULONG,
  LONG,
  FLOAT,
  DOUBLE,
  CSHORT,
  CINT,
  CFLOAT,
  CDOUBLE
}
 
enum  IOPixelType {
  UNKNOWNPIXELTYPE,
  SCALAR,
  RGB,
  RGBA,
  OFFSET,
  VECTOR,
  POINT,
  COVARIANTVECTOR,
  SYMMETRICSECONDRANKTENSOR,
  DIFFUSIONTENSOR3D,
  COMPLEX,
  FIXEDARRAY,
  MATRIX
}
 
typedef itk::SmartPointer< SelfPointer
 
typedef ImageIOBase Self
 
typedef std::streamoff SizeType
 
typedef unsigned long SizeValueType
 
typedef itk::LightProcessObject Superclass
 
- Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightProcessObject 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 bool CanReadFile (const char *)
 
virtual bool CanStreamRead ()
 
virtual bool CanStreamWrite ()
 
virtual bool CanWriteFile (const char *)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetOverviewsCount ()
 
virtual std::vector< std::string > GetOverviewsInfo ()
 
virtual void Read (void *buffer)
 
virtual void ReadImageInformation ()
 
virtual void ReadVolume (void *buffer)
 
virtual void SetOutputImagePixelType (bool, bool)
 
virtual void Write (const void *buffer)
 
virtual void WriteImageInformation ()
 
- Public Member Functions inherited from otb::ImageIOBase
virtual itk::ImageIORegion GenerateStreamableReadRegionFromRequestedRegion (const itk::ImageIORegion &requested) const
 
virtual unsigned int GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const itk::ImageIORegion &pasteRegion, const itk::ImageIORegion &largestPossibleRegion)
 
std::string GetByteOrderAsString (ByteOrder) const
 
virtual unsigned int GetComponentSize () const
 
std::string GetComponentTypeAsString (IOComponentType) const
 
virtual std::vector< double > GetDefaultDirection (unsigned int i) const
 
std::string GetFileTypeAsString (FileType) const
 
SizeType GetImageSizeInBytes () const
 
SizeType GetImageSizeInComponents () const
 
SizeType GetImageSizeInPixels () const
 
virtual SizeType GetPixelStride () const
 
std::string GetPixelTypeAsString (IOPixelType) const
 
virtual itk::ImageIORegion GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const itk::ImageIORegion &pasteRegion, const itk::ImageIORegion &largestPossibleRegion)
 
const ArrayOfExtensionsTypeGetSupportedReadExtensions () const
 
const ArrayOfExtensionsTypeGetSupportedWriteExtensions () const
 
virtual bool SetPixelTypeInfo (const std::type_info &ptype)
 
virtual bool SupportsDimension (unsigned long dim)
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
void SetNumberOfDimensions (unsigned int)
 
virtual unsigned int GetNumberOfDimensions () const
 
virtual void SetDimensions (unsigned int i, unsigned int dim)
 
virtual unsigned int GetDimensions (unsigned int i) const
 
virtual void SetOrigin (unsigned int i, double origin)
 
virtual double GetOrigin (unsigned int i) const
 
virtual void SetSpacing (unsigned int i, double spacing)
 
virtual double GetSpacing (unsigned int i) const
 
virtual void SetDirection (unsigned int i, std::vector< double > &direction)
 
virtual void SetDirection (unsigned int i, vnl_vector< double > &direction)
 
virtual std::vector< double > GetDirection (unsigned int i) const
 
virtual void SetIORegion (itk::ImageIORegion _arg)
 
virtual const itk::ImageIORegionGetIORegion () const
 
virtual void SetPixelType (const IOPixelType _arg)
 
virtual IOPixelType GetPixelType () const
 
virtual void SetComponentType (const IOComponentType _arg)
 
virtual IOComponentType GetComponentType () const
 
virtual const std::type_info & GetComponentTypeInfo () const
 
virtual void SetNumberOfComponents (unsigned int _arg)
 
virtual const unsigned int & GetNumberOfComponents () const
 
virtual void SetUseCompression (bool _arg)
 
virtual bool GetUseCompression () const
 
virtual void UseCompressionOn ()
 
virtual void UseCompressionOff ()
 
virtual void SetUseStreamedReading (bool _arg)
 
virtual bool GetUseStreamedReading () const
 
virtual void UseStreamedReadingOn ()
 
virtual void UseStreamedReadingOff ()
 
virtual void SetUseStreamedWriting (bool _arg)
 
virtual bool GetUseStreamedWriting () const
 
virtual void UseStreamedWritingOn ()
 
virtual void UseStreamedWritingOff ()
 
virtual void SetFileType (const FileType _arg)
 
virtual FileType GetFileType () const
 
void SetFileTypeToASCII ()
 
void SetFileTypeToBinary ()
 
virtual void SetByteOrder (const ByteOrder _arg)
 
virtual ByteOrder GetByteOrder () const
 
void SetByteOrderToBigEndian ()
 
void SetByteOrderToLittleEndian ()
 
- Public Member Functions inherited from itk::LightProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
virtual const float & GetProgress () const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetProgress (float _arg)
 
virtual void UpdateOutputData ()
 
void UpdateProgress (float amount)
 
- 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 (void) const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
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 ITK_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) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
- 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::LightProcessObject
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 InternalReadImageInformation ()
 
bool OpenOneraDataFileForReading (const char *filename)
 
bool OpenOneraDataFileForWriting (const char *filename)
 
bool OpenOneraHeaderFileForReading (const char *filename)
 
bool OpenOneraHeaderFileForWriting (const char *filename)
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 
 RADImageIO ()
 
virtual ~RADImageIO ()
 
- Protected Member Functions inherited from otb::ImageIOBase
void AddSupportedReadExtension (const char *extension)
 
void AddSupportedWriteExtension (const char *extension)
 
void ComputeStrides ()
 
virtual unsigned int GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const itk::ImageIORegion &pasteRegion) const
 
SizeType GetComponentStride () const
 
virtual unsigned int GetPixelSize () const
 
SizeType GetRowStride () const
 
SizeType GetSliceStride () const
 
virtual itk::ImageIORegion GetSplitRegionForWritingCanStreamWrite (unsigned int ithPiece, unsigned int numberOfActualSplits, const itk::ImageIORegion &pasteRegion) const
 
 ImageIOBase ()
 
void ReadBufferAsASCII (std::istream &os, void *buffer, IOComponentType ctype, SizeType numberOfBytesToBeRead)
 
bool ReadBufferAsBinary (std::istream &os, void *buffer, SizeType numberOfBytesToBeRead)
 
virtual void Reset (const bool freeDynamic=true)
 
void Resize (const unsigned int numDimensions, const unsigned int *dimensions)
 
void WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentType ctype, SizeType numberOfBytesToWrite)
 
virtual ~ImageIOBase ()
 
- Protected Member Functions inherited from itk::LightProcessObject
virtual void GenerateData ()
 
 LightProcessObject ()
 
 ~LightProcessObject ()
 
- 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

bool InternalReadHeaderInformation (const std::string &file_name, std::fstream &file, const bool reportError)
 
void operator= (const Self &)
 
 RADImageIO (const Self &)
 

Private Attributes

int m_BytePerPixel
 
std::fstream * m_ChannelsFile
 
std::vector< std::string > m_ChannelsFileName
 
otb::ImageIOBase::ByteOrder m_FileByteOrder
 
bool m_FlagWriteImageInformation
 
std::fstream m_HeaderFile
 
unsigned int m_NbOfChannels
 
std::string m_TypeRAD
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from otb::ImageIOBase
ByteOrder m_ByteOrder
 
IOComponentType m_ComponentType
 
std::vector< SizeValueTypem_Dimensions
 
std::vector< std::vector
< double > > 
m_Direction
 
std::string m_FileName
 
FileType m_FileType
 
bool m_Initialized
 
itk::ImageIORegion m_IORegion
 
unsigned int m_NumberOfComponents
 
unsigned int m_NumberOfDimensions
 
std::vector< double > m_Origin
 
IOPixelType m_PixelType
 
std::vector< double > m_Spacing
 
std::vector< SizeTypem_Strides
 
bool m_UseCompression
 
bool m_UseStreamedReading
 
bool m_UseStreamedWriting
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Detailed Description

ImageIO object for reading (not writing) RAD format images.

The streaming read is implemented.

Definition at line 40 of file otbRADImageIO.h.

Member Typedef Documentation

typedef Superclass::ByteOrder otb::RADImageIO::ByteOrder

Byte order typedef

Definition at line 50 of file otbRADImageIO.h.

Definition at line 47 of file otbRADImageIO.h.

Standard class typedefs.

Definition at line 45 of file otbRADImageIO.h.

Definition at line 46 of file otbRADImageIO.h.

Constructor & Destructor Documentation

otb::RADImageIO::RADImageIO ( )
protected

Constructor.

virtual otb::RADImageIO::~RADImageIO ( )
protectedvirtual

Destructor.

otb::RADImageIO::RADImageIO ( const Self )
private

Member Function Documentation

virtual bool otb::RADImageIO::CanReadFile ( const char *  )
virtual

Determine the file type. Returns true if this ImageIO can read the file specified.

Implements otb::ImageIOBase.

virtual bool otb::RADImageIO::CanStreamRead ( )
inlinevirtual

Determine the file type. Returns true if the ImageIO can stream read the specified file

Reimplemented from otb::ImageIOBase.

Definition at line 65 of file otbRADImageIO.h.

virtual bool otb::RADImageIO::CanStreamWrite ( )
inlinevirtual

Determine the file type. Returns true if the ImageIO can stream write the specified file

Reimplemented from otb::ImageIOBase.

Definition at line 86 of file otbRADImageIO.h.

virtual bool otb::RADImageIO::CanWriteFile ( const char *  )
virtual

Determine the file type. Returns true if this ImageIO can read the file specified.

Implements otb::ImageIOBase.

virtual::itk::LightObject::Pointer otb::RADImageIO::CreateAnother ( void  ) const
virtual

Reimplemented from itk::LightProcessObject.

virtual const char* otb::RADImageIO::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from otb::ImageIOBase.

virtual unsigned int otb::RADImageIO::GetOverviewsCount ( )
inlinevirtual

Get the number of overviews available into the file specified This imageIO didn't support overviews

Implements otb::ImageIOBase.

Definition at line 104 of file otbRADImageIO.h.

virtual std::vector<std::string> otb::RADImageIO::GetOverviewsInfo ( )
inlinevirtual

Get information about overviews available into the file specified This imageIO didn't support overviews

Implements otb::ImageIOBase.

Definition at line 111 of file otbRADImageIO.h.

bool otb::RADImageIO::InternalReadHeaderInformation ( const std::string &  file_name,
std::fstream &  file,
const bool  reportError 
)
private

Internal method to read header informations

void otb::RADImageIO::InternalReadImageInformation ( )
protected
static Pointer otb::RADImageIO::New ( )
static

Method for creation through the object factory.

bool otb::RADImageIO::OpenOneraDataFileForReading ( const char *  filename)
protected
bool otb::RADImageIO::OpenOneraDataFileForWriting ( const char *  filename)
protected
bool otb::RADImageIO::OpenOneraHeaderFileForReading ( const char *  filename)
protected
bool otb::RADImageIO::OpenOneraHeaderFileForWriting ( const char *  filename)
protected
void otb::RADImageIO::operator= ( const Self )
private
void otb::RADImageIO::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual

Reimplemented from otb::ImageIOBase.

virtual void otb::RADImageIO::Read ( void *  buffer)
virtual

Reads the data from disk into the memory buffer provided.

Implements otb::ImageIOBase.

virtual void otb::RADImageIO::ReadImageInformation ( )
virtual

Set the spacing and dimention information for the set filename.

Implements otb::ImageIOBase.

virtual void otb::RADImageIO::ReadVolume ( void *  buffer)
virtual

Reads 3D data from multiple files assuming one slice per file.

virtual void otb::RADImageIO::SetOutputImagePixelType ( bool  ,
bool   
)
inlinevirtual

Provide hist about the output container to deal with complex pixel type (Not used here)

Implements otb::ImageIOBase.

Definition at line 119 of file otbRADImageIO.h.

virtual void otb::RADImageIO::Write ( const void *  buffer)
virtual

Writes the data to disk from the memory buffer provided. Make sure that the IORegion has been set properly.

Implements otb::ImageIOBase.

virtual void otb::RADImageIO::WriteImageInformation ( )
virtual

Writes the spacing and dimentions of the image. Assumes SetFileName has been called with a valid file name.

Implements otb::ImageIOBase.

Member Data Documentation

int otb::RADImageIO::m_BytePerPixel
private

Definition at line 181 of file otbRADImageIO.h.

std::fstream* otb::RADImageIO::m_ChannelsFile
private

Definition at line 179 of file otbRADImageIO.h.

std::vector<std::string> otb::RADImageIO::m_ChannelsFileName
private

Definition at line 178 of file otbRADImageIO.h.

otb::ImageIOBase::ByteOrder otb::RADImageIO::m_FileByteOrder
private

Definition at line 175 of file otbRADImageIO.h.

bool otb::RADImageIO::m_FlagWriteImageInformation
private

Definition at line 174 of file otbRADImageIO.h.

std::fstream otb::RADImageIO::m_HeaderFile
private

Definition at line 176 of file otbRADImageIO.h.

unsigned int otb::RADImageIO::m_NbOfChannels
private

Definition at line 180 of file otbRADImageIO.h.

std::string otb::RADImageIO::m_TypeRAD
private

Definition at line 177 of file otbRADImageIO.h.


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