VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImageToPolyDataFilter Class Reference

generate linear primitives (vtkPolyData) from an image More...

#include <vtkImageToPolyDataFilter.h>

Inheritance diagram for vtkImageToPolyDataFilter:
[legend]
Collaboration diagram for vtkImageToPolyDataFilter:
[legend]

Public Types

typedef vtkPolyDataAlgorithm Superclass
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetOutputStyle (int)
virtual int GetOutputStyle ()
void SetOutputStyleToPixelize ()
void SetOutputStyleToPolygonalize ()
void SetOutputStyleToRunLength ()
virtual void SetColorMode (int)
virtual int GetColorMode ()
void SetColorModeToLUT ()
void SetColorModeToLinear256 ()
virtual void SetLookupTable (vtkScalarsToColors *)
virtual vtkScalarsToColorsGetLookupTable ()
virtual void SetSmoothing (int)
virtual int GetSmoothing ()
virtual void SmoothingOn ()
virtual void SmoothingOff ()
virtual void SetNumberOfSmoothingIterations (int)
virtual int GetNumberOfSmoothingIterations ()
virtual void SetDecimation (int)
virtual int GetDecimation ()
virtual void DecimationOn ()
virtual void DecimationOff ()
virtual void SetDecimationError (double)
virtual double GetDecimationError ()
virtual void SetError (int)
virtual int GetError ()
virtual void SetSubImageSize (int)
virtual int GetSubImageSize ()
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkDataObjectGetInput ()
vtkDataObjectGetInput (int port)
vtkPolyDataGetPolyDataInput (int port)
vtkPolyDataGetOutput ()
vtkPolyDataGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void AddInput (vtkDataObject *)
void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkImageToPolyDataFilterSafeDownCast (vtkObject *o)
static vtkImageToPolyDataFilterNew ()

Protected Member Functions

 vtkImageToPolyDataFilter ()
 ~vtkImageToPolyDataFilter ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual void PixelizeImage (vtkUnsignedCharArray *pixels, int dims[3], double origin[3], double spacing[3], vtkPolyData *output)
virtual void PolygonalizeImage (vtkUnsignedCharArray *pixels, int dims[3], double origin[3], double spacing[3], vtkPolyData *output)
virtual void RunLengthImage (vtkUnsignedCharArray *pixels, int dims[3], double origin[3], double spacing[3], vtkPolyData *output)
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 ~vtkPolyDataAlgorithm ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

int OutputStyle
int ColorMode
int Smoothing
int NumberOfSmoothingIterations
int Decimation
double DecimationError
int Error
int SubImageSize
vtkScalarsToColorsLookupTable

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
- Friends inherited from vtkObject

Detailed Description

generate linear primitives (vtkPolyData) from an image

vtkImageToPolyDataFilter converts raster data (i.e., an image) into polygonal data (i.e., quads or n-sided polygons), with each polygon assigned a constant color. This is useful for writers that generate vector formats (i.e., CGM or PostScript). To use this filter, you specify how to quantize the color (or whether to use an image with a lookup table), and what style the output should be. The output is always polygons, but the choice is n x m quads (where n and m define the input image dimensions) "Pixelize" option; arbitrary polygons "Polygonalize" option; or variable number of quads of constant color generated along scan lines "RunLength" option.

The algorithm quantizes color in order to create coherent regions that the polygons can represent with good compression. By default, the input image is quantized to 256 colors using a 3-3-2 bits for red-green-blue. However, you can also supply a single component image and a lookup table, with the single component assumed to be an index into the table. (Note: a quantized image can be generated with the filter vtkImageQuantizeRGBToIndex.) The number of colors on output is equal to the number of colors in the input lookup table (or 256 if the built in linear ramp is used).

The output of the filter is polygons with a single color per polygon cell. If the output style is set to "Polygonalize", the polygons may have an large number of points (bounded by something like 2*(n+m)); and the polygon may not be convex which may cause rendering problems on some systems (use vtkTriangleFilter). Otherwise, each polygon will have four vertices. The output also contains scalar data defining RGB color in unsigned char form.

Warning
The input linear lookup table must be of the form of 3-component unsigned char.
This filter defines constant cell colors. If you have a plotting device that supports Gouraud shading (linear interpolation of color), then superior algorithms are available for generating polygons from images.
Note that many plotting devices/formats support only a limited number of colors.
See Also
vtkCGMWriter vtkImageQuantizeRGBToIndex vtkTriangleFilter
Tests:
vtkImageToPolyDataFilter (Tests)

Definition at line 88 of file vtkImageToPolyDataFilter.h.

Member Typedef Documentation

Definition at line 91 of file vtkImageToPolyDataFilter.h.

