Helper class to work with moment parameters. (cmomy.core.moment_params)#

Data:

MomParamsType

Moment parameter input types

Classes:

MomParamsDict

Input dict for moment parameters.

MomParams([ndim, axes, dims])

Dataclass for moment parameters input

MomParamsBase(ndim)

Base class for moment parameters.

MomParamsArrayOptional(ndim, axes)

Array moment parameters.

MomParamsArray(ndim, axes)

Array Mom Params

MomParamsXArrayOptional(ndim, dims)

Optional moment parameters for xarray objects.

MomParamsXArray(ndim, dims)

Moment parameters for xarray objects

Functions:

factory_mom_params(target, *[, mom_params, ...])

Factory method to create mom_params.

cmomy.core.moment_params.MomParamsType = 'MomParams | MomParamsBase | MomParamsDict | None'#

Moment parameter input types

class cmomy.core.moment_params.MomParamsDict[source]#

Input dict for moment parameters.

Attributes:

ndim

Number of moment dimensions

axes

Moment axes

dims

Moment dimensions

ndim#

Number of moment dimensions

axes#

Moment axes

dims#

Moment dimensions

class cmomy.core.moment_params.MomParams(ndim=None, axes=None, dims=None)[source]#

Dataclass for moment parameters input

Attributes:

ndim

Number of moment dimensions

axes

Moment axes

dims

Moment dimensions

ndim = None#

Number of moment dimensions

axes = None#

Moment axes

dims = None#

Moment dimensions

class cmomy.core.moment_params.MomParamsBase(ndim)[source]#

Base class for moment parameters.

Methods:

normalize_axis_index(axis, data_ndim[, ...])

Normalize axis relative to self.ndim

normalize_axis_tuple(axis, data_ndim[, ...])

Normalize axis tuple relative to self.ndim.

normalize_axis_index(axis, data_ndim, msg_prefix=None)[source]#

Normalize axis relative to self.ndim

normalize_axis_tuple(axis, data_ndim, msg_prefix=None, allow_duplicate=False)[source]#

Normalize axis tuple relative to self.ndim.

class cmomy.core.moment_params.MomParamsArrayOptional(ndim, axes)[source]#

Array moment parameters.

Methods:

factory([mom_params, ndim, axes, default_ndim])

Factory method.

from_params([ndim, axes, default_ndim, dims])

Create from parameters.

raise_if_in_mom_axes(*axes)

Raise ValueError if any axes in self.axes.

get_mom_shape(data)

Calculate moment shape from data shape

axes_to_end()

Create new object with self.axes at end.

normalize_axes(data_ndim)

Normalize self.axes in new object relative to data_ndim.

maybe_reorder_dataarray(x)

Reorder DataArray mom_axes_last to mom_axes.

classmethod factory(mom_params=None, ndim=None, axes=None, default_ndim=None)[source]#

Factory method.

Parameters:
  • mom_params (MomParams | MomParamsBase | MomParamsDict | None, default: None) – Moment parameters. You can set moment parameters axes and dims using this option. For example, passing mom_params={"dim": ("a", "b")} is equivalent to passing mom_dims=("a", "b"). You can also pass as a MomParams object with mom_params=cmomy.MomParams(dims=("a", "b")).

  • ndim (int | None, default: None) – Number of moment dimensions.

  • axes (int | Sequence[int] | None, default: None) – Axes/Axis for moment dimension(s) (equivalent to mom_ndim).

  • default_ndim (MomNDim | None, default: None) – Fallback value for ndim.

classmethod from_params(ndim=None, axes=None, default_ndim=None, dims=None)[source]#

Create from parameters.

raise_if_in_mom_axes(*axes)[source]#

Raise ValueError if any axes in self.axes.

get_mom_shape(data)[source]#

Calculate moment shape from data shape

Overrides:

MomParamsBase.get_mom_shape

axes_to_end()[source]#

Create new object with self.axes at end.

Overrides:

MomParamsBase.axes_to_end

normalize_axes(data_ndim)[source]#

Normalize self.axes in new object relative to data_ndim.

maybe_reorder_dataarray(x)[source]#

Reorder DataArray mom_axes_last to mom_axes.

class cmomy.core.moment_params.MomParamsArray(ndim, axes)[source]#

Array Mom Params

Methods:

factory_mom(mom[, mom_params, axes, ...])

Factory method to validate mom and create mom_params object.

axes_data_reduction(*inner, axis[, out_has_axis])

Axes for reducing data along axis

classmethod factory_mom(mom, mom_params=None, axes=None, default_ndim=None)[source]#

Factory method to validate mom and create mom_params object.

