some medical image properties. More...

#include <vtkMedicalImageProperties.h>

Inheritance diagram for vtkMedicalImageProperties:

Collaboration diagram for vtkMedicalImageProperties:

Public Types
enum	OrientationType { AXIAL = 0 , CORONAL , SAGITTAL }

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkMedicalImageProperties *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	Clear ()
	Convenience method to reset all fields to an empty string/value.

int	GetPatientAgeYear ()

int	GetPatientAgeMonth ()

int	GetPatientAgeWeek ()

int	GetPatientAgeDay ()

int	GetPatientBirthDateYear ()

int	GetPatientBirthDateMonth ()

int	GetPatientBirthDateDay ()

int	GetAcquisitionDateYear ()

int	GetAcquisitionDateMonth ()

int	GetAcquisitionDateDay ()

int	GetImageDateYear ()

int	GetImageDateMonth ()

int	GetImageDateDay ()

virtual void	AddUserDefinedValue (const char name, const char value)

virtual const char *	GetUserDefinedValue (const char *name)

virtual unsigned int	GetNumberOfUserDefinedValues ()

virtual const char *	GetUserDefinedNameByIndex (unsigned int idx)

virtual const char *	GetUserDefinedValueByIndex (unsigned int idx)

virtual void	RemoveAllUserDefinedValues ()

int	GetSliceIDFromInstanceUID (int &volumeidx, const char *uid)
	Provides the inverse mapping.

int	GetOrientationType (int volumeidx)

void	SetOrientationType (int volumeidx, int orientation)

virtual void	DeepCopy (vtkMedicalImageProperties *p)
	Copy the contents of p to this instance.


virtual void	SetPatientName (const char *)
	Patient name For ex: DICOM (0010,0010) = DOE,JOHN.

virtual char *	GetPatientName ()
	Patient name For ex: DICOM (0010,0010) = DOE,JOHN.


virtual void	SetPatientID (const char *)
	Patient ID For ex: DICOM (0010,0020) = 1933197.

virtual char *	GetPatientID ()
	Patient ID For ex: DICOM (0010,0020) = 1933197.


virtual void	SetPatientAge (const char *)
	Patient age Format: nnnD, nnW, nnnM or nnnY (eventually nnD, nnW, nnY) with D (day), M (month), W (week), Y (year) For ex: DICOM (0010,1010) = 031Y.

virtual char *	GetPatientAge ()
	Patient age Format: nnnD, nnW, nnnM or nnnY (eventually nnD, nnW, nnY) with D (day), M (month), W (week), Y (year) For ex: DICOM (0010,1010) = 031Y.


virtual void	SetPatientSex (const char *)
	Patient sex For ex: DICOM (0010,0040) = M.

virtual char *	GetPatientSex ()
	Patient sex For ex: DICOM (0010,0040) = M.


virtual void	SetPatientBirthDate (const char *)
	Patient birth date Format: yyyymmdd For ex: DICOM (0010,0030) = 19680427.

virtual char *	GetPatientBirthDate ()
	Patient birth date Format: yyyymmdd For ex: DICOM (0010,0030) = 19680427.


virtual void	SetStudyDate (const char *)
	Study Date Format: yyyymmdd For ex: DICOM (0008,0020) = 20030617.

virtual char *	GetStudyDate ()
	Study Date Format: yyyymmdd For ex: DICOM (0008,0020) = 20030617.


virtual void	SetAcquisitionDate (const char *)
	Acquisition Date Format: yyyymmdd For ex: DICOM (0008,0022) = 20030617.

virtual char *	GetAcquisitionDate ()
	Acquisition Date Format: yyyymmdd For ex: DICOM (0008,0022) = 20030617.


virtual void	SetStudyTime (const char *)
	Study Time Format: hhmmss.frac (any trailing component(s) can be omitted) For ex: DICOM (0008,0030) = 162552.0705 or 230012, or 0012.

virtual char *	GetStudyTime ()
	Study Time Format: hhmmss.frac (any trailing component(s) can be omitted) For ex: DICOM (0008,0030) = 162552.0705 or 230012, or 0012.


virtual void	SetAcquisitionTime (const char *)
	Acquisition time Format: hhmmss.frac (any trailing component(s) can be omitted) For ex: DICOM (0008,0032) = 162552.0705 or 230012, or 0012.

virtual char *	GetAcquisitionTime ()
	Acquisition time Format: hhmmss.frac (any trailing component(s) can be omitted) For ex: DICOM (0008,0032) = 162552.0705 or 230012, or 0012.


virtual void	SetImageDate (const char *)
	Image Date aka Content Date Format: yyyymmdd For ex: DICOM (0008,0023) = 20030617.

