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

itk::VOLImageIO Class Reference
[Input and Output Filters]

Read and write .VOL 3D ultrasound images. More...

#include <itkVOLImageIO.h>

Inheritance diagram for itk::VOLImageIO:

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

Collaboration graph
[legend]
List of all members.

Public Types

typedef VOLImageIO Self
typedef ImageIOBase Superclass
typedef SmartPointer< Self > Pointer

Public Methods

virtual const char * GetClassName () const
virtual bool CanReadFile (const char *)
virtual const std::type_info & GetPixelType () const
virtual void Read (void *buffer)
virtual bool CanWriteFile (const char *)
virtual void WriteImageInformation ()
virtual void Write (const void *)
virtual void ReadImageInformation ()
void ReadVersion1_0 (FILE *fp)
void ReadVersion1_1 (FILE *fp)
void ReadVersion2_1 (FILE *fp)
void ReadVersion2_3 (FILE *fp)
unsigned int GetComponentSize () const
virtual unsigned long GetFile_type ()
virtual char * GetFile_rev ()
virtual char * GetDescription ()
virtual char * GetDate ()
virtual char * GetTime ()
virtual char * GetPatient ()
virtual char * GetClinic ()
virtual unsigned long GetNumEchoFrames ()
virtual unsigned long GetNumDopFrames ()
virtual char GetDopmode ()
virtual long GetEchoLPF ()
virtual long GetDopLPF ()
virtual long GetRepetition ()
virtual char * GetXducer_name ()
virtual long GetXducer_ID ()
virtual double GetXducer_freq ()
virtual double GetDepth ()
virtual double GetDefault_depth ()
virtual char * GetApp_name ()
virtual char GetApplication ()
virtual long GetScan_fmt ()
virtual char * GetDataset_name ()
virtual short GetFirst_tx_line ()
virtual short GetLast_tx_line ()
virtual short GetLines ()
virtual short GetAz_lines ()
virtual double GetAz_angle ()
virtual double GetAz_angular_separation ()
virtual short GetEl_lines ()
virtual double GetEl_angle ()
virtual double GetEl_angular_separation ()
virtual long GetTx_offset ()
virtual long GetRx_offset ()
virtual double GetMclkFreq ()
virtual double GetSampleSize ()
virtual double GetMclk2Size ()
virtual long GetSampleRate ()
virtual unsigned long GetLineGroupSize ()
virtual unsigned long GetNumECGSamples ()
virtual unsigned long GetGrayImageSize ()
virtual unsigned long GetDopplerImageSize ()
virtual unsigned long GetEcgSize ()
virtual unsigned long GetMiscDataSize ()
virtual unsigned long GetGrayImageOffset ()
virtual unsigned long GetDopplerImageOffset ()
virtual unsigned long GetEcgOffset ()
virtual unsigned long GetMiscDataOffset ()
virtual char * GetFile_control_timing_type ()
virtual char * GetDopplerVolInfo ()
virtual short GetScanDepthCount ()
virtual short GetScanDepth ()
virtual double GetAz_sector_tilt ()
virtual double GetElev_sector_tilt ()
virtual char * GetDopplerSegData ()
virtual double GetFrameRate ()
virtual long GetSweepspeed ()
virtual long GetUpdate_interval ()
virtual unsigned long GetContrast_on ()
virtual long GetComp_curve_p0_x ()
virtual long GetComp_curve_p0_y ()
virtual long GetComp_curve_p1_x ()
virtual long GetComp_curve_p1_y ()
virtual long GetComp_curve_p2_x ()
virtual long GetComp_curve_p2_y ()
virtual long GetComp_curve_p3_x ()
virtual long GetComp_curve_p3_y ()
virtual long GetComp_curve_scaling_index ()
virtual long GetEcho_reject ()
const double ** GetMt_tp () const
virtual unsigned long GetTrue_axis_defined ()
virtual unsigned long GetTrue_axis_on ()
virtual double GetParallel_x_tilt ()
virtual double GetParallel_y_tilt ()
virtual double GetParallel_depth ()
virtual double GetParallel_spacing ()
virtual long GetParallel_thickness ()
virtual unsigned long GetViewport_transform_flags ()
virtual unsigned long GetStress_mode ()
virtual char * GetStress_label ()
virtual double GetHeart_rate ()
virtual long GetStage_timer_value ()
virtual unsigned long GetEcg_display_on ()
double GetBlanking ()
virtual short GetSamples ()
virtual unsigned long GetColorImageSize ()
virtual unsigned long GetColorImageOffset ()
virtual char * GetOag_params ()
virtual unsigned long GetCscanfmt ()
virtual unsigned long GetOaglinear ()
virtual unsigned long GetMaxradius ()
virtual double GetAnglescale ()
double GetSkinoffset ()

