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

Write DICOM image files. More...

#include <vtkDICOMWriter.h>

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

Public Types

enum  RowOrder { FileNative , TopDown , BottomUp }
 Enumeration for top-down vs. bottom-up ordering.
 
enum  SliceOrder { RHR , LHR , Same , Reverse }
 Enumeration for file order.
 
typedef vtkImageWriter Superclass
 
- Public Types inherited from vtkImageWriter
typedef vtkImageAlgorithm Superclass
 
- Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 
vtkDICOMWriterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) VTK_DICOM_OVERRIDE
 Print information about this object.
 
virtual void SetSeriesDescription (const char *)
 Set a short description (max 64 chars) for the DICOM series. More...
 
virtual char * GetSeriesDescription ()
 
virtual void SetImageType (const char *)
 Set the image type, using a series of DICOM code strings. More...
 
virtual char * GetImageType ()
 
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 parameters to rescale integer pixel values into real values. More...
 
virtual double GetRescaleIntercept ()
 
virtual void SetRescaleSlope (double)
 
virtual double GetRescaleSlope ()
 
void SetPatientMatrix (vtkMatrix4x4 *)
 Set the matrix that places the image in DICOM patient coords. More...
 
vtkMatrix4x4 * GetPatientMatrix ()
 
void SetMemoryRowOrder (int order)
 Set the ordering of the image rows in memory. More...
 
void SetMemoryRowOrderToFileNative ()
 
void SetMemoryRowOrderToTopDown ()
 
void SetMemoryRowOrderToBottomUp ()
 
int GetMemoryRowOrder ()
 
const char * GetMemoryRowOrderAsString ()
 
void SetFileSliceOrder (int order)
 Set the slice ordering of the files to be written. More...
 
void SetFileSliceOrderToRHR ()
 
void SetFileSliceOrderToLHR ()
 
void SetFileSliceOrderToSame ()
 
void SetFileSliceOrderToReverse ()
 
int GetFileSliceOrder ()
 
const char * GetFileSliceOrderAsString ()
 
void SetMetaData (vtkDICOMMetaData *)
 Set the meta data to include with the file. More...
 
vtkDICOMMetaDataGetMetaData ()
 
void SetGenerator (vtkDICOMGenerator *)
 Set the generator for image modality you wish to write. More...
 
vtkDICOMGeneratorGetGenerator ()
 
virtual void SetTransferSyntaxUID (const char *)
 Set the Transfer Syntax UID. More...
 
virtual char * GetTransferSyntaxUID ()
 
virtual void SetStreaming (int)
 Turn on streaming, to pass one slice though the pipeline at a time. More...
 
virtual int GetStreaming ()
 
virtual void StreamingOn ()
 
virtual void StreamingOff ()
 
void SetOverlayInputData (vtkImageData *data)
 Provide an overlay to be written with the data.
 
void SetOverlayInputConnection (vtkAlgorithmOutput *data)
 
vtkImageData * GetOverlayInput ()
 
virtual void SetOverlayType (int)
 Set the overlay type.
 
virtual int GetOverlayType ()
 
void SetOverlayTypeToGraphics ()
 
void SetOverlayTypeToROI ()
 
void Write () VTK_DICOM_OVERRIDE
 Write the file to disk.
 
- Public Member Functions inherited from vtkImageWriter
vtkImageWriterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetFileName (const char *)
 
virtual char * GetFileName ()
 
virtual void SetFilePrefix (const char *)
 
virtual char * GetFilePrefix ()
 
virtual void SetFilePattern (const char *)
 
virtual char * GetFilePattern ()
 
virtual void SetFileDimensionality (int)
 
virtual int GetFileDimensionality ()
 
vtkImageData * GetInput ()
 
void DeleteFiles ()
 
- Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithmNewInstance () const
 
vtkImageData * GetOutput ()
 
vtkImageData * GetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) VTK_OVERRIDE
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
vtkDataObject * GetInput (int port)
 
vtkDataObject * GetInput ()
 
vtkImageData * GetImageDataInput (int port)
 
virtual void AddInputData (vtkDataObject *)
 
virtual void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 
vtkExecutive * GetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformation * GetInputPortInformation (int port)
 
vtkInformation * GetOutputPortInformation (int port)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void Register (vtkObjectBase *o) VTK_OVERRIDE
 
void UnRegister (vtkObjectBase *o) VTK_OVERRIDE
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void UpdateProgress (double amount)
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 
vtkInformation * GetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObject * GetOutputDataObject (int port)
 
vtkDataObject * GetInputDataObject (int port, int connection)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutput * GetOutputPort (int index)
 
vtkAlgorithmOutput * GetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutput * GetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutive * GetInputExecutive (int port, int index)
 
