firecrown.data_types.TwoPointMeasurement#

class firecrown.data_types.TwoPointMeasurement(*, data, indices, covariance_name, metadata)[source]#

Bases: YAMLSerializable

Class defining the data for a two-point measurement.

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

This includes the measured two-point function, their indices in the covariance matrix and the name of the covariance matrix. The corresponding metadata is also stored.

Parameters:
  • data (ndarray[tuple[int, ...], dtype[float64]]) –

  • indices (ndarray[tuple[int, ...], dtype[int64]]) –

  • covariance_name (str) –

  • metadata (TwoPointReal | TwoPointHarmonic) –

Public Methods:

__post_init__()

Make sure the data and indices have the same shape.

__eq__(other)

Equality test for TwoPointMeasurement objects.

is_real()

Check if the metadata is real.

is_harmonic()

Check if the metadata is harmonic.

__hash__()

Return hash(self).

__replace__(**changes)

__init__(*, data, indices, covariance_name, ...)

param data:

__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 TwoPointMeasurement objects.

Return type:

bool

__post_init__()[source]#

Make sure the data and indices have the same shape.

Return type:

None

is_harmonic()[source]#

Check if the metadata is harmonic.

Return type:

bool

is_real()[source]#

Check if the metadata is real.

Return type:

bool