Constructor & Destructor Documentation

vtkImageToPolyDataFilter::vtkImageToPolyDataFilter ( )
protected
vtkImageToPolyDataFilter::~vtkImageToPolyDataFilter ( )
protected

Member Function Documentation

virtual const char* vtkImageToPolyDataFilter::GetClassName ( )
virtual

Reimplemented from vtkPolyDataAlgorithm.

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

virtual int vtkImageToPolyDataFilter::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 vtkPolyDataAlgorithm.

static vtkImageToPolyDataFilter* vtkImageToPolyDataFilter::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkPolyDataAlgorithm.

void vtkImageToPolyDataFilter::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 vtkPolyDataAlgorithm.

static vtkImageToPolyDataFilter* vtkImageToPolyDataFilter::New ( )
static

Instantiate object with initial number of colors 256.

Reimplemented from vtkPolyDataAlgorithm.

virtual void vtkImageToPolyDataFilter::SetOutputStyle ( int  )
virtual

Specify how to create the output. Pixelize means converting the image to quad polygons with a constant color per quad. Polygonalize means merging colors together into polygonal regions, and then smoothing the regions (if smoothing is turned on). RunLength means creating quad polygons that may encompass several pixels on a scan line. The default behavior is Polygonalize.

virtual int vtkImageToPolyDataFilter::GetOutputStyle ( )
virtual

Specify how to create the output. Pixelize means converting the image to quad polygons with a constant color per quad. Polygonalize means merging colors together into polygonal regions, and then smoothing the regions (if smoothing is turned on). RunLength means creating quad polygons that may encompass several pixels on a scan line. The default behavior is Polygonalize.

void vtkImageToPolyDataFilter::SetOutputStyleToPixelize ( )
inline

Specify how to create the output. Pixelize means converting the image to quad polygons with a constant color per quad. Polygonalize means merging colors together into polygonal regions, and then smoothing the regions (if smoothing is turned on). RunLength means creating quad polygons that may encompass several pixels on a scan line. The default behavior is Polygonalize.

Definition at line 106 of file vtkImageToPolyDataFilter.h.

void vtkImageToPolyDataFilter::SetOutputStyleToPolygonalize ( )
inline

Specify how to create the output. Pixelize means converting the image to quad polygons with a constant color per quad. Polygonalize means merging colors together into polygonal regions, and then smoothing the regions (if smoothing is turned on). RunLength means creating quad polygons that may encompass several pixels on a scan line. The default behavior is Polygonalize.

Definition at line 108 of file vtkImageToPolyDataFilter.h.

void vtkImageToPolyDataFilter::SetOutputStyleToRunLength ( )
inline

Specify how to create the output. Pixelize means converting the image to quad polygons with a constant color per quad. Polygonalize means merging colors together into polygonal regions, and then smoothing the regions (if smoothing is turned on). RunLength means creating quad polygons that may encompass several pixels on a scan line. The default behavior is Polygonalize.

Definition at line 110 of file vtkImageToPolyDataFilter.h.

virtual void vtkImageToPolyDataFilter::SetColorMode ( int  )
virtual

Specify how to quantize color.

virtual int vtkImageToPolyDataFilter::GetColorMode ( )
virtual

Specify how to quantize color.

void vtkImageToPolyDataFilter::SetColorModeToLUT ( )
inline

Specify how to quantize color.

Definition at line 118 of file vtkImageToPolyDataFilter.h.

void vtkImageToPolyDataFilter::SetColorModeToLinear256 ( )
inline

Specify how to quantize color.

Definition at line 120 of file vtkImageToPolyDataFilter.h.

virtual void vtkImageToPolyDataFilter::SetLookupTable ( vtkScalarsToColors )
virtual

Set/Get the vtkLookupTable to use. The lookup table is used when the color mode is set to LUT and a single component scalar is input.

virtual vtkScalarsToColors* vtkImageToPolyDataFilter::GetLookupTable ( )
virtual

Set/Get the vtkLookupTable to use. The lookup table is used when the color mode is set to LUT and a single component scalar is input.

virtual void vtkImageToPolyDataFilter::SetSmoothing ( int  )
virtual

If the output style is set to polygonalize, then you can control whether to smooth boundaries.

virtual int vtkImageToPolyDataFilter::GetSmoothing ( )
virtual

If the output style is set to polygonalize, then you can control whether to smooth boundaries.

virtual void vtkImageToPolyDataFilter::SmoothingOn ( )
virtual

If the output style is set to polygonalize, then you can control whether to smooth boundaries.

virtual void vtkImageToPolyDataFilter::SmoothingOff ( )
virtual

If the output style is set to polygonalize, then you can control whether to smooth boundaries.