virtual char *	GetImageDate ()
	Image Date aka Content Date Format: yyyymmdd For ex: DICOM (0008,0023) = 20030617.


virtual void	SetImageTime (const char *)
	Image Time Format: hhmmss.frac (any trailing component(s) can be omitted) For ex: DICOM (0008,0033) = 162552.0705 or 230012, or 0012.

virtual char *	GetImageTime ()
	Image Time Format: hhmmss.frac (any trailing component(s) can be omitted) For ex: DICOM (0008,0033) = 162552.0705 or 230012, or 0012.


virtual void	SetImageNumber (const char *)
	Image number For ex: DICOM (0020,0013) = 1.

virtual char *	GetImageNumber ()
	Image number For ex: DICOM (0020,0013) = 1.


virtual void	SetSeriesNumber (const char *)
	Series number For ex: DICOM (0020,0011) = 902.

virtual char *	GetSeriesNumber ()
	Series number For ex: DICOM (0020,0011) = 902.


virtual void	SetSeriesDescription (const char *)
	Series Description User provided description of the Series For ex: DICOM (0008,103e) = SCOUT.

virtual char *	GetSeriesDescription ()
	Series Description User provided description of the Series For ex: DICOM (0008,103e) = SCOUT.


virtual void	SetStudyID (const char *)
	Study ID For ex: DICOM (0020,0010) = 37481.

virtual char *	GetStudyID ()
	Study ID For ex: DICOM (0020,0010) = 37481.


virtual void	SetStudyDescription (const char *)
	Study description For ex: DICOM (0008,1030) = BRAIN/C-SP/FACIAL.

virtual char *	GetStudyDescription ()
	Study description For ex: DICOM (0008,1030) = BRAIN/C-SP/FACIAL.


virtual void	SetModality (const char *)
	Modality For ex: DICOM (0008,0060)= CT.

virtual char *	GetModality ()
	Modality For ex: DICOM (0008,0060)= CT.


virtual void	SetManufacturer (const char *)
	Manufacturer For ex: DICOM (0008,0070) = Siemens.

virtual char *	GetManufacturer ()
	Manufacturer For ex: DICOM (0008,0070) = Siemens.


virtual void	SetManufacturerModelName (const char *)
	Manufacturer's Model Name For ex: DICOM (0008,1090) = LightSpeed QX/i.

virtual char *	GetManufacturerModelName ()
	Manufacturer's Model Name For ex: DICOM (0008,1090) = LightSpeed QX/i.


virtual void	SetStationName (const char *)
	Station Name For ex: DICOM (0008,1010) = LSPD_OC8.

virtual char *	GetStationName ()
	Station Name For ex: DICOM (0008,1010) = LSPD_OC8.


virtual void	SetInstitutionName (const char *)
	Institution Name For ex: DICOM (0008,0080) = FooCity Medical Center.

virtual char *	GetInstitutionName ()
	Institution Name For ex: DICOM (0008,0080) = FooCity Medical Center.


virtual void	SetConvolutionKernel (const char *)
	Convolution Kernel (or algorithm used to reconstruct the data) For ex: DICOM (0018,1210) = Bone.

virtual char *	GetConvolutionKernel ()
	Convolution Kernel (or algorithm used to reconstruct the data) For ex: DICOM (0018,1210) = Bone.


virtual void	SetSliceThickness (const char *)
	Slice Thickness (Nominal reconstructed slice thickness, in mm) For ex: DICOM (0018,0050) = 0.273438.

virtual char *	GetSliceThickness ()
	Slice Thickness (Nominal reconstructed slice thickness, in mm) For ex: DICOM (0018,0050) = 0.273438.

virtual double	GetSliceThicknessAsDouble ()
	Slice Thickness (Nominal reconstructed slice thickness, in mm) For ex: DICOM (0018,0050) = 0.273438.


virtual void	SetKVP (const char *)
	Peak kilo voltage output of the (x-ray) generator used For ex: DICOM (0018,0060) = 120.

virtual char *	GetKVP ()
	Peak kilo voltage output of the (x-ray) generator used For ex: DICOM (0018,0060) = 120.


virtual void	SetGantryTilt (const char *)
	Gantry/Detector tilt (Nominal angle of tilt in degrees of the scanning gantry.) For ex: DICOM (0018,1120) = 15.

virtual char *	GetGantryTilt ()
	Gantry/Detector tilt (Nominal angle of tilt in degrees of the scanning gantry.) For ex: DICOM (0018,1120) = 15.

