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

shift and scale an input image More...

#include <vtkImageShiftScale.h>

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

List of all members.

Public Types

typedef vtkThreadedImageAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkImageShiftScaleNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetShift (double)
virtual double GetShift ()
virtual void SetScale (double)
virtual double GetScale ()
virtual void SetOutputScalarType (int)
virtual int GetOutputScalarType ()
void SetOutputScalarTypeToDouble ()
void SetOutputScalarTypeToFloat ()
void SetOutputScalarTypeToLong ()
void SetOutputScalarTypeToUnsignedLong ()
void SetOutputScalarTypeToInt ()
void SetOutputScalarTypeToUnsignedInt ()
void SetOutputScalarTypeToShort ()
void SetOutputScalarTypeToUnsignedShort ()
void SetOutputScalarTypeToChar ()
void SetOutputScalarTypeToUnsignedChar ()
virtual void SetClampOverflow (int)
virtual int GetClampOverflow ()
virtual void ClampOverflowOn ()
virtual void ClampOverflowOff ()

Static Public Member Functions

static vtkImageShiftScaleNew ()
static int IsTypeOf (const char *type)
static vtkImageShiftScaleSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkImageShiftScale ()
 ~vtkImageShiftScale ()
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void ThreadedRequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *, vtkImageData ***inData, vtkImageData **outData, int outExt[6], int threadId)

Protected Attributes

double Shift
double Scale
int OutputScalarType
int ClampOverflow

Detailed Description

shift and scale an input image

With vtkImageShiftScale Pixels are shifted (a constant value added) and then scaled (multiplied by a scalar. As a convenience, this class allows you to set the output scalar type similar to vtkImageCast. This is because shift scale operations frequently convert data types.

Examples:
vtkImageShiftScale (Examples)
Tests:
vtkImageShiftScale (Tests)

Definition at line 37 of file vtkImageShiftScale.h.


Member Typedef Documentation

Reimplemented from vtkThreadedImageAlgorithm.

Definition at line 41 of file vtkImageShiftScale.h.


Constructor & Destructor Documentation


Member Function Documentation

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

Reimplemented from vtkAlgorithm.

static int vtkImageShiftScale::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 vtkImageShiftScale::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 from vtkThreadedImageAlgorithm.

virtual vtkObjectBase* vtkImageShiftScale::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkThreadedImageAlgorithm.

Reimplemented from vtkThreadedImageAlgorithm.

void vtkImageShiftScale::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 vtkImageShiftScale::SetShift ( double  ) [virtual]

Set/Get the shift value. This value is added to each pixel

virtual double vtkImageShiftScale::GetShift ( ) [virtual]

Set/Get the shift value. This value is added to each pixel

virtual void vtkImageShiftScale::SetScale ( double  ) [virtual]

Set/Get the scale value. Each pixel is multiplied by this value.

virtual double vtkImageShiftScale::GetScale ( ) [virtual]

Set/Get the scale value. Each pixel is multiplied by this value.

virtual void vtkImageShiftScale::SetOutputScalarType ( int  ) [virtual]

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.

Definition at line 61 of file vtkImageShiftScale.h.

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.

Definition at line 63 of file vtkImageShiftScale.h.

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.

Definition at line 65 of file vtkImageShiftScale.h.

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.

Definition at line 67 of file vtkImageShiftScale.h.

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.

Definition at line 69 of file vtkImageShiftScale.h.

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.

Definition at line 71 of file vtkImageShiftScale.h.

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.

Definition at line 73 of file vtkImageShiftScale.h.

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.

Definition at line 75 of file vtkImageShiftScale.h.

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.

Definition at line 77 of file vtkImageShiftScale.h.

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.

Definition at line 79 of file vtkImageShiftScale.h.

virtual void vtkImageShiftScale::SetClampOverflow ( int  ) [virtual]

When the ClampOverflow flag is on, the data is thresholded so that the output value does not exceed the max or min of the data type. By default, ClampOverflow is off.

When the ClampOverflow flag is on, the data is thresholded so that the output value does not exceed the max or min of the data type. By default, ClampOverflow is off.

virtual void vtkImageShiftScale::ClampOverflowOn ( ) [virtual]

When the ClampOverflow flag is on, the data is thresholded so that the output value does not exceed the max or min of the data type. By default, ClampOverflow is off.

virtual void vtkImageShiftScale::ClampOverflowOff ( ) [virtual]

When the ClampOverflow flag is on, the data is thresholded so that the output value does not exceed the max or min of the data type. By default, ClampOverflow is off.

virtual int vtkImageShiftScale::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

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

Reimplemented from vtkImageAlgorithm.

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

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.


Member Data Documentation

Definition at line 96 of file vtkImageShiftScale.h.

Definition at line 97 of file vtkImageShiftScale.h.

Definition at line 98 of file vtkImageShiftScale.h.

Definition at line 99 of file vtkImageShiftScale.h.


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