halomod.wdm.HaloModelWDM¶
- class halomod.wdm.HaloModelWDM(*args, **kwargs)[source]¶
This class is a derivative of HaloModel which sets a few defaults that make more sense for a WDM model, and also implements the framework to include a smooth component.
See Schneider et al. 2012 for details on the smooth component.
Methods
__init__
(**kw)Initializer for the class.
clone
(**kwargs)Create and return an updated clone of the current object.
get_all_parameter_defaults
([recursive])Dictionary of all parameters and defaults.
Yield all parameter names in the class.
get_dependencies
(*q)Determine all parameter dependencies of the quantities in q.
parameter_info
([names])Prints information about each parameter in the class.
power_hh
(k[, mmin, mmax, mmin2, mmax2])The halo-centre power spectrum of haloes in a given mass range.
Obtain a list of all available output quantities.
update
(**kwargs)Update parameters of the framework with kwargs.
validate
()Perform validation of the input parameters as they relate to each other.
Attributes
Switch to turn off exceptions for mdef’s not matching hmf_model
Maximum mass at which to perform analysis [units \(\log_{10}M_\odot h^{-1}\)].
Minimum mass at which to perform analysis [units \(\log_{10}M_\odot h^{-1}\)].
A model for empirical recalibration of the HMF.
Model parameters for alter_model.
The halo bias as a function of halo mass.
The effective bias of matter in DM halos.
Bias Model.
Dictionary of parameters for the Bias model.
Bias of smooth component of the field
Concentration-mass-redshift relation.
An instance of a COLOSSUS cosmology, which can be used to perform various COLOSSUS operations.
Options for colossus cosmology not set/derived in the astropy cosmology.
The halo model 1-halo dark matter auto-correlation function.
A callable returning the halo model 1-halo DM auto-correlation function.
The 2-halo term of the matter auto-correlation.
A callable returning the 2-halo term of the matter auto-correlation at arbitrary k.
The halo-model-derived nonlinear dark matter auto-correlation function.
A callable returning the halo-model DM auto-correlation function.
The nonlinear (from halofit) auto-correlation function of dark matter.
A callable returning the nonlinear auto-correlation function of dark matter.
The linear auto-correlation function of dark matter.
A callable returning the linear auto-correlation function of dark matter.
Cosmographic object (
astropy.cosmology.FLRW
object), with custom cosmology fromcosmo_params
applied.The basis for the cosmology – see astropy documentation.
Parameters for the cosmology that deviate from the base cosmology passed.
The critical overdensity for collapse, \(\delta_c\).
Dimensionless power spectrum, \(\Delta_k = \frac{k^3 P(k)}{2\pi^2}\).
Disable converting mass function from builtin definition to that provided.
Step-size of log wave-numbers
log10 interval between mass bins
The differential mass function in terms of natural log of m,
len=len(m)
[units \(h^3 Mpc^{-3}\)]The differential mass function in terms of log of m,
len=len(m)
[units \(h^3 Mpc^{-3}\)]The number density of haloes in WDM,
len=len(m)
.The width of r bin.
A string identifier for the type of halo exclusion used (or None).
Dictionary of parameters for the Exclusion model.
The total fraction of mass bound up in halos.
Instantiated model for filter/window functions.
A model for the window/filter function.
Model parameters for filter_model.
Suppress 1-halo power on scales larger than a few virial radii.
The multiplicity function, \(f(\sigma)\), for hmf_model.
The instantiated growth model.
The growth factor.
The model to use to calculate the growth function/growth rate.
Relevant parameters of the
growth_model
.Halo bias.
Halo Concentration
A halo_concentration-mass relation
Dictionary of parameters for the concentration model.
The halo overdensity with respect to the critical density.
The halo overdensity with respect to the mean background.
A class containing the elements necessary to calculate halo halo_profile quantities.
Mass-normalised halo profile self-convolution, with shape (len(r), len(m)).
The halo density halo_profile model.
Dictionary of parameters for the Profile model.
Mass-normalised halo density profile, with shape (len(r), len(m)).
Mass-normalised fourier halo profile, with shape (len(k), len(m)).
The spectrum with which the halo-centre power spectrum is identified.
The width of k bin in log10.
The maximum k bin in log10.
The minimum k bin in log10.
Instantiated model for the hmf fitting function.
A model to use as the fitting function \(f(\sigma)\)
Model parameters for hmf_model.
Size of simulation volume in which to expect one halo of mass m (with 95% probability), ` len=len(m)` [units \(Mpch^{-1}\)]
Wavenumbers, [h/Mpc]
The wave-numbers at which halo-model power spectra are calculated.
A callable returning the linear power as a function of k (in h/Mpc).
Maximum (natural) log wave-number,
k
[h/Mpc].Minimum (natural) log wave-number,
k
[h/Mpc].Natural log of inverse mass variance,
len=len(m)
.Halo masses (defined via
mdef
).The nonlinear mass, nu(Mstar) = 1.
The halo mass-definition model instance.
A model to use as the mass definition.
Model parameters for mdef_model.
Mean density of universe at redshift z.
Mean density of universe at z=0, [Msun h^2 / Mpc**3]
Mean density of matter in halos
Mean density of matter outside halos
Spectral index of fluctuations
Effective spectral index at scale of halo radius,
len=len(m)
The cumulative mass function above m,
len=len(m)
[units \(h^3 Mpc^{-3}\)]Dimensionless nonlinear power spectrum.
Non-linear log power [units \(Mpc^3/h^3\)].
A callable returning the nonlinear (halofit) power as a function of k (in h/Mpc).
A normalised filter, such that filter.sigma(8) == sigma8
The parameter \(\nu = \left(\frac{\delta_c}{\sigma}\right)^2\),
len=len(m)
Dictionary of all parameters and their current values
Normalised log power spectrum [units \(Mpc^3/h^3\)].
The halo model-derived nonlinear 1-halo dark matter auto-power spectrum.
A callable returning the halo model 1-halo DM auto-power spectrum.
The halo model 2-halo matter auto-power spectrum at
k_hm
.Return the halo model 2-halo matter auto-power spectrum at k.
Auto power spectrum of dark matter
A callable returning the halo-model DM auto-power spectrum.
The halo-halo matter power spectrum (includes both 1-halo and 2-halo terms).
The smooth-halo cross power spectrum.
The smooth-smooth matter power spectrum.
Scales at which correlation functions are computed [Mpc/h].
The radii corresponding to the masses m.
Mass density in haloes >m,
len=len(m)
[units \(M_\odot h^2 Mpc^{-3}\)]Mass density in haloes <m,
len=len(m)
[units \(M_\odot h^2 Mpc^{-3}\)]If True, r bins are logarithmically distributed.
Maximum length scale.
Minimum length scale.
Number of r bins.
A class containing relevant methods to calculate scale-dependent bias corrections.
Return the correction for scale dependancy of bias.
Model of Scale Dependant Bias.
Dictionary of parameters for Scale Dependant Bias.
The sqrt of the mass variance at z,
len=len(m)
.RMS linear density fluctuations in spheres of radius 8 Mpc/h
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.
The instantiated WDM model.
Mass of the WDM particle.
A model for the WDM effect on the transfer function.
Parameters of the WDM model.
Redshift.