Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkImageShiftScale Class Reference

shift and scale an input image. More...

#include <vtkImageShiftScale.h>

Inheritance diagram for vtkImageShiftScale:

Inheritance graph
Collaboration diagram for vtkImageShiftScale:

Collaboration graph
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetShift (float)
virtual float GetShift ()
virtual void SetScale (float)
virtual float 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 Methods

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

Protected Methods

 vtkImageShiftScale ()
 ~vtkImageShiftScale ()
 vtkImageShiftScale (const vtkImageShiftScale &)
void operator= (const vtkImageShiftScale &)
void ExecuteInformation (vtkImageData *inData, vtkImageData *outData)
void ExecuteInformation ()
void ThreadedExecute (vtkImageData *inData, vtkImageData *outData, int extent[6], int id)

Protected Attributes

float Shift
float Scale
int OutputScalarType
int ClampOverflow

Detailed Description

shift and scale an input image.

2000/12/10 20:09:10
Thanks to C. Charles Law who developed this class.
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.
vtkImageShiftScale (examples)

Definition at line 62 of file vtkImageShiftScale.h.

Constructor & Destructor Documentation

vtkImageShiftScale::vtkImageShiftScale   [protected]

vtkImageShiftScale::~vtkImageShiftScale   [inline, protected]

Definition at line 111 of file vtkImageShiftScale.h.

vtkImageShiftScale::vtkImageShiftScale const vtkImageShiftScale &    [inline, protected]

Definition at line 112 of file vtkImageShiftScale.h.

Member Function Documentation

vtkImageShiftScale* vtkImageShiftScale::New   [static]

Instantiate object with no start, end, or progress methods.

Reimplemented from vtkImageToImageFilter.

virtual const char* vtkImageShiftScale::GetClassName   [virtual]

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageToImageFilter.

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageToImageFilter.

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageToImageFilter.

vtkImageShiftScale* vtkImageShiftScale::SafeDownCast vtkObject   o [static]

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageToImageFilter.

void vtkImageShiftScale::PrintSelf ostream &    os,
vtkIndent    indent

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

virtual void vtkImageShiftScale::SetShift float    [virtual]

Set/Get the shift value.

virtual float vtkImageShiftScale::GetShift   [virtual]

virtual void vtkImageShiftScale::SetScale float    [virtual]

Set/Get the scale value.

virtual float vtkImageShiftScale::GetScale   [virtual]

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]

void vtkImageShiftScale::SetOutputScalarTypeToDouble   [inline]

Definition at line 81 of file vtkImageShiftScale.h.

void vtkImageShiftScale::SetOutputScalarTypeToFloat   [inline]

Definition at line 83 of file vtkImageShiftScale.h.

void vtkImageShiftScale::SetOutputScalarTypeToLong   [inline]

Definition at line 85 of file vtkImageShiftScale.h.

void vtkImageShiftScale::SetOutputScalarTypeToUnsignedLong   [inline]

Definition at line 87 of file vtkImageShiftScale.h.

void vtkImageShiftScale::SetOutputScalarTypeToInt   [inline]

Definition at line 89 of file vtkImageShiftScale.h.

void vtkImageShiftScale::SetOutputScalarTypeToUnsignedInt   [inline]

Definition at line 91 of file vtkImageShiftScale.h.

void vtkImageShiftScale::SetOutputScalarTypeToShort   [inline]

Definition at line 93 of file vtkImageShiftScale.h.

void vtkImageShiftScale::SetOutputScalarTypeToUnsignedShort   [inline]

Definition at line 95 of file vtkImageShiftScale.h.

void vtkImageShiftScale::SetOutputScalarTypeToChar   [inline]

Definition at line 97 of file vtkImageShiftScale.h.

void vtkImageShiftScale::SetOutputScalarTypeToUnsignedChar   [inline]

Definition at line 99 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]

virtual void vtkImageShiftScale::ClampOverflowOn   [virtual]

virtual void vtkImageShiftScale::ClampOverflowOff   [virtual]

void vtkImageShiftScale::operator= const vtkImageShiftScale &    [inline, protected]

Definition at line 113 of file vtkImageShiftScale.h.

void vtkImageShiftScale::ExecuteInformation vtkImageData   inData,
vtkImageData   outData
[protected, virtual]

Reimplemented from vtkImageToImageFilter.

void vtkImageShiftScale::ExecuteInformation   [inline, protected, virtual]

Reimplemented from vtkImageToImageFilter.

Definition at line 121 of file vtkImageShiftScale.h.

void vtkImageShiftScale::ThreadedExecute vtkImageData   inData,
vtkImageData   outData,
int    extent[6],
int    id
[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 vtkImageToImageFilter.

Member Data Documentation

float vtkImageShiftScale::Shift [protected]

Definition at line 115 of file vtkImageShiftScale.h.

float vtkImageShiftScale::Scale [protected]

Definition at line 116 of file vtkImageShiftScale.h.

int vtkImageShiftScale::OutputScalarType [protected]

Definition at line 117 of file vtkImageShiftScale.h.

int vtkImageShiftScale::ClampOverflow [protected]

Definition at line 118 of file vtkImageShiftScale.h.

The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:48:58 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001