FieldAnalysis

Evaluates a BooleanFieldFunction, ContinuousFieldFunction, or DiscreteFieldFunction and produces a visual result for display in an AnalysisOverlay. The visualization updates automatically when function parameters change. There is no need to call ContinuousFieldFunction.evaluate, DiscreteFieldFunction.evaluate, or BooleanFieldFunction.evaluate.

Since

300.0.0

Constructors

Link copied to clipboard
constructor(booleanFieldFunction: BooleanFieldFunction, colormapRenderer: ColormapRenderer)

Creates a FieldAnalysis with a BooleanFieldFunction and a ColormapRenderer. Regions in the function result that are true are rendered using the color associated with 1, if defined.

constructor(continuousFieldFunction: ContinuousFieldFunction, stretchRenderer: StretchRenderer)

Creates a FieldAnalysis with a ContinuousFieldFunction and a StretchRenderer. Only stretch renderers created with MinMaxStretchParameters are supported. The minimum and maximum values must be specified.

constructor(discreteFieldFunction: DiscreteFieldFunction, colormapRenderer: ColormapRenderer)

Creates a FieldAnalysis with a DiscreteFieldFunction and a ColormapRenderer. If the renderer is created with an empty or null colormap, the whole analysis is transparent.

Properties

Link copied to clipboard

The opacity for the FieldAnalysis. Opacity values range from 0.0 to 1.0, where 0.0 is fully transparent and 1.0 is fully opaque.

Inherited properties

Link copied to clipboard

Whether or not the analysis is visible. Visibility can be controlled for individual analyses as well as for the AnalysisOverlay that contains them. Returns false if an error occurs.