vtkMedicalImageProperties.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkMedicalImageProperties_h
#define vtkMedicalImageProperties_h
 
#include "vtkIOImageModule.h" // For export macro
#include "vtkObject.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkMedicalImagePropertiesInternals;
 
class VTKIOIMAGE_EXPORT vtkMedicalImageProperties : public vtkObject
{
public:
  static vtkMedicalImageProperties* New();
  vtkTypeMacro(vtkMedicalImageProperties, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  virtual void Clear();
 
 
  vtkSetStringMacro(PatientName);
  vtkGetStringMacro(PatientName);
 
 
  vtkSetStringMacro(PatientID);
  vtkGetStringMacro(PatientID);
 
 
  vtkSetStringMacro(PatientAge);
  vtkGetStringMacro(PatientAge);
 
  static int GetAgeAsFields(const char* age, int& year, int& month, int& week, int& day);
 
  // For Tcl:
  // From C++ use GetPatientAge + GetAgeAsField
  // Those function parse a DICOM string, and return the value of the number
  // expressed this is either expressed in year, month or days. Thus if a
  // string is expressed in years
  // GetPatientAgeDay/GetPatientAgeWeek/GetPatientAgeMonth will return 0
  int GetPatientAgeYear();
  int GetPatientAgeMonth();
  int GetPatientAgeWeek();
  int GetPatientAgeDay();
 
 
  vtkSetStringMacro(PatientSex);
  vtkGetStringMacro(PatientSex);
 
 
  vtkSetStringMacro(PatientBirthDate);
  vtkGetStringMacro(PatientBirthDate);
 
  // For Tcl:
  // From C++ use GetPatientBirthDate + GetDateAsFields
  int GetPatientBirthDateYear();
  int GetPatientBirthDateMonth();
  int GetPatientBirthDateDay();
 
 
  vtkSetStringMacro(StudyDate);
  vtkGetStringMacro(StudyDate);
 
 
  vtkSetStringMacro(AcquisitionDate);
  vtkGetStringMacro(AcquisitionDate);
 
  // For Tcl:
  // From C++ use GetAcquisitionDate + GetDateAsFields
  int GetAcquisitionDateYear();
  int GetAcquisitionDateMonth();
  int GetAcquisitionDateDay();
 
 
  vtkSetStringMacro(StudyTime);
  vtkGetStringMacro(StudyTime);
 
 
  vtkSetStringMacro(AcquisitionTime);
  vtkGetStringMacro(AcquisitionTime);
 
 
  vtkSetStringMacro(ImageDate);
  vtkGetStringMacro(ImageDate);
 
  // For Tcl:
  // From C++ use GetImageDate + GetDateAsFields
  int GetImageDateYear();
  int GetImageDateMonth();
  int GetImageDateDay();
 
  static int GetDateAsFields(const char* date, int& year, int& month, int& day);
 
  static int GetTimeAsFields(
    const char* time, int& hour, int& minute, int& second /* , long &milliseconds */);
 
  static int GetDateAsLocale(const char* date, char* locale);
 
 
  vtkSetStringMacro(ImageTime);
  vtkGetStringMacro(ImageTime);
 
 
  vtkSetStringMacro(ImageNumber);
  vtkGetStringMacro(ImageNumber);
 
 
  vtkSetStringMacro(SeriesNumber);
  vtkGetStringMacro(SeriesNumber);
 
 
  vtkSetStringMacro(SeriesDescription);
  vtkGetStringMacro(SeriesDescription);
 
 
  vtkSetStringMacro(StudyID);
  vtkGetStringMacro(StudyID);
 
 
  vtkSetStringMacro(StudyDescription);
  vtkGetStringMacro(StudyDescription);
 
 
  vtkSetStringMacro(Modality);
  vtkGetStringMacro(Modality);
 
 
  vtkSetStringMacro(Manufacturer);
  vtkGetStringMacro(Manufacturer);
 
 
  vtkSetStringMacro(ManufacturerModelName);
  vtkGetStringMacro(ManufacturerModelName);
 
 
  vtkSetStringMacro(StationName);
  vtkGetStringMacro(StationName);
 
 
  vtkSetStringMacro(InstitutionName);
  vtkGetStringMacro(InstitutionName);
 
 
  vtkSetStringMacro(ConvolutionKernel);
  vtkGetStringMacro(ConvolutionKernel);
 
 
  vtkSetStringMacro(SliceThickness);
  vtkGetStringMacro(SliceThickness);
  virtual double GetSliceThicknessAsDouble();
 
 
  vtkSetStringMacro(KVP);
  vtkGetStringMacro(KVP);
 
 
  vtkSetStringMacro(GantryTilt);
  vtkGetStringMacro(GantryTilt);
  virtual double GetGantryTiltAsDouble();
 
 
  vtkSetStringMacro(EchoTime);
  vtkGetStringMacro(EchoTime);
 
 
  vtkSetStringMacro(EchoTrainLength);
  vtkGetStringMacro(EchoTrainLength);
 
 
  vtkSetStringMacro(RepetitionTime);
  vtkGetStringMacro(RepetitionTime);
 
 
  vtkSetStringMacro(ExposureTime);
  vtkGetStringMacro(ExposureTime);
 
 
  vtkSetStringMacro(XRayTubeCurrent);
  vtkGetStringMacro(XRayTubeCurrent);
 
 
  vtkSetStringMacro(Exposure);
  vtkGetStringMacro(Exposure);
 
 
  vtkSetVector6Macro(DirectionCosine, double);
  vtkGetVector6Macro(DirectionCosine, double);
 
  // Interface to allow insertion of user define values, for instance in DICOM
  // one would want to
  // store the Protocol Name (0018,1030), in this case one would do:
  // AddUserDefinedValue( "Protocol Name", "T1W/SE/1024" );
  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);
  virtual void RemoveWindowLevelPreset(double w, double l);
  virtual void RemoveAllWindowLevelPresets();
  virtual int GetNumberOfWindowLevelPresets();
  virtual vtkTypeBool 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) VTK_SIZEHINT(2);
  virtual void SetNthWindowLevelPresetComment(int idx, const char* comment);
  virtual const char* GetNthWindowLevelPresetComment(int idx);
 
 
  const char* GetInstanceUIDFromSliceID(int volumeidx, int sliceid);
  void SetInstanceUIDFromSliceID(int volumeidx, int sliceid, const char* uid);
 
  int GetSliceIDFromInstanceUID(int& volumeidx, const char* uid);
 
  typedef enum
  {
    AXIAL = 0,
    CORONAL,
    SAGITTAL
  } OrientationType;
 
  int GetOrientationType(int volumeidx);
  void SetOrientationType(int volumeidx, int orientation);
  static const char* GetStringFromOrientationType(unsigned int type);
 
  virtual void DeepCopy(vtkMedicalImageProperties* p);
 
protected:
  vtkMedicalImageProperties();
  ~vtkMedicalImageProperties() override;
 
  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;
 
private:
  vtkMedicalImageProperties(const vtkMedicalImageProperties&) = delete;
  void operator=(const vtkMedicalImageProperties&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif