Skip to content

Latest commit

 

History

History
233 lines (180 loc) · 2.96 KB

api.rst

File metadata and controls

233 lines (180 loc) · 2.96 KB

scipp

Classes

Bins DataArray Dataset GroupByDataArray GroupByDataset Unit Variable

Creation functions

array arange empty empty_like geomspace linspace logspace matrix matrices ones ones_like scalar vector vectors zeros zeros_like

Free functions

General

bin bins choose collapse histogram logical_and logical_or logical_xor merge rebin slices sort stddevs to_unit values variances

Math

abs add divide dot exp floor_divide log log10 mod multiply norm reciprocal sqrt subtract

Shape

broadcast concatenate flatten fold transpose

Comparison

Comparison operators compare element-wise and ignore variances.

less greater less_equal greater_equal equal not_equal isclose allclose identical islinspace issorted

inf and nan handling

Special-value (inf and nan) checks. inf and nan in the variances is ignored.

isnan isinf isfinite isposinf isneginf nan_to_num

Reduction

Reduction operations are operations to remove one or more dimension, e.g., by performing a sum over all elements along a dimension.

all any cumsum max mean min nanmax nanmean nanmin nansum sum

Trigonometric

sin cos tan asin acos atan atan2

Geometric

geometry.position geometry.rotation_matrix_from_quaternion_coeffs

Group-by (split-apply-combine)

Reduction

groupby

Counts

"Counts" refers to the default unit of data after histogramming. It is also known as frequency. This can be converted into a counts (frequency) density, e.g., for visualization purposes.

counts_to_density density_to_counts

Visualization

show table to_html plot

Compatibility

to_dict from_dict

Typing

typing.MetaDataMap typing.VariableLike