ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::RawImageIO< TPixel, VImageDimension > Class Template Reference
Input and Output Filters | Module ITKIORAW

#include <itkRawImageIO.h>

+ Inheritance diagram for itk::RawImageIO< TPixel, VImageDimension >:
+ Collaboration diagram for itk::RawImageIO< TPixel, VImageDimension >:

Detailed Description

template<typename TPixel, unsigned int VImageDimension = 2>
class itk::RawImageIO< TPixel, VImageDimension >

Read and write raw binary images.

This class reads and writes 2D or 3D images. Because raw data has little useful information built into the format, the user is responsible for specifying pixel type, dimensions, spacing, origin, header type, and so on. (Note: the pixel type and image dimension is defined via the template parameter.)

See Also
ImageFileReader
Examples:
Examples/IO/VisibleHumanStreamReadWrite.cxx.

Definition at line 48 of file itkRawImageIO.h.

Public Types

typedef ByteSwapper
< ComponentType > 		ByteSwapperType
 
typedef PixelTraits< PixelType >
::ValueType 		ComponentType
 
typedef TPixel PixelType
 
typedef SmartPointer< Self > Pointer
 
typedef RawImageIO Self
 
typedef Superclass::SizeValueType SizeValueType
 
typedef ImageIOBase Superclass
 
- Public Types inherited from itk::ImageIOBase
typedef std::vector< std::string > ArrayOfExtensionsType
 
typedef ::itk::OffsetValueType BufferSizeType
 
enum  ByteOrder {
  BigEndian,
  LittleEndian,
  OrderNotApplicable
}
 
enum  FileType {
  ASCII,
  Binary,
  TypeNotApplicable
}
 
typedef ::itk::IndexValueType IndexValueType
 
enum  IOComponentType {
  UNKNOWNCOMPONENTTYPE,
  UCHAR,
  CHAR,
  USHORT,
  SHORT,
  UINT,
  INT,
  ULONG,
  LONG,
  FLOAT,
  DOUBLE
}
 
enum  IOPixelType {
  UNKNOWNPIXELTYPE,
  SCALAR,
  RGB,
  RGBA,
  OFFSET,
  VECTOR,
  POINT,
  COVARIANTVECTOR,
  SYMMETRICSECONDRANKTENSOR,
  DIFFUSIONTENSOR3D,
  COMPLEX,
  FIXEDARRAY,
  MATRIX
}
 
typedef SmartPointer< Self > Pointer
 
typedef ImageIOBase Self
 
typedef ::itk::intmax_t SizeType
 
typedef ::itk::SizeValueType SizeValueType
 
typedef LightProcessObject Superclass
 
- Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef LightProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef LightObject Self
 

Public Member Functions

virtual bool CanReadFile (const char *) override
 
virtual bool CanWriteFile (const char *) override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
SizeValueType GetHeaderSize ()
 
virtual const char * GetNameOfClass () const
 
virtual void Read (void *buffer) override
 
virtual void ReadHeader (const std::string=std::string())
 
virtual void ReadImageInformation () override
 
void SetHeaderSize (SizeValueType size)
 
virtual bool SupportsDimension (unsigned long dim) override
 
virtual void Write (const void *buffer) override
 
virtual void WriteImageInformation (void) override
 
virtual void SetFileDimensionality (unsigned long _arg)
 
virtual unsigned long GetFileDimensionality () const
 
virtual const unsigned short & GetImageMask () const
 
void SetImageMask (unsigned long val)
 
- Public Member Functions inherited from itk::ImageIOBase
virtual bool CanStreamRead ()
 
virtual bool CanStreamWrite ()
 
virtual ImageIORegion GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requested) const
 
virtual unsigned int GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
 
std::string GetByteOrderAsString (ByteOrder) const
 
virtual unsigned int GetComponentSize () const
 
virtual IOComponentType GetComponentType () const
 
virtual const std::type_info & GetComponentTypeInfo () const
 
virtual std::vector< double > GetDefaultDirection (unsigned int i) const
 
virtual itk::SizeValueType GetDimensions (unsigned int i) const
 
virtual std::vector< double > GetDirection (unsigned int i) const
 
std::string GetFileTypeAsString (FileType) const
 
SizeType GetImageSizeInBytes () const
 
SizeType GetImageSizeInComponents () const
 
SizeType GetImageSizeInPixels () const
 
virtual unsigned int GetNumberOfDimensions () const
 
