firecrown.metadata.two_point.TwoPointCells#

class firecrown.metadata.two_point.TwoPointCells(*, XY, ells)[source]#

Bases: YAMLSerializable

Class defining the metadata for an harmonic-space two-point measurement.

The class used to store the metadata for a (spherical) harmonic-space two-point function measured on a sphere.

This includes the two redshift resolutions (one for each binned quantity) and the array of (integer) l’s at which the two-point function which has this metadata were calculated.

Parameters:
  • XY (TwoPointXY) –

  • ells (ndarray[Any, dtype[int64]]) –

Public Methods:

__post_init__()

Validate the TwoPointCells data.

__eq__(other)

Equality test for TwoPointCells objects.

get_sacc_name()

Return the SACC name for the two-point function.

__hash__()

Return hash(self).

__init__(*, XY, ells)

param XY:

__repr__()

Return repr(self).

__setattr__(name, value)

Implement setattr(self, name, value).

__delattr__(name)

Implement delattr(self, name).

Inherited from YAMLSerializable

to_yaml()

Return the YAML representation of the object.

from_yaml(yaml_str)

Load the object from YAML.


__eq__(other)[source]#

Equality test for TwoPointCells objects.

Return type:

bool

__post_init__()[source]#

Validate the TwoPointCells data.

Make sure the ells are a 1D array and X and Y are compatible with harmonic-space calculations.

Return type:

None

get_sacc_name()[source]#

Return the SACC name for the two-point function.

Return type:

str