virtual double	GetGantryTiltAsDouble ()
	Gantry/Detector tilt (Nominal angle of tilt in degrees of the scanning gantry.) For ex: DICOM (0018,1120) = 15.


virtual void	SetEchoTime (const char *)
	Echo Time (Time in ms between the middle of the excitation pulse and the peak of the echo produced) For ex: DICOM (0018,0081) = 105.

virtual char *	GetEchoTime ()
	Echo Time (Time in ms between the middle of the excitation pulse and the peak of the echo produced) For ex: DICOM (0018,0081) = 105.


virtual void	SetEchoTrainLength (const char *)
	Echo Train Length (Number of lines in k-space acquired per excitation per image) For ex: DICOM (0018,0091) = 35.

virtual char *	GetEchoTrainLength ()
	Echo Train Length (Number of lines in k-space acquired per excitation per image) For ex: DICOM (0018,0091) = 35.


virtual void	SetRepetitionTime (const char *)
	Repetition Time The period of time in msec between the beginning of a pulse sequence and the beginning of the succeeding (essentially identical) pulse sequence.

virtual char *	GetRepetitionTime ()
	Repetition Time The period of time in msec between the beginning of a pulse sequence and the beginning of the succeeding (essentially identical) pulse sequence.


virtual void	SetExposureTime (const char *)
	Exposure time (time of x-ray exposure in msec) For ex: DICOM (0018,1150) = 5.

virtual char *	GetExposureTime ()
	Exposure time (time of x-ray exposure in msec) For ex: DICOM (0018,1150) = 5.


virtual void	SetXRayTubeCurrent (const char *)
	X-ray tube current (in mA) For ex: DICOM (0018,1151) = 400.

virtual char *	GetXRayTubeCurrent ()
	X-ray tube current (in mA) For ex: DICOM (0018,1151) = 400.


virtual void	SetExposure (const char *)
	Exposure (The exposure expressed in mAs, for example calculated from Exposure Time and X-ray Tube Current) For ex: DICOM (0018,1152) = 114.

virtual char *	GetExposure ()
	Exposure (The exposure expressed in mAs, for example calculated from Exposure Time and X-ray Tube Current) For ex: DICOM (0018,1152) = 114.


virtual void	SetDirectionCosine (double, double, double, double, double, double)
	Get the direction cosine (default to 1,0,0,0,1,0)

virtual void	SetDirectionCosine (double[6])
	Get the direction cosine (default to 1,0,0,0,1,0)

virtual double *	GetDirectionCosine ()
	Get the direction cosine (default to 1,0,0,0,1,0)

virtual void	GetDirectionCosine (double &, double &, double &, double &, double &, double &)
	Get the direction cosine (default to 1,0,0,0,1,0)

virtual void	GetDirectionCosine (double[6])
	Get the direction cosine (default to 1,0,0,0,1,0)


virtual int	AddWindowLevelPreset (double w, double l)
	Add/Remove/Query the window/level presets that may have been associated to a medical image.

virtual void	RemoveWindowLevelPreset (double w, double l)
	Add/Remove/Query the window/level presets that may have been associated to a medical image.

virtual void	RemoveAllWindowLevelPresets ()
	Add/Remove/Query the window/level presets that may have been associated to a medical image.

virtual int	GetNumberOfWindowLevelPresets ()
	Add/Remove/Query the window/level presets that may have been associated to a medical image.

virtual int	HasWindowLevelPreset (double w, double l)
	Add/Remove/Query the window/level presets that may have been associated to a medical image.

virtual int	GetWindowLevelPresetIndex (double w, double l)
	Add/Remove/Query the window/level presets that may have been associated to a medical image.

virtual int	GetNthWindowLevelPreset (int idx, double w, double l)
	Add/Remove/Query the window/level presets that may have been associated to a medical image.

virtual double *	GetNthWindowLevelPreset (int idx)
	Add/Remove/Query the window/level presets that may have been associated to a medical image.

virtual void	SetNthWindowLevelPresetComment (int idx, const char *comment)
	Add/Remove/Query the window/level presets that may have been associated to a medical image.

virtual const char *	GetNthWindowLevelPresetComment (int idx)
	Add/Remove/Query the window/level presets that may have been associated to a medical image.


const char *	GetInstanceUIDFromSliceID (int volumeidx, int sliceid)
	Mapping from a sliceidx within a volumeidx into a DICOM Instance UID Some DICOM reader can populate this structure so that later on from a slice index in a vtkImageData volume we can backtrack and find out which 2d slice it was coming from.

