vtkgdcm
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkGDCMThreadedImageReader Class Reference

read DICOM files with multiple threads More...

#include <vtkGDCMThreadedImageReader.h>

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

Public Types

typedef vtkGDCMImageReader Superclass
 
- Public Types inherited from vtkGDCMImageReader
typedef vtkMedicalImageReader2 Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetShift (double)
 Explicitly set the Rescale Intercept (0028,1052) More...
 
virtual void SetScale (double)
 Explicitly get/set the Rescale Slope (0028,1053) More...
 
virtual void SetUseShiftScale (int)
 Determine whether or not reader should use value from Shift/Scale Default is 1. More...
 
virtual int GetUseShiftScale ()
 
virtual void UseShiftScaleOn ()
 
virtual void UseShiftScaleOff ()
 
- Public Member Functions inherited from vtkGDCMImageReader
virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int CanReadFile (const char *fname)
 
virtual const char * GetFileExtensions ()
 Valid extensions. More...
 
virtual const char * GetDescriptiveName ()
 A descriptive name for this format. More...
 
virtual vtkMatrix4x4 * GetDirectionCosines ()
 Get the Image Position (Patient) as stored in the DICOM file This is a read-only data member. More...
 
virtual vtkMedicalImageProperties * GetMedicalImageProperties ()
 Get the medical image properties object. More...
 
virtual void SetMedicalImageProperties (vtkMedicalImageProperties *pd)
 
virtual void SetFileNames (vtkStringArray *)
 
virtual vtkStringArray * GetFileNames ()
 
virtual int GetLoadOverlays ()
 Specifically request to load the overlay into the gdcm-VTK layer (gdcm always loads them when found). More...
 
virtual void SetLoadOverlays (int)
 
virtual void LoadOverlaysOn ()
 
virtual void LoadOverlaysOff ()
 
virtual int GetLoadIconImage ()
 Set/Get whether or not to load the Icon as vtkImageData (if found in the DICOM file) More...
 
virtual void SetLoadIconImage (int)
 
virtual void LoadIconImageOn ()
 
virtual void LoadIconImageOff ()
 
virtual int GetLossyFlag ()
 Set/Get whether or not the image was compressed using a lossy compression algorithm. More...
 
virtual void SetLossyFlag (int)
 
virtual void LossyFlagOn ()
 
virtual void LossyFlagOff ()
 
virtual int GetNumberOfOverlays ()
 Read only: number of overlays as found in this image (multiple overlays per slice is allowed) Only valid when LoadOverlays is true. More...
 
virtual int GetNumberOfIconImages ()
 Read only: number of icon image (there can only be zero or one icon per file) Only valid when LoadIconImage is true. More...
 
vtkImageData * GetOverlay (int i)
 Get Overlay/IconImage Remember to ALWAYS use those methods in your code, as the internal number for the output port is not garantee to remain the same, as features are added to the reader. More...
 
vtkImageData * GetIconImage ()
 
virtual int GetApplyLookupTable ()
 Load image with its associated Lookup Table. More...
 
virtual void SetApplyLookupTable (int)
 
virtual void ApplyLookupTableOn ()
 
virtual void ApplyLookupTableOff ()
 
virtual int GetApplyYBRToRGB ()
 Load image as YBR. More...
 
virtual void SetApplyYBRToRGB (int)
 
virtual void ApplyYBRToRGBOn ()
 
virtual void ApplyYBRToRGBOff ()
 
virtual int GetImageFormat ()
 Return VTK_LUMINANCE, VTK_INVERSE_LUMINANCE, VTK_RGB, VTK_RGBA, VTK_LOOKUP_TABLE, VTK_YBR or VTK_CMYK or 0 when ImageFormat is not handled. More...
 
virtual int GetPlanarConfiguration ()
 Return the Planar Configuration. More...
 
virtual double * GetImagePositionPatient ()
 Return the 'raw' information stored in the DICOM file: In case of a series of multiple files, only the first file is considered. More...
 
virtual void GetImagePositionPatient (double &, double &, double &)
 
virtual void GetImagePositionPatient (double[3])
 
virtual double * GetImageOrientationPatient ()
 
virtual void GetImageOrientationPatient (double &, double &, double &, double &, double &, double &)
 
virtual void GetImageOrientationPatient (double[6])
 
virtual vtkPolyData * GetCurve ()
 Set/Get the first Curve Data: More...
 
virtual void SetCurve (vtkPolyData *pd)
 
virtual double GetShift ()
 \DEPRECATED: Modality LUT Value returned by GetShift/GetScale might be inaccurate since Shift/Scale could be varying along the Series read. More...
 
virtual double GetScale ()
 

Static Public Member Functions

static vtkGDCMThreadedImageReaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGDCMThreadedImageReaderSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkGDCMImageReader
static vtkGDCMImageReaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGDCMImageReaderSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkGDCMThreadedImageReader ()
 
 ~vtkGDCMThreadedImageReader ()
 
void ExecuteInformation ()
 
void ExecuteData (vtkDataObject *out)
 
void ReadFiles (unsigned int nfiles, const char *filenames[])
 
