VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkImageMathematics Class Reference

Add, subtract, multiply, divide, invert, sin, cos, exp, log. More...

#include <vtkImageMathematics.h>

Inheritance diagram for vtkImageMathematics:
[legend]
Collaboration diagram for vtkImageMathematics:
[legend]

List of all members.

Public Types

typedef vtkThreadedImageAlgorithm Superclass
- Public Types inherited from vtkThreadedImageAlgorithm
- Public Types inherited from vtkImageAlgorithm
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetOperationToAdd ()
void SetOperationToSubtract ()
void SetOperationToMultiply ()
void SetOperationToDivide ()
void SetOperationToConjugate ()
void SetOperationToComplexMultiply ()
void SetOperationToInvert ()
void SetOperationToSin ()
void SetOperationToCos ()
void SetOperationToExp ()
void SetOperationToLog ()
void SetOperationToAbsoluteValue ()
void SetOperationToSquare ()
void SetOperationToSquareRoot ()
void SetOperationToMin ()
void SetOperationToMax ()
void SetOperationToATAN ()
void SetOperationToATAN2 ()
void SetOperationToMultiplyByK ()
void SetOperationToAddConstant ()
void SetOperationToReplaceCByK ()
virtual void SetOperation (int)
virtual int GetOperation ()
virtual void SetConstantK (double)
virtual double GetConstantK ()
virtual void SetConstantC (double)
virtual double GetConstantC ()
virtual void SetDivideByZeroToC (int)
virtual int GetDivideByZeroToC ()
virtual void DivideByZeroToCOn ()
virtual void DivideByZeroToCOff ()
virtual void SetInput1 (vtkDataObject *in)
virtual void SetInput2 (vtkDataObject *in)
- Public Member Functions inherited from vtkThreadedImageAlgorithm
virtual void ThreadedExecute (vtkImageData *inData, vtkImageData *outData, int extent[6], int threadId)
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
vtkDataObjectGetInput (int port)
vtkDataObjectGetInput ()
vtkImageDataGetImageDataInput (int port)
vtkImageDataGetOutput ()
vtkImageDataGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
virtual void AddInput (vtkDataObject *)
virtual void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
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)
vtkDataObjectGetInputDataObject (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)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (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)
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 Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkImageMathematicsNew ()
static int IsTypeOf (const char *type)
static vtkImageMathematicsSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageMathematics ()
 ~vtkImageMathematics ()
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int extent[6], int threadId)
virtual int FillInputPortInformation (int port, vtkInformation *info)
- Protected Member Functions inherited from vtkThreadedImageAlgorithm
 vtkThreadedImageAlgorithm ()
 ~vtkThreadedImageAlgorithm ()
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 ~vtkImageAlgorithm ()
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void AllocateOutputData (vtkImageData *out, int *uExtent)
virtual vtkImageDataAllocateOutputData (vtkDataObject *out)
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~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)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

int Operation
double ConstantK
double ConstantC
int DivideByZeroToC
- Protected Attributes inherited from vtkThreadedImageAlgorithm
vtkMultiThreaderThreader
int NumberOfThreads

Detailed Description

Add, subtract, multiply, divide, invert, sin, cos, exp, log.

vtkImageMathematics implements basic mathematic operations SetOperation is used to select the filters behavior. The filter can take two or one input.

Tests:
vtkImageMathematics (Tests)

Definition at line 56 of file vtkImageMathematics.h.


Member Typedef Documentation

Reimplemented from vtkThreadedImageAlgorithm.

Definition at line 60 of file vtkImageMathematics.h.


Constructor & Destructor Documentation

vtkImageMathematics::vtkImageMathematics ( )
protected
vtkImageMathematics::~vtkImageMathematics ( )
inlineprotected

Definition at line 180 of file vtkImageMathematics.h.


Member Function Documentation

static vtkImageMathematics* vtkImageMathematics::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

virtual const char* vtkImageMathematics::GetClassName ( )
virtual

Reimplemented from vtkThreadedImageAlgorithm.

static int vtkImageMathematics::IsTypeOf ( const char *  name)
static

Return 1 if this class type 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.

virtual int vtkImageMathematics::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.

static vtkImageMathematics* vtkImageMathematics::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkThreadedImageAlgorithm.

void vtkImageMathematics::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkThreadedImageAlgorithm.

virtual void vtkImageMathematics::SetOperation ( int  )
virtual

Set/Get the Operation to perform.

virtual int vtkImageMathematics::GetOperation ( )
virtual

Set/Get the Operation to perform.

void vtkImageMathematics::SetOperationToAdd ( )
inline

Set each pixel in the output image to the sum of the corresponding pixels in Input1 and Input2.

Definition at line 71 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToSubtract ( )
inline

Set each pixel in the output image to the difference of the corresponding pixels in Input1 and Input2 (output = Input1 - Input2).

Definition at line 75 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToMultiply ( )
inline

