firecrown.models.cluster.mass_proxy.MassRichnessGaussian#

class firecrown.models.cluster.mass_proxy.MassRichnessGaussian(parameter_prefix=None)[source]#

Bases: Updatable

The representation of mass richness relations that are of a gaussian form.

Parameters:

parameter_prefix (None | str) –

Public Methods:

observed_value(p, mass, z, pivot_mass, ...)

Return observed quantity corrected by redshift and mass.

get_proxy_mean(mass, z)

Return observed quantity corrected by redshift and mass.

get_proxy_sigma(mass, z)

Return observed scatter corrected by redshift and mass.

Inherited from Updatable

__init__([parameter_prefix])

Updatable initialization.

__setattr__(key, value)

Set the attribute named key to the supplied value.

set_parameter(key, value)

Sets the parameter to the given value.

set_internal_parameter(key, value)

Assure this InternalParameter has not already been set, and then set it.

set_sampler_parameter(value)

Assure this SamplerParameter has not already been set, and then set it.

update(params)

Update self by calling to prepare for the next MCMC sample.

is_updated()

Determine if the object has been updated.

reset()

Reset the updatable.

required_parameters()

Returns a RequiredParameters object.

get_derived_parameters()

Returns a collection of derived parameters.

Private Methods:

_distribution_binned(mass, z, mass_proxy_limits)

param mass:

_distribution_unbinned(mass, z, mass_proxy)

param mass:

Inherited from Updatable

_update(params)

Method for auxiliary updates to be made to an updatable.

_reset()

Abstract method implemented by all concrete classes to update self.

_required_parameters()

Return a RequiredParameters object containing the information for this class.

_get_derived_parameters()

Returns the derived parameters of an implementation.


abstract get_proxy_mean(mass, z)[source]#

Return observed quantity corrected by redshift and mass.

Parameters:
  • mass (ndarray[Any, dtype[float64]]) –

  • z (ndarray[Any, dtype[float64]]) –

Return type:

ndarray[Any, dtype[float64]]

abstract get_proxy_sigma(mass, z)[source]#

Return observed scatter corrected by redshift and mass.

Parameters:
  • mass (ndarray[Any, dtype[float64]]) –

  • z (ndarray[Any, dtype[float64]]) –

Return type:

ndarray[Any, dtype[float64]]

static observed_value(p, mass, z, pivot_mass, log1p_pivot_redshift)[source]#

Return observed quantity corrected by redshift and mass.

Parameters:
  • p (tuple[float, float, float]) –

  • mass (ndarray[Any, dtype[float64]]) –

  • z (ndarray[Any, dtype[float64]]) –

  • pivot_mass (float) –

  • log1p_pivot_redshift (float) –

Return type:

ndarray[Any, dtype[float64]]