vtkLSMReader Class Reference

#include <vtkLSMReader.h>

Inheritance diagram for vtkLSMReader:
[legend]
Collaboration diagram for vtkLSMReader:
[legend]

List of all members.


Detailed Description

read LSM files

Date
Revision

vtkLSMReader is a source object that reads LSM files. It should be able to read most any LSM file

Thanks:
This class was developed as a part of the BioImageXD Project. The BioImageXD project includes the following people:
Thanks:
Dan White <dan@chalkie.org.uk> Kalle Pahajoki <kalpaha@st.jyu.fi> Pasi Kankaanpää <ppkank@bytl.jyu.fi>

Definition at line 85 of file vtkLSMReader.h.


Public Types

typedef vtkImageSource Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
int GetHeaderIdentifier ()
int IsValidLSMFile ()
int IsCompressed ()
int GetNumberOfTimePoints ()
int GetNumberOfChannels ()
int OpenFile ()
int GetChannelColorComponent (int, int)
char * GetChannelName (int)
void SetFileName (const char *)
void ExecuteInformation ()
void SetUpdateTimePoint (int)
void SetUpdateChannel (int)
void SetDataByteOrderToBigEndian ()
void SetDataByteOrderToLittleEndian ()
void SetDataByteOrder (int)
int GetDataByteOrder ()
const char * GetDataByteOrderAsString ()
virtual char * GetFileName ()
virtual double * GetVoxelSizes ()
virtual void GetVoxelSizes (double &, double &, double &)
virtual void GetVoxelSizes (double[3])
virtual int * GetDimensions ()
virtual void GetDimensions (int data[5])
virtual int * GetNumberOfIntensityValues ()
virtual void GetNumberOfIntensityValues (int data[4])
virtual unsigned short GetIdentifier ()
virtual unsigned int GetNewSubFileType ()
virtual unsigned int GetCompression ()
virtual unsigned int GetSamplesPerPixel ()
virtual unsigned short GetScanType ()
virtual int GetDataType ()
virtual vtkDoubleArrayGetTimeStampInformation ()
virtual vtkIntArrayGetChannelColors ()
vtkImageDataGetTimePointOutput (int, int)
const char * GetFileExtensions ()
virtual void SetSwapBytes (int)
virtual int GetSwapBytes ()
virtual void SwapBytesOn ()
virtual void SwapBytesOff ()

Static Public Member Functions

static vtkLSMReaderNew ()
static int IsTypeOf (const char *type)
static vtkLSMReaderSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkLSMReader ()
 ~vtkLSMReader ()
int TIFF_BYTES (unsigned short)
int BYTES_BY_DATA_TYPE (int)
void ClearFileName ()
void Clean ()
unsigned long ReadImageDirectory (ifstream *, unsigned long)
int AllocateChannelNames (int)
int SetChannelName (const char *, int)
int ClearChannelNames ()
int FindChannelNameStart (const char *, int)
int ReadChannelName (const char *, int, char *)
int ReadChannelColorsAndNames (ifstream *, unsigned long)
int ReadTimeStampInformation (ifstream *, unsigned long)
int ReadLSMSpecificInfo (ifstream *, unsigned long)
int AnalyzeTag (ifstream *, unsigned long)
int NeedToReadHeaderInformation ()
void NeedToReadHeaderInformationOn ()
void NeedToReadHeaderInformationOff ()
unsigned long SeekFile (int)
unsigned long GetOffsetToImage (int, int)
ifstream * GetFile ()
void ExecuteData (vtkDataObject *out)
void CalculateExtentAndSpacing (int extent[6], double spacing[3])
unsigned char CharPointerToUnsignedChar (char *)
int CharPointerToInt (char *)
unsigned int CharPointerToUnsignedInt (char *)
short CharPointerToShort (char *)
unsigned short CharPointerToUnsignedShort (char *)
double CharPointerToDouble (char *)
int ReadInt (ifstream *, unsigned long *)
unsigned int ReadUnsignedInt (ifstream *, unsigned long *)
short ReadShort (ifstream *, unsigned long *)
unsigned short ReadUnsignedShort (ifstream *, unsigned long *)
double ReadDouble (ifstream *, unsigned long *)
int ReadFile (ifstream *, unsigned long *, int, char *, bool swap=0)
int ReadData (ifstream *, unsigned long *, int, char *)

