Histogram

Introduction

A distribution created by collecting observation values—optionally weighted—on either a voxel or particle basis and sorting them into bins defined by a start range, end range, and number of bins.

Property Grid

General

Bin Range Start

Start value for histogram bin range.

Bin Range End

End value for histogram bin range.

Number of Bins

Number of histogram bins.

Observation Type

Iterate over this value at runtime.

Voxel

Particle

Histogram UDF

user-defined units | This UDF defines the observation value and any associated weighing function associated with the observation. One output must be defined within the UDF: a floating-point variable named value. These output values are the observations that are sorted into histogram bins, defined by the Bin Range Start, Bin Range End, and Number of Bins.

Histogram observations may be computed either on a particle-by-particle basis or a voxel-by-voxel basis, as determined by the observation type. When the observation type is Voxel, the local UDF is calculated on a voxel-by-voxel basis using the local fluid properties. The number of observations populating the histogram will be related to the lattice size. When the observation type is Particle, the local UDF is calculated on a particle-by-particle basis using the local particle properties. The number of observations populating the histogram will be related to the particle count of the corresponding particle selection.

One optional second floating point variable named weight can also be defined within the UDF. This variable defines the weight associated with each observation. If no value is specified, the weight will default to 1, implying each observation has the same weight/influence on the distribution. The output value weight is unitless. This is either a particle-based or a voxel-based local UDF.

Download Sample File: Histogram

Units

Optional units to add to file output.

Histogram Toolbar

Context-Specific Toolbar Forms	Description
Help	The Help command launches the M-Star reference documentation in your web browser.

For a full description of each selection on the Context-Specific Toolbar, see Toolbar Selections.