vtkImageShiftScale Class Reference

#include <vtkImageShiftScale.h>

Inheritance diagram for vtkImageShiftScale:

[legend]Collaboration diagram for vtkImageShiftScale:

[legend]List of all members.

Detailed Description

shift and scale an input image

With vtkImageShiftScale Pixels are shifted and then scaled. 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.

Created by:

Law, Charles

CVS contributions (if > 5%):

Law, Charles (55%)
Martin, Ken (27%)
Lorensen, Bill (7%)

CVS logs (CVSweb):

.cxx (/Imaging/vtkImageShiftScale.cxx)
.h (/Imaging/vtkImageShiftScale.h)

Examples:: vtkImageShiftScale (Examples)

Tests:: vtkImageShiftScale (Tests)

Member Typedef Documentation

typedef vtkThreadedImageAlgorithm vtkImageShiftScale::Superclass

Reimplemented from vtkThreadedImageAlgorithm.
Definition at line 52 of file vtkImageShiftScale.h.

Constructor & Destructor Documentation

vtkImageShiftScale::vtkImageShiftScale ( ) [protected]

vtkImageShiftScale::~vtkImageShiftScale ( ) [inline, protected]

Definition at line 105 of file vtkImageShiftScale.h.

Member Function Documentation

vtkImageShiftScale* vtkImageShiftScale::New ( ) [static]

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

virtual const char* vtkImageShiftScale::GetClassName ( ) [virtual]

Reimplemented from vtkThreadedImageAlgorithm.

int vtkImageShiftScale::IsTypeOf ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkThreadedImageAlgorithm.

virtual int vtkImageShiftScale::IsA ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkThreadedImageAlgorithm.

vtkImageShiftScale* vtkImageShiftScale::SafeDownCast ( vtkObject * o ) [static]

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.

virtual double vtkImageShiftScale::GetShift ( ) [virtual]

Set/Get the shift value.

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

Set/Get the scale value.

virtual double vtkImageShiftScale::GetScale ( ) [virtual]

Set/Get the scale 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.

virtual int vtkImageShiftScale::GetOutputScalarType ( ) [virtual]

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

void vtkImageShiftScale::SetOutputScalarTypeToDouble ( ) [inline]

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.
Definition at line 72 of file vtkImageShiftScale.h.
References VTK_DOUBLE.

void vtkImageShiftScale::SetOutputScalarTypeToFloat ( ) [inline]

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.
Definition at line 74 of file vtkImageShiftScale.h.
References VTK_FLOAT.

void vtkImageShiftScale::SetOutputScalarTypeToLong ( ) [inline]

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.
Definition at line 76 of file vtkImageShiftScale.h.
References VTK_LONG.

void vtkImageShiftScale::SetOutputScalarTypeToUnsignedLong ( ) [inline]

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.
Definition at line 78 of file vtkImageShiftScale.h.
References VTK_UNSIGNED_LONG.

void vtkImageShiftScale::SetOutputScalarTypeToInt ( ) [inline]

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.
Definition at line 80 of file vtkImageShiftScale.h.
References VTK_INT.

void vtkImageShiftScale::SetOutputScalarTypeToUnsignedInt ( ) [inline]

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.
Definition at line 82 of file vtkImageShiftScale.h.
References VTK_UNSIGNED_INT.

void vtkImageShiftScale::SetOutputScalarTypeToShort ( ) [inline]

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.
Definition at line 84 of file vtkImageShiftScale.h.
References VTK_SHORT.

void vtkImageShiftScale::SetOutputScalarTypeToUnsignedShort ( ) [inline]

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.
Definition at line 86 of file vtkImageShiftScale.h.
References VTK_UNSIGNED_SHORT.

void vtkImageShiftScale::SetOutputScalarTypeToChar ( ) [inline]

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.
Definition at line 88 of file vtkImageShiftScale.h.
References VTK_CHAR.

void vtkImageShiftScale::SetOutputScalarTypeToUnsignedChar ( ) [inline]

Set the desired output scalar type. The result of the shift and scale operations is cast to the type specified.
Definition at line 90 of file vtkImageShiftScale.h.
References VTK_UNSIGNED_CHAR.

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.

virtual int vtkImageShiftScale::GetClampOverflow ( ) [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::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.

void vtkImageShiftScale::ExecuteInformation ( vtkInformation * ,

vtkInformationVector * ,

vtkInformationVector *

) [protected, virtual]

Reimplemented from vtkImageAlgorithm.

void vtkImageShiftScale::ThreadedExecute ( vtkImageData * inData,

vtkImageData * outData,

int extent[6],

int id

) [protected, virtual]

Reimplemented from vtkThreadedImageAlgorithm.

Member Data Documentation

double vtkImageShiftScale::Shift [protected]

Definition at line 107 of file vtkImageShiftScale.h.

double vtkImageShiftScale::Scale [protected]

Definition at line 108 of file vtkImageShiftScale.h.

int vtkImageShiftScale::OutputScalarType [protected]

Definition at line 109 of file vtkImageShiftScale.h.

int vtkImageShiftScale::ClampOverflow [protected]

Definition at line 110 of file vtkImageShiftScale.h.

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

dox/Imaging/vtkImageShiftScale.h


Public Types
typedef vtkThreadedImageAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
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
vtkImageShiftScale *	New ()
int	IsTypeOf (const char *type)
vtkImageShiftScale *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkImageShiftScale ()
	~vtkImageShiftScale ()
void	ExecuteInformation (vtkInformation , vtkInformationVector , vtkInformationVector *)
void	ThreadedExecute (vtkImageData inData, vtkImageData outData, int extent[6], int id)
Protected Attributes
double	Shift
double	Scale
int	OutputScalarType
int	ClampOverflow

vtkImageShiftScale Class Reference

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation