Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::IPLCommonImageIO Class Reference

Class that defines how to read GE4 file format. More...

#include <itkIPLCommonImageIO.h>

Inheritance diagram for itk::IPLCommonImageIO:

Inheritance graph
[legend]
Collaboration diagram for itk::IPLCommonImageIO:

Collaboration graph
[legend]
List of all members.

Public Types

typedef IPLCommonImageIO Self
typedef ImageIOBase Superclass
typedef SmartPointer< SelfPointer
typedef unsigned char U8
typedef signed char S8
typedef unsigned short U16
typedef signed short S16
typedef unsigned int U32
typedef signed int S32
typedef unsigned long U64
typedef signed long S64
typedef float F32
typedef double F64
typedef FILESORTINFOSTRUCT FILESORTINFO
enum  ENUM_PLANE_SELECTION {
  NO_PLANE = 0, AXIAL = 1, CORONAL = 2, SAGITTAL = 3,
  UNKNOWN_PLANE = 5
}

Public Member Functions

virtual const char * GetClassName () const
virtual bool CanReadFile (const char *FileNameToRead)
virtual void ReadImageInformation ()
virtual const std::type_info & GetPixelType () const
virtual void Read (void *buffer)
virtual unsigned int GetComponentSize () const
virtual bool CanWriteFile (const char *FileNameToWrite)
virtual void WriteImageInformation ()
virtual void Write (const void *buffer)

Static Public Member Functions

Pointer New ()

Protected Types

typedef FILENAMELISTSTRUCT FILENAMELIST

Protected Member Functions

 IPLCommonImageIO ()
 ~IPLCommonImageIO ()
void PrintSelf (std::ostream &os, Indent indent) const
void InitializeFILENAMELIST (FILENAMELIST *const fnList)
int AddElementToList (FILENAMELIST *const fnList, char const *const filename, const float sliceLocation, const int offset, const int XDim, const int YDim, const int Key1, const int Key2)
void sortImageListAscend (FILENAMELIST *const fnList)
void sortImageListDescend (FILENAMELIST *const fnList)
int statTimeToAscii (void *clock, char *timeString)
virtual struct GEImageHeaderReadHeader (const char *FileNameToRead)
int GetStringAt (std::ifstream &f, std::streamoff Offset, char *buf, vcl_size_t amount, 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 GetFloatAt (std::ifstream &f, std::streamoff Offset, float *ip, bool throw_exception=true)
int GetDoubleAt (std::ifstream &f, std::streamoff Offset, double *ip, bool throw_exception=true)
short hdr2Short (char *hdr)
int hdr2Int (char *hdr)
float hdr2Float (char *hdr)
double hdr2Double (char *hdr)

Protected Attributes

GEImageHeaderm_ImageHeader
ImageIOBase::ByteOrder m_system_byteOrder
FILENAMELIST m_fnlist

Detailed Description

Class that defines how to read GE4 file format.

Author:
Hans J. Johnson

Definition at line 46 of file itkIPLCommonImageIO.h.


Member Typedef Documentation

typedef float itk::IPLCommonImageIO::F32
 

Definition at line 62 of file itkIPLCommonImageIO.h.

typedef double itk::IPLCommonImageIO::F64
 

Definition at line 63 of file itkIPLCommonImageIO.h.

typedef struct FILENAMELISTSTRUCT itk::IPLCommonImageIO::FILENAMELIST [protected]
 

Definition at line 147 of file itkIPLCommonImageIO.h.

typedef struct FILESORTINFOSTRUCT itk::IPLCommonImageIO::FILESORTINFO
 

Definition at line 128 of file itkIPLCommonImageIO.h.

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

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::GE4ImageIO, itk::GE5ImageIO, itk::GEAdwImageIO, and itk::SiemensVisionImageIO.

Definition at line 53 of file itkIPLCommonImageIO.h.

typedef signed short itk::IPLCommonImageIO::S16
 

Definition at line 57 of file itkIPLCommonImageIO.h.

typedef signed int itk::IPLCommonImageIO::S32
 

Definition at line 59 of file itkIPLCommonImageIO.h.

typedef signed long itk::IPLCommonImageIO::S64
 

Definition at line 61 of file itkIPLCommonImageIO.h.

typedef signed char itk::IPLCommonImageIO::S8
 

Definition at line 55 of file itkIPLCommonImageIO.h.

typedef IPLCommonImageIO itk::IPLCommonImageIO::Self
 

Standard class typedefs.

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::GE4ImageIO, itk::GE5ImageIO, itk::GEAdwImageIO, and itk::SiemensVisionImageIO.

Definition at line 51 of file itkIPLCommonImageIO.h.

typedef ImageIOBase itk::IPLCommonImageIO::Superclass
 

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::GE4ImageIO, itk::GE5ImageIO, itk::GEAdwImageIO, and itk::SiemensVisionImageIO.

Definition at line 52 of file itkIPLCommonImageIO.h.

typedef unsigned short itk::IPLCommonImageIO::U16
 

Definition at line 56 of file itkIPLCommonImageIO.h.

typedef unsigned int itk::IPLCommonImageIO::U32
 

Definition at line 58 of file itkIPLCommonImageIO.h.

typedef unsigned long itk::IPLCommonImageIO::U64
 

Definition at line 60 of file itkIPLCommonImageIO.h.

typedef unsigned char itk::IPLCommonImageIO::U8
 

Definition at line 54 of file itkIPLCommonImageIO.h.


Member Enumeration Documentation

enum itk::IPLCommonImageIO::ENUM_PLANE_SELECTION
 

Enumeration values:
NO_PLANE 
AXIAL 
CORONAL 
SAGITTAL 
UNKNOWN_PLANE 
Definition at line 111 of file itkIPLCommonImageIO.h.


Constructor & Destructor Documentation

itk::IPLCommonImageIO::IPLCommonImageIO  )  [protected]
 

