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 (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 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 * name ) [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 vtkThreadedImageAlgorithm.

virtual int vtkImageShiftScale::IsA ( const char * name ) [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 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. 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]