Protected Attributes

int SwapBytes
int UpdateExtent [5]
unsigned long OffsetToLastAccessedImage
int NumberOfLastAccessedImage
int FileNameChanged
ifstream * File
char * FileName
double VoxelSizes [3]
int Dimensions [5]
int NumberOfIntensityValues [4]
unsigned short Identifier
unsigned int NewSubFileType
vtkUnsignedShortArrayBitsPerSample
unsigned int Compression
vtkUnsignedIntArrayStripOffset
unsigned int SamplesPerPixel
vtkUnsignedIntArrayStripByteCount
unsigned int LSMSpecificInfoOffset
unsigned short PhotometricInterpretation
unsigned long ColorMapOffset
unsigned short PlanarConfiguration
unsigned short Predictor
unsigned short ScanType
int DataType
unsigned long ChannelInfoOffset
vtkIntArrayChannelColors
char ** ChannelNames
vtkDoubleArrayTimeStampInformation

Member Typedef Documentation

typedef vtkImageSource vtkLSMReader::Superclass

Reimplemented from vtkImageSource.

Definition at line 90 of file vtkLSMReader.h.


Constructor & Destructor Documentation

vtkLSMReader::vtkLSMReader (  )  [protected]

vtkLSMReader::~vtkLSMReader (  )  [protected]


Member Function Documentation

static vtkLSMReader* vtkLSMReader::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

virtual const char* vtkLSMReader::GetClassName (  )  [virtual]

Reimplemented from vtkImageSource.

static int vtkLSMReader::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkImageSource.

