firecrown.likelihood.gauss_family.statistic.source.number_counts.NumberCounts

class firecrown.likelihood.gauss_family.statistic.source.number_counts.NumberCounts(*, sacc_tracer, has_rsd=False, derived_scale=False, scale=1.0, systematics=None)

Bases: SourceGalaxy[NumberCountsArgs]

Source class for number counts.

Parameters:

• sacc_tracer (str) –

• has_rsd (bool) –

• derived_scale (bool) –

• scale (float) –

• systematics (Optional[Sequence[SourceGalaxySystematic[NumberCountsArgs]]]) –

Public Methods:

__init__(*, sacc_tracer[, has_rsd, ...])	Initialize the NumberCounts object.
create_ready(inferred_zdist[, has_rsd, ...])	Create a NumberCounts object with the given tracer name and scale.
create_tracers(tools)	Create the tracers for this source.
get_scale()	Return the scale for this source.

Inherited from SourceGalaxy

__init__(*, sacc_tracer[, systematics])

Initialize the SourceGalaxy object.

Inherited from Source

__init__(sacc_tracer)	Create a Source object that uses the named tracer.
read(sacc_data)	Read the data for this source from the SACC file.
get_scale()	Abstract method to return the scales for this Source.
create_tracers(tools)	Create tracers for this Source, for the given cosmology.
get_tracers(tools)	Return the tracer for the given cosmology.

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.

Inherited from Generic

__class_getitem__	Parameterizes a generic class.
__init_subclass__	Function to initialize subclasses.

Private Methods:

_update_source(params)	Perform any updates necessary after the parameters have being updated.
_get_derived_parameters()	Returns the derived parameters of an implementation.
_read(sacc_data)	Read the data for this source from the SACC file.

Inherited from SourceGalaxy

_read(sacc_data)

Read the galaxy redshift distribution model from a sacc file.

Inherited from Source

_read(sacc_data)	Abstract method to read the data for this source from the SACC file.
_update_source(params)	Method to update the source from the given ParamsMap.
_update(params)	Implementation of Updatable interface method _update.

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.

---

final _get_derived_parameters()

Returns the derived parameters of an implementation.

Derived classes can override this, returning a DerivedParameterCollection containing the derived parameters for the class. The default implementation returns an empty DerivedParameterCollection.

Return type:

DerivedParameterCollection

_read(sacc_data)

Read the data for this source from the SACC file.

Parameters:

sacc_data (sacc.Sacc) – The data in the sacc format.

final _update_source(params)

Perform any updates necessary after the parameters have being updated.

This implementation must update all contained Updatable instances.

Parameters:

params (ParamsMap) –

classmethod create_ready(inferred_zdist, has_rsd=False, derived_scale=False, scale=1.0, systematics=None)

Create a NumberCounts object with the given tracer name and scale.

Parameters:

• inferred_zdist (InferredGalaxyZDist) –

• has_rsd (bool) –

• derived_scale (bool) –

• scale (float) –

• systematics (None | list[SourceGalaxySystematic[NumberCountsArgs]]) –

Return type:

NumberCounts

create_tracers(tools)

Create the tracers for this source.

Parameters:

tools (ModelingTools) –

Return type:

tuple[list[Tracer], NumberCountsArgs]

get_scale()

Return the scale for this source.