Static Public Methods

Pointer New ()

Protected Methods

 VOLImageIO ()
 ~VOLImageIO ()
void PrintSelf (std::ostream &os, Indent indent) const
void ReadData (FILE *fp, void *buffer, vcl_size_t size, long pos=-1)
void ReadData (FILE *fp, char *buffer, vcl_size_t size, long pos=-1)

Detailed Description

Read and write .VOL 3D ultrasound images.

See also:
ImageFileReader

Definition at line 39 of file itkVOLImageIO.h.

Member Typedef Documentation

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

Reimplemented from itk::ImageIOBase.

Definition at line 45 of file itkVOLImageIO.h.

typedef VOLImageIO itk::VOLImageIO::Self
 

Smart pointer typedef support.

Reimplemented from itk::ImageIOBase.

Definition at line 43 of file itkVOLImageIO.h.

typedef ImageIOBase itk::VOLImageIO::Superclass
 

Reimplemented from itk::ImageIOBase.

Definition at line 44 of file itkVOLImageIO.h.

Constructor & Destructor Documentation

itk::VOLImageIO::VOLImageIO (    )  [protected]
 

itk::VOLImageIO::~VOLImageIO (    )  [protected]
 

Member Function Documentation

virtual bool itk::VOLImageIO::CanReadFile (  const char *    )  [virtual]
 

Determine the file type. Returns true if this ImageIOBase can read the file specified. Reads in the header as well.

Implements itk::ImageIOBase.

virtual bool itk::VOLImageIO::CanWriteFile (  const char *    )  [inline, virtual]
 

Determine the file type. Returns true if this ImageIO can read the file specified.

Implements itk::ImageIOBase.

Definition at line 77 of file itkVOLImageIO.h.

virtual double itk::VOLImageIO::GetAnglescale (    )  [virtual]
 

VOL file format version 1.0 specific.

