vtk-dicom  0.8.14
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkDICOMMRGenerator Class Reference

Generate DICOM data objects for MR images. More...

#include <vtkDICOMMRGenerator.h>

Inheritance diagram for vtkDICOMMRGenerator:
Inheritance graph
[legend]
Collaboration diagram for vtkDICOMMRGenerator:
Collaboration graph
[legend]

Public Types

typedef vtkDICOMGenerator Superclass
 
- Public Types inherited from vtkDICOMGenerator
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 
vtkDICOMMRGeneratorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) VTK_DICOM_OVERRIDE
 Print information about this object.
 
bool GenerateInstance (vtkInformation *info) VTK_DICOM_OVERRIDE
 Generate an instance of one of the supported classes. More...
 
- Public Member Functions inherited from vtkDICOMGenerator
vtkDICOMGeneratorNewInstance () const
 
vtkDICOMMetaDataGetMetaData ()
 Get the generated meta data. More...
 
virtual void SetExtended (int)
 Copy extended attributes from source (default: Off). More...
 
virtual void ExtendedOn ()
 
virtual void ExtendedOff ()
 
virtual int GetExtended ()
 
virtual void SetMultiFrame (int)
 Create a multi-frame object (default: Off). More...
 
virtual void MultiFrameOn ()
 
virtual void MultiFrameOff ()
 
virtual int GetMultiFrame ()
 
virtual void SetTimeAsVector (int)
 Write scalar components as the time dimension (default: Off). More...
 
virtual void TimeAsVectorOn ()
 
virtual void TimeAsVectorOff ()
 
virtual int GetTimeAsVector ()
 
virtual void SetTimeDimension (int)
 Set the time dimension to use in the DICOM file (or zero if none). More...
 
virtual int GetTimeDimension ()
 
virtual void SetTimeSpacing (double)
 
virtual double GetTimeSpacing ()
 
virtual void SetRescaleIntercept (double)
 Set the rescaling parameters, for example for CT. More...
 
virtual double GetRescaleIntercept ()
 
virtual void SetRescaleSlope (double)
 
virtual double GetRescaleSlope ()
 
virtual void SetNumberOfOverlays (int)
 Set the number of overlays to generate. More...
 
virtual int GetNumberOfOverlays ()
 
void SetPatientMatrix (vtkMatrix4x4 *)
 Set the matrix that places the image in DICOM patient coords. More...
 
vtkMatrix4x4 * GetPatientMatrix ()
 
virtual void SetOriginAtBottom (int)
 Let the generator know how the image is arranged in memory. More...
 
virtual int GetOriginAtBottom ()
 
virtual void SetReverseSliceOrder (int)
 Let the generator know how to order the slices. More...
 
virtual int GetReverseSliceOrder ()
 
void SetSourceMetaData (vtkDICOMMetaData *)
 Set some meta data for the constructor to use as a source. More...
 
vtkDICOMMetaDataGetSourceMetaData ()
 
void SetUIDGenerator (vtkDICOMUIDGenerator *)
 Set the UID generator, for generating unique IDs. More...
 
vtkDICOMUIDGeneratorGetUIDGenerator ()
 
vtkIntArray * GetSliceIndexArray ()
 Get an array that maps file and frame to slice. More...
 
vtkIntArray * GetComponentIndexArray ()
 Get an array that maps file and frame to component. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommand * GetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
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)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
int GetReferenceCount ()
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkDICOMMRGeneratorNew ()
 Static method for construction.
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDICOMMRGeneratorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkDICOMGenerator
static vtkDICOMGeneratorNew ()
 Static method for construction.
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDICOMGeneratorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
virtual bool GenerateMRSeriesModule (vtkDICOMMetaData *source)
 Generate the Series Module.
 
virtual bool GenerateMRImageModule (vtkDICOMMetaData *source)
 Generate the Image Module.
 
virtual bool GenerateMRInstance (vtkInformation *info)
 Instantiate a DICOM Secondary Capture Image object.
 
