#include <svkImageMathematics.h>

Inheritance diagram for svkImageMathematics:

Public Types
enum	svkImageMathematicsParameters { INPUT_IMAGE_1 = 0, INPUT_IMAGE_2, MASK, ADD, SUBTRACT, MULTIPLY, MULTIPLY_BY_SCALAR, MULTIPLY_IMAGE_1_BY_IMAGE_2_MEDIAN, NUM_BINS_FOR_HISTOGRAM, BIN_SIZE_FOR_HISTOGRAM, START_BIN_FOR_HISTOGRAM, SMOOTH_BINS_FOR_HISTOGRAM, MASK_FOR_MEDIAN, OUTPUT_SERIES_DESCRIPTION, OUTPUT_TYPE }

enum	svkImageMathematicsOutputType { UNDEFINED = 0, UNSIGNED_INT_2 = 1, SIGNED_FLOAT_4 }

Public Member Functions
void	SetInputPortsFromXML ()
	Uses port mapper to parse an XML element and convert it into input port data objects. More...

svkAlgorithmPortMapper *	GetPortMapper ()
	Get the internal XML interpreter. More...

	vtkTypeMacro (svkImageMathematics, vtkImageMathematics)

virtual void	Update ()

void	PrintSelf (ostream &os, vtkIndent indent)
	Prints all input parameters set. More...

void	SetOutputType (int outputType)

svkInt *	GetOutputType ()

Static Public Member Functions
static svkImageMathematics *	New ()

Protected Member Functions
	svkImageMathematics ()

	~svkImageMathematics ()

virtual int	FillOutputPortInformation (int vtkNotUsed(port), vtkInformation *info)

virtual int	FillInputPortInformation (int vtkNotUsed(port), vtkInformation *info)

Protected Attributes
svkAlgorithmPortMapper *	portMapper
	The port mapper used to set the input port parameters. More...

Detailed Description

Wrapper class around vtkImageMathematics that operates on each vtkPointData array in the input vtkImageData objects. This is a convenience for applying an operation to a multi-volume image object.

Member Enumeration Documentation

enum svkImageMathematicsOutputType

Enumerator
UNDEFINED
UNSIGNED_INT_2
SIGNED_FLOAT_4

enum svkImageMathematicsParameters

Enumerator
INPUT_IMAGE_1
INPUT_IMAGE_2
MASK
ADD
SUBTRACT
MULTIPLY
MULTIPLY_BY_SCALAR
MULTIPLY_IMAGE_1_BY_IMAGE_2_MEDIAN
NUM_BINS_FOR_HISTOGRAM
BIN_SIZE_FOR_HISTOGRAM
START_BIN_FOR_HISTOGRAM
SMOOTH_BINS_FOR_HISTOGRAM
MASK_FOR_MEDIAN
OUTPUT_SERIES_DESCRIPTION
OUTPUT_TYPE

Constructor & Destructor Documentation

svkImageMathematics ( )

protected

Default input type is svkImageData base class. Override with a specific concrete type in sub class if necessary. Port 0 -> input 1 image to operate on 1 -> input 2 image to operate on (optional) 2 -> mask (optional)

~svkImageMathematics ( )

protected

References svkImageMathematics::portMapper.

Member Function Documentation

int FillInputPortInformation	(	int	vtkNotUsedport,
		vtkInformation *	info
	)

protectedvirtual

Pass through method to the internal svkAlgorithmPortMapper

References svkAlgorithmPortMapper::FillInputPortInformation(), and svkImageMathematics::GetPortMapper().

int FillOutputPortInformation	(	int	vtkNotUsedport,
		vtkInformation *	info
	)

protectedvirtual

Pass through method to the internal svkAlgorithmPortMapper

References svkAlgorithmPortMapper::FillOutputPortInformation(), and svkImageMathematics::GetPortMapper().

svkInt * GetOutputType ( )

Utility getter for input port: Output float

References svkAlgorithmPortMapper::GetIntInputPortValue(), svkImageMathematics::GetPortMapper(), and svkImageMathematics::OUTPUT_TYPE.

svkAlgorithmPortMapper * GetPortMapper ( )

Get the internal XML interpreter.

Returns the port mapper. Performs lazy initialization.

References svkAlgorithmPortMapper::New(), svkImageMathematics::portMapper, and svkAlgorithmPortMapper::SetAlgorithm().

Referenced by svkImageMathematics::FillInputPortInformation(), svkImageMathematics::FillOutputPortInformation(), svkImageMathematics::GetOutputType(), svkImageMathematics::PrintSelf(), svkImageMathematics::SetInputPortsFromXML(), svkImageMathematics::SetOutputType(), svkImageMathematics::svkImageMathematics(), and svkImageMathematics::Update().

static svkImageMathematics* New ( )

static

Referenced by svkImageAlgorithmPipeline::InitializeAlgorithmForTag().

void PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

Prints all input parameters set.

PrintSelf method calls parent class PrintSelf, then prints all parameters using the port mapper.

References svkImageMathematics::GetPortMapper(), and svkAlgorithmPortMapper::PrintSelf().

void SetInputPortsFromXML ( )

Uses port mapper to parse an XML element and convert it into input port data objects.

Pass through method to the internal svkAlgorithmPortMapper

References svkImageMathematics::ADD, svkAlgorithmPortMapper::GetDoubleInputPortValue(), svkImageMathematics::GetPortMapper(), svkDouble::GetValue(), svkImageMathematics::MULTIPLY, svkImageMathematics::MULTIPLY_BY_SCALAR, svkImageMathematics::MULTIPLY_IMAGE_1_BY_IMAGE_2_MEDIAN, and svkImageMathematics::SUBTRACT.

Referenced by svkImageMathematics::Update().

void SetOutputType ( int outputType )

Utility setter for input port: Output float

References svkImageMathematics::GetPortMapper(), svkImageMathematics::OUTPUT_TYPE, and svkAlgorithmPortMapper::SetIntInputPortValue().

void Update ( )

virtual

This method loops over all volumes and calls the VTK super class update method on each to perform the specified calculation. If necessary the output will be masked by an input mask.

vtkTypeMacro	(	svkImageMathematics	,
		vtkImageMathematics
	)

Member Data Documentation

svkAlgorithmPortMapper* portMapper

protected

The port mapper used to set the input port parameters.

Referenced by svkImageMathematics::GetPortMapper(), svkImageMathematics::svkImageMathematics(), and svkImageMathematics::~svkImageMathematics().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation