Superclass for DICOM image filters. More...

#include <vtkDICOMAlgorithm.h>

Inheritance diagram for vtkDICOMAlgorithm:

[legend]

Collaboration diagram for vtkDICOMAlgorithm:

[legend]

Public Types
typedef vtkThreadedImageAlgorithm	Superclass

Public Types inherited from vtkThreadedImageAlgorithm
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)

vtkDICOMAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) VTK_DICOM_OVERRIDE
	Print information about this object.

Public Member Functions inherited from vtkThreadedImageAlgorithm
vtkThreadedImageAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE

virtual void	ThreadedExecute (vtkImageData inData, vtkImageData outData, int extent[6], int threadId)

virtual bool	GetEnableSMP ()

virtual void	SetEnableSMP (bool)

virtual void	SetMinimumPieceSize (int, int, int)

virtual void	SetMinimumPieceSize (int[3])

virtual int *	GetMinimumPieceSize ()

virtual void	GetMinimumPieceSize (int &, int &, int &)

virtual void	GetMinimumPieceSize (int[3])

virtual void	SetDesiredBytesPerPiece (vtkIdType)

virtual vtkIdType	GetDesiredBytesPerPiece ()

virtual void	SetSplitMode (int)

void	SetSplitModeToSlab ()

void	SetSplitModeToBeam ()

void	SetSplitModeToBlock ()

virtual int	GetSplitMode ()

virtual void	SetNumberOfThreads (int)

virtual int	GetNumberOfThreads ()

virtual int	SplitExtent (int splitExt[6], int startExt[6], int num, int total)

Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithm *	NewInstance () 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
vtkAlgorithm *	NewInstance () 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)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkAlgorithm *	GetInputAlgorithm ()

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 ()

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 vtkDICOMAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkDICOMAlgorithm *	New ()
	Static method for construction.

static vtkInformationDataObjectKey *	META_DATA ()
	The information key for the meta data.

static vtkInformationDoubleVectorKey *	PATIENT_MATRIX ()
	A key to get the patient matrix from the VTK pipeline.

Static Public Member Functions inherited from vtkThreadedImageAlgorithm
static vtkTypeBool	IsTypeOf (const char *type)

static vtkThreadedImageAlgorithm *	SafeDownCast (vtkObjectBase *o)

static void	SetGlobalDefaultEnableSMP (bool enable)

static bool	GetGlobalDefaultEnableSMP ()

Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool	IsTypeOf (const char *type)

static vtkImageAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (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 vtkObject *	New ()

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 vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

vtkInformation *	GetMetaDataInformation (vtkInformationVector **inputVector, int inputPort, int inputConnection)
	Get the information object that holds the meta data for the given input.

virtual void	CopyMetaDataToOutputInformation (vtkInformationVector *inputVector, int inputPort, int inputConnection, vtkInformationVector outputVector, int outputPort)
	Copy the meta data from an input connection to an output port. More...

virtual void	CopyMetaDataToOutputData (vtkInformation outInfo, vtkDataObject outData)
	Copy the meta data from the output information to the output data. More...

int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) VTK_DICOM_OVERRIDE

int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) VTK_DICOM_OVERRIDE

void	ThreadedRequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector, vtkImageData *inData, vtkImageData outData, int ext[6], int id) VTK_DICOM_OVERRIDE

Protected Member Functions inherited from vtkThreadedImageAlgorithm
int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) VTK_OVERRIDE

virtual void	SMPRequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector, vtkImageData *inData, vtkImageData outData, vtkIdType begin, vtkIdType end, vtkIdType pieces, int extent[6])

virtual void	PrepareImageData (vtkInformationVector *inputVector, vtkInformationVector outputVector, vtkImageData *inDataObjects=0, vtkImageData outDataObjects=0)

Protected Member Functions inherited from vtkImageAlgorithm
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 &)

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Protected Types inherited from vtkThreadedImageAlgorithm
enum	SplitModeEnum { SLAB = 0 , BEAM = 1 , BLOCK = 2 }

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Protected Attributes inherited from vtkThreadedImageAlgorithm
vtkMultiThreader *	Threader

int	NumberOfThreads

bool	EnableSMP

int	SplitMode

int	SplitPath [3]

int	SplitPathLength

int	MinimumPieceSize [3]

vtkIdType	DesiredBytesPerPiece

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

Static Protected Attributes inherited from vtkThreadedImageAlgorithm
static bool	GlobalDefaultEnableSMP

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Superclass for DICOM image filters.

This class allows the DICOM meta data to be carried by the VTK pipeline. Subclasses should always call Superclass::RequestInformation() and Superclass::RequestData within their own RequestInformation and RequestData methods.

Member Function Documentation

◆ CopyMetaDataToOutputData()

virtual void vtkDICOMAlgorithm::CopyMetaDataToOutputData	(	vtkInformation *	outInfo,
		vtkDataObject *	outData
	)

protectedvirtual

Copy the meta data from the output information to the output data.

This is called by RequestData.

◆ CopyMetaDataToOutputInformation()

virtual void vtkDICOMAlgorithm::CopyMetaDataToOutputInformation	(	vtkInformationVector **	inputVector,
		int	inputPort,
		int	inputConnection,
		vtkInformationVector *	outputVector,
		int	outputPort
	)

protectedvirtual

Copy the meta data from an input connection to an output port.

This is called by RequestInformation. To copy the meta data to all output ports, use "-1" as the output port.

◆ IsA()

virtual vtkTypeBool vtkDICOMAlgorithm::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 vtkThreadedImageAlgorithm.

Reimplemented in vtkDICOMCTRectifier, vtkDICOMApplyRescale, and vtkDICOMApplyPalette.

◆ RequestData()

int vtkDICOMAlgorithm::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 vtkImageAlgorithm.

Reimplemented in vtkDICOMCTRectifier, vtkDICOMApplyRescale, and vtkDICOMApplyPalette.

◆ RequestInformation()

int vtkDICOMAlgorithm::RequestInformation	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

protectedvirtual

Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkDICOMCTRectifier, vtkDICOMApplyRescale, and vtkDICOMApplyPalette.

◆ ThreadedRequestData()

void vtkDICOMAlgorithm::ThreadedRequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector,
		vtkImageData ***	inData,
		vtkImageData **	outData,
		int	extent[6],
		int	threadId
	)

protectedvirtual

If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method. It is public so that the thread functions can call this method.

Reimplemented from vtkThreadedImageAlgorithm.

Reimplemented in vtkDICOMCTRectifier, vtkDICOMApplyRescale, and vtkDICOMApplyPalette.

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

vtkDICOMAlgorithm.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CopyMetaDataToOutputData()

◆ CopyMetaDataToOutputInformation()

◆ IsA()

◆ RequestData()

◆ RequestInformation()

◆ ThreadedRequestData()