vtkExecutive * GetInputExecutive ()
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetInputInformation ()
 
vtkInformation * GetOutputInformation (int port)
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual int Update (int port, vtkInformationVector *requests)
 
virtual int Update (vtkInformation *requests)
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)
 
virtual int UpdateExtent (const int extents[6])
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)
 
virtual void UpdateInformation ()
 
virtual void UpdateDataObject ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int port, int extent[6])
 
void SetUpdateExtent (int extent[6])
 
int * GetUpdateExtent ()
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 
virtual vtkProgressObserver * GetProgressObserver ()
 
- 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)
 
int GetReferenceCount ()
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDICOMWriterSafeDownCast (vtkObjectBase *o)
 
static vtkDICOMWriterNew ()
 Static method for construction.
 
- Static Public Member Functions inherited from vtkImageWriter
static vtkImageWriterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKey * INPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKey * INPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKey * INPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKey * INPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKey * INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKey * INPUT_PORT ()
 
static vtkInformationIntegerKey * INPUT_CONNECTION ()
 
static vtkInformationIntegerKey * CAN_PRODUCE_SUB_EXTENT ()
 
static vtkInformationIntegerKey * CAN_HANDLE_PIECE_REQUEST ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
- 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
 
void ComputeInternalFileName (int slice)
 Compute the name of one of the output files.
 
void FreeInternalFileName ()
 Free the filename created by ComputeInternalFileName.
 
virtual int GenerateMetaData (vtkInformation *info)
 Generate the meta data to be written for the files.
 
virtual void GenerateOverlays (int minFileIdx, int maxFileIdx, const int extent[4])
 Generate the overlays.
 
int FillInputPortInformation (int port, vtkInformation *info) VTK_DICOM_OVERRIDE
 The main execution method, which writes the file.
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) VTK_DICOM_OVERRIDE
 
- Protected Member Functions inherited from vtkImageWriter
virtual void RecursiveWrite (int dim, vtkImageData *region, vtkInformation *inInfo, ofstream *file)
 
virtual void RecursiveWrite (int dim, vtkImageData *cache, vtkImageData *data, vtkInformation *inInfo, ofstream *file)
 
virtual void WriteFile (ofstream *file, vtkImageData *data, int extent[6], int wExtent[6])
 
virtual void WriteFileHeader (ofstream *, vtkImageData *, int[6])
 
virtual void WriteFileTrailer (ofstream *, vtkImageData *)
 
- Protected Member Functions inherited from vtkImageAlgorithm
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual void CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual void ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
 
virtual void ExecuteData (vtkDataObject *output)
 
virtual void Execute ()
 
virtual void AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
 
virtual vtkImageData * AllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
 
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
 
int FillOutputPortInformation (int port, vtkInformation *info) VTK_OVERRIDE
 
int FillInputPortInformation (int port, vtkInformation *info) VTK_OVERRIDE
 
- Protected Member Functions inherited from vtkAlgorithm
virtual void SetNumberOfInputPorts (int n)
 
virtual void SetNumberOfOutputPorts (int n)
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformation * GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual vtkExecutive * CreateDefaultExecutive ()
 
virtual void SetErrorCode (unsigned long)
 
void ReportReferences (vtkGarbageCollector *) VTK_OVERRIDE
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
virtual void SetNumberOfInputConnections (int port, int n)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- 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 &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkDICOMMetaDataMetaData
 The meta data set by the user.
 
vtkDICOMMetaDataGeneratedMetaData
 The meta data generated by the generator.
 
vtkDICOMGeneratorGenerator
 The modality-specific generator for the DICOM data object.
 
int TimeAsVector
 Whether time is stored in slices or in scalar components.
 
int TimeDimension
 Time dimension to use in the file.
 
double TimeSpacing
 
double RescaleIntercept
 The parameters for rescaling the data to real values.
 
double RescaleSlope
 
vtkMatrix4x4 * PatientMatrix
 The orientation matrix for the DICOM file.
 
char * SeriesDescription
 A description of how the file was produced.
 
char * TransferSyntaxUID
 The transfer syntax to use when writing the data.
 
char * ImageType
 The DICOM Image Type.
 
int OverlayType
 The overlay type.
 
int MemoryRowOrder
 The row order to use when storing the data in memory.
 
int FileSliceOrder
 The slice order to use when writing the files to disk.
 
int Streaming
 Whether to stream the data and write one file at a time.
 
- Protected Attributes inherited from vtkImageWriter
int FileDimensionality
 
char * FilePrefix
 
char * FilePattern
 
char * FileName
 
int FileNumber
 
int FileLowerLeft
 
char * InternalFileName
 
int MinimumFileNumber
 
int MaximumFileNumber
 
int FilesDeleted
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserver * ProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive * DefaultExecutivePrototype
 

