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
vtkMaskPoints Class Reference

selectively filter points More...

#include <vtkMaskPoints.h>

Inheritance diagram for vtkMaskPoints:
[legend]

Public Types

typedef vtkPolyDataAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkMaskPointsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetOnRatio (int)
 
virtual int GetOnRatio ()
 
virtual void SetMaximumNumberOfPoints (vtkIdType)
 
virtual vtkIdType GetMaximumNumberOfPoints ()
 
virtual void SetOffset (vtkIdType)
 
virtual vtkIdType GetOffset ()
 
virtual void SetRandomMode (int)
 
virtual int GetRandomMode ()
 
virtual void RandomModeOn ()
 
virtual void RandomModeOff ()
 
virtual void SetRandomModeType (int)
 
virtual int GetRandomModeType ()
 
virtual void SetProportionalMaximumNumberOfPoints (int)
 
virtual int GetProportionalMaximumNumberOfPoints ()
 
virtual void ProportionalMaximumNumberOfPointsOn ()
 
virtual void ProportionalMaximumNumberOfPointsOff ()
 
virtual void SetGenerateVertices (int)
 
virtual int GetGenerateVertices ()
 
virtual void GenerateVerticesOn ()
 
virtual void GenerateVerticesOff ()
 
virtual void SetSingleVertexPerCell (int)
 
virtual int GetSingleVertexPerCell ()
 
virtual void SingleVertexPerCellOn ()
 
virtual void SingleVertexPerCellOff ()
 

Static Public Member Functions

static vtkMaskPointsNew ()
 
static int IsTypeOf (const char *type)
 
static vtkMaskPointsSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkMaskPoints ()
 
 ~vtkMaskPoints ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual void InternalScatter (unsigned long *, unsigned long *, int, int)
 
virtual void InternalGather (unsigned long *, unsigned long *, int, int)
 
virtual int InternalGetNumberOfProcesses ()
 
virtual int InternalGetLocalProcessId ()
 
virtual void InternalBarrier ()
 
unsigned long GetLocalSampleSize (vtkIdType, int)
 

Protected Attributes

int OnRatio
 
vtkIdType Offset
 
int RandomMode
 
vtkIdType MaximumNumberOfPoints
 
int GenerateVertices
 
int SingleVertexPerCell
 
int RandomModeType
 
int ProportionalMaximumNumberOfPoints
 

Detailed Description

selectively filter points

vtkMaskPoints is a filter that passes through points and point attributes from input dataset. (Other geometry is not passed through.) It is possible to mask every nth point, and to specify an initial offset to begin masking from. It is possible to also generate different random selections (jittered strides, real random samples, and spatially stratified random samples) from the input data. The filter can also generate vertices (topological primitives) as well as points. This is useful because vertices are rendered while points are not.

Examples:
vtkMaskPoints (Examples)
Tests:
vtkMaskPoints (Tests)

Definition at line 42 of file vtkMaskPoints.h.

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkMaskPoints::Superclass

Definition at line 46 of file vtkMaskPoints.h.

Constructor & Destructor Documentation

vtkMaskPoints::vtkMaskPoints ( )
protected
vtkMaskPoints::~vtkMaskPoints ( )
inlineprotected

Definition at line 133 of file vtkMaskPoints.h.

Member Function Documentation

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

Reimplemented in vtkPMaskPoints.

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

Reimplemented in vtkPMaskPoints.

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

Turn on every nth point (strided sampling), ignored by random modes.

virtual int vtkMaskPoints::GetOnRatio ( )
virtual

Turn on every nth point (strided sampling), ignored by random modes.

virtual void vtkMaskPoints::SetMaximumNumberOfPoints ( vtkIdType  )
virtual

Limit the number of points that can be passed through (i.e., sets the output sample size).

virtual vtkIdType vtkMaskPoints::GetMaximumNumberOfPoints ( )
virtual

Limit the number of points that can be passed through (i.e., sets the output sample size).

virtual void vtkMaskPoints::SetOffset ( vtkIdType  )
virtual

Start sampling with this point. Ignored by certain random modes.

virtual vtkIdType vtkMaskPoints::GetOffset ( )
virtual

Start sampling with this point. Ignored by certain random modes.

virtual void vtkMaskPoints::SetRandomMode ( int  )
virtual

Special flag causes randomization of point selection.

virtual int vtkMaskPoints::GetRandomMode ( )
virtual

Special flag causes randomization of point selection.

