Typing aliases (cmomy.core.typing)

Data:

CentralMomentsDataArray	DataArray wrapper
CentralMomentsDataset	Dataset wrapper
CentralMomentsDataAny	DataArray or Dataset wrapper
CentralMomentsArrayAny	Any Array wrapper
IndexAny	Index

Classes:

CentralMomentsT	Generic wrapper TypeVar
CentralMomentsArrayT	Array wrapper TypeVar
CentralMomentsDataT	xarray object wrapper TypeVar
MomParamsT	Moment parameters TypeVar
GenArrayT	General data set/array
DataT	DataArray or Dataset
ArrayT	TypeVar of array types with restriction
SamplerArrayT	TypeVar of types wrapped by IndexSampler
FloatT	TypeVar of floating point precision (np.float32, np.float64, default=Any)
ScalarT	TypeVar of for np.generic dtype.
FloatingT	TypeVar of floating point precision (all)
ReduceDataKwargs	Extra parameters to reduction.reduce_data()
ReduceValsKwargs	Extra parameters to reduction.reduce_vals()
ReduceDataGroupedKwargs	Extra parameters to grouped.reduce_data_grouped()
ReduceDataIndexedKwargs	Extra parameters to grouped.reduce_data_indexed()
ReduceValsGroupedKwargs	Extra parameters to grouped.reduce_vals_grouped()
ReduceValsIndexedKwargs	Extra parameters to grouped.reduce_vals_indexed()
ResampleDataKwargs	Extra parameters to resample.resample_data()
ResampleValsKwargs	Extra parameters for resample.resample_vals()
JackknifeDataKwargs	Extra parameters for resample.jackknife_data()
JackknifeValsKwargs	Extra parameters for resample.jackknife_data()
WrapRawKwargs	Extra parameters for wrap_raw()
MomentsTypeKwargs	Extra parameters for convert.moments_type()
CumulativeKwargs	Extra parameters for convert.cumulative()
MomentsToComomentsKwargs	Extra parameters for convert.moments_to_comoments()
SelectMomentKwargs	Extra parameters to utils.select_moment()
ValsToDataKwargs	Extra parameters to utils.vals_to_data()
RollingDataKwargs	Extra parameters to rolling.rolling_data()
RollingValsKwargs	Extra parameters to rolling.rolling_vals()
RollingExpDataKwargs	Extra parameters to rolling.rolling_exp_data()
RollingExpValsKwargs	Extra parameters to rolling.rolling_exp_vals()
WrapKwargs	Extra parameters to cmomy.wrap()
ZerosLikeKwargs	Extra parameters to cmomy.zeros_like()
WrapNPTransform	Extra parameters to CentralMomentsArray.cumulative()
WrapNPResampleAndReduceKwargs	Extra parameters to CentralMomentsArray.resample_and_reduce()
WrapNPReduceKwargs	Extra parameters to CentralMomentsArray.reduce()
IndexSamplerFromDataKwargs	Extra parameters to resample.IndexSampler.from_data()
FactoryIndexSamplerKwargs	Extra parameters to resample.factory_sampler()

cmomy.core.typing.CentralMomentsDataArray = 'CentralMomentsData[xr.DataArray]'

DataArray wrapper

cmomy.core.typing.CentralMomentsDataset = 'CentralMomentsData[xr.Dataset]'

Dataset wrapper

cmomy.core.typing.CentralMomentsDataAny = 'CentralMomentsData[Any]'

DataArray or Dataset wrapper

cmomy.core.typing.CentralMomentsArrayAny = 'CentralMomentsArray[Any]'

Any Array wrapper

class cmomy.core.typing.CentralMomentsT

Generic wrapper TypeVar

alias of TypeVar(‘CentralMomentsT’, bound=CentralMomentsABC[Any, Any])

class cmomy.core.typing.CentralMomentsArrayT

Array wrapper TypeVar

alias of TypeVar(‘CentralMomentsArrayT’, bound=CentralMomentsArray[Any])

class cmomy.core.typing.CentralMomentsDataT

xarray object wrapper TypeVar

alias of TypeVar(‘CentralMomentsDataT’, bound=CentralMomentsData[Any])

cmomy.core.typing.MomParamsInput(*args, **kwargs)

Moment parameters input

alias of MomParams | MomParamsBase | MomParamsDict | None

class cmomy.core.typing.MomParamsT

Moment parameters TypeVar