- Protected Member Functions inherited from vtkDICOMGenerator
 vtkDICOMGenerator ()
 Protected constructor method.
 
std::string GenerateUID (vtkDICOMTag tag)
 Generate a UID for the provided tag.
 
void GenerateUIDs (vtkDICOMTag tag, vtkStringArray *uids)
 Generate a series of UIDs, sorted from low to high. More...
 
void SetPixelRestrictions (unsigned int pixelRepresentation, unsigned int bitsStored, int colorComponents)
 Used by subclasses to place restrictions on the pixel type.
 
virtual bool GenerateSOPCommonModule (vtkDICOMMetaData *meta, const char *SOPClass)
 Generate the DICOM SOP Common Module.
 
virtual bool GeneratePatientModule (vtkDICOMMetaData *source)
 Generate the DICOM Patient Module.
 
virtual bool GenerateClinicalTrialSubjectModule (vtkDICOMMetaData *source)
 Generate the DICOM Clinical Trial Subject Module.
 
virtual bool GenerateGeneralStudyModule (vtkDICOMMetaData *source)
 Generate the DICOM General Study Module.
 
virtual bool GeneratePatientStudyModule (vtkDICOMMetaData *source)
 Generate the DICOM Patient Study Module.
 
virtual bool GenerateClinicalTrialStudyModule (vtkDICOMMetaData *source)
 Generate the DICOM Clinical Trial Study Module.
 
virtual bool GenerateGeneralSeriesModule (vtkDICOMMetaData *source)
 Generate the DICOM Series Module.
 
virtual bool GenerateClinicalTrialSeriesModule (vtkDICOMMetaData *source)
 Generate the DICOM Clinical Trial Series Module.
 
virtual bool GenerateFrameOfReferenceModule (vtkDICOMMetaData *source)
 Generate the DICOM Frame of Reference Module.
 
virtual bool GenerateGeneralEquipmentModule (vtkDICOMMetaData *source)
 Generate the DICOM Equipment Module.
 
virtual bool GenerateGeneralImageModule (vtkDICOMMetaData *source)
 Generate the DICOM Image Module.
 
virtual bool GenerateImagePlaneModule (vtkDICOMMetaData *source)
 Generate the DICOM Plane Module.
 
virtual bool GenerateImagePixelModule (vtkDICOMMetaData *source)
 Generate the DICOM Pixel Module.
 
virtual bool GenerateContrastBolusModule (vtkDICOMMetaData *source)
 Generate The DICOM Contrast/Bolus Module.
 
virtual bool GenerateMultiFrameModule (vtkDICOMMetaData *source)
 Generate The DICOM Multi-frame Module.
 
virtual bool GenerateDeviceModule (vtkDICOMMetaData *source)
 Generate The DICOM Device Module.
 
virtual bool GenerateSpecimenModule (vtkDICOMMetaData *source)
 Generate The DICOM Specimen Module.
 
virtual bool GenerateOverlayPlaneModule (vtkDICOMMetaData *source)
 Generate the DICOM Overlay Plane Module.
 
virtual bool GenerateVOILUTModule (vtkDICOMMetaData *source)
 Generate the DICOM VOI LUT Module.
 
virtual bool CopyRequiredAttributes (const DC::EnumType *tags, vtkDICOMMetaData *source)
 Copy required attributes into the meta data. More...
 
virtual bool CopyOptionalAttributes (const DC::EnumType *tags, vtkDICOMMetaData *source)
 Copy optional attributes into the meta data. More...
 
virtual bool CopyAttributes (const DC::EnumType *blacklist, vtkDICOMMetaData *source)
 Copy all attributes into the meta data, excluding blacklisted ones. More...
 
void ComputeAdjustedMatrix (double matrix[16], double origin[3], double spacing[3])
 Compute the matrix, needed for Position and Orientation.
 
virtual void ComputeDimensions (vtkInformation *info, int *nframes, int dims[5], double spacing[5], double origin[5])
 Compute the dimensions. More...
 
