firecrown.metadata_types.TwoPointHarmonic

class firecrown.metadata_types.TwoPointHarmonic(*, XY, ells, window=None)

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[tuple[int, ...], dtype[int64]]) –

• window (None | ndarray[tuple[int, ...], dtype[float64]]) –

Public Methods:

__post_init__()	Validate the TwoPointHarmonic data.
__eq__(other)	Equality test for TwoPointHarmonic objects.
__str__()	Return a string representation of the TwoPointHarmonic object.
get_sacc_name()	Return the SACC name for the two-point function.
n_observations()	Return the number of observations described by these metadata.
__hash__()	Return hash(self).
__replace__(**changes)
__init__(*, XY, ells[, window])	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)

Equality test for TwoPointHarmonic objects.

Return type:

bool

__post_init__()

Validate the TwoPointHarmonic data.

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

Return type:

None

__str__()

Return a string representation of the TwoPointHarmonic object.

Return type:

str

get_sacc_name()

Return the SACC name for the two-point function.

Return type:

str

n_observations()

Return the number of observations described by these metadata.

Return type:

int

Returns:

The number of observations.