active_scalars_algorithm

active_scalars_algorithm(

inp,

name: str,

preference: PointLiteral | CellLiteral = 'point',

) → ActiveScalarsAlgorithm

Add a filter that sets the active scalars.

Parameters:

inppyvista.DataSet | vtkAlgorithm

Input data or algorithm.

namestr

Name of the scalars to set as active.

preferencestr, default: ‘point’

Either 'point' or 'cell'. Determines the field association when the same array name exists on both.

Returns:

ActiveScalarsAlgorithm

Active scalars filter applied to the input data.