Top level API (cmomy)

Public api for cmomy

Central Moments wrapper classes

CentralMomentsArray(obj, *[, mom_ndim, ...])	Central moments wrapper of ndarray arrays.
CentralMomentsData(obj, *[, mom_ndim, ...])	Central moments wrapper of DataArray or Dataset objects.

Legacy wrapper classes

CentralMoments	alias of CentralMomentsArray
xCentralMoments	alias of CentralMomentsData

Factory methods to create wrapper objects

wrap(obj, *[, mom_ndim, mom_axes, mom_dims, ...])	Wrap object with central moments class.
wrap_reduce_vals(x, *y, mom[, weight, axis, ...])	Create wrapped object from values.
wrap_resample_vals(x, *y, mom, sampler[, ...])	Create wrapped object from resampled values.
wrap_raw(raw, *[, mom_ndim, mom_axes, ...])	Create object from raw moment data.
zeros_like(c, *[, dtype, order, subok, ...])	Create new wrapped object with zeros like given wrapped object.

Moment parameters

MomParams([ndim, axes, dims])	Dataclass for moment parameters input
MomParamsDict	Input dict for moment parameters.

Reduction routines available at top level (reduction)

reduce_data(data, *[, axis, dim, mom_ndim, ...])	Reduce central moments array along axis.
reduce_data_grouped(data, by, *[, axis, ...])	Reduce data by group.
reduce_data_indexed(data, *, index, ...[, ...])	Reduce data by index

Resampling routines available at top level (resample)

resample_data(data, *, sampler[, axis, dim, ...])	Resample and reduce data.
resample_vals(x, *y, sampler, mom[, axis, ...])	Resample and reduce values.
factory_sampler([sampler, freq, indices, ...])	Factory method to create sampler.
random_freq(nrep, ndat[, nsamp, rng, ...])	Create frequencies for random resampling (bootstrapping).
random_indices(nrep, ndat[, nsamp, rng, replace])	Create indices for random resampling (bootstrapping).

Default random number generator (cmomy.random)

default_rng([seed])

Get default internal random number generator.

Concatenation

concat(arrays, *[, axis, dim])

Concatenate moments objects.

Convert

convert.moments_type(values_in, *[, ...])	Convert between central and raw moments type.
convert.cumulative(values_in, *[, axis, ...])	Convert between moments array and cumulative moments array.

Confidence intervals (confidence_interval)

bootstrap_confidence_interval(theta_boot[, ...])

Create the bootstrap confidence interval.

Central moment array utilities (utils)

moveaxis(x[, axis, dest, dim, dest_dim, ...])	Generalized moveaxis for moments arrays.
select_moment(data, name, *[, mom_ndim, ...])	Select specific moments for a central moments array.
assign_moment(data[, moment, mom_ndim, ...])	Update weights of moments array.
vals_to_data(x, *y, mom[, weight, mom_dims, ...])	Convert values to central moments array.

Pre-loaded modules

random	Internal numpy.random.Generator (cmomy.random)
reduction	Routines to perform central moments reduction (reduction)
resample	Routine to perform resampling (cmomy.resample)
convert	Conversion routines (convert)
utils	Interface to utility functions (cmomy.utils)
rolling	Rolling and rolling exponential averages (rolling)