firecrown.models.cluster.binning

Classes for defining bins used in the cluster likelihood.

This module contains the classes that define the bins and binning used for cluster theoretical predictions within Firecrown.

Classes

`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.

Module Contents

class firecrown.models.cluster.binning.NDimensionalBin[source]

Bases: abc.ABC

Inheritance diagram of firecrown.models.cluster.binning.NDimensionalBin

Class which defines the interface for an N dimensional bin.

property z_edges: tuple[float, float][source]

Abstractmethod:
Return type:: tuple[float, float]

Redshift bin edges.

property mass_proxy_edges: tuple[float, float][source]

Abstractmethod:
Return type:: tuple[float, float]

Mass proxy bin edges.

property radius_edges: tuple[float, float][source]

Abstractmethod:
Return type:: tuple[float, float]

Radius bin edges.

property radius_center: float[source]

Abstractmethod:
Return type:: float

Radius bin edges.

__str__()[source]

Returns a string representation of the bin edges.

Return type:: str

class firecrown.models.cluster.binning.SaccBin(coordinate_bins)[source]

Bases: NDimensionalBin

Inheritance diagram of firecrown.models.cluster.binning.SaccBin

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][source]

Redshift bin edges.

Return type:: tuple[float, float]

property mass_proxy_edges: tuple[float, float][source]

Mass proxy bin edges.

Return type:: tuple[float, float]

property radius_edges: tuple[float, float][source]

Radius bin edges.

Return type:: tuple[float, float]

property radius_center: float[source]

Radius bin center.

Return type:: float

__eq__(other)[source]

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

Parameters:: other (object)
Return type:: bool

__hash__()[source]

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

Return type:: int

class firecrown.models.cluster.binning.TupleBin(coordinate_bins)[source]

Bases: NDimensionalBin

Inheritance diagram of firecrown.models.cluster.binning.TupleBin

An implementation of the N dimensional bin using sacc tracers.

Parameters:: coordinate_bins (list[tuple])

coordinate_bins

property dimension: int[source]

Number of dimensions for this bin.

Return type:: int

property mass_proxy_edges: tuple[float, float][source]

Mass proxy bin edges.

Return type:: tuple[float, float]

property z_edges: tuple[float, float][source]

Redshift bin edges.

Return type:: tuple[float, float]

property radius_edges: tuple[float, float][source]

Radius bin edges.

Return type:: tuple[float, float]

property radius_center: float[source]

Radius bin center.

Return type:: float

__eq__(other)[source]

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

Parameters:: other (object)
Return type:: bool

__hash__()[source]

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

Return type:: int