cuda_histogram.hist module

class cuda_histogram.hist.Hist(*axes, label=None, name=None)

Bases: object

Construct a new histogram.

Parameters:

  • *args (Axis) – Provide 1 or more axis instances.

  • label (str = None) – Histogram’s label

  • name (str = None) – Histogram’s name

DEFAULT_DTYPE = 'd'
axes()

Get all axes in this histogram

dense_dim()

Dense dimension of this histogram (number of non-sparse axes)

dim()

Dimension of this histogram (number of axes)

fill(*args, weight=None)

Insert data into the histogram.

Parameters:

  • *args (cupy.ndarray) – Provide one value or array per dimension.

  • weight (cupy.ndarray) – Provide weights.

property label

A label describing the meaning of the sum of weights

property name

A label describing the meaning of the sum of weights

sparse_axes()

All sparse axes

to_boost()

Convert this cuda_histogram object to a boost_histogram object.

underflow and overflow are set True and nanflow is lost in the conversion.

Appropriate boost-histogram axis and storage are automatically chosen. All the arguments of cuda-histogram’s axis and histogram are passed down.

to_hist()

Convert this cuda_histogram object to a hist object

values(flow=False)

Extract the values from this histogram.

Parameters:

flow (bool)

variance(flow=False)

Extract the variances from this histogram.

Parameters:

flow (bool)