void	SetInstanceUIDFromSliceID (int volumeidx, int sliceid, const char *uid)
	Mapping from a sliceidx within a volumeidx into a DICOM Instance UID Some DICOM reader can populate this structure so that later on from a slice index in a vtkImageData volume we can backtrack and find out which 2d slice it was coming from.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkMedicalImageProperties *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkMedicalImageProperties *	SafeDownCast (vtkObjectBase *o)

static int	GetAgeAsFields (const char *age, int &year, int &month, int &week, int &day)
	Take as input a string in VR=AS (DICOM PS3.5) and extract either different fields namely: year month week day Return 0 on error, 1 on success One can test fields if they are different from -1 upon success.

static int	GetDateAsFields (const char *date, int &year, int &month, int &day)
	Take as input a string in ISO 8601 date (YYYY/MM/DD) and extract the different fields namely: year month day Return 0 on error, 1 on success.

static int	GetTimeAsFields (const char *time, int &hour, int &minute, int &second)
	Take as input a string in VR:TM format (HHMMSS) and extract the different fields namely: hour, minute and second Return 0 on error, 1 on success.

static int	GetDateAsLocale (const char date, char locale)
	Take as input a string in ISO 8601 date (YYYY/MM/DD) and construct a locale date based on the different fields (see GetDateAsFields to extract different fields) Return 0 on error, 1 on success.

static const char *	GetStringFromOrientationType (unsigned int type)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkMedicalImageProperties ()

	~vtkMedicalImageProperties () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
char *	StudyDate

char *	AcquisitionDate

char *	StudyTime

char *	AcquisitionTime

char *	ConvolutionKernel

char *	EchoTime

char *	EchoTrainLength

char *	Exposure

char *	ExposureTime

char *	GantryTilt

char *	ImageDate

char *	ImageNumber

char *	ImageTime

char *	InstitutionName

char *	KVP

char *	ManufacturerModelName

char *	Manufacturer

char *	Modality

char *	PatientAge

char *	PatientBirthDate

char *	PatientID

char *	PatientName

char *	PatientSex

char *	RepetitionTime

char *	SeriesDescription

char *	SeriesNumber

char *	SliceThickness

char *	StationName

char *	StudyDescription

char *	StudyID

char *	XRayTubeCurrent

double	DirectionCosine [6]

vtkMedicalImagePropertiesInternals *	Internals
	PIMPL Encapsulation for STL containers.

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

some medical image properties.

vtkMedicalImageProperties is a helper class that can be used by medical image readers and applications to encapsulate medical image/acquisition properties. Later on, this should probably be extended to add any user-defined property.

See also: vtkMedicalImageReader2

Definition at line 35 of file vtkMedicalImageProperties.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkMedicalImageProperties::Superclass

Definition at line 39 of file vtkMedicalImageProperties.h.

Member Enumeration Documentation

◆ OrientationType

enum vtkMedicalImageProperties::OrientationType

Enumerator
AXIAL
CORONAL
SAGITTAL

Definition at line 467 of file vtkMedicalImageProperties.h.

Constructor & Destructor Documentation

◆ vtkMedicalImageProperties()

vtkMedicalImageProperties::vtkMedicalImageProperties ( )

protected

◆ ~vtkMedicalImageProperties()

vtkMedicalImageProperties::~vtkMedicalImageProperties ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkMedicalImageProperties * vtkMedicalImageProperties::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkMedicalImageProperties::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkMedicalImageProperties::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkMedicalImageProperties * vtkMedicalImageProperties::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkMedicalImageProperties::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkMedicalImageProperties * vtkMedicalImageProperties::NewInstance ( ) const

◆ PrintSelf()

void vtkMedicalImageProperties::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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 vtkObject.

◆ Clear()

virtual void vtkMedicalImageProperties::Clear ( )

virtual

Convenience method to reset all fields to an empty string/value.

◆ SetPatientName()

virtual void vtkMedicalImageProperties::SetPatientName ( const char * )

virtual

Patient name For ex: DICOM (0010,0010) = DOE,JOHN.

◆ GetPatientName()

virtual char * vtkMedicalImageProperties::GetPatientName ( )

virtual

Patient name For ex: DICOM (0010,0010) = DOE,JOHN.

◆ SetPatientID()

virtual void vtkMedicalImageProperties::SetPatientID ( const char * )

virtual

Patient ID For ex: DICOM (0010,0020) = 1933197.

◆ GetPatientID()

virtual char * vtkMedicalImageProperties::GetPatientID ( )

virtual

Patient ID For ex: DICOM (0010,0020) = 1933197.

◆ SetPatientAge()

virtual void vtkMedicalImageProperties::SetPatientAge ( const char * )

virtual

