firecrown.models.cluster.abundance_data

The module responsible for extracting cluster data from a sacc file.

Classes

AbundanceData

The class used to wrap a sacc file and return the cluster abundance data.

Module Contents

class firecrown.models.cluster.abundance_data.AbundanceData(sacc_data)

Bases: firecrown.models.cluster.cluster_data.ClusterData

The class used to wrap a sacc file and return the cluster abundance data.

The sacc file is a complicated set of tracers (bins) and surveys. This class manipulates that data and returns only the data relevant for the cluster number count statistic. The data in this class is specific to a single survey name.

Parameters:

sacc_data (sacc.Sacc)

get_observed_data_and_indices_by_survey(survey_nm, properties)

Returns the observed data for the specified survey and properties.

For example if the caller has enabled COUNTS then the observed cluster counts within each N dimensional bin will be returned.

Parameters:

• survey_nm (str)

• properties (firecrown.models.cluster.properties.ClusterProperty)

Return type:

tuple[list[float], list[int]]

get_bin_edges(survey_nm, properties)

Returns the limits for all z, mass bins for the requested data type.

Parameters:

• survey_nm (str)

• properties (firecrown.models.cluster.properties.ClusterProperty)

Return type:

list[firecrown.models.cluster.binning.SaccBin]