void RequestDataCompat ()
 
- Protected Member Functions inherited from vtkGDCMImageReader
 vtkGDCMImageReader ()
 
 ~vtkGDCMImageReader ()
 
virtual void SetImageOrientationPatient (double, double, double, double, double, double)
 
virtual void SetImageOrientationPatient (double[6])
 
void FillMedicalImageInformation (const gdcm::ImageReader &reader)
 
int RequestInformationCompat ()
 
int RequestDataCompat ()
 
void ExecuteInformation ()
 
void ExecuteData (vtkDataObject *out)
 
int LoadSingleFile (const char *filename, char *pointer, unsigned long &outlen)
 
void SetFilePrefix (const char *)
 
virtual char * GetFilePrefix ()
 
void SetFilePattern (const char *)
 
virtual char * GetFilePattern ()
 

Additional Inherited Members

- Protected Attributes inherited from vtkGDCMImageReader
vtkMedicalImageProperties * MedicalImageProperties
 Medical Image properties. More...
 
vtkStringArray * FileNames
 
vtkMatrix4x4 * DirectionCosines
 
int LoadOverlays
 
int NumberOfOverlays
 
int LoadIconImage
 
int NumberOfIconImages
 
int IconImageDataExtent [6]
 
double ImagePositionPatient [3]
 
double ImageOrientationPatient [6]
 
vtkPolyData * Curve
 
int ImageFormat
 
int ApplyInverseVideo
 
int ApplyLookupTable
 
int ApplyYBRToRGB
 
int ApplyPlanarConfiguration
 
int ApplyShiftScale
 
double Shift
 
double Scale
 
int IconDataScalarType
 
int IconNumberOfScalarComponents
 
int PlanarConfiguration
 
int LossyFlag
 
int ForceRescale
 

Detailed Description

read DICOM files with multiple threads

vtkGDCMThreadedImageReader is a source object that reads some DICOM files This reader is threaded. Meaning that on a multiple core CPU with N cpu, it will read approx N times faster than when reading in a single thread.

Warning
you have to understand how physically medium works first (sequential reading for instance) before playing with this class
Attention
upside down as VTK would expect, use this option only if you know what you are doing
FIXME: you need to call SetFileName when reading a volume file (multiple slices DICOM):
since SetFileNames expect each single file to be single slice (see parent class)
See also
vtkMedicalImageReader2 vtkMedicalImageProperties vtkGDCMThreadedImageReader2

Definition at line 44 of file vtkGDCMThreadedImageReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 48 of file vtkGDCMThreadedImageReader.h.

Constructor & Destructor Documentation

◆ vtkGDCMThreadedImageReader()

vtkGDCMThreadedImageReader::vtkGDCMThreadedImageReader ( )
protected

◆ ~vtkGDCMThreadedImageReader()

vtkGDCMThreadedImageReader::~vtkGDCMThreadedImageReader ( )
protected

Member Function Documentation

◆ New()

static vtkGDCMThreadedImageReader * vtkGDCMThreadedImageReader::New ( )
static

◆ GetClassName()

virtual const char * vtkGDCMThreadedImageReader::GetClassName ( )
virtual

Reimplemented from vtkGDCMImageReader.

◆ IsTypeOf()

static int vtkGDCMThreadedImageReader::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkGDCMThreadedImageReader::IsA ( const char *  type)
virtual

Reimplemented from vtkGDCMImageReader.

◆ SafeDownCast()

static vtkGDCMThreadedImageReader * vtkGDCMThreadedImageReader::SafeDownCast ( vtkObject *  o)
static

◆ PrintSelf()

virtual void vtkGDCMThreadedImageReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Reimplemented from vtkGDCMImageReader.

◆ SetShift()

virtual void vtkGDCMThreadedImageReader::SetShift ( double  )
virtual

Explicitly set the Rescale Intercept (0028,1052)

◆ SetScale()

virtual void vtkGDCMThreadedImageReader::SetScale ( double  )
virtual

Explicitly get/set the Rescale Slope (0028,1053)

◆ SetUseShiftScale()

virtual void vtkGDCMThreadedImageReader::SetUseShiftScale ( int  )
virtual

Determine whether or not reader should use value from Shift/Scale Default is 1.

◆ GetUseShiftScale()

virtual int vtkGDCMThreadedImageReader::GetUseShiftScale ( )
virtual

◆ UseShiftScaleOn()

virtual void vtkGDCMThreadedImageReader::UseShiftScaleOn ( )
virtual

◆ UseShiftScaleOff()

virtual void vtkGDCMThreadedImageReader::UseShiftScaleOff ( )
virtual

◆ ExecuteInformation()

void vtkGDCMThreadedImageReader::ExecuteInformation ( )
protected

◆ ExecuteData()

void vtkGDCMThreadedImageReader::ExecuteData ( vtkDataObject *  out)
protected

◆ ReadFiles()

void vtkGDCMThreadedImageReader::ReadFiles ( unsigned int  nfiles,
const char *  filenames[] 
)
protected

◆ RequestDataCompat()

void vtkGDCMThreadedImageReader::RequestDataCompat ( )
protected

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