alias of TypeVar(‘MomParamsT’, MomParamsArray, MomParamsXArray)

class cmomy.core.typing.GenArrayT

General data set/array

alias of TypeVar(‘GenArrayT’, ~numpy.ndarray[tuple[~typing.Any, …], ~numpy.dtype[~typing.Any]], ~xarray.core.dataarray.DataArray, ~xarray.core.dataset.Dataset)

class cmomy.core.typing.DataT

DataArray or Dataset

alias of TypeVar(‘DataT’, ~xarray.core.dataarray.DataArray, ~xarray.core.dataset.Dataset)

class cmomy.core.typing.ArrayT

TypeVar of array types with restriction

alias of TypeVar(‘ArrayT’, ~numpy.ndarray[tuple[~typing.Any, …], ~numpy.dtype[~numpy.float64]], ~numpy.ndarray[tuple[~typing.Any, …], ~numpy.dtype[~numpy.float32]], ~xarray.core.dataarray.DataArray)

class cmomy.core.typing.SamplerArrayT

TypeVar of types wrapped by IndexSampler

alias of TypeVar(‘SamplerArrayT’, ~numpy.ndarray[tuple[~typing.Any, …], ~numpy.dtype[~typing.Any]], ~xarray.core.dataarray.DataArray, ~xarray.core.dataset.Dataset, ~xarray.core.dataarray.DataArray | ~xarray.core.dataset.Dataset)

class cmomy.core.typing.FloatT

TypeVar of floating point precision (np.float32, np.float64, default=Any)

alias of TypeVar(‘FloatT’, ~numpy.float64, ~numpy.float32)

class cmomy.core.typing.ScalarT

TypeVar of for np.generic dtype.

alias of TypeVar(‘ScalarT’, bound=generic)

class cmomy.core.typing.FloatingT

TypeVar of floating point precision (all)

alias of TypeVar(‘FloatingT’, bound=np.floating[Any])

cmomy.core.typing.Axes(*args, **kwargs)

Axes type

alias of int | tuple[int, ...]

cmomy.core.typing.AxesWrap(*args, **kwargs)

Axes type (with wrapping)

alias of complex | tuple[complex, ...]

cmomy.core.typing.AxisReduce(*args, **kwargs)

Reduction axes type

alias of int | None

cmomy.core.typing.AxisReduceWrap(*args, **kwargs)

Reduction axes type (with wrapping)

alias of complex | None

cmomy.core.typing.AxisReduceMult(*args, **kwargs)

Reduction axes type (multiple)

alias of int | tuple[int, ...] | None

cmomy.core.typing.AxisReduceMultWrap(*args, **kwargs)

Reduction axes type (multiple, with wrapping)

alias of complex | tuple[complex, ...] | None

cmomy.core.typing.RngTypes(*args, **kwargs)

Random number generator types

alias of int | Sequence[int] | SeedSequence | BitGenerator | Generator

cmomy.core.typing.DTypeAny

Any dtype

cmomy.core.typing.FloatDTypes(*args, **kwargs)

Floating dtype

alias of float32 | float64

cmomy.core.typing.LongIntDType

Long integer dtype

cmomy.core.typing.NDArrayAny(*args, **kwargs)

Array type (any dtype)

alias of ndarray[tuple[Any, …], dtype[Any]]

cmomy.core.typing.NDArrayInt(*args, **kwargs)

Array type (int dtype)

alias of ndarray[tuple[Any, …], dtype[int64]]

cmomy.core.typing.NDArrayFloats(*args, **kwargs)

Array type (float dtype)

alias of ndarray[tuple[Any, …], dtype[float32 | float64]]

cmomy.core.typing.NDArrayBool(*args, **kwargs)

Array type (bool dtype)

alias of ndarray[tuple[Any, …], dtype[bool]]

cmomy.core.typing.IntDTypeT

Integer dtype

cmomy.core.typing.NDGeneric(*args, **kwargs)

Float or array of float

alias of FloatT | ndarray[tuple[Any, …], dtype[FloatT]]

cmomy.core.typing.Moments(*args, **kwargs)

Moments type

alias of int | tuple[int] | tuple[int, int]

cmomy.core.typing.MomentsStrict(*args, **kwargs)

Strict moments type

alias of tuple[int] | tuple[int, int]

cmomy.core.typing.MomNDim(*args, **kwargs)

Number of moment dimensions

alias of Literal[1, 2]

cmomy.core.typing.MomAxes(*args, **kwargs)

