Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkImageShiftScale Class Reference

#include <vtkImageShiftScale.h>

Inheritance diagram for vtkImageShiftScale:

Inheritance graph
[legend]
Collaboration diagram for vtkImageShiftScale:

Collaboration graph
[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.

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

Definition at line 36 of file 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

static vtkImageShiftScale * New ()
static int IsTypeOf (const char *type)
static vtkImageShiftScale * SafeDownCast (vtkObject *o)

Protected Member Functions

 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

Member Typedef Documentation

typedef vtkThreadedImageAlgorithm vtkImageShiftScale::Superclass
 

Reimplemented from vtkThreadedImageAlgorithm.

Definition at line 40 of file vtkImageShiftScale.h.

Constructor & Destructor Documentation

vtkImageShiftScale::vtkImageShiftScale (   )  [protected]
 

vtkImageShiftScale::~vtkImageShiftScale (   )  [protected]
 

Member Function Documentation

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

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

static 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]
 

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 60 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 62 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 64 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 66 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 68 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 70 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 72 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 74 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 76 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 78 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.

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

Reimplemented from vtkImageAlgorithm.

virtual void vtkImageShiftScale::ThreadedRequestData (  vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *  ,
vtkImageData ***  inData,
vtkImageData **  outData,
int  outExt[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

double vtkImageShiftScale::Shift [protected]
 

Definition at line 95 of file vtkImageShiftScale.h.

double vtkImageShiftScale::Scale [protected]
 

Definition at line 96 of file vtkImageShiftScale.h.

int vtkImageShiftScale::OutputScalarType [protected]
 

Definition at line 97 of file vtkImageShiftScale.h.

int vtkImageShiftScale::ClampOverflow [protected]
 

Definition at line 98 of file vtkImageShiftScale.h.

The documentation for this class was generated from the following file:
Generated on Mon Jan 21 23:53:09 2008 for VTK by  doxygen 1.4.3-20050530