VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkMedicalImageProperties Class Reference

some medical image properties. More...

#include <vtkMedicalImageProperties.h>

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

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. More...
 
vtkMedicalImagePropertiesNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Clear ()
 Convenience method to reset all fields to an empty string/value. More...
 
virtual void SetPatientName (const char *)
 Patient name For ex: DICOM (0010,0010) = DOE,JOHN. More...
 
virtual char * GetPatientName ()
 
virtual void SetPatientID (const char *)
 Patient ID For ex: DICOM (0010,0020) = 1933197. More...
 
virtual char * GetPatientID ()
 
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. More...
 
virtual char * GetPatientAge ()
 
int GetPatientAgeYear ()
 
int GetPatientAgeMonth ()
 
int GetPatientAgeWeek ()
 
int GetPatientAgeDay ()
 
virtual void SetPatientSex (const char *)
 Patient sex For ex: DICOM (0010,0040) = M. More...
 
virtual char * GetPatientSex ()
 
virtual void SetPatientBirthDate (const char *)
 Patient birth date Format: yyyymmdd For ex: DICOM (0010,0030) = 19680427. More...
 
virtual char * GetPatientBirthDate ()
 
int GetPatientBirthDateYear ()
 
int GetPatientBirthDateMonth ()
 
int GetPatientBirthDateDay ()
 
virtual void SetStudyDate (const char *)
 Study Date Format: yyyymmdd For ex: DICOM (0008,0020) = 20030617. More...
 
virtual char * GetStudyDate ()
 
virtual void SetAcquisitionDate (const char *)
 Acquisition Date Format: yyyymmdd For ex: DICOM (0008,0022) = 20030617. More...
 
virtual char * GetAcquisitionDate ()
 
int GetAcquisitionDateYear ()
 
int GetAcquisitionDateMonth ()
 
int GetAcquisitionDateDay ()
 
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. More...
 
virtual char * GetStudyTime ()
 
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. More...
 
virtual char * GetAcquisitionTime ()
 
virtual void SetImageDate (const char *)
 Image Date aka Content Date Format: yyyymmdd For ex: DICOM (0008,0023) = 20030617. More...
 
virtual char * GetImageDate ()
 
int GetImageDateYear ()
 
int GetImageDateMonth ()
 
int GetImageDateDay ()
 
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. More...
 
virtual char * GetImageTime ()
 
virtual void SetImageNumber (const char *)
 Image number For ex: DICOM (0020,0013) = 1. More...
 
virtual char * GetImageNumber ()
 
virtual void SetSeriesNumber (const char *)
 Series number For ex: DICOM (0020,0011) = 902. More...
 
virtual char * GetSeriesNumber ()
 
virtual void SetSeriesDescription (const char *)
 Series Description User provided description of the Series For ex: DICOM (0008,103e) = SCOUT. More...
 
virtual char * GetSeriesDescription ()
 
virtual void SetStudyID (const char *)
 Study ID For ex: DICOM (0020,0010) = 37481. More...
 
virtual char * GetStudyID ()
 
virtual void SetStudyDescription (const char *)
 Study description For ex: DICOM (0008,1030) = BRAIN/C-SP/FACIAL. More...
 
virtual char * GetStudyDescription ()
 
virtual void SetModality (const char *)
 Modality For ex: DICOM (0008,0060)= CT. More...
 
virtual char * GetModality ()
 
virtual void SetManufacturer (const char *)
 Manufacturer For ex: DICOM (0008,0070) = Siemens. More...
 
virtual char * GetManufacturer ()
 
virtual void SetManufacturerModelName (const char *)
 Manufacturer's Model Name For ex: DICOM (0008,1090) = LightSpeed QX/i. More...
 
virtual char * GetManufacturerModelName ()
 
virtual void SetStationName (const char *)
 Station Name For ex: DICOM (0008,1010) = LSPD_OC8. More...
 
virtual char * GetStationName ()
 
virtual void SetInstitutionName (const char *)
 Institution Name For ex: DICOM (0008,0080) = FooCity Medical Center. More...
 
virtual char * GetInstitutionName ()
 
virtual void SetConvolutionKernel (const char *)
 Convolution Kernel (or algorithm used to reconstruct the data) For ex: DICOM (0018,1210) = Bone. More...
 
virtual char * GetConvolutionKernel ()
 
virtual void SetSliceThickness (const char *)
 Slice Thickness (Nominal reconstructed slice thickness, in mm) For ex: DICOM (0018,0050) = 0.273438. More...
 
virtual char * GetSliceThickness ()
 
virtual double GetSliceThicknessAsDouble ()
 
virtual void SetKVP (const char *)
 Peak kilo voltage output of the (x-ray) generator used For ex: DICOM (0018,0060) = 120. More...
 
