vtkDICOMImageReader Class Reference

#include <vtkDICOMImageReader.h>

Inheritance diagram for vtkDICOMImageReader:

[legend]Collaboration diagram for vtkDICOMImageReader:

[legend]List of all members.

---

Detailed Description

Reads some DICOM images.

DICOM (stands for Digital Imaging in COmmunications and Medicine) is a medical image file format widely used to exchange data, provided by various modalities.

Warning:

This reader might eventually handle ACR-NEMA file (predecessor of the DICOM format for medical images). This reader does not handle encapsulated format, only plain raw file are handled. This reader also does not handle multi-frames DICOM datasets.

See also:

vtkBMPReader vtkPNMReader vtkTIFFReader

Tests:

vtkDICOMImageReader (Tests)

Definition at line 44 of file vtkDICOMImageReader.h.

typedef vtkImageReader2	Superclass
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
static vtkDICOMImageReader *	New ()
static int	IsTypeOf (const char *type)
static vtkDICOMImageReader *	SafeDownCast (vtkObject *o)
Public Member Functions
double *	GetPixelSpacing ()
int	GetWidth ()
int	GetHeight ()
float *	GetImagePositionPatient ()
float *	GetImageOrientationPatient ()
int	GetBitsAllocated ()
int	GetPixelRepresentation ()
int	GetNumberOfComponents ()
const char *	GetTransferSyntaxUID ()
float	GetRescaleSlope ()
float	GetRescaleOffset ()
const char *	GetPatientName ()
const char *	GetStudyUID ()
const char *	GetStudyID ()
float	GetGantryAngle ()
virtual int	CanReadFile (const char *fname)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetFileName (const char *fn)
void	SetDirectoryName (const char *dn)
virtual char *	GetDirectoryName ()
virtual const char *	GetFileExtensions ()
virtual const char *	GetDescriptiveName ()
Protected Member Functions
void	SetupOutputInformation (int num_slices)
virtual void	ExecuteInformation ()
virtual void	ExecuteData (vtkDataObject *out)
	vtkDICOMImageReader ()
virtual	~vtkDICOMImageReader ()
int	GetNumberOfDICOMFileNames ()
const char *	GetDICOMFileName (int index)
Protected Attributes
DICOMParser *	Parser
DICOMAppHelper *	AppHelper
vtkDICOMImageReaderVector *	DICOMFileNames
char *	DirectoryName
char *	PatientName
char *	StudyUID
char *	StudyID
char *	TransferSyntaxUID

---

Member Typedef Documentation

typedef vtkImageReader2 vtkDICOMImageReader::Superclass

Reimplemented from vtkImageReader2. Definition at line 50 of file vtkDICOMImageReader.h.

---

Constructor & Destructor Documentation

vtkDICOMImageReader::vtkDICOMImageReader (   )  [protected]

virtual vtkDICOMImageReader::~vtkDICOMImageReader (   )  [protected, virtual]

---

Member Function Documentation

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

Static method for construction. Reimplemented from vtkImageReader2.

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

Reimplemented from vtkImageReader2.

