svkImageCopy Class Reference

#include <svkImageCopy.h>

Inheritance diagram for svkImageCopy:

Public Types
enum	{ INPUT_IMAGE = 0, OUTPUT_SERIES_DESCRIPTION, OUTPUT_SCALAR_TYPE, ZERO_COPY }

Public Member Functions
	vtkTypeMacro (svkImageCopy, svkImageAlgorithmWithPortMapper)
void	SetSeriesDescription (string newSeriesDescription)
void	SetOutputDataType (int dataType)
void	SetZeroCopy (bool zeroCopy)
Public Member Functions inherited from svkImageAlgorithmWithPortMapper
	vtkTypeMacro (svkImageAlgorithmWithPortMapper, svkImageAlgorithm)
virtual void	SetInputPortsFromXML (vtkXMLDataElement *element)
	Parses an XML element and converts it into input port parameters. Converts image filename strings to svkImageData objects. More...
virtual svkAlgorithmPortMapper *	GetPortMapper ()
	Get the internal port mapper. More...
void	PrintSelf (ostream &os, vtkIndent indent)
	Prints all input parameters set. More...
Public Member Functions inherited from svkImageAlgorithm
	vtkTypeMacro (svkImageAlgorithm, vtkImageAlgorithm)
svkImageData *	GetOutput ()
svkImageData *	GetOutput (int port)
svkImageData *	GetImageDataInput (int port)

Static Public Member Functions
static svkImageCopy *	New ()
Static Public Member Functions inherited from svkImageAlgorithmWithPortMapper
static svkImageAlgorithmWithPortMapper *	New ()

Public Attributes
enum svk::svkImageCopy:: { ... }	svkImageCopyParameters

Protected Member Functions
	svkImageCopy ()
	~svkImageCopy ()
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Protected Member Functions inherited from svkImageAlgorithmWithPortMapper
	svkImageAlgorithmWithPortMapper ()
	~svkImageAlgorithmWithPortMapper ()
virtual int	FillInputPortInformation (int port, vtkInformation *info)
	All ports must be initialized through the svkAlgorithmPortMapper BEFORE this method is called. More...
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
Protected Member Functions inherited from svkImageAlgorithm
	svkImageAlgorithm ()
	~svkImageAlgorithm ()
virtual int	FillOutputPortInformation (int vtkNotUsed(port), vtkInformation *info)
virtual int	FillInputPortInformation (int vtkNotUsed(port), vtkInformation *info)

Detailed Description

Class to manage copying svkImageData as part of a pipeline, updating the header and provenance.

Member Enumeration Documentation

anonymous enum

Enumerator
INPUT_IMAGE
OUTPUT_SERIES_DESCRIPTION
OUTPUT_SCALAR_TYPE
ZERO_COPY

Constructor & Destructor Documentation

svkImageCopy ( )

protected

References svkImageAlgorithmWithPortMapper::GetPortMapper(), svkAlgorithmPortMapper::InitializeInputPort(), svkAlgorithmPortMapper::InitializeOutputPort(), svkImageCopy::INPUT_IMAGE, svkImageCopy::OUTPUT_SCALAR_TYPE, svkImageCopy::OUTPUT_SERIES_DESCRIPTION, svkAlgorithmPortMapper::SVK_BOOL, svkAlgorithmPortMapper::SVK_INT, svkAlgorithmPortMapper::SVK_MR_IMAGE_DATA, svkAlgorithmPortMapper::SVK_STRING, and svkImageCopy::ZERO_COPY.

~svkImageCopy ( )

protected

Member Function Documentation

static svkImageCopy* New ( )

static

Referenced by svkImageAlgorithmPipeline::InitializeAlgorithmForTag().

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

protectedvirtual

Copy the Dcm Header and Provenance from the input to the output.

References svkImageData::DeepCopy(), svkImageAlgorithm::GetImageDataInput(), svkAlgorithmPortMapper::GetIntInputPortValue(), svkImageAlgorithm::GetOutput(), svkImageAlgorithmWithPortMapper::GetPortMapper(), svkInt::GetValue(), svkImageCopy::OUTPUT_SCALAR_TYPE, svkDcmHeader::UNDEFINED, svkImageCopy::ZERO_COPY, and svkImageData::ZeroCopy().

void SetOutputDataType

(

int

dataType

)

Optionally sets the output data type to cast the copy to.

References svkImageAlgorithmWithPortMapper::GetPortMapper(), svkImageCopy::OUTPUT_SCALAR_TYPE, and svkAlgorithmPortMapper::SetIntInputPortValue().

void SetSeriesDescription

(

string

newSeriesDescription

)

This is an in-place filter, so just pass original svkImageData input back out:

Set the series description for the DICOM header of the copy.

References svkImageAlgorithmWithPortMapper::GetPortMapper(), svkImageCopy::OUTPUT_SERIES_DESCRIPTION, and svkAlgorithmPortMapper::SetStringInputPortValue().

void SetZeroCopy

(

bool

zeroCopy

)

If set, the copy will have pixels set to 0. This is also useful for downcasting a copy.

References svkImageAlgorithmWithPortMapper::GetPortMapper(), svkAlgorithmPortMapper::SetBoolInputPortValue(), and svkImageCopy::ZERO_COPY.

vtkTypeMacro	(	svkImageCopy	,
		svkImageAlgorithmWithPortMapper
	)

Member Data Documentation

enum { ... } svkImageCopyParameters

---

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

• svkImageCopy.h
• svkImageCopy.cc