virtual char * GetKVP ()
 
virtual void SetGantryTilt (const char *)
 Gantry/Detector tilt (Nominal angle of tilt in degrees of the scanning gantry.) For ex: DICOM (0018,1120) = 15. More...
 
virtual char * GetGantryTilt ()
 
virtual double GetGantryTiltAsDouble ()
 
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. More...
 
virtual char * GetEchoTime ()
 
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. More...
 
virtual char * GetEchoTrainLength ()
 
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. More...
 
virtual char * GetRepetitionTime ()
 
virtual void SetExposureTime (const char *)
 Exposure time (time of x-ray exposure in msec) For ex: DICOM (0018,1150) = 5. More...
 
virtual char * GetExposureTime ()
 
virtual void SetXRayTubeCurrent (const char *)
 X-ray tube current (in mA) For ex: DICOM (0018,1151) = 400. More...
 
virtual char * GetXRayTubeCurrent ()
 
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. More...
 
virtual char * GetExposure ()
 
virtual void SetDirectionCosine (double, double, double, double, double, double)
 Get the direction cosine (default to 1,0,0,0,1,0) More...
 
virtual void SetDirectionCosine (double[6])
 
virtual double * GetDirectionCosine ()
 
virtual void GetDirectionCosine (double &, double &, double &, double &, double &, double &)
 
virtual void GetDirectionCosine (double[6])
 
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 ()
 
virtual int AddWindowLevelPreset (double w, double l)
 Add/Remove/Query the window/level presets that may have been associated to a medical image. More...
 
virtual void RemoveWindowLevelPreset (double w, double l)
 
virtual void RemoveAllWindowLevelPresets ()
 
virtual int GetNumberOfWindowLevelPresets ()
 
virtual int HasWindowLevelPreset (double w, double l)
 
virtual int GetWindowLevelPresetIndex (double w, double l)
 
virtual int GetNthWindowLevelPreset (int idx, double *w, double *l)
 
virtual double * GetNthWindowLevelPreset (int idx)
 
virtual void SetNthWindowLevelPresetComment (int idx, const char *comment)
 
virtual const char * GetNthWindowLevelPresetComment (int idx)
 
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. More...
 
void SetInstanceUIDFromSliceID (int volumeidx, int sliceid, const char *uid)
 
int GetSliceIDFromInstanceUID (int &volumeidx, const char *uid)
 Provides the inverse mapping. More...
 
int GetOrientationType (int volumeidx)
 
void SetOrientationType (int volumeidx, int orientation)
 
