ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
itk::IPLCommonImageIO Class Reference

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

#include <itkIPLCommonImageIO.h>

Inheritance diagram for itk::IPLCommonImageIO:
Collaboration diagram for itk::IPLCommonImageIO:

List of all members.

Public Types

typedef float F32
typedef double F64
typedef SmartPointer< SelfPointer
typedef signed short S16
typedef signed int S32
typedef int64_t S64
typedef signed char S8
typedef IPLCommonImageIO Self
typedef ImageIOBase Superclass
typedef unsigned short U16
typedef unsigned int U32
typedef uint64_t U64
typedef unsigned char U8

Public Member Functions

virtual bool CanReadFile (const char *FileNameToRead)
virtual bool CanWriteFile (const char *FileNameToWrite)
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual unsigned int GetComponentSize () const
virtual const char * GetNameOfClass () 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 ()

Static Public Member Functions

static Pointer New ()

Protected Member Functions

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
virtual GEImageHeaderReadHeader (const char *FileNameToRead)
void sortImageListAscend ()
void sortImageListDescend ()
int statTimeToAscii (void *clock, char *timeString, int len)
 ~IPLCommonImageIO ()

Protected Attributes

IPLFileNameList * m_FilenameList
GEImageHeaderm_ImageHeader
ImageIOBase::ByteOrder m_SystemByteOrder

Private Member Functions

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

Detailed Description

Class that defines how to read GE4 file format.

Author:
Hans J. Johnson

Definition at line 49 of file itkIPLCommonImageIO.h.


Member Typedef Documentation

Definition at line 65 of file itkIPLCommonImageIO.h.

Definition at line 66 of file itkIPLCommonImageIO.h.

Reimplemented from itk::ImageIOBase.

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

Definition at line 55 of file itkIPLCommonImageIO.h.

typedef signed short itk::IPLCommonImageIO::S16

Definition at line 60 of file itkIPLCommonImageIO.h.

typedef signed int itk::IPLCommonImageIO::S32

Definition at line 62 of file itkIPLCommonImageIO.h.

Definition at line 64 of file itkIPLCommonImageIO.h.

typedef signed char itk::IPLCommonImageIO::S8

Definition at line 58 of file itkIPLCommonImageIO.h.

Standard class typedefs.

Reimplemented from itk::ImageIOBase.

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

Definition at line 53 of file itkIPLCommonImageIO.h.

Reimplemented from itk::ImageIOBase.

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

Definition at line 54 of file itkIPLCommonImageIO.h.

typedef unsigned short itk::IPLCommonImageIO::U16

Definition at line 59 of file itkIPLCommonImageIO.h.

typedef unsigned int itk::IPLCommonImageIO::U32

Definition at line 61 of file itkIPLCommonImageIO.h.

Definition at line 63 of file itkIPLCommonImageIO.h.

typedef unsigned char itk::IPLCommonImageIO::U8

Definition at line 57 of file itkIPLCommonImageIO.h.


Constructor & Destructor Documentation

itk::IPLCommonImageIO::IPLCommonImageIO ( ) [protected]
itk::IPLCommonImageIO::~IPLCommonImageIO ( ) [protected]
itk::IPLCommonImageIO::IPLCommonImageIO ( const Self ) [private]

Member Function Documentation

int itk::IPLCommonImageIO::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 
) [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:
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.

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:
FileNameToWriteThe 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::itk::LightObject::Pointer itk::IPLCommonImageIO::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::LightProcessObject.

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 char* itk::IPLCommonImageIO::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

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

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]
virtual void itk::IPLCommonImageIO::ModifyImageInformation ( ) [inline, virtual]

Optionally, modify spacing, origin and direction

Reimplemented in itk::GE5ImageIO.

Definition at line 88 of file itkIPLCommonImageIO.h.

static 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::operator= ( const Self ) [private]

This method causes the filter to generate its output.

Reimplemented from itk::ImageIOBase.

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 GEImageHeader* itk::IPLCommonImageIO::ReadHeader ( const char *  FileNameToRead) [protected, virtual]
virtual void itk::IPLCommonImageIO::ReadImageInformation ( ) [virtual]

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

void itk::IPLCommonImageIO::sortImageListAscend ( ) [protected]
virtual void itk::IPLCommonImageIO::SortImageListByNameAscend ( ) [virtual]

Set sorting method by name ascending.

virtual void itk::IPLCommonImageIO::SortImageListByNameDescend ( ) [virtual]

Set sorting method by name descending.

void itk::IPLCommonImageIO::sortImageListDescend ( ) [protected]
int itk::IPLCommonImageIO::statTimeToAscii ( void *  clock,
char *  timeString,
int  len 
) [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

IPLFileNameList* itk::IPLCommonImageIO::m_FilenameList [protected]

Definition at line 148 of file itkIPLCommonImageIO.h.

Definition at line 146 of file itkIPLCommonImageIO.h.

Definition at line 147 of file itkIPLCommonImageIO.h.


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