Patient age Format: nnnD, nnW, nnnM or nnnY (eventually nnD, nnW, nnY) with D (day), M (month), W (week), Y (year) For ex: DICOM (0010,1010) = 031Y.

◆ GetPatientAge()

virtual char * vtkMedicalImageProperties::GetPatientAge ( )

virtual

Patient age Format: nnnD, nnW, nnnM or nnnY (eventually nnD, nnW, nnY) with D (day), M (month), W (week), Y (year) For ex: DICOM (0010,1010) = 031Y.

◆ GetAgeAsFields()

static int vtkMedicalImageProperties::GetAgeAsFields	(	const char *	age,
		int &	year,
		int &	month,
		int &	week,
		int &	day
	)

static

Take as input a string in VR=AS (DICOM PS3.5) and extract either different fields namely: year month week day Return 0 on error, 1 on success One can test fields if they are different from -1 upon success.

◆ GetPatientAgeYear()

int vtkMedicalImageProperties::GetPatientAgeYear ( )

◆ GetPatientAgeMonth()

int vtkMedicalImageProperties::GetPatientAgeMonth ( )

◆ GetPatientAgeWeek()

int vtkMedicalImageProperties::GetPatientAgeWeek ( )

◆ GetPatientAgeDay()

int vtkMedicalImageProperties::GetPatientAgeDay ( )

◆ SetPatientSex()

virtual void vtkMedicalImageProperties::SetPatientSex ( const char * )

virtual

Patient sex For ex: DICOM (0010,0040) = M.

◆ GetPatientSex()

virtual char * vtkMedicalImageProperties::GetPatientSex ( )

virtual

Patient sex For ex: DICOM (0010,0040) = M.

◆ SetPatientBirthDate()

virtual void vtkMedicalImageProperties::SetPatientBirthDate ( const char * )

virtual

Patient birth date Format: yyyymmdd For ex: DICOM (0010,0030) = 19680427.

◆ GetPatientBirthDate()

virtual char * vtkMedicalImageProperties::GetPatientBirthDate ( )

virtual

Patient birth date Format: yyyymmdd For ex: DICOM (0010,0030) = 19680427.

◆ GetPatientBirthDateYear()

int vtkMedicalImageProperties::GetPatientBirthDateYear ( )

◆ GetPatientBirthDateMonth()

int vtkMedicalImageProperties::GetPatientBirthDateMonth ( )

◆ GetPatientBirthDateDay()

int vtkMedicalImageProperties::GetPatientBirthDateDay ( )

◆ SetStudyDate()

virtual void vtkMedicalImageProperties::SetStudyDate ( const char * )

virtual

Study Date Format: yyyymmdd For ex: DICOM (0008,0020) = 20030617.

◆ GetStudyDate()

virtual char * vtkMedicalImageProperties::GetStudyDate ( )

virtual

Study Date Format: yyyymmdd For ex: DICOM (0008,0020) = 20030617.

◆ SetAcquisitionDate()

virtual void vtkMedicalImageProperties::SetAcquisitionDate ( const char * )

virtual

Acquisition Date Format: yyyymmdd For ex: DICOM (0008,0022) = 20030617.

◆ GetAcquisitionDate()

virtual char * vtkMedicalImageProperties::GetAcquisitionDate ( )

virtual

Acquisition Date Format: yyyymmdd For ex: DICOM (0008,0022) = 20030617.

◆ GetAcquisitionDateYear()

int vtkMedicalImageProperties::GetAcquisitionDateYear ( )

◆ GetAcquisitionDateMonth()

int vtkMedicalImageProperties::GetAcquisitionDateMonth ( )

◆ GetAcquisitionDateDay()

int vtkMedicalImageProperties::GetAcquisitionDateDay ( )

◆ SetStudyTime()

virtual void vtkMedicalImageProperties::SetStudyTime ( const char * )

virtual

Study Time Format: hhmmss.frac (any trailing component(s) can be omitted) For ex: DICOM (0008,0030) = 162552.0705 or 230012, or 0012.

◆ GetStudyTime()

virtual char * vtkMedicalImageProperties::GetStudyTime ( )

virtual

Study Time Format: hhmmss.frac (any trailing component(s) can be omitted) For ex: DICOM (0008,0030) = 162552.0705 or 230012, or 0012.

◆ SetAcquisitionTime()

virtual void vtkMedicalImageProperties::SetAcquisitionTime ( const char * )

virtual

Acquisition time Format: hhmmss.frac (any trailing component(s) can be omitted) For ex: DICOM (0008,0032) = 162552.0705 or 230012, or 0012.

◆ GetAcquisitionTime()

virtual char * vtkMedicalImageProperties::GetAcquisitionTime ( )

