ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
itk::GE4ImageIO Class Reference
Input and Output Filters | Module ITKIOGE

#include <itkGE4ImageIO.h>

+ Inheritance diagram for itk::GE4ImageIO:
+ Collaboration diagram for itk::GE4ImageIO:

List of all members.

Public Types

typedef SmartPointer< Self > Pointer
typedef GE4ImageIO Self
typedef IPLCommonImageIO Superclass
- Public Types inherited from itk::IPLCommonImageIO
typedef float F32
typedef double F64
typedef signed short S16
typedef signed int S32
typedef int64_t S64
typedef signed char S8
typedef unsigned short U16
typedef unsigned int U32
typedef uint64_t U64
typedef unsigned char U8
- 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 ::itk::intmax_t SizeType
typedef ::itk::SizeValueType SizeValueType
- Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const Self > ConstPointer
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual bool CanReadFile (const char *FileNameToRead)
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
- Public Member Functions inherited from itk::IPLCommonImageIO
virtual bool CanWriteFile (const char *FileNameToWrite)
virtual unsigned int GetComponentSize () const
virtual void ModifyImageInformation ()
virtual void Read (void *buffer)
virtual void ReadImageInformation ()
virtual void SortImageListByNameAscend ()
virtual void SortImageListByNameDescend ()
virtual void Write (const void *buffer)
virtual void WriteImageInformation ()
- 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 IOComponentType GetComponentType () const
virtual const std::type_info & GetComponentTypeInfo () const
virtual std::vector< double > GetDefaultDirection (unsigned int i) const
virtual unsigned int 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, std::vector< double > &direction)
virtual void SetDirection (unsigned int i, vnl_vector< double > &direction)
void SetFileTypeToBinary ()
void SetNumberOfDimensions (unsigned int)
virtual void SetOrigin (unsigned int i, double origin)
template<class 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 bool SupportsDimension (unsigned long dim)
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 ()
virtual void SetPixelType (const IOPixelType _arg)
virtual IOPixelType GetPixelType () const
virtual void SetNumberOfComponents (unsigned int _arg)
virtual const unsigned int & GetNumberOfComponents ()
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 ()
virtual void SetAbortGenerateData (bool _arg)
virtual void UpdateOutputData ()
void UpdateProgress (float amount)
virtual void SetProgress (float _arg)
virtual const float & GetProgress ()
- 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 (void)
const MetaDataDictionary & GetMetaDataDictionary (void) const
virtual unsigned long 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
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () 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 ()

Protected Member Functions

 GE4ImageIO ()
virtual GEImageHeader * ReadHeader (const char *FileNameToRead)
 ~GE4ImageIO ()
- Protected Member Functions inherited from itk::IPLCommonImageIO
int AddElementToList (char const *const filename, const float sliceLocation, const int offset, const int XDim, const int YDim, const float XRes, const float YRes, const int Key1, const int Key2)
int GetDoubleAt (std::ifstream &f, std::streamoff Offset, double *ip, bool throw_exception=true)
int GetFloatAt (std::ifstream &f, std::streamoff Offset, float *ip, bool throw_exception=true)
int GetIntAt (std::ifstream &f, std::streamoff Offset, int *ip, bool throw_exception=true)
int GetShortAt (std::ifstream &f, std::streamoff Offset, short *ip, bool throw_exception=true)
int GetStringAt (std::ifstream &f, std::streamoff Offset, char *buf, vcl_size_t amount, bool throw_exception=true)
double hdr2Double (char *hdr)
float hdr2Float (char *hdr)
int hdr2Int (char *hdr)
short hdr2Short (char *hdr)
 IPLCommonImageIO ()
void PrintSelf (std::ostream &os, Indent indent) const
void sortImageListAscend ()
void sortImageListDescend ()
int statTimeToAscii (void *clock, char *timeString, int len)
 ~IPLCommonImageIO ()
- 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 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 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
 LightProcessObject ()
 ~LightProcessObject ()
virtual void GenerateData ()
- 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

 GE4ImageIO (const Self &)
float MvtSunf (int numb)
void operator= (const Self &)

Additional Inherited Members

- Protected Attributes inherited from itk::IPLCommonImageIO
IPLFileNameList * m_FilenameList
GEImageHeader * m_ImageHeader
ImageIOBase::ByteOrder m_SystemByteOrder
- 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

Detailed Description

Class that defines how to read GE4 file format.

Author:
Hans J. Johnson

Definition at line 57 of file itkGE4ImageIO.h.

Member Typedef Documentation

typedef SmartPointer< Self > itk::GE4ImageIO::Pointer

Reimplemented from itk::IPLCommonImageIO.

Definition at line 63 of file itkGE4ImageIO.h.

typedef GE4ImageIO itk::GE4ImageIO::Self

Standard class typedefs.

Reimplemented from itk::IPLCommonImageIO.

Definition at line 61 of file itkGE4ImageIO.h.

typedef IPLCommonImageIO itk::GE4ImageIO::Superclass

Reimplemented from itk::IPLCommonImageIO.

Definition at line 62 of file itkGE4ImageIO.h.

Constructor & Destructor Documentation

itk::GE4ImageIO::GE4ImageIO ( )
protected

Set the spacing and dimension information for the set filename. Get the type of the pixel. Reads the data from disk into the memory buffer provided. Compute the size (in bytes) of the components of a pixel. For example, and RGB pixel of unsigned char would have a component size of 1 byte.

itk::GE4ImageIO::~GE4ImageIO ( )
protected
itk::GE4ImageIO::GE4ImageIO ( const Self &  )
private

Member Function Documentation

virtual bool itk::GE4ImageIO::CanReadFile ( const char *  FileNameToRead)
virtual

Determine if the file can be read with this ImageIO implementation.

Author:
Hans J Johnson
Parameters:
FileNameToReadThe name of the file to test for reading.
Postcondition:
Sets classes ImageIOBase::m_FileName variable to be FileNameToWrite
Returns:
Returns true if this ImageIO can read the file specified.

Reimplemented from itk::IPLCommonImageIO.

virtual::itk::LightObject::Pointer itk::GE4ImageIO::CreateAnother ( void  ) 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::IPLCommonImageIO.

virtual const char* itk::GE4ImageIO::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::IPLCommonImageIO.

float itk::GE4ImageIO::MvtSunf ( int  numb)
private
static Pointer itk::GE4ImageIO::New ( )
static

Method for creation through the object factory.

Reimplemented from itk::IPLCommonImageIO.

void itk::GE4ImageIO::operator= ( const Self &  )
private

This method causes the filter to generate its output.

Reimplemented from itk::IPLCommonImageIO.

virtual GEImageHeader* itk::GE4ImageIO::ReadHeader ( const char *  FileNameToRead)
protectedvirtual

Reimplemented from itk::IPLCommonImageIO.

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 Wed Jul 11 2012 00:03:58 for ITK by doxygen 1.8.1