virtual void vtkMaskPoints::RandomModeOn ( )
virtual

Special flag causes randomization of point selection.

virtual void vtkMaskPoints::RandomModeOff ( )
virtual

Special flag causes randomization of point selection.

virtual void vtkMaskPoints::SetRandomModeType ( int  )
virtual

Special mode selector that switches between random mode types. 0 - randomized strides: randomly strides through the data (default); fairly certain that this is not a statistically random sample because the output depends on the order of the input and the input points do not have an equal chance to appear in the output (plus Vitter's incremental random algorithms are more complex than this, while not a proof it is good indication this isn't a statistically random sample

  • the closest would be algorithm S) 1 - random sample: create a statistically random sample using Vitter's incremental algorithm D without A described in Vitter "Faster Mthods for Random Sampling", Communications of the ACM Volume 27, Issue 7, 1984 (OnRatio and Offset are ignored) O(sample size) 2 - spatially stratified random sample: create a spatially stratified random sample using the first method described in Woodring et al. "In-situ Sampling of a Large-Scale Particle Simulation for Interactive Visualization and Analysis", Computer Graphics Forum, 2011 (EuroVis 2011). (OnRatio and Offset are ignored) O(N log N)
virtual int vtkMaskPoints::GetRandomModeType ( )
virtual

Special mode selector that switches between random mode types. 0 - randomized strides: randomly strides through the data (default); fairly certain that this is not a statistically random sample because the output depends on the order of the input and the input points do not have an equal chance to appear in the output (plus Vitter's incremental random algorithms are more complex than this, while not a proof it is good indication this isn't a statistically random sample

  • the closest would be algorithm S) 1 - random sample: create a statistically random sample using Vitter's incremental algorithm D without A described in Vitter "Faster Mthods for Random Sampling", Communications of the ACM Volume 27, Issue 7, 1984 (OnRatio and Offset are ignored) O(sample size) 2 - spatially stratified random sample: create a spatially stratified random sample using the first method described in Woodring et al. "In-situ Sampling of a Large-Scale Particle Simulation for Interactive Visualization and Analysis", Computer Graphics Forum, 2011 (EuroVis 2011). (OnRatio and Offset are ignored) O(N log N)
virtual void vtkMaskPoints::SetProportionalMaximumNumberOfPoints ( int  )
virtual

THIS ONLY WORKS WITH THE PARALLEL IMPLEMENTATION vtkPMaskPoints RUNNING IN PARALLEL. NOTHING WILL CHANGE IF THIS IS NOT THE PARALLEL vtkPMaskPoints. Determines whether maximum number of points is taken per processor (default) or if the maximum number of points is proportionally taken across processors (i.e., number of points per processor = points on a processor * maximum number of points / total points across all processors). In the first case, the total number of points = maximum number of points * number of processors. In the second case, the total number of points = maximum number of points.

virtual int vtkMaskPoints::GetProportionalMaximumNumberOfPoints ( )
virtual

THIS ONLY WORKS WITH THE PARALLEL IMPLEMENTATION vtkPMaskPoints RUNNING IN PARALLEL. NOTHING WILL CHANGE IF THIS IS NOT THE PARALLEL vtkPMaskPoints. Determines whether maximum number of points is taken per processor (default) or if the maximum number of points is proportionally taken across processors (i.e., number of points per processor = points on a processor * maximum number of points / total points across all processors). In the first case, the total number of points = maximum number of points * number of processors. In the second case, the total number of points = maximum number of points.

virtual void vtkMaskPoints::ProportionalMaximumNumberOfPointsOn ( )
virtual

THIS ONLY WORKS WITH THE PARALLEL IMPLEMENTATION vtkPMaskPoints RUNNING IN PARALLEL. NOTHING WILL CHANGE IF THIS IS NOT THE PARALLEL vtkPMaskPoints. Determines whether maximum number of points is taken per processor (default) or if the maximum number of points is proportionally taken across processors (i.e., number of points per processor = points on a processor * maximum number of points / total points across all processors). In the first case, the total number of points = maximum number of points * number of processors. In the second case, the total number of points = maximum number of points.

virtual void vtkMaskPoints::ProportionalMaximumNumberOfPointsOff ( )
virtual

