VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkImageCast Class Reference

Image Data type Casting Filter. More...

#include <vtkImageCast.h>

Inheritance diagram for vtkImageCast:
Inheritance graph
[legend]
Collaboration diagram for vtkImageCast:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkThreadedImageAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkImageCastNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetOutputScalarType (int)
virtual int GetOutputScalarType ()
void SetOutputScalarTypeToFloat ()
void SetOutputScalarTypeToDouble ()
void SetOutputScalarTypeToInt ()
void SetOutputScalarTypeToUnsignedInt ()
void SetOutputScalarTypeToLong ()
void SetOutputScalarTypeToUnsignedLong ()
void SetOutputScalarTypeToShort ()
void SetOutputScalarTypeToUnsignedShort ()
void SetOutputScalarTypeToUnsignedChar ()
void SetOutputScalarTypeToChar ()
virtual void SetClampOverflow (int)
virtual int GetClampOverflow ()
virtual void ClampOverflowOn ()
virtual void ClampOverflowOff ()

Static Public Member Functions

static vtkImageCastNew ()
static int IsTypeOf (const char *type)
static vtkImageCastSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkImageCast ()
 ~vtkImageCast ()
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void ThreadedExecute (vtkImageData *inData, vtkImageData *outData, int ext[6], int id)

Protected Attributes

int ClampOverflow
int OutputScalarType

Detailed Description

Image Data type Casting Filter.

vtkImageCast filter casts the input type to match the output type in the image processing pipeline. The filter does nothing if the input already has the correct type. To specify the "CastTo" type, use "SetOutputScalarType" method.

Warning:
As vtkImageCast only casts values without rescaling them, its use is not recommented. vtkImageShiftScale is the recommented way to change the type of an image data.
See also:
vtkImageThreshold vtkImageShiftScale
Examples:
vtkImageCast (Examples)
Tests:
vtkImageCast (Tests)

Definition at line 45 of file vtkImageCast.h.


Member Typedef Documentation

Reimplemented from vtkThreadedImageAlgorithm.

Definition at line 49 of file vtkImageCast.h.


Constructor & Destructor Documentation

vtkImageCast::vtkImageCast ( ) [protected]
vtkImageCast::~vtkImageCast ( ) [inline, protected]

Definition at line 88 of file vtkImageCast.h.


Member Function Documentation

static vtkImageCast* vtkImageCast::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

static int vtkImageCast::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 vtkImageCast::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.

Reimplemented from vtkThreadedImageAlgorithm.

virtual vtkObjectBase* vtkImageCast::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkThreadedImageAlgorithm.

Reimplemented from vtkThreadedImageAlgorithm.

void vtkImageCast::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 vtkImageCast::SetOutputScalarType ( int  ) [virtual]

Set the desired output scalar type to cast to.

virtual int vtkImageCast::GetOutputScalarType ( ) [virtual]

Set the desired output scalar type to cast to.

Set the desired output scalar type to cast to.

Definition at line 56 of file vtkImageCast.h.

Set the desired output scalar type to cast to.

Definition at line 57 of file vtkImageCast.h.

Set the desired output scalar type to cast to.

Definition at line 58 of file vtkImageCast.h.

Set the desired output scalar type to cast to.

Definition at line 59 of file vtkImageCast.h.

Set the desired output scalar type to cast to.

Definition at line 61 of file vtkImageCast.h.

Set the desired output scalar type to cast to.

Definition at line 62 of file vtkImageCast.h.

Set the desired output scalar type to cast to.

Definition at line 64 of file vtkImageCast.h.

Set the desired output scalar type to cast to.

Definition at line 65 of file vtkImageCast.h.

Set the desired output scalar type to cast to.

Definition at line 67 of file vtkImageCast.h.

Set the desired output scalar type to cast to.

Definition at line 69 of file vtkImageCast.h.

virtual void vtkImageCast::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. Clamping is safer because otherwise you might invoke undefined behavior (and may crash) if the type conversion is out of range of the data type. On the other hand, clamping is slower. By default ClampOverflow is off.

virtual int vtkImageCast::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. Clamping is safer because otherwise you might invoke undefined behavior (and may crash) if the type conversion is out of range of the data type. On the other hand, clamping is slower. By default ClampOverflow is off.

virtual void vtkImageCast::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. Clamping is safer because otherwise you might invoke undefined behavior (and may crash) if the type conversion is out of range of the data type. On the other hand, clamping is slower. By default ClampOverflow is off.

virtual void vtkImageCast::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. Clamping is safer because otherwise you might invoke undefined behavior (and may crash) if the type conversion is out of range of the data type. On the other hand, clamping is slower. By default ClampOverflow is off.

virtual int vtkImageCast::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.

Reimplemented from vtkImageAlgorithm.

void vtkImageCast::ThreadedExecute ( vtkImageData inData,
vtkImageData outData,
int  ext[6],
int  id 
) [protected, virtual]

Reimplemented from vtkThreadedImageAlgorithm.


Member Data Documentation

Definition at line 90 of file vtkImageCast.h.

Definition at line 91 of file vtkImageCast.h.


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