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 | Protected Attributes | List of all members
vtkLassoStencilSource Class Reference

Create a stencil from a contour. More...

#include <vtkLassoStencilSource.h>

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

Public Types

enum  { POLYGON = 0, SPLINE = 1 }
 
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)
 
vtkLassoStencilSourceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void RemoveAllSlicePoints ()
 
unsigned long GetMTime ()
 
virtual int GetShape ()
 
virtual void SetShape (int)
 
void SetShapeToPolygon ()
 
void SetShapeToSpline ()
 
virtual const char * GetShapeAsString ()
 
virtual void SetPoints (vtkPoints *points)
 
virtual vtkPoints * GetPoints ()
 
virtual int GetSliceOrientation ()
 
virtual void SetSliceOrientation (int)
 
virtual void SetSlicePoints (int i, vtkPoints *points)
 
virtual vtkPoints * GetSlicePoints (int i)
 
- 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 vtkLassoStencilSourceNew ()
 
static int IsTypeOf (const char *type)
 
static vtkLassoStencilSourceSafeDownCast (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
 
 vtkLassoStencilSource ()
 
 ~vtkLassoStencilSource ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- 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 int FillInputPortInformation (int port, vtkInformation *info)
 
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)
 

Protected Attributes

int Shape
 
int SliceOrientation
 
vtkPoints * Points
 
vtkSplineSplineX
 
vtkSplineSplineY
 
vtkLSSPointMap * PointMap
 
- 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 Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Create a stencil from a contour.

vtkLassoStencilSource will create an image stencil from a set of points that define a contour. Its output can be used with vtkImageStecil or other vtk classes that apply a stencil to an image.

See Also
vtkROIStencilSource vtkPolyDataToImageStencil
Thanks:
Thanks to David Gobbi for contributing this class to VTK.
Tests:
vtkLassoStencilSource (Tests)

Definition at line 42 of file vtkLassoStencilSource.h.

Member Typedef Documentation

Definition at line 46 of file vtkLassoStencilSource.h.

Member Enumeration Documentation

anonymous enum
Enumerator
POLYGON 
SPLINE 

Definition at line 50 of file vtkLassoStencilSource.h.

Constructor & Destructor Documentation

vtkLassoStencilSource::vtkLassoStencilSource ( )
protected
vtkLassoStencilSource::~vtkLassoStencilSource ( )
protected

Member Function Documentation

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

Reimplemented from vtkImageStencilSource.

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

Reimplemented from vtkImageStencilSource.

vtkLassoStencilSource* vtkLassoStencilSource::NewInstance ( ) const
void vtkLassoStencilSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual int vtkLassoStencilSource::GetShape ( )
virtual

The shape to use, default is "Polygon". The spline is a cardinal spline. Bezier splines are not yet supported.

virtual void vtkLassoStencilSource::SetShape ( int  )
virtual

The shape to use, default is "Polygon". The spline is a cardinal spline. Bezier splines are not yet supported.

void vtkLassoStencilSource::SetShapeToPolygon ( )
inline

The shape to use, default is "Polygon". The spline is a cardinal spline. Bezier splines are not yet supported.

Definition at line 61 of file vtkLassoStencilSource.h.

void vtkLassoStencilSource::SetShapeToSpline ( )
inline

The shape to use, default is "Polygon". The spline is a cardinal spline. Bezier splines are not yet supported.

Definition at line 62 of file vtkLassoStencilSource.h.

virtual const char* vtkLassoStencilSource::GetShapeAsString ( )
virtual

The shape to use, default is "Polygon". The spline is a cardinal spline. Bezier splines are not yet supported.

virtual void vtkLassoStencilSource::SetPoints ( vtkPoints *  points)
virtual

The points that make up the lassoo. The loop does not have to be closed, the last point will automatically be connected to the first point by a straight line segment.

virtual vtkPoints* vtkLassoStencilSource::GetPoints ( )
virtual

The points that make up the lassoo. The loop does not have to be closed, the last point will automatically be connected to the first point by a straight line segment.

virtual int vtkLassoStencilSource::GetSliceOrientation ( )
virtual

The slice orientation. The default is 2, which is XY. Other values are 0, which is YZ, and 1, which is XZ.

virtual void vtkLassoStencilSource::SetSliceOrientation ( int  )
virtual

The slice orientation. The default is 2, which is XY. Other values are 0, which is YZ, and 1, which is XZ.

virtual void vtkLassoStencilSource::SetSlicePoints ( int  i,
vtkPoints *  points 
)
virtual

The points for a particular slice. This will override the points that were set by calling SetPoints() for the slice. To clear the setting, call SetSlicePoints(slice, NULL).

virtual vtkPoints* vtkLassoStencilSource::GetSlicePoints ( int  i)
virtual

The points for a particular slice. This will override the points that were set by calling SetPoints() for the slice. To clear the setting, call SetSlicePoints(slice, NULL).

virtual void vtkLassoStencilSource::RemoveAllSlicePoints ( )
virtual

Remove points from all slices.

unsigned long vtkLassoStencilSource::GetMTime ( )

Overload GetMTime() to include the timestamp on the points.

virtual int vtkLassoStencilSource::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Reimplemented from vtkImageStencilAlgorithm.

Member Data Documentation

int vtkLassoStencilSource::Shape
protected

Definition at line 102 of file vtkLassoStencilSource.h.

int vtkLassoStencilSource::SliceOrientation
protected

Definition at line 103 of file vtkLassoStencilSource.h.

vtkPoints* vtkLassoStencilSource::Points
protected

Definition at line 104 of file vtkLassoStencilSource.h.

vtkSpline* vtkLassoStencilSource::SplineX
protected

Definition at line 105 of file vtkLassoStencilSource.h.

vtkSpline* vtkLassoStencilSource::SplineY
protected

Definition at line 106 of file vtkLassoStencilSource.h.

vtkLSSPointMap* vtkLassoStencilSource::PointMap
protected

Definition at line 107 of file vtkLassoStencilSource.h.


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