Detailed Description

Write DICOM image files.

This class writes a series of one or more DICOM files. The default behavior is to write a series of Secondary Capture files with no modality-specific information. To write other kinds of DICOM files, use the SetGenerator() method to supply a generator for the type of data set that you wish to write. Currently, there are generators for MR and CT data sets.

Member Function Documentation

◆ IsA()

virtual vtkTypeBool vtkDICOMWriter::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 vtkImageWriter.

◆ RequestData()

int vtkDICOMWriter::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

This is called in response to a REQUEST_DATA request from the executive. Subclasses should override either this method or the ExecuteDataWithInformation method in order to generate data for their outputs. For images, the output arrays will already be allocated, so all that is necessary is to fill in the voxel values.

Reimplemented from vtkImageWriter.

◆ SetFileSliceOrder()

void vtkDICOMWriter::SetFileSliceOrder ( int  order)

Set the slice ordering of the files to be written.

The default is RHR (right-hand-rule), which means that if your right thumb points along an image row, and your index finger points down a row (starting at the top left of the image), then a bent middle finger points in the direction of increasing slice index. LHR is the reverse of this. Same keeps files in the same order as VTK slices.

◆ SetGenerator()

void vtkDICOMWriter::SetGenerator ( vtkDICOMGenerator )

Set the generator for image modality you wish to write.

The generator combines the image information from VTK with the supplied MetaData to create the DICOM data series that will be written to disk. The default generator will write a Secondary Capture series, rather than a series belonging to a specific imaging modality.

◆ SetImageType()

virtual void vtkDICOMWriter::SetImageType ( const char *  )
virtual

Set the image type, using a series of DICOM code strings.

This must follow the DICOM standard, an error will be generated if it doesn't. The default value is DERIVED/SECONDARY/OTHER, where the forward-slashes will be replaced by backslashes when the attribute is written. Set this to NULL if you wish to use the original ImageType.

◆ SetMemoryRowOrder()

void vtkDICOMWriter::SetMemoryRowOrder ( int  order)

Set the ordering of the image rows in memory.

If the order is BottomUp (which is the default) then the images will be flipped when they are read from disk. The native orientation of DICOM images is top-to-bottom.

◆ SetMetaData()

void vtkDICOMWriter::SetMetaData ( vtkDICOMMetaData )

Set the meta data to include with the file.

The supplied meta data is only used as a hint, the writer will override attributes that aren't valid for the image.

◆ SetPatientMatrix()

void vtkDICOMWriter::SetPatientMatrix ( vtkMatrix4x4 *  )

Set the matrix that places the image in DICOM patient coords.

The 3x3 portion of the matrix must be orthonormal, and the last column of the matrix is understood to be in millimetres.

◆ SetRescaleIntercept()

virtual void vtkDICOMWriter::SetRescaleIntercept ( double  )
virtual

Set the parameters to rescale integer pixel values into real values.

These parameters are the intercept and slope int the equation v = m*x + b that converts the stored pixel values to real units such as Hounsfield units. Most modalities (including MR) ignore these values, while certain modalities (such as CT) require them.

◆ SetSeriesDescription()

virtual void vtkDICOMWriter::SetSeriesDescription ( const char *  )
virtual

Set a short description (max 64 chars) for the DICOM series.

The default description is "VTKX.Y" where X.Y is the VTK version.

◆ SetStreaming()

virtual void vtkDICOMWriter::SetStreaming ( int  )
virtual

Turn on streaming, to pass one slice though the pipeline at a time.

Streaming decreases memory usage for images with a large number of slices, since only one slice will have to be in memory at a time. However, streaming can be slower (sometimes much slower) than reading and processing all of the slices at once.

◆ SetTimeAsVector()

virtual void vtkDICOMWriter::SetTimeAsVector ( int  )
virtual

Write scalar components as the time dimension (default: Off).

If this is on, the writer assumes that each time slot is stored in a different scalar component of the image data. If it is off, the writer assumes that each block of N adjacent slices correspond to the N time slots of the time dimension.

◆ SetTimeDimension()

virtual void vtkDICOMWriter::SetTimeDimension ( int  )
virtual

Set the time dimension to use in the DICOM file (or zero if none).

The number of components of the input data must be divisible by the time dimension if the time dimension is not set to zero. The vector dimension will be set to the number of components divided by the time dimension. This will be ignored if the SOP Class IOD does not permit a time dimension.

◆ SetTransferSyntaxUID()

virtual void vtkDICOMWriter::SetTransferSyntaxUID ( const char *  )
virtual

Set the Transfer Syntax UID.

Setting the transfer syntax is an experimental feature. If not set, the transfer syntax will be 1.2.840.10008.1.2.1 (uncompressed little-endian with explicit VR).


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