virtual void ComputePixelValueRange (vtkInformation *info, int seriesRange[2])
 Compute the range of the data. More...
 
virtual void MatchInstances (vtkDICOMMetaData *source)
 Attempt to match each slice to a source meta data slice.
 
virtual void InitializeMetaData (vtkInformation *info)
 Initialize the meta data and compute the slice index array. More...
 
- Protected Member Functions inherited from vtkObject
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Types inherited from vtkDICOMGenerator
enum  {
  RepresentationUnsigned = 1u , RepresentationSigned = 2u , BitsStored1 = 1u , BitsStored6 = (1u << 5) ,
  BitsStored8 = (1u << 7) , BitsStored10 = (1u << 9) , BitsStored12 = (1u << 11) , BitsStored16 = (1u << 15) ,
  BitsStored32 = (1u << 31)
}
 Enumerated values for restricting pixel values.
 
- Static Protected Member Functions inherited from vtkDICOMGenerator
static void ComputeAspectRatio (const double spacing[2], int aspect[2])
 Compute aspect ratio from spacing.
 
static void ComputePositionAndOrientation (const double origin[3], const double matrix[16], double position[3], double orientation[6])
 Compute the position and orientation for a slice. More...
 
- Protected Attributes inherited from vtkDICOMGenerator
vtkDICOMMetaDataMetaData
 The generated meta data.
 
vtkDICOMMetaDataSourceMetaData
 The source meta data.
 
vtkDICOMUIDGeneratorUIDGenerator
 The UID generator.
 
int Extended
 Whether to copy attributes that aren't in the base SOP class.
 
int MultiFrame
 Whether to prefer multi-frame files over single-frame.
 
int OriginAtBottom
 Whether VTK image data is not top-to-bottom yet.
 
int ReverseSliceOrder
 Whether to reverse the slices as compared to input data.
 
int TimeAsVector
 Whether time is stored in slices or in scalar components.
 
int TimeDimension
 Time dimension suggested by the writer.
 
double TimeSpacing
 
double RescaleIntercept
 Data rescaling parameters.
 
double RescaleSlope
 
int NumberOfOverlays
 The number of overlays to generate.
 
int ScalarType
 The VTK scalar type of the data, set by InitializeMetaData().
 
int NumberOfColorComponents
 The number of color components, for color scalars. More...
 
unsigned int AllowedPixelRepresentation
 The permitted pixel representation and bits stored, as bitfields.
 
unsigned int AllowedBitsStored
 
int NumberOfFrames
 The number of frames. More...
 
int Dimensions [5]
 The actual dimensions to write to the file. More...
 
double Spacing [5]
 
double Origin [5]
 
int PixelValueRange [2]
 The smallest and largest pixel values in the image data. More...
 
vtkMatrix4x4 * PatientMatrix
 The orientation matrix for the DICOM file.
 
vtkIntArray * SliceIndexArray
 The file-and-frame to slice-and-component maps.
 
vtkIntArray * ComponentIndexArray
 
vtkIntArray * SourceInstanceArray
 Map from output files to input files.
 
vtkIntArray * RangeArray
 Map from frame to image min/max.
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Generate DICOM data objects for MR images.

Generate a DICOM data set belonging to one of the MR SOP classes. The assumption is that images have been read into VTK as MR, and are being written out as derived images after being processed. The specific IOD classes supported are as follows:

Member Function Documentation

◆ GenerateInstance()

bool vtkDICOMMRGenerator::GenerateInstance ( vtkInformation *  info)
virtual

Generate an instance of one of the supported classes.

This is the primary interface method of this class. Given the information for a vtkImageData object, it will populate the attributes of the supplied vtkDICOMMetaData object.

Reimplemented from vtkDICOMGenerator.

◆ IsA()

virtual vtkTypeBool vtkDICOMMRGenerator::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 vtkDICOMGenerator.


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