firecrown.models.cluster_redshift.ClusterRedshift
- class firecrown.models.cluster_redshift.ClusterRedshift[source]
Bases:
Updatable
Cluster Redshift class.
Public Methods:
read
(sacc_data)Abstract method to read the data for this source from the SACC file.
gen_bins_by_array
(z_bins)Generate the bins by an array of bin edges.
gen_bin_from_tracer
(tracer)Return the bin for the given tracer.
Inherited from
Updatable
__init__
()Updatable initialization.
__setattr__
(key, value)Set the attribute named
key
to the suppliedvalue
.set_internal_parameter
(key, value)Assure this InternalParameter has not already been set, and then set it.
set_sampler_parameter
(key, 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.
reset
()Clean up self by clearing the _updated status and reseting all internals.
Return a RequiredParameters object containing the information for all parameters defined in the implementing class, any additional parameter
Returns a collection of derived parameters once per iteration of the statistical analysis.
Private Methods:
_update_cluster_redshift
(params)Method to update the ClusterRedshift from the given ParamsMap.
Abstract method to reset the ClusterRedshift.
_update
(params)Implementation of Updatable interface method _update.
_reset
()Implementation of the Updatable interface method _reset.
Inherited from
Updatable
_update
(params)Do any updating other than calling
update
on containedUpdatable
objects._reset
()Abstract method to be implemented by all concrete classes to update self.
Return a RequiredParameters object containing the information for this Updatable.
Abstract method to be implemented by all concrete classes to return their derived parameters.
- final _reset()[source]
Implementation of the Updatable interface method _reset.
This calls the abstract method _reset_cluster_redshift, which must be implemented by all subclasses.
- Return type
None
- final _update(params)[source]
Implementation of Updatable interface method _update.
- Parameters
params (
ParamsMap
) –
- _update_cluster_redshift(params)[source]
Method to update the ClusterRedshift from the given ParamsMap. Subclasses that need to do more than update their contained
Updatable
instance variables should implement this method.- Parameters
params (
ParamsMap
) –
- abstract gen_bin_from_tracer(tracer)[source]
Return the bin for the given tracer.
- Parameters
tracer (
BaseTracer
) –- Return type
- abstract gen_bins_by_array(z_bins)[source]
Generate the bins by an array of bin edges.
- Parameters
z_bins (
ndarray
) –- Return type
List
[ClusterRedshiftArgument
]