firecrown.metadata_types.TwoPointReal#

class firecrown.metadata_types.TwoPointReal(*, XY, thetas)[source]#

Bases: YAMLSerializable

Class defining the metadata for a real-space two-point measurement.

The class used to store the metadata for a real-space two-point function measured on a sphere.

This includes the two redshift resolutions (one for each binned quantity) and the a array of (floating point) theta (angle) values at which the two-point function which has this metadata were calculated.

Parameters:
  • XY (TwoPointXY) –

  • thetas (ndarray[tuple[int, ...], dtype[float64]]) –

Public Methods:

__post_init__()

Validate the TwoPointCWindow data.

__str__()

Return a string representation of the TwoPointReal object.

get_sacc_name()

Return the SACC name for the two-point function.

__eq__(other)

Equality test for TwoPointReal objects.

n_observations()

Return the number of observations described by these metadata.

__hash__()

Return hash(self).

__replace__(**changes)

__init__(*, XY, thetas)

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 TwoPointReal objects.

Return type:

bool

__post_init__()[source]#

Validate the TwoPointCWindow data.

Make sure the window is

__str__()[source]#

Return a string representation of the TwoPointReal object.

Return type:

str

get_sacc_name()[source]#

Return the SACC name for the two-point function.

Return type:

str

n_observations()[source]#

Return the number of observations described by these metadata.

Return type:

int

Returns:

The number of observations.