virtual void vtkImageToPolyDataFilter::SetNumberOfSmoothingIterations ( int  )
virtual

Specify the number of smoothing iterations to smooth polygons. (Only in effect if output style is Polygonalize and smoothing is on.)

virtual int vtkImageToPolyDataFilter::GetNumberOfSmoothingIterations ( )
virtual

Specify the number of smoothing iterations to smooth polygons. (Only in effect if output style is Polygonalize and smoothing is on.)

virtual void vtkImageToPolyDataFilter::SetDecimation ( int  )
virtual

Turn on/off whether the final polygons should be decimated. whether to smooth boundaries.

virtual int vtkImageToPolyDataFilter::GetDecimation ( )
virtual

Turn on/off whether the final polygons should be decimated. whether to smooth boundaries.

virtual void vtkImageToPolyDataFilter::DecimationOn ( )
virtual

Turn on/off whether the final polygons should be decimated. whether to smooth boundaries.

virtual void vtkImageToPolyDataFilter::DecimationOff ( )
virtual

Turn on/off whether the final polygons should be decimated. whether to smooth boundaries.

virtual void vtkImageToPolyDataFilter::SetDecimationError ( double  )
virtual

Specify the error to use for decimation (if decimation is on). The error is an absolute number–the image spacing and dimensions are used to create points so the error should be consistent with the image size.

virtual double vtkImageToPolyDataFilter::GetDecimationError ( )
virtual

Specify the error to use for decimation (if decimation is on). The error is an absolute number–the image spacing and dimensions are used to create points so the error should be consistent with the image size.

virtual void vtkImageToPolyDataFilter::SetError ( int  )
virtual

Specify the error value between two colors where the colors are considered the same. Only use this if the color mode uses the default 256 table.

virtual int vtkImageToPolyDataFilter::GetError ( )
virtual

Specify the error value between two colors where the colors are considered the same. Only use this if the color mode uses the default 256 table.

virtual void vtkImageToPolyDataFilter::SetSubImageSize ( int  )
virtual

Specify the size (n by n pixels) of the largest region to polygonalize. When the OutputStyle is set to VTK_STYLE_POLYGONALIZE, large amounts of memory are used. In order to process large images, the image is broken into pieces that are at most Size pixels in width and height.

virtual int vtkImageToPolyDataFilter::GetSubImageSize ( )
virtual

Specify the size (n by n pixels) of the largest region to polygonalize. When the OutputStyle is set to VTK_STYLE_POLYGONALIZE, large amounts of memory are used. In order to process large images, the image is broken into pieces that are at most Size pixels in width and height.

virtual int vtkImageToPolyDataFilter::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkImageToPolyDataFilter::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkPolyDataAlgorithm.

virtual void vtkImageToPolyDataFilter::PixelizeImage ( vtkUnsignedCharArray pixels,
int  dims[3],
double  origin[3],
double  spacing[3],
vtkPolyData output 
)
protectedvirtual
virtual void vtkImageToPolyDataFilter::PolygonalizeImage ( vtkUnsignedCharArray pixels,
int  dims[3],
double  origin[3],
double  spacing[3],
vtkPolyData output 
)
protectedvirtual
virtual void vtkImageToPolyDataFilter::RunLengthImage ( vtkUnsignedCharArray pixels,
int  dims[3],
double  origin[3],
double  spacing[3],
vtkPolyData output 
)
protectedvirtual

Member Data Documentation

int vtkImageToPolyDataFilter::OutputStyle
protected

Definition at line 188 of file vtkImageToPolyDataFilter.h.

int vtkImageToPolyDataFilter::ColorMode
protected

Definition at line 189 of file vtkImageToPolyDataFilter.h.

int vtkImageToPolyDataFilter::Smoothing
protected

Definition at line 190 of file vtkImageToPolyDataFilter.h.

int vtkImageToPolyDataFilter::NumberOfSmoothingIterations
protected

Definition at line 191 of file vtkImageToPolyDataFilter.h.

int vtkImageToPolyDataFilter::Decimation
protected

Definition at line 192 of file vtkImageToPolyDataFilter.h.

double vtkImageToPolyDataFilter::DecimationError
protected

Definition at line 193 of file vtkImageToPolyDataFilter.h.

int vtkImageToPolyDataFilter::Error
protected

Definition at line 194 of file vtkImageToPolyDataFilter.h.

int vtkImageToPolyDataFilter::SubImageSize
protected

Definition at line 195 of file vtkImageToPolyDataFilter.h.

vtkScalarsToColors* vtkImageToPolyDataFilter::LookupTable
protected

Definition at line 196 of file vtkImageToPolyDataFilter.h.


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