virtual double GetOrigin (unsigned int i) const
 
virtual SizeType GetPixelStride () const
 
virtual double GetSpacing (unsigned int i) const
 
virtual ImageIORegion GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
 
const ArrayOfExtensionsType & GetSupportedReadExtensions () const
 
const ArrayOfExtensionsType & GetSupportedWriteExtensions () const
 
void SetByteOrderToLittleEndian ()
 
virtual void SetComponentType (const IOComponentType _arg)
 
virtual void SetDirection (unsigned int i, const std::vector< double > &direction)
 
virtual void SetDirection (unsigned int i, const vnl_vector< double > &direction)
 
void SetFileTypeToBinary ()
 
void SetNumberOfDimensions (unsigned int)
 
virtual void SetOrigin (unsigned int i, double origin)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const SymmetricSecondRankTensor< TPixel, VLength > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const DiffusionTensor3D< TPixel > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const Matrix< TPixel, VLength, VLength > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const std::complex< TPixel > *)
 
template<unsigned VLength>
void SetPixelTypeInfo (const Offset< VLength > *)
 
virtual void SetSpacing (unsigned int i, double spacing)
 
template<typename TPixel >
void SetTypeInfo (const TPixel *)
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
virtual void SetDimensions (unsigned int i, unsigned int dim)
 
virtual void SetIORegion (ImageIORegion _arg)
 
virtual const ImageIORegion & GetIORegion () const
 
virtual void SetPixelType (const IOPixelType _arg)
 
virtual IOPixelType GetPixelType () 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 ()
 
virtual void SetByteOrder (const ByteOrder _arg)
 
virtual ByteOrder GetByteOrder () const
 
void SetByteOrderToBigEndian ()
 
template<typename TPixel >
void SetPixelTypeInfo (const TPixel *)
 
template<typename TPixel >
void SetPixelTypeInfo (const RGBPixel< TPixel > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const RGBAPixel< TPixel > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const Vector< TPixel, VLength > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const VariableLengthVector< TPixel > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const CovariantVector< TPixel, VLength > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const FixedArray< TPixel, VLength > *)
 
- Public Member Functions inherited from itk::LightProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void UpdateOutputData ()
 
void UpdateProgress (float amount)
 
virtual void SetProgress (float _arg)
 
virtual const float & GetProgress () const
 
- 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
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () 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 SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- 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::ImageIOBase
static std::string GetComponentTypeAsString (IOComponentType)
 
static IOComponentType GetComponentTypeFromString (const std::string &typeString)
 
static std::string GetPixelTypeAsString (IOPixelType)
 
static IOPixelType GetPixelTypeFromString (const std::string &pixelString)
 
- 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

virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 RawImageIO ()
 
 ~RawImageIO ()
 
- Protected Member Functions inherited from itk::ImageIOBase
void AddSupportedReadExtension (const char *extension)
 
void AddSupportedWriteExtension (const char *extension)
 
void ComputeStrides ()
 
virtual unsigned int GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion) const
 
SizeType GetComponentStride () const
 
virtual const
ImageRegionSplitterBase * 		GetImageRegionSplitter () const
 
virtual unsigned int GetPixelSize () const
 
SizeType GetRowStride () const
 
SizeType GetSliceStride () const
 
virtual ImageIORegion GetSplitRegionForWritingCanStreamWrite (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion) const
 
 ImageIOBase ()
 
virtual void OpenFileForReading (std::ifstream &inputStream, const std::string &filename, bool ascii=false)
 
virtual void OpenFileForWriting (std::ofstream &outputStream, const std::string &filename, bool truncate=true, bool ascii=false)
 
virtual 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)
 
virtual void WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentType ctype, SizeType numberOfBytesToWrite)
 
 ~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

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

Private Attributes

unsigned long m_FileDimensionality
 
SizeValueType m_HeaderSize
 
unsigned short m_ImageMask
 
std::string m_InternalFileName
 
bool m_ManualHeaderSize
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageIOBase
ByteOrder m_ByteOrder
 
IOComponentType m_ComponentType
 
std::vector< SizeValueType > m_Dimensions
 
std::vector< std::vector
< double > > 		m_Direction
 
std::string m_FileName
 
FileType m_FileType
 
bool m_Initialized
 
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< SizeType > m_Strides
 
bool m_UseCompression
 
bool m_UseStreamedReading
 