Axes containing moment(s).

alias of int | tuple[int] | tuple[int, int]

cmomy.core.typing.MomAxesStrict(*args, **kwargs)

Axes containing moment(s).

alias of tuple[int] | tuple[int, int]

cmomy.core.typing.DimsReduce(*args, **kwargs)

Reduction dimension

alias of Hashable | None

cmomy.core.typing.DimsReduceMult(*args, **kwargs)

Reduction dimension(s)

alias of Hashable | Collection[Hashable] | None

cmomy.core.typing.Dims(*args, **kwargs)

Dimensions

alias of str | Collection[Hashable] | EllipsisType | None

cmomy.core.typing.MomDims(*args, **kwargs)

Dimensions containing moment(s)

alias of Hashable | tuple[Hashable] | tuple[Hashable, Hashable]

cmomy.core.typing.MomDimsStrict(*args, **kwargs)

Dimensions containing moment(s)

alias of tuple[Hashable] | tuple[Hashable, Hashable]

cmomy.core.typing.IndexAny = 'pd.Index[Any]'

Index

cmomy.core.typing.CoordsType(*args, **kwargs)

Coordinates

alias of Mapping[Any, Any] | None

cmomy.core.typing.ArrayOrderCF(*args, **kwargs)

Order parameters

alias of Literal[‘C’, ‘F’] | None

cmomy.core.typing.ArrayOrderACF(*args, **kwargs)

Order parameters

alias of Literal[‘A’, ‘C’, ‘F’] | None

cmomy.core.typing.ArrayOrderKACF(*args, **kwargs)

Order parameters

alias of Literal[‘K’, ‘A’, ‘C’, ‘F’] | None

cmomy.core.typing.Casting(*args, **kwargs)

Casting rules

alias of Literal[‘no’, ‘equiv’, ‘safe’, ‘same_kind’, ‘unsafe’]

cmomy.core.typing.MissingCoreDimOptions(*args, **kwargs)

What to do if missing a core dimensions.

alias of Literal[‘raise’, ‘copy’, ‘drop’]

cmomy.core.typing.SelectMoment(*args, **kwargs)

Moment names.

alias of Literal[‘weight’, ‘ave’, ‘cov’, ‘var’, ‘xave’, ‘yave’, ‘xvar’, ‘yvar’, ‘all’, ‘xmom_0’, ‘xmom_1’, ‘ymom_0’, ‘ymom_1’]

cmomy.core.typing.ConvertStyle(*args, **kwargs)

Style to convert to

alias of Literal[‘central’, ‘raw’]

class cmomy.core.typing.ReduceDataKwargs

Bases: _MomParamsKwargs, _MomNDimKwargs, _AxisMultKwargs, _ReductionKwargs, _ParallelKwargs, _OrderKACFKwargs, _MomAxesKwargs, _KeepDimsKwargs, _MoveAxisToEndKwargs

Extra parameters to reduction.reduce_data()

class cmomy.core.typing.ReduceValsKwargs

Bases: _ValsCFKwargs

Extra parameters to reduction.reduce_vals()

class cmomy.core.typing.ReduceDataGroupedKwargs

Bases: _DataCFKwargs, _GroupsKwargs, _CoordsPolicyKwargs

Extra parameters to grouped.reduce_data_grouped()

class cmomy.core.typing.ReduceDataIndexedKwargs

Bases: _DataKACFKwargs, _GroupsKwargs, _IndexedKwargs, _CoordsPolicyKwargs

Extra parameters to grouped.reduce_data_indexed()

class cmomy.core.typing.ReduceValsGroupedKwargs

Bases: _ValsCFKwargs, _GroupsKwargs, _CoordsPolicyKwargs

Extra parameters to grouped.reduce_vals_grouped()

class cmomy.core.typing.ReduceValsIndexedKwargs

Bases: _ValsCFKwargs, _GroupsKwargs, _IndexedKwargs, _CoordsPolicyKwargs

Extra parameters to grouped.reduce_vals_indexed()

class cmomy.core.typing.ResampleDataKwargs

Bases: _DataKACFKwargs, _RepDimKwargs, _SamplerKwargs

Extra parameters to resample.resample_data()

class cmomy.core.typing.ResampleValsKwargs

Bases: _ValsCFKwargs, _RepDimKwargs, _SamplerKwargs

Extra parameters for resample.resample_vals()

class cmomy.core.typing.JackknifeDataKwargs

Bases: _DataKACFKwargs