virtual char* itk::VOLImageIO::GetApp_name (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual char itk::VOLImageIO::GetApplication (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual double itk::VOLImageIO::GetAz_angle (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual double itk::VOLImageIO::GetAz_angular_separation (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual short itk::VOLImageIO::GetAz_lines (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual double itk::VOLImageIO::GetAz_sector_tilt (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

double itk::VOLImageIO::GetBlanking (    ) 
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual const char* itk::VOLImageIO::GetClassName (    )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

virtual char* itk::VOLImageIO::GetClinic (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetColorImageOffset (    )  [virtual]
 

VOL file format version 1.0 specific.

virtual unsigned long itk::VOLImageIO::GetColorImageSize (    )  [virtual]
 

VOL file format version 1.0 specific.

virtual long itk::VOLImageIO::GetComp_curve_p0_x (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetComp_curve_p0_y (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetComp_curve_p1_x (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetComp_curve_p1_y (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetComp_curve_p2_x (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetComp_curve_p2_y (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetComp_curve_p3_x (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetComp_curve_p3_y (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetComp_curve_scaling_index (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

unsigned int itk::VOLImageIO::GetComponentSize (    )  const [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

Reimplemented from itk::ImageIOBase.

virtual unsigned long itk::VOLImageIO::GetContrast_on (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetCscanfmt (    )  [virtual]
 

VOL file format version 1.0 specific.

virtual char* itk::VOLImageIO::GetDataset_name (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual char* itk::VOLImageIO::GetDate (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual double itk::VOLImageIO::GetDefault_depth (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual double itk::VOLImageIO::GetDepth (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual char* itk::VOLImageIO::GetDescription (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetDopLPF (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual char itk::VOLImageIO::GetDopmode (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetDopplerImageOffset (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetDopplerImageSize (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual char* itk::VOLImageIO::GetDopplerSegData (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual char* itk::VOLImageIO::GetDopplerVolInfo (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetEcg_display_on (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetEcgOffset (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetEcgSize (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetEcho_reject (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetEchoLPF (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual double itk::VOLImageIO::GetEl_angle (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual double itk::VOLImageIO::GetEl_angular_separation (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual short itk::VOLImageIO::GetEl_lines (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual double itk::VOLImageIO::GetElev_sector_tilt (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual char* itk::VOLImageIO::GetFile_control_timing_type (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual char* itk::VOLImageIO::GetFile_rev (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetFile_type (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual short itk::VOLImageIO::GetFirst_tx_line (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual double itk::VOLImageIO::GetFrameRate (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetGrayImageOffset (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetGrayImageSize (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual double itk::VOLImageIO::GetHeart_rate (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual short itk::VOLImageIO::GetLast_tx_line (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetLineGroupSize (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual short itk::VOLImageIO::GetLines (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetMaxradius (    )  [virtual]
 

VOL file format version 1.0 specific.

virtual double itk::VOLImageIO::GetMclk2Size (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual double itk::VOLImageIO::GetMclkFreq (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetMiscDataOffset (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetMiscDataSize (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

const double** itk::VOLImageIO::GetMt_tp (    )  const
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetNumDopFrames (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetNumECGSamples (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetNumEchoFrames (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual char* itk::VOLImageIO::GetOag_params (    )  [virtual]
 

VOL file format version 1.0 specific.

virtual unsigned long itk::VOLImageIO::GetOaglinear (    )  [virtual]
 

VOL file format version 1.0 specific.

virtual double itk::VOLImageIO::GetParallel_depth (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual double itk::VOLImageIO::GetParallel_spacing (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetParallel_thickness (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual double itk::VOLImageIO::GetParallel_x_tilt (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual double itk::VOLImageIO::GetParallel_y_tilt (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual char* itk::VOLImageIO::GetPatient (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual const std::type_info& itk::VOLImageIO::GetPixelType (    )  const [virtual]
 

Get the type of the pixel.

Reimplemented from itk::ImageIOBase.

virtual long itk::VOLImageIO::GetRepetition (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetRx_offset (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetSampleRate (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual short itk::VOLImageIO::GetSamples (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual double itk::VOLImageIO::GetSampleSize (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetScan_fmt (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual short itk::VOLImageIO::GetScanDepth (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual short itk::VOLImageIO::GetScanDepthCount (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

double itk::VOLImageIO::GetSkinoffset (    ) 
 

VOL file format version 1.0 specific.

virtual long itk::VOLImageIO::GetStage_timer_value (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual char* itk::VOLImageIO::GetStress_label (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetStress_mode (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetSweepspeed (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual char* itk::VOLImageIO::GetTime (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetTrue_axis_defined (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetTrue_axis_on (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetTx_offset (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetUpdate_interval (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual unsigned long itk::VOLImageIO::GetViewport_transform_flags (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual double itk::VOLImageIO::GetXducer_freq (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual long itk::VOLImageIO::GetXducer_ID (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

virtual char* itk::VOLImageIO::GetXducer_name (    )  [virtual]
 

Methods that provide information about the data file. This information is only valid after the file is read successfully.

Pointer itk::VOLImageIO::New (    )  [static]
 

Method for creation through the object factory.

Reimplemented from itk::LightProcessObject.

void itk::VOLImageIO::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::VOLImageIO::Read (  void *    buffer )  [virtual]
 

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

void itk::VOLImageIO::ReadData (  FILE *    fp,
char *    buffer,
vcl_size_t    size,
long    pos = -1
)  [protected]
 

Read the data into a void* or char* pointer.

void itk::VOLImageIO::ReadData (  FILE *    fp,
void *    buffer,
vcl_size_t    size,
long    pos = -1
)  [protected]
 

Read the data into a void* or char* pointer.

virtual void itk::VOLImageIO::ReadImageInformation (    )  [virtual]
 

Set the spacing and diemention information for the set filename.

Implements itk::ImageIOBase.

void itk::VOLImageIO::ReadVersion1_0 (  FILE *    fp ) 
 

Set the spacing and diemention information for the set filename.

void itk::VOLImageIO::ReadVersion1_1 (  FILE *    fp ) 
 

Set the spacing and diemention information for the set filename.

void itk::VOLImageIO::ReadVersion2_1 (  FILE *    fp ) 
 

Set the spacing and diemention information for the set filename.

void itk::VOLImageIO::ReadVersion2_3 (  FILE *    fp ) 
 

Set the spacing and diemention information for the set filename.

virtual void itk::VOLImageIO::Write (  const void *    )  [inline, virtual]
 

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

Implements itk::ImageIOBase.

Definition at line 86 of file itkVOLImageIO.h.

virtual void itk::VOLImageIO::WriteImageInformation (  void    )  [inline, virtual]
 

Writes the spacing and dimentions of the image. Assumes SetFileName has been called with a valid file name.

Implements itk::ImageIOBase.

Definition at line 82 of file itkVOLImageIO.h.

The documentation for this class was generated from the following file:
Generated at Fri May 21 01:45:11 2004 for ITK by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2000