bool m_UseStreamedWriting
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TPixel , unsigned int VImageDimension = 2>
typedef ByteSwapper< ComponentType > itk::RawImageIO< TPixel, VImageDimension >::ByteSwapperType

Helper class to swap bytes when necessary

Definition at line 73 of file itkRawImageIO.h.

template<typename TPixel , unsigned int VImageDimension = 2>
typedef PixelTraits< PixelType >::ValueType itk::RawImageIO< TPixel, VImageDimension >::ComponentType

this type is used in case the pixel has several components

Definition at line 70 of file itkRawImageIO.h.

template<typename TPixel , unsigned int VImageDimension = 2>
typedef TPixel itk::RawImageIO< TPixel, VImageDimension >::PixelType

Pixel typedef support. Used to declare pixel type in filters or other operations.

Definition at line 60 of file itkRawImageIO.h.

template<typename TPixel , unsigned int VImageDimension = 2>
typedef SmartPointer< Self > itk::RawImageIO< TPixel, VImageDimension >::Pointer

Definition at line 54 of file itkRawImageIO.h.

template<typename TPixel , unsigned int VImageDimension = 2>
typedef RawImageIO itk::RawImageIO< TPixel, VImageDimension >::Self

Standard class typedefs.

Definition at line 52 of file itkRawImageIO.h.

template<typename TPixel , unsigned int VImageDimension = 2>
typedef Superclass::SizeValueType itk::RawImageIO< TPixel, VImageDimension >::SizeValueType

Type used for counting elements.

Definition at line 67 of file itkRawImageIO.h.

template<typename TPixel , unsigned int VImageDimension = 2>
typedef ImageIOBase itk::RawImageIO< TPixel, VImageDimension >::Superclass

Definition at line 53 of file itkRawImageIO.h.

Constructor & Destructor Documentation

template<typename TPixel , unsigned int VImageDimension = 2>
itk::RawImageIO< TPixel, VImageDimension >::RawImageIO ( )
protected
template<typename TPixel , unsigned int VImageDimension = 2>
itk::RawImageIO< TPixel, VImageDimension >::~RawImageIO ( )
protected
template<typename TPixel , unsigned int VImageDimension = 2>
itk::RawImageIO< TPixel, VImageDimension >::RawImageIO ( const Self &  )
private

Member Function Documentation

template<typename TPixel , unsigned int VImageDimension = 2>
virtual bool itk::RawImageIO< TPixel, VImageDimension >::CanReadFile ( const char *  )
inlineoverridevirtual

Determine the file type. Returns true if this ImageIOBase can read the file specified. Always returns false because we don't want to use this reader unless absolutely sure (i.e., manual ImageIO creation).

Implements itk::ImageIOBase.

Definition at line 101 of file itkRawImageIO.h.

template<typename TPixel , unsigned int VImageDimension = 2>
virtual bool itk::RawImageIO< TPixel, VImageDimension >::CanWriteFile ( const char *  )
overridevirtual

Returns true if this ImageIO can write the specified file. False is only returned when the file name is not specified. Otherwise true is always returned.

Implements itk::ImageIOBase.

template<typename TPixel , unsigned int VImageDimension = 2>
virtual::itk::LightObject::Pointer itk::RawImageIO< TPixel, VImageDimension >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightProcessObject.

template<typename TPixel , unsigned int VImageDimension = 2>
virtual unsigned long itk::RawImageIO< TPixel, VImageDimension >::GetFileDimensionality ( ) const
virtual

The number of dimensions stored in a file. Defaults to two. If two, each file contains one "slice". If three, each file will contain one "volume".

template<typename TPixel , unsigned int VImageDimension = 2>
SizeValueType itk::RawImageIO< TPixel, VImageDimension >::GetHeaderSize ( )
template<typename TPixel , unsigned int VImageDimension = 2>
virtual const unsigned short& itk::RawImageIO< TPixel, VImageDimension >::GetImageMask ( ) const
virtual

Set/Get the Data mask.

template<typename TPixel , unsigned int VImageDimension = 2>
virtual const char* itk::RawImageIO< TPixel, VImageDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

template<typename TPixel , unsigned int VImageDimension = 2>
static Pointer itk::RawImageIO< TPixel, VImageDimension >::New ( )
static

Method for creation through the object factory.

template<typename TPixel , unsigned int VImageDimension = 2>
void itk::RawImageIO< TPixel, VImageDimension >::operator= ( const Self &  )
private
template<typename TPixel , unsigned int VImageDimension = 2>
virtual void itk::RawImageIO< TPixel, VImageDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageIOBase.