virtual void DeepCopy (vtkMedicalImageProperties *p)
 Copy the contents of p to this instance. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkMedicalImagePropertiesNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMedicalImagePropertiesSafeDownCast (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. More...
 
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. More...
 
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. More...
 
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. More...
 
static const char * GetStringFromOrientationType (unsigned int type)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
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. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

Definition at line 39 of file vtkMedicalImageProperties.h.

Member Enumeration Documentation

◆ 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

◆ SetPatientID()

virtual void vtkMedicalImageProperties::SetPatientID ( const char *  )
virtual

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

◆ GetPatientID()

virtual char* vtkMedicalImageProperties::GetPatientID ( )
virtual

◆ 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

◆ 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

◆ 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

◆ 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

◆ SetAcquisitionDate()

virtual void vtkMedicalImageProperties::SetAcquisitionDate ( const char *  )
virtual

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

◆ GetAcquisitionDate()

virtual char* vtkMedicalImageProperties::GetAcquisitionDate ( )
virtual

◆ 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

◆ 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

◆ 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

◆ 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

◆ SetImageNumber()

virtual void vtkMedicalImageProperties::SetImageNumber ( const char *  )
virtual

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

◆ GetImageNumber()

virtual char* vtkMedicalImageProperties::GetImageNumber ( )
virtual

◆ SetSeriesNumber()

virtual void vtkMedicalImageProperties::SetSeriesNumber ( const char *  )
virtual

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

◆ GetSeriesNumber()

virtual char* vtkMedicalImageProperties::GetSeriesNumber ( )
virtual

◆ 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

◆ SetStudyID()

virtual void vtkMedicalImageProperties::SetStudyID ( const char *  )
virtual

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

◆ GetStudyID()

virtual char* vtkMedicalImageProperties::GetStudyID ( )
virtual

◆ 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

◆ SetModality()

virtual void vtkMedicalImageProperties::SetModality ( const char *  )
virtual

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

◆ GetModality()

virtual char* vtkMedicalImageProperties::GetModality ( )
virtual

◆ SetManufacturer()

virtual void vtkMedicalImageProperties::SetManufacturer ( const char *  )
virtual

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

◆ GetManufacturer()

virtual char* vtkMedicalImageProperties::GetManufacturer ( )
virtual

◆ 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

◆ SetStationName()

virtual void vtkMedicalImageProperties::SetStationName ( const char *  )
virtual

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

◆ GetStationName()

virtual char* vtkMedicalImageProperties::GetStationName ( )
virtual

◆ SetInstitutionName()

virtual void vtkMedicalImageProperties::SetInstitutionName ( const char *  )
virtual

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

◆ GetInstitutionName()

virtual char* vtkMedicalImageProperties::GetInstitutionName ( )
virtual

◆ 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

◆ 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

◆ GetSliceThicknessAsDouble()

virtual double vtkMedicalImageProperties::GetSliceThicknessAsDouble ( )
virtual

◆ 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

◆ 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

◆ GetGantryTiltAsDouble()

virtual double vtkMedicalImageProperties::GetGantryTiltAsDouble ( )
virtual

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ GetDirectionCosine() [1/3]

virtual double* vtkMedicalImageProperties::GetDirectionCosine ( )
virtual

◆ GetDirectionCosine() [2/3]

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

◆ GetDirectionCosine() [3/3]

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

◆ 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

◆ AddWindowLevelPreset()

virtual int vtkMedicalImageProperties::AddWindowLevelPreset ( double  w,
double  l 
)
virtual

Add/Remove/Query the window/level presets that may have been associated to a medical image.

Window is also known as 'width', level is also known as 'center'. The same window/level pair can not be added twice. As a convenience, a comment (aka Explanation) can be associated to a preset. For ex:

* DICOM Window Center (0028,1050) = 00045\000470
* DICOM Window Width  (0028,1051) = 0106\03412
* DICOM Window Center Width Explanation (0028,1055) = WINDOW1\WINDOW2
* 

◆ RemoveWindowLevelPreset()

virtual void vtkMedicalImageProperties::RemoveWindowLevelPreset ( double  w,
double  l 
)
virtual

◆ RemoveAllWindowLevelPresets()

virtual void vtkMedicalImageProperties::RemoveAllWindowLevelPresets ( )
virtual

◆ GetNumberOfWindowLevelPresets()

virtual int vtkMedicalImageProperties::GetNumberOfWindowLevelPresets ( )
virtual

◆ HasWindowLevelPreset()

virtual int vtkMedicalImageProperties::HasWindowLevelPreset ( double  w,
double  l 
)
virtual

◆ GetWindowLevelPresetIndex()

virtual int vtkMedicalImageProperties::GetWindowLevelPresetIndex ( double  w,
double  l 
)
virtual

◆ GetNthWindowLevelPreset() [1/2]

virtual int vtkMedicalImageProperties::GetNthWindowLevelPreset ( int  idx,
double *  w,
double *  l 
)
virtual

◆ GetNthWindowLevelPreset() [2/2]

virtual double* vtkMedicalImageProperties::GetNthWindowLevelPreset ( int  idx)
virtual

◆ SetNthWindowLevelPresetComment()

virtual void vtkMedicalImageProperties::SetNthWindowLevelPresetComment ( int  idx,
const char *  comment 
)
virtual

◆ GetNthWindowLevelPresetComment()

virtual const char* vtkMedicalImageProperties::GetNthWindowLevelPresetComment ( int  idx)
virtual

◆ GetInstanceUIDFromSliceID()

const char* vtkMedicalImageProperties::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.

◆ SetInstanceUIDFromSliceID()

void vtkMedicalImageProperties::SetInstanceUIDFromSliceID ( int  volumeidx,
int  sliceid,
const char *  uid 
)

◆ GetSliceIDFromInstanceUID()

int vtkMedicalImageProperties::GetSliceIDFromInstanceUID ( int &  volumeidx,
const char *  uid 
)

Provides the inverse mapping.

Returns -1 if a slice for this uid is not found.

◆ GetOrientationType()

int vtkMedicalImageProperties::GetOrientationType ( int  volumeidx)

◆ SetOrientationType()

void vtkMedicalImageProperties::SetOrientationType ( int  volumeidx,
int  orientation 
)

◆ GetStringFromOrientationType()

static const char* vtkMedicalImageProperties::GetStringFromOrientationType ( unsigned int  type)
static

◆ DeepCopy()

virtual void vtkMedicalImageProperties::DeepCopy ( vtkMedicalImageProperties p)
virtual

Copy the contents of p to this instance.

Member Data Documentation

◆ StudyDate

char* vtkMedicalImageProperties::StudyDate
protected

Definition at line 487 of file vtkMedicalImageProperties.h.

◆ AcquisitionDate

char* vtkMedicalImageProperties::AcquisitionDate
protected

Definition at line 488 of file vtkMedicalImageProperties.h.

◆ StudyTime

char* vtkMedicalImageProperties::StudyTime
protected

Definition at line 489 of file vtkMedicalImageProperties.h.

◆ AcquisitionTime

char* vtkMedicalImageProperties::AcquisitionTime
protected

Definition at line 490 of file vtkMedicalImageProperties.h.

◆ ConvolutionKernel

char* vtkMedicalImageProperties::ConvolutionKernel
protected

Definition at line 491 of file vtkMedicalImageProperties.h.

◆ EchoTime

char* vtkMedicalImageProperties::EchoTime
protected

Definition at line 492 of file vtkMedicalImageProperties.h.

◆ EchoTrainLength

char* vtkMedicalImageProperties::EchoTrainLength
protected

Definition at line 493 of file vtkMedicalImageProperties.h.

◆ Exposure

char* vtkMedicalImageProperties::Exposure
protected

Definition at line 494 of file vtkMedicalImageProperties.h.

◆ ExposureTime

char* vtkMedicalImageProperties::ExposureTime
protected

Definition at line 495 of file vtkMedicalImageProperties.h.

◆ GantryTilt

char* vtkMedicalImageProperties::GantryTilt
protected

Definition at line 496 of file vtkMedicalImageProperties.h.

◆ ImageDate

char* vtkMedicalImageProperties::ImageDate
protected

Definition at line 497 of file vtkMedicalImageProperties.h.

◆ ImageNumber

char* vtkMedicalImageProperties::ImageNumber
protected

Definition at line 498 of file vtkMedicalImageProperties.h.

◆ ImageTime

char* vtkMedicalImageProperties::ImageTime
protected

Definition at line 499 of file vtkMedicalImageProperties.h.

◆ InstitutionName

char* vtkMedicalImageProperties::InstitutionName
protected

Definition at line 500 of file vtkMedicalImageProperties.h.

◆ KVP

char* vtkMedicalImageProperties::KVP
protected

Definition at line 501 of file vtkMedicalImageProperties.h.

◆ ManufacturerModelName

char* vtkMedicalImageProperties::ManufacturerModelName
protected

Definition at line 502 of file vtkMedicalImageProperties.h.

◆ Manufacturer

char* vtkMedicalImageProperties::Manufacturer
protected

Definition at line 503 of file vtkMedicalImageProperties.h.

◆ Modality

char* vtkMedicalImageProperties::Modality
protected

Definition at line 504 of file vtkMedicalImageProperties.h.

◆ PatientAge

char* vtkMedicalImageProperties::PatientAge
protected

Definition at line 505 of file vtkMedicalImageProperties.h.

◆ PatientBirthDate

char* vtkMedicalImageProperties::PatientBirthDate
protected

Definition at line 506 of file vtkMedicalImageProperties.h.

◆ PatientID

char* vtkMedicalImageProperties::PatientID
protected

Definition at line 507 of file vtkMedicalImageProperties.h.

◆ PatientName

char* vtkMedicalImageProperties::PatientName
protected

Definition at line 508 of file vtkMedicalImageProperties.h.

◆ PatientSex

char* vtkMedicalImageProperties::PatientSex
protected

Definition at line 509 of file vtkMedicalImageProperties.h.

◆ RepetitionTime

char* vtkMedicalImageProperties::RepetitionTime
protected

Definition at line 510 of file vtkMedicalImageProperties.h.

◆ SeriesDescription

char* vtkMedicalImageProperties::SeriesDescription
protected

Definition at line 511 of file vtkMedicalImageProperties.h.

◆ SeriesNumber

char* vtkMedicalImageProperties::SeriesNumber
protected

Definition at line 512 of file vtkMedicalImageProperties.h.

◆ SliceThickness

char* vtkMedicalImageProperties::SliceThickness
protected

Definition at line 513 of file vtkMedicalImageProperties.h.

◆ StationName

char* vtkMedicalImageProperties::StationName
protected

Definition at line 514 of file vtkMedicalImageProperties.h.

◆ StudyDescription

char* vtkMedicalImageProperties::StudyDescription
protected

Definition at line 515 of file vtkMedicalImageProperties.h.

◆ StudyID

char* vtkMedicalImageProperties::StudyID
protected

Definition at line 516 of file vtkMedicalImageProperties.h.

◆ XRayTubeCurrent

char* vtkMedicalImageProperties::XRayTubeCurrent
protected

Definition at line 517 of file vtkMedicalImageProperties.h.

◆ DirectionCosine

double vtkMedicalImageProperties::DirectionCosine[6]
protected

Definition at line 518 of file vtkMedicalImageProperties.h.

◆ Internals

vtkMedicalImagePropertiesInternals* vtkMedicalImageProperties::Internals
protected

PIMPL Encapsulation for STL containers.

Definition at line 523 of file vtkMedicalImageProperties.h.


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