Documentation for vtkImageShiftScale

vtkImageShiftScale - shift and scale an input image

Super Class: vtkImageFilter

Description:

With vtkImageShiftScale Pixels are shifted and then scaled. As a convinience this class allows you to set the output scalar type similar to vtkImageCast. This is because frequently shift scale operations are associated with converting data types.

 

Methods:

void vtkImageShiftScale ()
static vtkImageShiftScale *New ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
void SetShift (float )
float GetShift ()
void SetScale (float )
float GetScale ()
void SetOutputScalarType (int )
int GetOutputScalarType ()
void SetOutputScalarTypeToFloat ()
void SetOutputScalarTypeToInt ()
void SetOutputScalarTypeToShort ()
void SetOutputScalarTypeToUnsignedShort ()
void SetOutputScalarTypeToUnsignedChar ()
void SetClampOverflow (int )
int GetClampOverflow ()
void ClampOverflowOn ()
void ClampOverflowOff ()
void ExecuteImageInformation ()
void ThreadedExecute (vtkImageData * ,vtkImageData * ,int ,int )

 

Detailed Method Descriptions:

Set/Get the Shift

void SetShift (float )
float GetShift ()

Set/Get the scale Value;

void SetScale (float )
float GetScale ()

Set the desired output scalar type to cast to

void SetOutputScalarType (int )
int GetOutputScalarType ()
void SetOutputScalarTypeToFloat ()
void SetOutputScalarTypeToInt ()
void SetOutputScalarTypeToShort ()
void SetOutputScalarTypeToUnsignedShort ()
void SetOutputScalarTypeToUnsignedChar ()

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

void SetClampOverflow (int )
int GetClampOverflow ()
void ClampOverflowOn ()
void ClampOverflowOff ()