virtual int vtkLSMReader::IsA ( const char *  name  )  [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkImageSource.

static vtkLSMReader* vtkLSMReader::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkImageSource.

virtual void vtkLSMReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [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 vtkImageSource.

const char* vtkLSMReader::GetFileExtensions (  )  [inline]

Get the file extensions for this format. Returns a string with a space separated list of extensions in the format .extension

Definition at line 96 of file vtkLSMReader.h.

int vtkLSMReader::GetHeaderIdentifier (  ) 

int vtkLSMReader::IsValidLSMFile (  ) 

int vtkLSMReader::IsCompressed (  ) 

int vtkLSMReader::GetNumberOfTimePoints (  ) 

int vtkLSMReader::GetNumberOfChannels (  ) 

int vtkLSMReader::OpenFile (  ) 

int vtkLSMReader::GetChannelColorComponent ( int  ,
int   
)

char* vtkLSMReader::GetChannelName ( int   ) 

void vtkLSMReader::SetFileName ( const char *   ) 

void vtkLSMReader::ExecuteInformation (  )  [virtual]

Reimplemented from vtkSource.

void vtkLSMReader::SetUpdateTimePoint ( int   ) 

void vtkLSMReader::SetUpdateChannel ( int   ) 

void vtkLSMReader::SetDataByteOrderToBigEndian (  ) 

void vtkLSMReader::SetDataByteOrderToLittleEndian (  ) 

void vtkLSMReader::SetDataByteOrder ( int   ) 

int vtkLSMReader::GetDataByteOrder (  ) 

const char* vtkLSMReader::GetDataByteOrderAsString (  ) 

virtual void vtkLSMReader::SetSwapBytes ( int   )  [virtual]

Set/Get the byte swapping to explicitly swap the bytes of a file.

virtual int vtkLSMReader::GetSwapBytes (  )  [inline, virtual]

Set/Get the byte swapping to explicitly swap the bytes of a file.

Definition at line 125 of file vtkLSMReader.h.

virtual void vtkLSMReader::SwapBytesOn (  )  [virtual]

Set/Get the byte swapping to explicitly swap the bytes of a file.

virtual void vtkLSMReader::SwapBytesOff (  )  [virtual]

Set/Get the byte swapping to explicitly swap the bytes of a file.

virtual char* vtkLSMReader::GetFileName (  )  [virtual]

virtual double* vtkLSMReader::GetVoxelSizes (  )  [virtual]

virtual void vtkLSMReader::GetVoxelSizes ( double &  ,
double &  ,
double &   
) [virtual]

virtual void vtkLSMReader::GetVoxelSizes ( double  [3]  )  [virtual]

virtual int* vtkLSMReader::GetDimensions (  )  [virtual]

virtual void vtkLSMReader::GetDimensions ( int  data[5]  )  [virtual]

virtual int* vtkLSMReader::GetNumberOfIntensityValues (  )  [virtual]

virtual void vtkLSMReader::GetNumberOfIntensityValues ( int  data[4]  )  [virtual]

virtual unsigned short vtkLSMReader::GetIdentifier (  )  [virtual]

virtual unsigned int vtkLSMReader::GetNewSubFileType (  )  [virtual]

virtual unsigned int vtkLSMReader::GetCompression (  )  [virtual]

virtual unsigned int vtkLSMReader::GetSamplesPerPixel (  )  [virtual]

virtual unsigned short vtkLSMReader::GetScanType (  )  [virtual]

virtual int vtkLSMReader::GetDataType (  )  [virtual]

virtual vtkDoubleArray* vtkLSMReader::GetTimeStampInformation (  )  [virtual]

virtual vtkIntArray* vtkLSMReader::GetChannelColors (  )  [virtual]

vtkImageData* vtkLSMReader::GetTimePointOutput ( int  ,
int   
)

int vtkLSMReader::TIFF_BYTES ( unsigned  short  )  [protected]

int vtkLSMReader::BYTES_BY_DATA_TYPE ( int   )  [protected]

void vtkLSMReader::ClearFileName (  )  [protected]

void vtkLSMReader::Clean (  )  [protected]

unsigned long vtkLSMReader::ReadImageDirectory ( ifstream *  ,
unsigned  long 
) [protected]

int vtkLSMReader::AllocateChannelNames ( int   )  [protected]

int vtkLSMReader::SetChannelName ( const char *  ,
int   
) [protected]

int vtkLSMReader::ClearChannelNames (  )  [protected]

int vtkLSMReader::FindChannelNameStart ( const char *  ,
int   
) [protected]

int vtkLSMReader::ReadChannelName ( const char *  ,
int  ,
char *   
) [protected]

int vtkLSMReader::ReadChannelColorsAndNames ( ifstream *  ,
unsigned  long 
) [protected]

int vtkLSMReader::ReadTimeStampInformation ( ifstream *  ,
unsigned  long 
) [protected]

int vtkLSMReader::ReadLSMSpecificInfo ( ifstream *  ,
unsigned  long 
) [protected]

int vtkLSMReader::AnalyzeTag ( ifstream *  ,
unsigned  long 
) [protected]

int vtkLSMReader::NeedToReadHeaderInformation (  )  [protected]

void vtkLSMReader::NeedToReadHeaderInformationOn (  )  [protected]

void vtkLSMReader::NeedToReadHeaderInformationOff (  )  [protected]

unsigned long vtkLSMReader::SeekFile ( int   )  [protected]

unsigned long vtkLSMReader::GetOffsetToImage ( int  ,
int   
) [protected]

ifstream* vtkLSMReader::GetFile (  )  [protected]

void vtkLSMReader::ExecuteData ( vtkDataObject output  )  [protected, virtual]

This method is the one that should be used by subclasses, right now the default implementation is to call the backwards compatibility method

Reimplemented from vtkSource.

void vtkLSMReader::CalculateExtentAndSpacing ( int  extent[6],
double  spacing[3] 
) [protected]

unsigned char vtkLSMReader::CharPointerToUnsignedChar ( char *   )  [protected]

int vtkLSMReader::CharPointerToInt ( char *   )  [protected]

unsigned int vtkLSMReader::CharPointerToUnsignedInt ( char *   )  [protected]

short vtkLSMReader::CharPointerToShort ( char *   )  [protected]

unsigned short vtkLSMReader::CharPointerToUnsignedShort ( char *   )  [protected]

double vtkLSMReader::CharPointerToDouble ( char *   )  [protected]

int vtkLSMReader::ReadInt ( ifstream *  ,
unsigned long *   
) [protected]

unsigned int vtkLSMReader::ReadUnsignedInt ( ifstream *  ,
unsigned long *   
) [protected]

short vtkLSMReader::ReadShort ( ifstream *  ,
unsigned long *   
) [protected]

unsigned short vtkLSMReader::ReadUnsignedShort ( ifstream *  ,
unsigned long *   
) [protected]

double vtkLSMReader::ReadDouble ( ifstream *  ,
unsigned long *   
) [protected]

int vtkLSMReader::ReadFile ( ifstream *  ,
unsigned long *  ,
int  ,
char *  ,
bool  swap = 0 
) [protected]

int vtkLSMReader::ReadData ( ifstream *  ,
unsigned long *  ,
int  ,
char *   
) [protected]


Member Data Documentation

int vtkLSMReader::SwapBytes [protected]

Definition at line 177 of file vtkLSMReader.h.

int vtkLSMReader::UpdateExtent[5] [protected]

Definition at line 179 of file vtkLSMReader.h.

unsigned long vtkLSMReader::OffsetToLastAccessedImage [protected]

Definition at line 180 of file vtkLSMReader.h.

int vtkLSMReader::NumberOfLastAccessedImage [protected]

Definition at line 181 of file vtkLSMReader.h.

int vtkLSMReader::FileNameChanged [protected]

Definition at line 182 of file vtkLSMReader.h.

ifstream* vtkLSMReader::File [protected]

Definition at line 183 of file vtkLSMReader.h.

char* vtkLSMReader::FileName [protected]

Definition at line 184 of file vtkLSMReader.h.

double vtkLSMReader::VoxelSizes[3] [protected]

Definition at line 185 of file vtkLSMReader.h.

int vtkLSMReader::Dimensions[5] [protected]

Definition at line 186 of file vtkLSMReader.h.

int vtkLSMReader::NumberOfIntensityValues[4] [protected]

Definition at line 187 of file vtkLSMReader.h.

unsigned short vtkLSMReader::Identifier [protected]

Definition at line 188 of file vtkLSMReader.h.

unsigned int vtkLSMReader::NewSubFileType [protected]

Definition at line 189 of file vtkLSMReader.h.

vtkUnsignedShortArray* vtkLSMReader::BitsPerSample [protected]

Definition at line 190 of file vtkLSMReader.h.

unsigned int vtkLSMReader::Compression [protected]

Definition at line 191 of file vtkLSMReader.h.

vtkUnsignedIntArray* vtkLSMReader::StripOffset [protected]

Definition at line 192 of file vtkLSMReader.h.

unsigned int vtkLSMReader::SamplesPerPixel [protected]

Definition at line 193 of file vtkLSMReader.h.

vtkUnsignedIntArray* vtkLSMReader::StripByteCount [protected]

Definition at line 194 of file vtkLSMReader.h.

unsigned int vtkLSMReader::LSMSpecificInfoOffset [protected]

Definition at line 195 of file vtkLSMReader.h.

unsigned short vtkLSMReader::PhotometricInterpretation [protected]

Definition at line 196 of file vtkLSMReader.h.

unsigned long vtkLSMReader::ColorMapOffset [protected]

Definition at line 197 of file vtkLSMReader.h.

unsigned short vtkLSMReader::PlanarConfiguration [protected]

Definition at line 198 of file vtkLSMReader.h.

unsigned short vtkLSMReader::Predictor [protected]

Definition at line 199 of file vtkLSMReader.h.

unsigned short vtkLSMReader::ScanType [protected]

Definition at line 200 of file vtkLSMReader.h.

int vtkLSMReader::DataType [protected]

Definition at line 201 of file vtkLSMReader.h.

unsigned long vtkLSMReader::ChannelInfoOffset [protected]

Definition at line 202 of file vtkLSMReader.h.

vtkIntArray* vtkLSMReader::ChannelColors [protected]

Definition at line 203 of file vtkLSMReader.h.

char** vtkLSMReader::ChannelNames [protected]

Definition at line 204 of file vtkLSMReader.h.

vtkDoubleArray* vtkLSMReader::TimeStampInformation [protected]

Definition at line 205 of file vtkLSMReader.h.


The documentation for this class was generated from the following file:
Generated on Fri Sep 7 17:48:00 2007 for VTK by  doxygen 1.5.3