VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkPolyDataToImageStencil Class Reference

use polydata to mask an image More...

#include <vtkPolyDataToImageStencil.h>

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

Public Types

typedef vtkImageStencilSource Superclass
 
- Public Types inherited from vtkImageStencilSource
typedef vtkImageStencilAlgorithm Superclass
 
- Public Types inherited from vtkImageStencilAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkPolyDataToImageStencilNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetInputData (vtkPolyData *)
 
vtkPolyDataGetInput ()
 
virtual void SetTolerance (double)
 
virtual double GetTolerance ()
 
- Public Member Functions inherited from vtkImageStencilSource
vtkImageStencilSourceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void SetInformationInput (vtkImageData *)
 
virtual vtkImageData * GetInformationInput ()
 
virtual void SetOutputOrigin (double, double, double)
 
virtual void SetOutputOrigin (double[3])
 
virtual double * GetOutputOrigin ()
 
virtual void GetOutputOrigin (double &, double &, double &)
 
virtual void GetOutputOrigin (double[3])
 
virtual void SetOutputSpacing (double, double, double)
 
virtual void SetOutputSpacing (double[3])
 
virtual double * GetOutputSpacing ()
 
virtual void GetOutputSpacing (double &, double &, double &)
 
virtual void GetOutputSpacing (double[3])
 
virtual void SetOutputWholeExtent (int, int, int, int, int, int)
 
virtual void SetOutputWholeExtent (int[6])
 
virtual int * GetOutputWholeExtent ()
 
virtual void GetOutputWholeExtent (int &, int &, int &, int &, int &, int &)
 
virtual void GetOutputWholeExtent (int[6])
 
- Public Member Functions inherited from vtkImageStencilAlgorithm
vtkImageStencilAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetOutput (vtkImageStencilData *output)
 
vtkImageStencilDataGetOutput ()
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformation * GetInputPortInformation (int port)
 
vtkInformation * GetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformation * GetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int extent[6])
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformation * GetInformation ()
 
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)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformation * GetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int extent[6])
 
int * GetUpdateExtent ()
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 

Static Public Member Functions

static vtkPolyDataToImageStencilNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPolyDataToImageStencilSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageStencilSource
static vtkImageStencilSourceNew ()
 
static int IsTypeOf (const char *type)
 
static vtkImageStencilSourceSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageStencilAlgorithm
static vtkImageStencilAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkImageStencilAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKey * INPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKey * INPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey * 
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKey * INPUT_PORT ()
 
static vtkInformationIntegerKey * INPUT_CONNECTION ()
 
static vtkInformationIntegerKey * PRESERVES_DATASET ()
 
static vtkInformationIntegerKey * PRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKey * PRESERVES_BOUNDS ()
 
static vtkInformationIntegerKey * PRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKey * PRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKey * PRESERVES_RANGES ()
 
static vtkInformationIntegerKey * MANAGES_METAINFORMATION ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkPolyDataToImageStencil ()
 
 ~vtkPolyDataToImageStencil ()
 
void ThreadedExecute (vtkImageStencilData *output, int extent[6], int threadId)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int FillInputPortInformation (int, vtkInformation *)
 
- Protected Member Functions inherited from vtkImageStencilSource
 vtkImageStencilSource ()
 
 ~vtkImageStencilSource ()
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkImageStencilAlgorithm
 vtkImageStencilAlgorithm ()
 
 ~vtkImageStencilAlgorithm ()
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
vtkImageStencilDataAllocateOutputData (vtkDataObject *out, int *updateExt)
 
virtual int FillOutputPortInformation (int, vtkInformation *)
 
- 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 SetNumberOfInputConnections (int port, int n)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformation * GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
virtual void SetErrorCode (unsigned long)
 

Static Protected Member Functions

static void PolyDataCutter (vtkPolyData *input, vtkPolyData *output, double z, vtkMergePoints *locator)
 
static void PolyDataSelector (vtkPolyData *input, vtkPolyData *output, double z, double thickness, vtkMergePoints *locator)
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED ()
 

Protected Attributes

double Tolerance
 
- Protected Attributes inherited from vtkImageStencilSource
vtkImageData * InformationInput
 
int OutputWholeExtent [6]
 
double OutputOrigin [3]
 
double OutputSpacing [3]
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

use polydata to mask an image

The vtkPolyDataToImageStencil class will convert polydata into an image stencil. The polydata can either be a closed surface mesh or a series of polyline contours (one contour per slice).

Warning
If contours are provided, the contours must be aligned with the Z planes. Other contour orientations are not supported.
See Also
vtkImageStencil vtkImageAccumulate vtkImageBlend vtkImageReslice
Examples:
vtkPolyDataToImageStencil (Examples)
Tests:
vtkPolyDataToImageStencil (Tests)

Definition at line 77 of file vtkPolyDataToImageStencil.h.

Member Typedef Documentation

Definition at line 82 of file vtkPolyDataToImageStencil.h.

Constructor & Destructor Documentation

vtkPolyDataToImageStencil::vtkPolyDataToImageStencil ( )
protected
vtkPolyDataToImageStencil::~vtkPolyDataToImageStencil ( )
protected

Member Function Documentation

static vtkPolyDataToImageStencil* vtkPolyDataToImageStencil::New ( )
static
static int vtkPolyDataToImageStencil::IsTypeOf ( const char *  type)
static
virtual int vtkPolyDataToImageStencil::IsA ( const char *  type)
virtual

Reimplemented from vtkImageStencilSource.

static vtkPolyDataToImageStencil* vtkPolyDataToImageStencil::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkPolyDataToImageStencil::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageStencilSource.

vtkPolyDataToImageStencil* vtkPolyDataToImageStencil::NewInstance ( ) const
void vtkPolyDataToImageStencil::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkPolyDataToImageStencil::SetInputData ( vtkPolyData )
virtual

Specify the implicit function to convert into a stencil.

vtkPolyData* vtkPolyDataToImageStencil::GetInput ( )

Specify the implicit function to convert into a stencil.

virtual void vtkPolyDataToImageStencil::SetTolerance ( double  )
virtual

The tolerance to apply in when determining whether a voxel is inside the stencil, given as a fraction of a voxel. Only used in X and Y, not in Z.

virtual double vtkPolyDataToImageStencil::GetTolerance ( )
virtual

The tolerance to apply in when determining whether a voxel is inside the stencil, given as a fraction of a voxel. Only used in X and Y, not in Z.

void vtkPolyDataToImageStencil::ThreadedExecute ( vtkImageStencilData output,
int  extent[6],
int  threadId 
)
protected
static void vtkPolyDataToImageStencil::PolyDataCutter ( vtkPolyData input,
vtkPolyData output,
double  z,
vtkMergePoints locator 
)
staticprotected
static void vtkPolyDataToImageStencil::PolyDataSelector ( vtkPolyData input,
vtkPolyData output,
double  z,
double  thickness,
vtkMergePoints locator 
)
staticprotected
virtual int vtkPolyDataToImageStencil::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Reimplemented from vtkImageStencilAlgorithm.

virtual int vtkPolyDataToImageStencil::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 vtkAlgorithm.

Member Data Documentation

double vtkPolyDataToImageStencil::Tolerance
protected

The tolerance distance for favoring the inside of the stencil

Definition at line 119 of file vtkPolyDataToImageStencil.h.


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