virtual

Acquisition time Format: hhmmss.frac (any trailing component(s) can be omitted) For ex: DICOM (0008,0032) = 162552.0705 or 230012, or 0012.

◆ SetImageDate()

virtual void vtkMedicalImageProperties::SetImageDate ( const char * )

virtual

Image Date aka Content Date Format: yyyymmdd For ex: DICOM (0008,0023) = 20030617.

◆ GetImageDate()

virtual char * vtkMedicalImageProperties::GetImageDate ( )

virtual

Image Date aka Content Date Format: yyyymmdd For ex: DICOM (0008,0023) = 20030617.

◆ GetImageDateYear()

int vtkMedicalImageProperties::GetImageDateYear ( )

◆ GetImageDateMonth()

int vtkMedicalImageProperties::GetImageDateMonth ( )

◆ GetImageDateDay()

int vtkMedicalImageProperties::GetImageDateDay ( )

◆ GetDateAsFields()

static int vtkMedicalImageProperties::GetDateAsFields	(	const char *	date,
		int &	year,
		int &	month,
		int &	day
	)

static

Take as input a string in ISO 8601 date (YYYY/MM/DD) and extract the different fields namely: year month day Return 0 on error, 1 on success.

◆ GetTimeAsFields()

static int vtkMedicalImageProperties::GetTimeAsFields	(	const char *	time,
		int &	hour,
		int &	minute,
		int &	second
	)

static

Take as input a string in VR:TM format (HHMMSS) and extract the different fields namely: hour, minute and second Return 0 on error, 1 on success.

◆ GetDateAsLocale()

static int vtkMedicalImageProperties::GetDateAsLocale	(	const char *	date,
		char *	locale
	)

static

Take as input a string in ISO 8601 date (YYYY/MM/DD) and construct a locale date based on the different fields (see GetDateAsFields to extract different fields) Return 0 on error, 1 on success.

◆ SetImageTime()

virtual void vtkMedicalImageProperties::SetImageTime ( const char * )

virtual

Image Time Format: hhmmss.frac (any trailing component(s) can be omitted) For ex: DICOM (0008,0033) = 162552.0705 or 230012, or 0012.

◆ GetImageTime()

virtual char * vtkMedicalImageProperties::GetImageTime ( )

virtual

Image Time Format: hhmmss.frac (any trailing component(s) can be omitted) For ex: DICOM (0008,0033) = 162552.0705 or 230012, or 0012.

◆ SetImageNumber()

virtual void vtkMedicalImageProperties::SetImageNumber ( const char * )

virtual

Image number For ex: DICOM (0020,0013) = 1.

◆ GetImageNumber()

virtual char * vtkMedicalImageProperties::GetImageNumber ( )

virtual

Image number For ex: DICOM (0020,0013) = 1.

◆ SetSeriesNumber()

virtual void vtkMedicalImageProperties::SetSeriesNumber ( const char * )

virtual

Series number For ex: DICOM (0020,0011) = 902.

◆ GetSeriesNumber()

virtual char * vtkMedicalImageProperties::GetSeriesNumber ( )

virtual

Series number For ex: DICOM (0020,0011) = 902.

◆ SetSeriesDescription()

virtual void vtkMedicalImageProperties::SetSeriesDescription ( const char * )

virtual

Series Description User provided description of the Series For ex: DICOM (0008,103e) = SCOUT.

◆ GetSeriesDescription()

virtual char * vtkMedicalImageProperties::GetSeriesDescription ( )

virtual

Series Description User provided description of the Series For ex: DICOM (0008,103e) = SCOUT.

◆ SetStudyID()

virtual void vtkMedicalImageProperties::SetStudyID ( const char * )

virtual

Study ID For ex: DICOM (0020,0010) = 37481.

◆ GetStudyID()

virtual char * vtkMedicalImageProperties::GetStudyID ( )

virtual

Study ID For ex: DICOM (0020,0010) = 37481.

◆ SetStudyDescription()

virtual void vtkMedicalImageProperties::SetStudyDescription ( const char * )

virtual

Study description For ex: DICOM (0008,1030) = BRAIN/C-SP/FACIAL.

◆ GetStudyDescription()

virtual char * vtkMedicalImageProperties::GetStudyDescription ( )

virtual

Study description For ex: DICOM (0008,1030) = BRAIN/C-SP/FACIAL.

◆ SetModality()

virtual void vtkMedicalImageProperties::SetModality ( const char * )

virtual

Modality For ex: DICOM (0008,0060)= CT.

◆ GetModality()

virtual char * vtkMedicalImageProperties::GetModality ( )

virtual

