paraview.simple.MaskPoints(*input, **params)
The Mask Points
filter reduces the number of points in the dataset. It operates on any type of dataset, but produces only points / vertices as output.

Data Descriptors

This property specifies whether to generate vertex cells as the topography of the output. If set to 1, the geometry (vertices) will be displayed in the rendering window; otherwise no geometry will be displayed.
This property specifies the input to the Mask Points filter.
The value of this property indicates the maximum number of points in the output dataset.
The value of this property indicates the starting point id in the ordered list of input points from which to start masking.
The value of this property specifies that every OnStride-th points will be retained in the output when not using Random (the skip or stride size for point ids). (For example, if the on ratio is 3, then the output will contain every 3rd point, up to the the maximum number of points.)

When this is off, the maximum number of points is taken per processor when running in parallel (total number of points = number of processors * maximum number of points). When this is on, the maximum number of points is proportionally distributed across processors depending on the number of points per processor (“total number of points” is the same as “maximum number of points”

maximum number of points per processor = number of points on a processor * maximum number of points / total number of points across all processors


If the value of this property is set to true, then the points in the output will be randomly selected from the input in various ways set by Random Mode; otherwise this filter will subsample point ids regularly.
Randomized Id Strides picks points with random id increments starting at Offset (the output probably isn’t a statistically random sample). Random Sampling generates a statistically random sample of the input, ignoring Offset (fast - O(sample size)). Spatially Stratified Random Sampling is a variant of random sampling that splits the points into equal sized spatial strata before randomly sampling (slow - O(N log N)).
Tell filter to only generate one vertex per cell instead of multiple vertices in one cell.

Data Descriptors inherited from SourceProxy

Returns cell data information
Returns field data information
Returns point data information

Data Descriptors inherited from Proxy

dictionary for instance variables (if defined)
list of weak references to the object (if defined)


Initialize = aInitialize(self, connection=None, update=True)

Methods inherited from SourceProxy

Called when the filename of a source proxy is changed.
Returns the associated cell data information.
GetDataInformation(self, idx=None)
This method returns a DataInformation wrapper around a vtkPVDataInformation
Returns the associated cell data information.
Returns the associated point data information.
UpdatePipeline(self, time=None)
This method updates the server-side VTK pipeline and the associated data information. Make sure to update a source to validate the output meta-data.
This method updates the meta-data of the server-side VTK pipeline and the associated information properties
__getitem__(self, idx)
Given a slice, int or string, returns the corresponding output port

Methods inherited from Proxy

GetProperty(self, name)
Given a property name, returns the property object.
GetPropertyValue(self, name)
Returns a scalar for properties with 1 elements, the property itself for vectors.
InitializeFromProxy(self, aProxy, update=True)
Constructor. Assigns proxy to self.SMProxy, updates the server object as well as register the proxy in _pyproxies dictionary.
Returns a list of all property names on this proxy.
SetPropertyWithName(self, pname, arg)
Generic method for setting the value of a property.
Destructor. Cleans up all observers as well as remove the proxy from the _pyproxies dictionary
__eq__(self, other)
Returns true if the underlying SMProxies are the same.
__getattr__(self, name)
With the exception of a few overloaded methods, returns the SMProxy method
Return hash(self).
__init__(self, **args)
Default constructor. It can be used to initialize properties by passing keyword arguments where the key is the name of the property. In addition registrationGroup and registrationName (optional) can be specified (as keyword arguments) to automatically register the proxy with the proxy manager.
Creates an iterator for the properties.
__ne__(self, other)
Returns false if the underlying SMProxies are the same.
__setattr__(self, name, value)
Implement setattr(self, name, value).

add_attribute(self, name, value)

For the full list of servermanager proxies, please refer to Available readers, sources, writers, filters and animation cues