Set each pixel in the output image to the product of the corresponding pixels in Input1 and Input2.

Definition at line 79 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToDivide ( )
inline

Set each pixel in the output image to the quotient of the corresponding pixels in Input1 and Input2 (Output = Input1 / Input2).

Definition at line 83 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToConjugate ( )
inline

Definition at line 85 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToComplexMultiply ( )
inline

Definition at line 87 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToInvert ( )
inline

Set each pixel in the output image to 1 over the corresponding pixel in Input1 and Input2 (output = 1 / Input1). Input2 is not used.

Definition at line 92 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToSin ( )
inline

Set each pixel in the output image to the sine of the corresponding pixel in Input1. Input2 is not used.

Definition at line 96 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToCos ( )
inline

Set each pixel in the output image to the cosine of the corresponding pixel in Input1. Input2 is not used.

Definition at line 100 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToExp ( )
inline

Set each pixel in the output image to the exponential of the corresponding pixel in Input1. Input2 is not used.

Definition at line 104 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToLog ( )
inline

Set each pixel in the output image to the log of the corresponding pixel in Input1. Input2 is not used.

Definition at line 108 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToAbsoluteValue ( )
inline

Set each pixel in the output image to the absolute value of the corresponding pixel in Input1. Input2 is not used.

Definition at line 112 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToSquare ( )
inline

Set each pixel in the output image to the square of the corresponding pixel in Input1. Input2 is not used.

Definition at line 116 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToSquareRoot ( )
inline

Set each pixel in the output image to the square root of the corresponding pixel in Input1. Input2 is not used.

Definition at line 120 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToMin ( )
inline

Set each pixel in the output image to the minimum of the corresponding pixels in Input1 and Input2. (Output = min(Input1, Input2))

Definition at line 125 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToMax ( )
inline

Set each pixel in the output image to the maximum of the corresponding pixels in Input1 and Input2. (Output = max(Input1, Input2))

Definition at line 130 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToATAN ( )
inline

Set each pixel in the output image to the arctangent of the corresponding pixel in Input1. Input2 is not used.

Definition at line 134 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToATAN2 ( )
inline

Definition at line 136 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToMultiplyByK ( )
inline

Set each pixel in the output image to the product of ConstantK with the corresponding pixel in Input1. Input2 is not used.

Definition at line 140 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToAddConstant ( )
inline

Set each pixel in the output image to the product of ConstantC with the corresponding pixel in Input1. Input2 is not used.

Definition at line 144 of file vtkImageMathematics.h.

void vtkImageMathematics::SetOperationToReplaceCByK ( )
inline

Find every pixel in Input1 that equals ConstantC and set the corresponding pixels in the Output to ConstantK. Input2 is not used.

Definition at line 148 of file vtkImageMathematics.h.

virtual void vtkImageMathematics::SetConstantK ( double  )
virtual

A constant used by some operations (typically multiplicative). Default is 1.

virtual double vtkImageMathematics::GetConstantK ( )
virtual

A constant used by some operations (typically multiplicative). Default is 1.

virtual void vtkImageMathematics::SetConstantC ( double  )
virtual

A constant used by some operations (typically additive). Default is 0.

virtual double vtkImageMathematics::GetConstantC ( )
virtual

A constant used by some operations (typically additive). Default is 0.

virtual void vtkImageMathematics::SetDivideByZeroToC ( int  )
virtual

How to handle divide by zero. Default is 0.

virtual int vtkImageMathematics::GetDivideByZeroToC ( )
virtual

How to handle divide by zero. Default is 0.

virtual void vtkImageMathematics::DivideByZeroToCOn ( )
virtual

How to handle divide by zero. Default is 0.

virtual void vtkImageMathematics::DivideByZeroToCOff ( )
virtual

How to handle divide by zero. Default is 0.

virtual void vtkImageMathematics::SetInput1 ( vtkDataObject in)
inlinevirtual

Set the two inputs to this filter. For some operations, the second input is not used.

Definition at line 174 of file vtkImageMathematics.h.

virtual void vtkImageMathematics::SetInput2 ( vtkDataObject in)
inlinevirtual

Set the two inputs to this filter. For some operations, the second input is not used.

Definition at line 175 of file vtkImageMathematics.h.

virtual int vtkImageMathematics::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

Reimplemented from vtkImageAlgorithm.

virtual void vtkImageMathematics::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.

virtual int vtkImageMathematics::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkImageAlgorithm.


Member Data Documentation

int vtkImageMathematics::Operation
protected

Definition at line 180 of file vtkImageMathematics.h.

double vtkImageMathematics::ConstantK
protected

Definition at line 183 of file vtkImageMathematics.h.

double vtkImageMathematics::ConstantC
protected

Definition at line 184 of file vtkImageMathematics.h.

int vtkImageMathematics::DivideByZeroToC
protected

Definition at line 185 of file vtkImageMathematics.h.


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