template<typename TPixel , unsigned int VImageDimension = 2>
virtual void itk::RawImageIO< TPixel, VImageDimension >::Read ( void *  buffer)
overridevirtual

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

template<typename TPixel , unsigned int VImageDimension = 2>
virtual void itk::RawImageIO< TPixel, VImageDimension >::ReadHeader ( const std::string  = std::string())
inlinevirtual

Read a file's header to determine image dimensions, etc.

Definition at line 121 of file itkRawImageIO.h.

template<typename TPixel , unsigned int VImageDimension = 2>
virtual void itk::RawImageIO< TPixel, VImageDimension >::ReadImageInformation ( )
inlineoverridevirtual

Binary files have no image information to read. This must be set by the user of the class.

Implements itk::ImageIOBase.

Definition at line 105 of file itkRawImageIO.h.

template<typename TPixel , unsigned int VImageDimension = 2>
virtual void itk::RawImageIO< TPixel, VImageDimension >::SetFileDimensionality ( unsigned long  _arg)
virtual

The number of dimensions stored in a file. Defaults to two. If two, each file contains one "slice". If three, each file will contain one "volume".

template<typename TPixel , unsigned int VImageDimension = 2>
void itk::RawImageIO< TPixel, VImageDimension >::SetHeaderSize ( SizeValueType  size)

If the data is in the tail end of the file, you want to explicitly set the header size.

template<typename TPixel , unsigned int VImageDimension = 2>
void itk::RawImageIO< TPixel, VImageDimension >::SetImageMask ( unsigned long  val)
inline

Set/Get the Data mask.

Definition at line 112 of file itkRawImageIO.h.

References itk::RawImageIO< TPixel, VImageDimension >::m_ImageMask, and itk::Object::Modified().

template<typename TPixel , unsigned int VImageDimension = 2>
virtual bool itk::RawImageIO< TPixel, VImageDimension >::SupportsDimension ( unsigned long  dim)
inlineoverridevirtual

The different types of ImageIO's can support data of varying dimensionality. For example, some file formats are strictly 2D while others can support 2D, 3D, or even n-D. This method returns true/false as to whether the ImageIO can support the dimension indicated.

Reimplemented from itk::ImageIOBase.

Definition at line 93 of file itkRawImageIO.h.

References itk::RawImageIO< TPixel, VImageDimension >::m_FileDimensionality.

template<typename TPixel , unsigned int VImageDimension = 2>
virtual void itk::RawImageIO< TPixel, VImageDimension >::Write ( const void *  buffer)
overridevirtual

Writes the data to disk from the memory buffer provided.

Implements itk::ImageIOBase.

template<typename TPixel , unsigned int VImageDimension = 2>
virtual void itk::RawImageIO< TPixel, VImageDimension >::WriteImageInformation ( void  )
inlineoverridevirtual

Binary files have no image information to read.

Implements itk::ImageIOBase.

Definition at line 131 of file itkRawImageIO.h.

Member Data Documentation

template<typename TPixel , unsigned int VImageDimension = 2>
unsigned long itk::RawImageIO< TPixel, VImageDimension >::m_FileDimensionality
private

Definition at line 149 of file itkRawImageIO.h.

Referenced by itk::RawImageIO< TPixel, VImageDimension >::SupportsDimension().

template<typename TPixel , unsigned int VImageDimension = 2>
SizeValueType itk::RawImageIO< TPixel, VImageDimension >::m_HeaderSize
private

Definition at line 151 of file itkRawImageIO.h.

template<typename TPixel , unsigned int VImageDimension = 2>
unsigned short itk::RawImageIO< TPixel, VImageDimension >::m_ImageMask
private

Definition at line 152 of file itkRawImageIO.h.

Referenced by itk::RawImageIO< TPixel, VImageDimension >::SetImageMask().

template<typename TPixel , unsigned int VImageDimension = 2>
std::string itk::RawImageIO< TPixel, VImageDimension >::m_InternalFileName
private

Definition at line 147 of file itkRawImageIO.h.

template<typename TPixel , unsigned int VImageDimension = 2>
bool itk::RawImageIO< TPixel, VImageDimension >::m_ManualHeaderSize
private

Definition at line 150 of file itkRawImageIO.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Fri Jul 3 2015 04:24:44 for ITK by   doxygen 1.8.5