itk::IPLCommonImageIO::~IPLCommonImageIO  )  [protected]
 


Member Function Documentation

int itk::IPLCommonImageIO::AddElementToList FILENAMELIST *const  fnList,
char const *const  filename,
const float  sliceLocation,
const int  offset,
const int  XDim,
const int  YDim,
const int  Key1,
const int  Key2
[protected]
 

virtual bool itk::IPLCommonImageIO::CanReadFile const char *  FileNameToRead  )  [virtual]
 

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

Author:
Hans J Johnson
Parameters:
FileNameToRead The 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.

Implements itk::ImageIOBase.

Reimplemented in itk::GE4ImageIO, itk::GE5ImageIO, itk::GEAdwImageIO, and itk::SiemensVisionImageIO.

virtual bool itk::IPLCommonImageIO::CanWriteFile const char *  FileNameToWrite  )  [virtual]
 

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

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

Implements itk::ImageIOBase.

virtual const char* itk::IPLCommonImageIO::GetClassName  )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::GE4ImageIO, itk::GE5ImageIO, itk::GEAdwImageIO, and itk::SiemensVisionImageIO.

virtual unsigned int itk::IPLCommonImageIO::GetComponentSize  )  const [virtual]
 

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.

Reimplemented from itk::ImageIOBase.

int itk::IPLCommonImageIO::GetDoubleAt std::ifstream &  f,
std::streamoff  Offset,
double *  ip,
bool  throw_exception = true
[protected]
 

int itk::IPLCommonImageIO::GetFloatAt std::ifstream &  f,
std::streamoff  Offset,
float *  ip,
bool  throw_exception = true
[protected]
 

int itk::IPLCommonImageIO::GetIntAt std::ifstream &  f,
std::streamoff  Offset,
int *  ip,
bool  throw_exception = true
[protected]
 

virtual const std::type_info& itk::IPLCommonImageIO::GetPixelType  )  const [virtual]
 

Get the type of the pixel.

Reimplemented from itk::ImageIOBase.

int itk::IPLCommonImageIO::GetShortAt std::ifstream &  f,
std::streamoff  Offset,
short *  ip,
bool  throw_exception = true
[protected]
 

int itk::IPLCommonImageIO::GetStringAt std::ifstream &  f,
std::streamoff  Offset,
char *  buf,
vcl_size_t  amount,
bool  throw_exception = true
[protected]
 

double itk::IPLCommonImageIO::hdr2Double char *  hdr  )  [protected]
 

float itk::IPLCommonImageIO::hdr2Float char *  hdr  )  [protected]
 

int itk::IPLCommonImageIO::hdr2Int char *  hdr  )  [protected]
 

short itk::IPLCommonImageIO::hdr2Short char *  hdr  )  [protected]
 

void itk::IPLCommonImageIO::InitializeFILENAMELIST FILENAMELIST *const  fnList  )  [protected]
 

Pointer itk::IPLCommonImageIO::New  )  [static]
 

Method for creation through the object factory.

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::GE4ImageIO, itk::GE5ImageIO, itk::GEAdwImageIO, and itk::SiemensVisionImageIO.

void itk::IPLCommonImageIO::PrintSelf std::ostream &  os,
Indent  indent
const [protected, virtual]
 

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.

virtual void itk::IPLCommonImageIO::Read void *  buffer  )  [virtual]
 

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

virtual struct GEImageHeader* itk::IPLCommonImageIO::ReadHeader const char *  FileNameToRead  )  [protected, virtual]
 

Reimplemented in itk::GE4ImageIO, itk::GE5ImageIO, itk::GEAdwImageIO, and itk::SiemensVisionImageIO.

virtual void itk::IPLCommonImageIO::ReadImageInformation  )  [virtual]
 

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

void itk::IPLCommonImageIO::sortImageListAscend FILENAMELIST *const  fnList  )  [protected]
 

void itk::IPLCommonImageIO::sortImageListDescend FILENAMELIST *const  fnList  )  [protected]
 

int itk::IPLCommonImageIO::statTimeToAscii void *  clock,
char *  timeString
[protected]
 

virtual void itk::IPLCommonImageIO::Write const void *  buffer  )  [virtual]
 

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

Implements itk::ImageIOBase.

virtual void itk::IPLCommonImageIO::WriteImageInformation  )  [virtual]
 

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.


Member Data Documentation

FILENAMELIST itk::IPLCommonImageIO::m_fnlist [protected]
 

Definition at line 158 of file itkIPLCommonImageIO.h.

struct GEImageHeader* itk::IPLCommonImageIO::m_ImageHeader [protected]
 

Definition at line 156 of file itkIPLCommonImageIO.h.

ImageIOBase::ByteOrder itk::IPLCommonImageIO::m_system_byteOrder [protected]
 

Definition at line 157 of file itkIPLCommonImageIO.h.


The documentation for this class was generated from the following file:
Generated at Sat Mar 31 03:02:18 2007 for ITK by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2000