firecrown.models.cluster

Module that contains the cluster model classes.

Classes

AbundanceData	The class used to wrap a sacc file and return the cluster abundance data.
NDimensionalBin	Class which defines the interface for an N dimensional bin.
SaccBin	An implementation of the N dimensional bin using sacc tracers.
TupleBin	An implementation of the N dimensional bin using sacc tracers.
ClusterData	The class used to wrap a sacc file and return the cluster abundance data.
ShearData	The class used to wrap a sacc file and return the cluster deltasigma data.

Package Contents

class firecrown.models.cluster.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 (crow.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 (crow.properties.ClusterProperty)

Return type:

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

class firecrown.models.cluster.NDimensionalBin

Bases: abc.ABC

Class which defines the interface for an N dimensional bin.

property z_edges: tuple[float, float]

Abstractmethod:

Return type:

tuple[float, float]

Redshift bin edges.

property mass_proxy_edges: tuple[float, float]

Abstractmethod:

Return type:

tuple[float, float]

Mass proxy bin edges.

property radius_edges: tuple[float, float]

Abstractmethod:

Return type:

tuple[float, float]

Radius bin edges.

property radius_center: float

Abstractmethod:

Return type:

float

Radius bin edges.

__str__()

Returns a string representation of the bin edges.

Return type:

str

class firecrown.models.cluster.SaccBin(coordinate_bins)

Bases: NDimensionalBin

An implementation of the N dimensional bin using sacc tracers.

Parameters:

coordinate_bins (list[sacc.BaseTracer])

coordinate_bins

dimension

property z_edges: tuple[float, float]

Redshift bin edges.

Return type:

tuple[float, float]

property mass_proxy_edges: tuple[float, float]

Mass proxy bin edges.

Return type:

tuple[float, float]

property radius_edges: tuple[float, float]

Radius bin edges.

Return type:

tuple[float, float]

property radius_center: float

Radius bin center.

Return type:

float

__eq__(other)

Two bins are equal if they have the same lower/upper bound.

Parameters:

other (object)

Return type:

bool

__hash__()

One bin’s hash is determined by the dimension and lower/upper bound.

Return type:

int

class firecrown.models.cluster.TupleBin(coordinate_bins)

Bases: NDimensionalBin

An implementation of the N dimensional bin using sacc tracers.

Parameters:

coordinate_bins (list[tuple])

coordinate_bins

property dimension: int

Number of dimensions for this bin.

Return type:

int

property mass_proxy_edges: tuple[float, float]

Mass proxy bin edges.

Return type:

tuple[float, float]

property z_edges: tuple[float, float]

Redshift bin edges.

Return type:

tuple[float, float]

property radius_edges: tuple[float, float]

Radius bin edges.

Return type:

tuple[float, float]

property radius_center: float

Radius bin center.

Return type:

float

__eq__(other)

Two bins are equal if they have the same lower/upper bound.

Parameters:

other (object)

Return type:

bool

__hash__()

One bin’s hash is determined by the dimension and lower/upper bound.

Return type:

int

class firecrown.models.cluster.ClusterData(sacc_data)

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)

sacc_data

get_survey_tracer(survey_nm)

Returns the SurveyTracer for the specified survey name.

Parameters:

survey_nm (str)

Return type:

sacc.tracers.SurveyTracer

abstractmethod 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 (crow.properties.ClusterProperty)

Return type:

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

abstractmethod get_bin_edges(survey_nm, properties)

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

Parameters:

• survey_nm (str)

• properties (crow.properties.ClusterProperty)

Return type:

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

class firecrown.models.cluster.ShearData(sacc_data)

Bases: firecrown.models.cluster._cluster_data.ClusterData

The class used to wrap a sacc file and return the cluster deltasigma 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 DELTASIGMA then the observed cluster profile within each N dimensional bin will be returned.

Parameters:

• survey_nm (str)

• properties (crow.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 shear data type.

Parameters:

• survey_nm (str)

• properties (crow.properties.ClusterProperty)

Return type:

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