Modality For ex: DICOM (0008,0060)= CT.

◆ SetManufacturer()

virtual void vtkMedicalImageProperties::SetManufacturer ( const char * )

virtual

Manufacturer For ex: DICOM (0008,0070) = Siemens.

◆ GetManufacturer()

virtual char * vtkMedicalImageProperties::GetManufacturer ( )

virtual

Manufacturer For ex: DICOM (0008,0070) = Siemens.

◆ SetManufacturerModelName()

virtual void vtkMedicalImageProperties::SetManufacturerModelName ( const char * )

virtual

Manufacturer's Model Name For ex: DICOM (0008,1090) = LightSpeed QX/i.

◆ GetManufacturerModelName()

virtual char * vtkMedicalImageProperties::GetManufacturerModelName ( )

virtual

Manufacturer's Model Name For ex: DICOM (0008,1090) = LightSpeed QX/i.

◆ SetStationName()

virtual void vtkMedicalImageProperties::SetStationName ( const char * )

virtual

Station Name For ex: DICOM (0008,1010) = LSPD_OC8.

◆ GetStationName()

virtual char * vtkMedicalImageProperties::GetStationName ( )

virtual

Station Name For ex: DICOM (0008,1010) = LSPD_OC8.

◆ SetInstitutionName()

virtual void vtkMedicalImageProperties::SetInstitutionName ( const char * )

virtual

Institution Name For ex: DICOM (0008,0080) = FooCity Medical Center.

◆ GetInstitutionName()

virtual char * vtkMedicalImageProperties::GetInstitutionName ( )

virtual

Institution Name For ex: DICOM (0008,0080) = FooCity Medical Center.

◆ SetConvolutionKernel()

virtual void vtkMedicalImageProperties::SetConvolutionKernel ( const char * )

virtual

Convolution Kernel (or algorithm used to reconstruct the data) For ex: DICOM (0018,1210) = Bone.

◆ GetConvolutionKernel()

virtual char * vtkMedicalImageProperties::GetConvolutionKernel ( )

virtual

Convolution Kernel (or algorithm used to reconstruct the data) For ex: DICOM (0018,1210) = Bone.

◆ SetSliceThickness()

virtual void vtkMedicalImageProperties::SetSliceThickness ( const char * )

virtual

Slice Thickness (Nominal reconstructed slice thickness, in mm) For ex: DICOM (0018,0050) = 0.273438.

◆ GetSliceThickness()

virtual char * vtkMedicalImageProperties::GetSliceThickness ( )

virtual

Slice Thickness (Nominal reconstructed slice thickness, in mm) For ex: DICOM (0018,0050) = 0.273438.

◆ GetSliceThicknessAsDouble()

virtual double vtkMedicalImageProperties::GetSliceThicknessAsDouble ( )

virtual

Slice Thickness (Nominal reconstructed slice thickness, in mm) For ex: DICOM (0018,0050) = 0.273438.

◆ SetKVP()

virtual void vtkMedicalImageProperties::SetKVP ( const char * )

virtual

Peak kilo voltage output of the (x-ray) generator used For ex: DICOM (0018,0060) = 120.

◆ GetKVP()

virtual char * vtkMedicalImageProperties::GetKVP ( )

virtual

Peak kilo voltage output of the (x-ray) generator used For ex: DICOM (0018,0060) = 120.

◆ SetGantryTilt()

virtual void vtkMedicalImageProperties::SetGantryTilt ( const char * )

virtual

Gantry/Detector tilt (Nominal angle of tilt in degrees of the scanning gantry.) For ex: DICOM (0018,1120) = 15.

◆ GetGantryTilt()

virtual char * vtkMedicalImageProperties::GetGantryTilt ( )

virtual

Gantry/Detector tilt (Nominal angle of tilt in degrees of the scanning gantry.) For ex: DICOM (0018,1120) = 15.

◆ GetGantryTiltAsDouble()

virtual double vtkMedicalImageProperties::GetGantryTiltAsDouble ( )

virtual

Gantry/Detector tilt (Nominal angle of tilt in degrees of the scanning gantry.) For ex: DICOM (0018,1120) = 15.

◆ SetEchoTime()

virtual void vtkMedicalImageProperties::SetEchoTime ( const char * )

virtual

Echo Time (Time in ms between the middle of the excitation pulse and the peak of the echo produced) For ex: DICOM (0018,0081) = 105.

◆ GetEchoTime()

virtual char * vtkMedicalImageProperties::GetEchoTime ( )

virtual

Echo Time (Time in ms between the middle of the excitation pulse and the peak of the echo produced) For ex: DICOM (0018,0081) = 105.

