VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImageShiftScale Class Reference

shift and scale an input image More...

#include <vtkImageShiftScale.h>

Inherits vtkThreadedImageAlgorithm.

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 vtkObjectBase * NewInstanceInternal () 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

typedef vtkThreadedImageAlgorithm vtkImageShiftScale::Superclass

Definition at line 41 of file vtkImageShiftScale.h.

Constructor & Destructor Documentation

vtkImageShiftScale::vtkImageShiftScale ( )
protected
vtkImageShiftScale::~vtkImageShiftScale ( )
protected

Member Function Documentation

static vtkImageShiftScale* vtkImageShiftScale::New ( )
static
static int vtkImageShiftScale::IsTypeOf ( const char *  type)
static
virtual int vtkImageShiftScale::IsA ( const char *  type)
virtual
static vtkImageShiftScale* vtkImageShiftScale::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkImageShiftScale::NewInstanceInternal ( ) const
protectedvirtual
vtkImageShiftScale* vtkImageShiftScale::NewInstance ( ) const
void vtkImageShiftScale::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

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 61 of file vtkImageShiftScale.h.

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 63 of file vtkImageShiftScale.h.

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 65 of file vtkImageShiftScale.h.

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 67 of file vtkImageShiftScale.h.

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 69 of file vtkImageShiftScale.h.

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 71 of file vtkImageShiftScale.h.

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 73 of file vtkImageShiftScale.h.

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 75 of file vtkImageShiftScale.h.

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 77 of file vtkImageShiftScale.h.

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 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.

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.

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

Member Data Documentation

double vtkImageShiftScale::Shift
protected

Definition at line 96 of file vtkImageShiftScale.h.

double vtkImageShiftScale::Scale
protected

Definition at line 97 of file vtkImageShiftScale.h.

int vtkImageShiftScale::OutputScalarType
protected

Definition at line 98 of file vtkImageShiftScale.h.

int vtkImageShiftScale::ClampOverflow
protected

Definition at line 99 of file vtkImageShiftScale.h.


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