Extra parameters for resample.jackknife_data()

class cmomy.core.typing.JackknifeValsKwargs

Bases: _ValsCFKwargs

Extra parameters for resample.jackknife_data()

class cmomy.core.typing.WrapRawKwargs

Bases: _WrapRawKwargs

Extra parameters for wrap_raw()

class cmomy.core.typing.MomentsTypeKwargs

Bases: _WrapRawKwargs, _MoveAxisToEndKwargs

Extra parameters for convert.moments_type()

class cmomy.core.typing.CumulativeKwargs

Bases: _DataKACFKwargs

Extra parameters for convert.cumulative()

class cmomy.core.typing.MomentsToComomentsKwargs

Bases: _MomDimsAndApplyUFuncKwargs, _OrderCFKwargs, _MomAxesKwargs, _MomParamsKwargs

Extra parameters for convert.moments_to_comoments()

class cmomy.core.typing.SelectMomentKwargs

Bases: _MomNDimKwargs, _MomDimsAndApplyUFuncKwargs, _MomAxesKwargs, _MomParamsKwargs

Extra parameters to utils.select_moment()

class cmomy.core.typing.ValsToDataKwargs

Bases: _MomKwargs, _MomDimsAndApplyUFuncKwargs, _MomParamsKwargs

Extra parameters to utils.vals_to_data()

class cmomy.core.typing.RollingDataKwargs

Bases: _DataKACFKwargs, _RollingKwargs

Extra parameters to rolling.rolling_data()

class cmomy.core.typing.RollingValsKwargs

Bases: _ValsCFKwargs, _RollingKwargs

Extra parameters to rolling.rolling_vals()

class cmomy.core.typing.RollingExpDataKwargs

Bases: _DataKACFKwargs, _RollingExpKwargs

Extra parameters to rolling.rolling_exp_data()

class cmomy.core.typing.RollingExpValsKwargs

Bases: _ValsCFKwargs, _RollingExpKwargs

Extra parameters to rolling.rolling_exp_vals()

class cmomy.core.typing.WrapKwargs

Bases: _MomNDimKwargs, _MomAxesKwargs, _MomParamsKwargs

Extra parameters to cmomy.wrap()

class cmomy.core.typing.ZerosLikeKwargs

Bases: _OrderKACFKwargs

Extra parameters to cmomy.zeros_like()

class cmomy.core.typing.WrapNPTransform

Bases: _WrapNPTransform

Extra parameters to CentralMomentsArray.cumulative()

class cmomy.core.typing.WrapNPResampleAndReduceKwargs

Bases: _WrapNPTransform

Extra parameters to CentralMomentsArray.resample_and_reduce()

class cmomy.core.typing.WrapNPReduceKwargs

Bases: _WrapNPTransform, _KeepDimsKwargs

Extra parameters to CentralMomentsArray.reduce()

class cmomy.core.typing.IndexSamplerFromDataKwargs

Bases: _AxisKwargs, _MomAxesKwargs, _MomParamsKwargs

Extra parameters to resample.IndexSampler.from_data()

class cmomy.core.typing.FactoryIndexSamplerKwargs

Bases: TypedDict

Extra parameters to resample.factory_sampler()

Parameters:

• indices (array of int) – Array of shape (nrep, size). If passed, create freq from indices.

• freq (array-like, DataArray, or Dataset of int) – Array of shape (nrep, size) where nrep is the number of replicates and size = self.shape[axis]. freq is the weight that each sample contributes to a replicate. If freq is an xarray object, it should have dimensions rep_dim and dim.

• ndat (int) – Size of data along resampled axis.

• nrep (int) – Number of resample replicates.

• nsamp (int) – Number of samples in a single resampled replicate. Defaults to size of data along sampled axis.

• paired (bool) – If False and generating freq from nrep with data of type Dataset, Generate unique freq for each variable in data. If True, treat all variables in data as paired, and use same freq for each.

• rng – Random number generator object. Defaults to output of default_rng(). If pass in a seed value, create a new Generator object with this seed

• resample_replace (bool) – If True, do resampling with replacement.

• shuffle (bool) – If True, shuffle indices created from freq for each row.

cmomy.core.typing.Sampler(*args, **kwargs)

IndexSampler or mapping which can be converted to IndexSampler

alias of int | ndarray[tuple[Any, …], dtype[Any]] | DataArray | Dataset | IndexSampler[Any] | FactoryIndexSamplerKwargs