Parameters:
  • mom (int | Sequence[int]) – Order or moments. If integer or length one tuple, then moments are for a single variable. If length 2 tuple, then comoments of two variables

  • mom_params (MomParams | MomParamsBase | MomParamsDict | None, default: None) – Moment parameters. You can set moment parameters axes and dims using this option. For example, passing mom_params={"dim": ("a", "b")} is equivalent to passing mom_dims=("a", "b"). You can also pass as a MomParams object with mom_params=cmomy.MomParams(dims=("a", "b")).

  • axes (int | Sequence[int] | None, default: None) – Axes/Axis for moment dimension(s) (equivalent to mom_ndim).

  • default_ndim (MomNDim | None, default: None) – Fallback value for ndim.

axes_data_reduction(*inner, axis, out_has_axis=False)[source]#

Axes for reducing data along axis

if out_has_axis == True, then treat like resample, so output will still have axis with new size in output.

It is assumed that axis is validated against a moments array, (i.e., negative values should be < -mom_ndim)

Can also pass in “inner” dimensions (elements 1:-1 of output)

class cmomy.core.moment_params.MomParamsXArrayOptional(ndim, dims)[source]#

Optional moment parameters for xarray objects.

Methods:

factory([mom_params, ndim, dims, axes, ...])

Factory create object

from_params([ndim, dims, axes, data, ...])

Create from parameters.

axes_to_end()

Create new object with self.axes at end.

get_axes([data])

Moment axes.

get_mom_shape(data)

Calculate moment shape from data shape

classmethod factory(mom_params=None, ndim=None, dims=None, axes=None, data=None, default_ndim=None)[source]#

Factory create object

Parameters:
  • mom_params (MomParams | MomParamsBase | MomParamsDict | None, default: None) – Moment parameters. You can set moment parameters axes and dims using this option. For example, passing mom_params={"dim": ("a", "b")} is equivalent to passing mom_dims=("a", "b"). You can also pass as a MomParams object with mom_params=cmomy.MomParams(dims=("a", "b")).

  • ndim (int | None, default: None) – Number of moment dimensions.

  • dims (Hashable | Sequence[Hashable] | None, default: None) – Name of moment dimensions for xarray objects (equivalent to mom_dims).

  • axes (int | Sequence[int] | None, default: None) – Axes/Axis for moment dimension(s) (equivalent to mom_ndim).

  • data (object, default: None) – Moment collection array

  • default_ndim (MomNDim | None, default: None) – Fallback value for ndim.

classmethod from_params(ndim=None, dims=None, axes=None, data=None, default_ndim=None)[source]#

Create from parameters.

axes_to_end()[source]#

Create new object with self.axes at end.

Overrides:

MomParamsBase.axes_to_end

get_axes(data=None)[source]#

Moment axes.

If pass data, return data.get_axis_num(self.dims). Otherwise, return self.axes_last.

get_mom_shape(data)[source]#

Calculate moment shape from data shape

Overrides:

MomParamsBase.get_mom_shape

class cmomy.core.moment_params.MomParamsXArray(ndim, dims)[source]#

Moment parameters for xarray objects

Methods:

to_array([data])

Convert to MomParamsArray object.

core_dims(*dims)

Core dimensions.

to_array(data=None)[source]#

Convert to MomParamsArray object.

Axes is self.get_axes(data).

core_dims(*dims)[source]#

Core dimensions.

cmomy.core.moment_params.factory_mom_params(target, *, mom_params=None, ndim=None, axes=None, dims=None, data=None, default_ndim=None)[source]#

Factory method to create mom_params.

Overloads:
Parameters:
  • target (object | DataArray | Dataset) – Return object corresponding to data type of target.

  • mom_params (MomParams | MomParamsBase | MomParamsDict | None, default: None) – Moment parameters. You can set moment parameters axes and dims using this option. For example, passing mom_params={"dim": ("a", "b")} is equivalent to passing mom_dims=("a", "b"). You can also pass as a MomParams object with mom_params=cmomy.MomParams(dims=("a", "b")).

  • ndim (int | None, default: None) – Number of moment dimensions.

  • axes (int | Sequence[int] | None, default: None) – Axes/Axis for moment dimension(s) (equivalent to mom_ndim).

  • dims (Hashable | Sequence[Hashable] | None, default: None) – Name of moment dimensions for xarray objects (equivalent to mom_dims).

  • data (object, default: None) – Optional data to use as template to extract ndim using axes or ndim.

  • default_ndim (MomNDim | None, default: None) – Fallback value for ndim.

Returns:

MomParamsArray or MomParamsXArray – Moment parameters object.