THIS ONLY WORKS WITH THE PARALLEL IMPLEMENTATION vtkPMaskPoints RUNNING IN PARALLEL. NOTHING WILL CHANGE IF THIS IS NOT THE PARALLEL vtkPMaskPoints. Determines whether maximum number of points is taken per processor (default) or if the maximum number of points is proportionally taken across processors (i.e., number of points per processor = points on a processor * maximum number of points / total points across all processors). In the first case, the total number of points = maximum number of points * number of processors. In the second case, the total number of points = maximum number of points.

virtual void vtkMaskPoints::SetGenerateVertices ( int  )
virtual

Generate output polydata vertices as well as points. A useful convenience method because vertices are drawn (they are topology) while points are not (they are geometry). By default this method is off.

virtual int vtkMaskPoints::GetGenerateVertices ( )
virtual

Generate output polydata vertices as well as points. A useful convenience method because vertices are drawn (they are topology) while points are not (they are geometry). By default this method is off.

virtual void vtkMaskPoints::GenerateVerticesOn ( )
virtual

Generate output polydata vertices as well as points. A useful convenience method because vertices are drawn (they are topology) while points are not (they are geometry). By default this method is off.

virtual void vtkMaskPoints::GenerateVerticesOff ( )
virtual

Generate output polydata vertices as well as points. A useful convenience method because vertices are drawn (they are topology) while points are not (they are geometry). By default this method is off.

virtual void vtkMaskPoints::SetSingleVertexPerCell ( int  )
virtual

When vertex generation is enabled, by default vertices are produced as multi-vertex cells (more than one per cell), if you wish to have a single vertex per cell, enable this flag.

virtual int vtkMaskPoints::GetSingleVertexPerCell ( )
virtual

When vertex generation is enabled, by default vertices are produced as multi-vertex cells (more than one per cell), if you wish to have a single vertex per cell, enable this flag.

virtual void vtkMaskPoints::SingleVertexPerCellOn ( )
virtual

When vertex generation is enabled, by default vertices are produced as multi-vertex cells (more than one per cell), if you wish to have a single vertex per cell, enable this flag.

virtual void vtkMaskPoints::SingleVertexPerCellOff ( )
virtual

When vertex generation is enabled, by default vertices are produced as multi-vertex cells (more than one per cell), if you wish to have a single vertex per cell, enable this flag.

virtual int vtkMaskPoints::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
virtual int vtkMaskPoints::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual
virtual void vtkMaskPoints::InternalScatter ( unsigned long *  ,
unsigned long *  ,
int  ,
int   
)
inlineprotectedvirtual

Reimplemented in vtkPMaskPoints.

Definition at line 148 of file vtkMaskPoints.h.

virtual void vtkMaskPoints::InternalGather ( unsigned long *  ,
unsigned long *  ,
int  ,
int   
)
inlineprotectedvirtual

Reimplemented in vtkPMaskPoints.

Definition at line 149 of file vtkMaskPoints.h.

virtual int vtkMaskPoints::InternalGetNumberOfProcesses ( )
inlineprotectedvirtual

Reimplemented in vtkPMaskPoints.

Definition at line 150 of file vtkMaskPoints.h.

virtual int vtkMaskPoints::InternalGetLocalProcessId ( )
inlineprotectedvirtual

Reimplemented in vtkPMaskPoints.

Definition at line 151 of file vtkMaskPoints.h.

virtual void vtkMaskPoints::InternalBarrier ( )
inlineprotectedvirtual

Reimplemented in vtkPMaskPoints.

Definition at line 152 of file vtkMaskPoints.h.

unsigned long vtkMaskPoints::GetLocalSampleSize ( vtkIdType  ,
int   
)
protected

Member Data Documentation

int vtkMaskPoints::OnRatio
protected

Definition at line 139 of file vtkMaskPoints.h.

vtkIdType vtkMaskPoints::Offset
protected

Definition at line 140 of file vtkMaskPoints.h.

int vtkMaskPoints::RandomMode
protected

Definition at line 141 of file vtkMaskPoints.h.

vtkIdType vtkMaskPoints::MaximumNumberOfPoints
protected

Definition at line 142 of file vtkMaskPoints.h.

int vtkMaskPoints::GenerateVertices
protected

Definition at line 143 of file vtkMaskPoints.h.

int vtkMaskPoints::SingleVertexPerCell
protected

Definition at line 144 of file vtkMaskPoints.h.

int vtkMaskPoints::RandomModeType
protected

Definition at line 145 of file vtkMaskPoints.h.

int vtkMaskPoints::ProportionalMaximumNumberOfPoints
protected

Definition at line 146 of file vtkMaskPoints.h.


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