static int vtkDICOMImageReader::IsTypeOf (  const char *  type  )  [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 vtkImageReader2.

virtual int vtkDICOMImageReader::IsA (  const char *  type  )  [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 vtkImageReader2.

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

Reimplemented from vtkImageReader2.

void vtkDICOMImageReader::PrintSelf (  ostream &  os, vtkIndent  indent )  [virtual]

Prints the ivars. Reimplemented from vtkImageReader2.

void vtkDICOMImageReader::SetFileName (  const char *  fn  )  [inline, virtual]

Set the filename for the file to read. If this method is used, the reader will only read a single file. Reimplemented from vtkImageReader2. Definition at line 59 of file vtkDICOMImageReader.h. References vtkImageReader2::SetFileName().

void vtkDICOMImageReader::SetDirectoryName (  const char *  dn  )

Set the directory name for the reader to look in for DICOM files. If this method is used, the reader will try to find all the DICOM files in a directory. It will select the subset corresponding to the first series UID it stumbles across and it will try to build an ordered volume from them based on the slice number. The volume building will be upgraded to something more sophisticated in the future.

virtual char* vtkDICOMImageReader::GetDirectoryName (   )  [virtual]

Returns the directory name.

double* vtkDICOMImageReader::GetPixelSpacing (   )

Returns the pixel spacing (in X, Y, Z). Note: if there is only one slice, the Z spacing is set to the slice thickness. If there is more than one slice, it is set to the distance between the first two slices.

int vtkDICOMImageReader::GetWidth (   )

Returns the image width.

int vtkDICOMImageReader::GetHeight (   )

Returns the image height.

float* vtkDICOMImageReader::GetImagePositionPatient (   )

Get the (DICOM) x,y,z coordinates of the first pixel in the image (upper left hand corner) of the last image processed by the DICOMParser

float* vtkDICOMImageReader::GetImageOrientationPatient (   )

Get the (DICOM) directions cosines. It consist of the components of the first two vectors. The third vector needs to be computed to form an orthonormal basis.

int vtkDICOMImageReader::GetBitsAllocated (   )

Get the number of bits allocated for each pixel in the file.

int vtkDICOMImageReader::GetPixelRepresentation (   )

Get the pixel representation of the last image processed by the DICOMParser. A zero is a unsigned quantity. A one indicates a signed quantity

int vtkDICOMImageReader::GetNumberOfComponents (   )

Get the number of components of the image data for the last image processed.

const char* vtkDICOMImageReader::GetTransferSyntaxUID (   )

Get the transfer syntax UID for the last image processed.

float vtkDICOMImageReader::GetRescaleSlope (   )

Get the rescale slope for the pixel data.

float vtkDICOMImageReader::GetRescaleOffset (   )

Get the rescale offset for the pixel data.

const char* vtkDICOMImageReader::GetPatientName (   )

Get the patient name for the last image processed.

const char* vtkDICOMImageReader::GetStudyUID (   )

Get the study uid for the last image processed.

const char* vtkDICOMImageReader::GetStudyID (   )

Get the Study ID for the last image processed.

float vtkDICOMImageReader::GetGantryAngle (   )

Get the gantry angle for the last image processed.

virtual int vtkDICOMImageReader::CanReadFile (  const char *  fname  )  [virtual]

virtual const char* vtkDICOMImageReader::GetFileExtensions (   )  [inline, virtual]

Get the file extensions for this format. Returns a string with a space separated list of extensions in the format .extension Reimplemented from vtkImageReader2. Definition at line 151 of file vtkDICOMImageReader.h.

virtual const char* vtkDICOMImageReader::GetDescriptiveName (   )  [inline, virtual]

Return a descriptive name for the file format that might be useful in a GUI. Reimplemented from vtkImageReader2. Definition at line 159 of file vtkDICOMImageReader.h.

void vtkDICOMImageReader::SetupOutputInformation (  int  num_slices  )  [protected]

virtual void vtkDICOMImageReader::ExecuteInformation (   )  [protected, virtual]

Reimplemented from vtkImageReader2.

virtual void vtkDICOMImageReader::ExecuteData (  vtkDataObject *  out  )  [protected, virtual]

This method is the old style execute method Reimplemented from vtkImageReader2.

int vtkDICOMImageReader::GetNumberOfDICOMFileNames (   )  [protected]

const char* vtkDICOMImageReader::GetDICOMFileName (  int  index  )  [protected]

---

Member Data Documentation

DICOMParser* vtkDICOMImageReader::Parser [protected]

Definition at line 187 of file vtkDICOMImageReader.h.

DICOMAppHelper* vtkDICOMImageReader::AppHelper [protected]

Definition at line 192 of file vtkDICOMImageReader.h.

vtkDICOMImageReaderVector* vtkDICOMImageReader::DICOMFileNames [protected]

Definition at line 197 of file vtkDICOMImageReader.h.

char* vtkDICOMImageReader::DirectoryName [protected]

Definition at line 198 of file vtkDICOMImageReader.h.

char* vtkDICOMImageReader::PatientName [protected]

Definition at line 200 of file vtkDICOMImageReader.h.

char* vtkDICOMImageReader::StudyUID [protected]

Definition at line 201 of file vtkDICOMImageReader.h.

char* vtkDICOMImageReader::StudyID [protected]

Definition at line 202 of file vtkDICOMImageReader.h.

char* vtkDICOMImageReader::TransferSyntaxUID [protected]

Definition at line 203 of file vtkDICOMImageReader.h.

---

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

• dox/IO/vtkDICOMImageReader.h

---