yaw.core.abc.PatchedQuantity

class yaw.core.abc.PatchedQuantity

Bases: ABC

Base class for an object that has data organised in spatial patches.

Methods

__init__()
concatenate_patches(*data)	Concatenate pair count data containers with equal redshift binning.

Attributes

n_patches	Get the number of spatial patches.
patches	An Indexer attribute that supports iteration over the spatial patches or selecting a subset of the patches.

abstract concatenate_patches(*data: _Tpatched) → _Tpatched

Concatenate pair count data containers with equal redshift binning.

The data is merged by extending the dimension of the patch axes. The resulting data array will be a block matrix of the input data arrays, i.e. all elements with correlations between different inputs set to zero.

Note

Necessary condition for merging is that the the redshift binning of all inputs is identical. Cannot merge cross- with autocorrelation containers.

Parameters:

*data – Containers of same type that are appended to the patch dimension of this container.

Returns:

New instance of this container with combined data.

abstract property n_patches: int

Get the number of spatial patches.

abstract property patches: Indexer

An Indexer attribute that supports iteration over the spatial patches or selecting a subset of the patches.

The indexer always returns new container instances with the indexed data subset or the current item when iterating.

Note

Indexing rules for a one-dimensional numpy array apply.

Returns:

yaw.core.containers.Indexer