Transfer¶
- class hmf.density_field.transfer.Transfer(*args, **kwargs)[source]¶
A transfer function framework.
The purpose of this
hmf._frameworks.Frameworkis to calculate transfer functions, power spectra and several tightly associated quantities given a basic model for the transfer function.As in all frameworks, to update parameters optimally, use the
update()method. All output quantities are calculated only when needed (but stored after first calculation for quick access).In addition to the parameters directly passed to this class, others are available which are passed on to its superclass. To read a standard documented list of (all) parameters, use
Transfer.parameter_info(). If you want to just see the plain list of available parameters, useTransfer.get_all_parameters().To see the actual defaults for each parameter, useTransfer.get_all_parameter_defaults().By default, the growth_model is
GrowthFactor. However, if using a wCDM cosmology and camb is installed, it will default toCambGrowth.Attributes
The cosmography object with custom parameters applied.
The cosmological model instance.
Parameters deviating from the base cosmology.
Dimensionless power spectrum, \(\Delta_k = \frac{k^3 P(k)}{2\pi^2}\).
Step-size of log wave-numbers.
The instantiated growth model.
The growth factor.
The model to use to calculate the growth function/growth rate.
Relevant parameters of the
growth_model.Wavenumbers, [h/Mpc].
Maximum (natural) log wave-number,
k[h/Mpc].Minimum (natural) log wave-number,
k[h/Mpc].Mean density of universe at z=0, [Msun h^2 / Mpc**3].
Spectral index of fluctuations.
Dimensionless nonlinear power spectrum.
Non-linear log power [units \(Mpc^3/h^3\)].
Dictionary of all parameters and their current values.
Normalised log power spectrum [units \(Mpc^3/h^3\)].
References for the framework itself (not its component models), each a formatted citation string.
RMS linear density fluctuations in spheres of radius 8 Mpc/h.
"tot","cb"orNone.Whether to use updated HALOFIT coefficients from Takahashi+12.
The instantiated transfer model.
Normalised CDM log transfer function.
Defines which transfer function model to use.
Relevant parameters of the transfer_model.
Redshift.
Methods
- clone(**kwargs)¶
Create and return an updated clone of the current object.
- get_acknowledgments(flat: bool = False) dict[str, tuple[str, ...]] | list[str]¶
Get the references to cite for the current setup of the framework.
The references are grouped by where they come from, in this order:
"hmf": the paper describing hmf itself.The framework’s class name (e.g.
"MassFunction"): the framework’s ownreferences, including those of its parent framework classes. Only present if there are any.Each
*_modelparameter (e.g."hmf_model","transfer_model"): the references of the model currently set on it. A model with nothing to cite gives an empty tuple; a parameter set toNoneis left out.Each sub-framework, with its keys prefixed by the sub-framework’s name (e.g.
"tracer.transfer_model").
The keys say which model each citation belongs to, not whether that model was used in a quantity you computed. All references are read from the model classes, so this does not compute anything.
- Parameters:
flat – If True, return a single list of all the references with duplicates removed (keeping the first occurrence), e.g. for a paper’s bibliography.
- Returns:
A dict mapping each source to a tuple of formatted citations, or a flat list of citations if
flatis True.- Return type:
Examples
>>> from hmf import MassFunction >>> mf = MassFunction(hmf_model="Tinker08") >>> by_model = mf.get_acknowledgments() >>> bibliography = mf.get_acknowledgments(flat=True)
- classmethod get_all_parameter_defaults(recursive=True)¶
Dictionary of all parameters and defaults.
Defaults may be set with some logic in
__init__, so they are read from an instance. The instance is not validated, so no quantities are computed.
- classmethod get_all_parameter_names() list[str]¶
Return all parameter names in the class.
These are read from the class’s
@parameterdefinitions, so the class is not instantiated.
- get_dependencies(*q)¶
Determine all parameter dependencies of the quantities in q.
- classmethod parameter_info(names=None)¶
Prints information about each parameter in the class.
Optionally, restrict printed parameters to those found in the list of names provided.
- classmethod quantities_available() list[str]¶
Obtain a list of all available (public) output quantities.
These are the class’s
@cached_quantityand@subframeworkdefinitions, read without instantiating the class.
- update(**kwargs)¶
Update parameters of the framework with kwargs.
The update is atomic: if setting any parameter, or the validation of the new set of parameters, fails, all parameters are restored to their values from before the call, and the error is re-raised.
- Parameters:
**kwargs – New values of parameters of the framework. A key
<name>_params, where<name>is a sub-framework, takes a dict of parameters with which to update that sub-framework.- Raises:
ValueError – If a key is not a parameter of the framework (or a sub-framework’s
_params), or if the new parameters fail validation.