◆ SetEchoTrainLength()

virtual void vtkMedicalImageProperties::SetEchoTrainLength ( const char * )

virtual

Echo Train Length (Number of lines in k-space acquired per excitation per image) For ex: DICOM (0018,0091) = 35.

◆ GetEchoTrainLength()

virtual char * vtkMedicalImageProperties::GetEchoTrainLength ( )

virtual

Echo Train Length (Number of lines in k-space acquired per excitation per image) For ex: DICOM (0018,0091) = 35.

◆ SetRepetitionTime()

virtual void vtkMedicalImageProperties::SetRepetitionTime ( const char * )

virtual

Repetition Time The period of time in msec between the beginning of a pulse sequence and the beginning of the succeeding (essentially identical) pulse sequence.

For ex: DICOM (0018,0080) = 2040

◆ GetRepetitionTime()

virtual char * vtkMedicalImageProperties::GetRepetitionTime ( )

virtual

Repetition Time The period of time in msec between the beginning of a pulse sequence and the beginning of the succeeding (essentially identical) pulse sequence.

For ex: DICOM (0018,0080) = 2040

◆ SetExposureTime()

virtual void vtkMedicalImageProperties::SetExposureTime ( const char * )

virtual

Exposure time (time of x-ray exposure in msec) For ex: DICOM (0018,1150) = 5.

◆ GetExposureTime()

virtual char * vtkMedicalImageProperties::GetExposureTime ( )

virtual

Exposure time (time of x-ray exposure in msec) For ex: DICOM (0018,1150) = 5.

◆ SetXRayTubeCurrent()

virtual void vtkMedicalImageProperties::SetXRayTubeCurrent ( const char * )

virtual

X-ray tube current (in mA) For ex: DICOM (0018,1151) = 400.

◆ GetXRayTubeCurrent()

virtual char * vtkMedicalImageProperties::GetXRayTubeCurrent ( )

virtual

X-ray tube current (in mA) For ex: DICOM (0018,1151) = 400.

◆ SetExposure()

virtual void vtkMedicalImageProperties::SetExposure ( const char * )

virtual

Exposure (The exposure expressed in mAs, for example calculated from Exposure Time and X-ray Tube Current) For ex: DICOM (0018,1152) = 114.

◆ GetExposure()

virtual char * vtkMedicalImageProperties::GetExposure ( )

virtual

Exposure (The exposure expressed in mAs, for example calculated from Exposure Time and X-ray Tube Current) For ex: DICOM (0018,1152) = 114.

◆ SetDirectionCosine() [1/2]

virtual void vtkMedicalImageProperties::SetDirectionCosine	(	double	,
		double	,
		double	,
		double	,
		double	,
		double
	)

virtual

Get the direction cosine (default to 1,0,0,0,1,0)

◆ SetDirectionCosine() [2/2]

virtual void vtkMedicalImageProperties::SetDirectionCosine ( double [6] )

virtual

Get the direction cosine (default to 1,0,0,0,1,0)

◆ GetDirectionCosine() [1/3]

virtual double * vtkMedicalImageProperties::GetDirectionCosine ( )

virtual

Get the direction cosine (default to 1,0,0,0,1,0)

◆ GetDirectionCosine() [2/3]

virtual void vtkMedicalImageProperties::GetDirectionCosine	(	double &	,
		double &	,
		double &	,
		double &	,
		double &	,
		double &
	)

virtual

Get the direction cosine (default to 1,0,0,0,1,0)

◆ GetDirectionCosine() [3/3]

virtual void vtkMedicalImageProperties::GetDirectionCosine ( double [6] )

virtual

Get the direction cosine (default to 1,0,0,0,1,0)

◆ AddUserDefinedValue()

virtual void vtkMedicalImageProperties::AddUserDefinedValue	(	const char *	name,
		const char *	value
	)

virtual

◆ GetUserDefinedValue()

virtual const char * vtkMedicalImageProperties::GetUserDefinedValue ( const char * name )

virtual

◆ GetNumberOfUserDefinedValues()

virtual unsigned int vtkMedicalImageProperties::GetNumberOfUserDefinedValues ( )

virtual

◆ GetUserDefinedNameByIndex()

virtual const char * vtkMedicalImageProperties::GetUserDefinedNameByIndex ( unsigned int idx )

virtual

◆ GetUserDefinedValueByIndex()

virtual const char * vtkMedicalImageProperties::GetUserDefinedValueByIndex ( unsigned int idx )

virtual

◆ RemoveAllUserDefinedValues()

virtual void vtkMedicalImageProperties::RemoveAllUserDefinedValues ( )

virtual