paraview.simple.Threshold

paraview.simple.Threshold(*input, **params)

The Threshold filter extracts the portions of the input dataset whose scalars lie within the specified range. This filter operates on either point-centered or cell-centered data. It operates on any type of dataset and produces unstructured grid output. The scalar array from which to threshold the data can be selected in the ‘Scalars’ menu. For a multi-components array, ‘Selected Component’ menu allows you to select a specific component or magnitude if using the ‘Selected’ component mode. You can also choose ‘All’ or ‘Any’ that will keep data if either all components or at least one satisfies the threshold. Note that multi-components arrays are not available with Hyper Tree Grid inputs. The ‘Lower Threshold’ and ‘Upper Threshold’ sliders determine the range of the scalars to retain in the output. The threshold method can be selected from the ‘Threshold Method’ menu. The ‘All Scalars’ option only applies to Point Data. When this option is on, a cell will only be passed to the output if the scalar values of all of its points lie within the chosen range. When off, a cell will be added to the output if the specified scalar value for any of its points is within the chosen range.

Data Descriptors

AllScalars

If the value of this property is 1, then a cell is only included in the output if the value of the selected array for all its points is within the threshold. This is only relevant when thresholding by a point-centered array.

ComponentMode

This property specifies how multi-component arrays are handled. ‘Selected’ will use the ‘Selected Component’ property. ‘All’ will pass if all components satisfy the rule. ‘Any’ will pass if any component satisfies the rule.

Input

This property specifies the input to the Threshold filter.

Invert

Invert the threshold results. That is, cells that would have been in the output with this option off are excluded, while cells that would have been excluded from the output are included.

LowerThreshold

The value of this property specifies the lower bound of the thresholding operation.

MemoryStrategy

Select how to construct the result in memory: - MaskInput (default): shallow copy the input and mask all cells being thresholded - Regenerate Trees And Index Fields: generate a new tree structure but use indexed arrays on the input for cell data - New HyperTreeGrid: construct a new HyperTreeGrid from scratch representing the minimal threshold of the input

Scalars

The value of this property contains the name of the array from which to perform thresholding. Be aware that HTG does not support multi-component arrays.

SelectedComponent

This property specifies which component of the array needs to satisfy the rule.

ThresholdMethod

This property indicates the threshold method.

UpperThreshold

The value of this property specifies the upper bound of the thresholding operation.

UseContinuousCellRange

If off, the vertex scalars are treated as a discrete set. If on, they are treated as a continuous interval over the minimum and maximum. One important “on” use case: When setting lower and upper threshold equal to some value and turning AllScalars off, the results are cells containing the isosurface for that value. WARNING: Whether on or off, for higher order input, the filter will not give accurate results.

Data Descriptors inherited from Proxy

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

Methods

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

Methods inherited from SourceProxy

FileNameChanged(self)

Called when the filename of a source proxy is changed.

GetCellDataInformation(self)

Returns the associated cell data information.

GetDataInformation(self, idx=None)

This method returns a DataInformation wrapper around a vtkPVDataInformation

GetFieldDataInformation(self)

Returns the associated cell data information.

GetPointDataInformation(self)

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.

UpdatePipelineInformation(self)

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.

ListProperties(self)

Returns a list of all property names on this proxy.

SetPropertyWithName(self, pname, arg)

Generic method for setting the value of a property.

__del__(self)

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

__hash__(self)

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.

__iter__(self)

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