Helper class to work with moment parameters. (cmomy.core.moment_params)#
Data:
Moment parameter input types |
Classes:
Input dict for moment parameters. |
|
|
Dataclass for moment parameters input |
|
Base class for moment parameters. |
|
Array moment parameters. |
|
Array Mom Params |
|
Optional moment parameters for xarray objects. |
|
Moment parameters for xarray objects |
Functions:
|
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
- class cmomy.core.moment_params.MomParams(ndim=None, axes=None, dims=None)[source]#
Dataclass for moment parameters input
Attributes:
- 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.ndimnormalize_axis_tuple(axis, data_ndim[, ...])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
ValueErrorif anyaxesinself.axes.get_mom_shape(data)Calculate moment shape from data shape
Create new object with
self.axesat end.normalize_axes(data_ndim)Normalize self.axes in new object relative to
data_ndim.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 parametersaxesanddimsusing this option. For example, passingmom_params={"dim": ("a", "b")}is equivalent to passingmom_dims=("a", "b"). You can also pass as aMomParamsobject withmom_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 tomom_ndim).default_ndim (MomNDim | None, default:
None) – Fallback value forndim.
- classmethod from_params(ndim=None, axes=None, default_ndim=None, dims=None)[source]#
Create from parameters.
- get_mom_shape(data)[source]#
Calculate moment shape from data shape
- Overrides:
MomParamsBase.get_mom_shape
- class cmomy.core.moment_params.MomParamsArray(ndim, axes)[source]#
Array Mom Params
Methods:
factory_mom(mom[, mom_params, axes, ...])Factory method to validate
momand createmom_paramsobject.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
momand createmom_paramsobject.- 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 variablesmom_params (
MomParams|MomParamsBase|MomParamsDict|None, default:None) – Moment parameters. You can set moment parametersaxesanddimsusing this option. For example, passingmom_params={"dim": ("a", "b")}is equivalent to passingmom_dims=("a", "b"). You can also pass as aMomParamsobject withmom_params=cmomy.MomParams(dims=("a", "b")).axes (
int|Sequence[int] |None, default:None) – Axes/Axis for moment dimension(s) (equivalent tomom_ndim).default_ndim (MomNDim | None, default:
None) – Fallback value forndim.
- 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 haveaxiswith 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.
Create new object with
self.axesat 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 parametersaxesanddimsusing this option. For example, passingmom_params={"dim": ("a", "b")}is equivalent to passingmom_dims=("a", "b"). You can also pass as aMomParamsobject withmom_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 forxarrayobjects (equivalent tomom_dims).axes (
int|Sequence[int] |None, default:None) – Axes/Axis for moment dimension(s) (equivalent tomom_ndim).data (
object, default:None) – Moment collection arraydefault_ndim (MomNDim | None, default:
None) – Fallback value forndim.
- 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.axesat end.- Overrides:
MomParamsBase.axes_to_end
- class cmomy.core.moment_params.MomParamsXArray(ndim, dims)[source]#
Moment parameters for xarray objects
Methods:
- 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:
target (
DataArray|Dataset), *, mom_params (MomParams|MomParamsBase|MomParamsDict|None) =..., ndim (int|None) =..., axes (int|Sequence[int] |None) =..., dims (Hashable|Sequence[Hashable] |None) =..., data (object) =..., default_ndim (MomNDim | None) =...→MomParamsXArraytarget (
object), *, mom_params (MomParams|MomParamsBase|MomParamsDict|None) =..., ndim (int|None) =..., axes (int|Sequence[int] |None) =..., dims (Hashable|Sequence[Hashable] |None) =..., data (object) =..., default_ndim (MomNDim | None) =...→MomParamsArray
- Parameters:
target (
object|DataArray|Dataset) – Return object corresponding to data type oftarget.mom_params (
MomParams|MomParamsBase|MomParamsDict|None, default:None) – Moment parameters. You can set moment parametersaxesanddimsusing this option. For example, passingmom_params={"dim": ("a", "b")}is equivalent to passingmom_dims=("a", "b"). You can also pass as aMomParamsobject withmom_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 tomom_ndim).dims (
Hashable|Sequence[Hashable] |None, default:None) – Name of moment dimensions forxarrayobjects (equivalent tomom_dims).data (
object, default:None) – Optional data to use as template to extractndimusingaxesorndim.default_ndim (MomNDim | None, default:
None) – Fallback value forndim.
- Returns:
MomParamsArrayorMomParamsXArray– Moment parameters object.