halomod.halo_model.DMHaloModel

class halomod.halo_model.DMHaloModel(*args, **kwargs)

Dark-matter-only halo model class.

This Framework is subclassed from hmf’s MassFunction class, and operates in a similar manner.

**kwargs: anything that can be used in the MassFunction class

Methods

__init__([rmin, rmax, rnum, rlog, dr_table, …])	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.
get_all_parameter_names()	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.
quantities_available()	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

ERROR_ON_BAD_MDEF	Switch to turn off exceptions for mdef’s not matching hmf_model
Mmax	Maximum mass at which to perform analysis [units \(\log_{10}M_\odot h^{-1}\)].
Mmin	Minimum mass at which to perform analysis [units \(\log_{10}M_\odot h^{-1}\)].
bias	The halo bias as a function of halo mass.
bias_effective_matter	The effective bias of matter in DM halos.
bias_model	Bias Model.
bias_params	Dictionary of parameters for the Bias model.
cmz_relation	Concentration-mass-redshift relation.
colossus_cosmo	An instance of a COLOSSUS cosmology, which can be used to perform various COLOSSUS operations.
colossus_params	Options for colossus cosmology not set/derived in the astropy cosmology.
corr_1h_auto_matter	The halo model 1-halo dark matter auto-correlation function.
corr_1h_auto_matter_fnc	A callable returning the halo model 1-halo DM auto-correlation function.
corr_2h_auto_matter	The 2-halo term of the matter auto-correlation.
corr_2h_auto_matter_fnc	A callable returning the 2-halo term of the matter auto-correlation at arbitrary k.
corr_auto_matter	The halo-model-derived nonlinear dark matter auto-correlation function.
corr_auto_matter_fnc	A callable returning the halo-model DM auto-correlation function.
corr_halofit_mm	The nonlinear (from halofit) auto-correlation function of dark matter.
corr_halofit_mm_fnc	A callable returning the nonlinear auto-correlation function of dark matter.
corr_linear_mm	The linear auto-correlation function of dark matter.
corr_linear_mm_fnc	A callable returning the linear auto-correlation function of dark matter.
cosmo	Cosmographic object (astropy.cosmology.FLRW object), with custom cosmology from cosmo_params applied.
cosmo_model	The basis for the cosmology – see astropy documentation.
cosmo_params	Parameters for the cosmology that deviate from the base cosmology passed.
delta_c	The critical overdensity for collapse, \(\delta_c\).
delta_k	Dimensionless power spectrum, \(\Delta_k = \frac{k^3 P(k)}{2\pi^2}\).
disable_mass_conversion	Disable converting mass function from builtin definition to that provided.
dlnk	Step-size of log wave-numbers
dlog10m	log10 interval between mass bins
dndlnm	The differential mass function in terms of natural log of m, len=len(m) [units \(h^3 Mpc^{-3}\)]
dndlog10m	The differential mass function in terms of log of m, len=len(m) [units \(h^3 Mpc^{-3}\)]
dndm	The number density of haloes, len=len(m) [units \(h^4 M_\odot^{-1} Mpc^{-3}\)]
dr_table	The width of r bin.
exclusion_model	A string identifier for the type of halo exclusion used (or None).
exclusion_params	Dictionary of parameters for the Exclusion model.
filter	Instantiated model for filter/window functions.
filter_model	A model for the window/filter function.
filter_params	Model parameters for filter_model.
force_1halo_turnover	Suppress 1-halo power on scales larger than a few virial radii.
fsigma	The multiplicity function, \(f(\sigma)\), for hmf_model.
growth	The instantiated growth model.
growth_factor	The growth factor.
growth_model	The model to use to calculate the growth function/growth rate.
growth_params	Relevant parameters of the growth_model.
halo_bias	Halo bias.
halo_concentration	The concentration-mass relation.
halo_concentration_model	A halo_concentration-mass relation
halo_concentration_params	Dictionary of parameters for the concentration model.
halo_overdensity_crit	The halo overdensity with respect to the critical density.
halo_overdensity_mean	The halo overdensity with respect to the mean background.
halo_profile	A class containing the elements necessary to calculate halo halo_profile quantities.
halo_profile_lam	Mass-normalised halo profile self-convolution, with shape (len(r), len(m)).
halo_profile_model	The halo density halo_profile model.
halo_profile_params	Dictionary of parameters for the Profile model.
halo_profile_rho	Mass-normalised halo density profile, with shape (len(r), len(m)).
halo_profile_ukm	Mass-normalised fourier halo profile, with shape (len(k), len(m)).
hc_spectrum	The spectrum with which the halo-centre power spectrum is identified.
hm_dlog10k	The width of k bin in log10.
hm_logk_max	The maximum k bin in log10.
hm_logk_min	The minimum k bin in log10.
hmf	Instantiated model for the hmf fitting function.
hmf_model	A model to use as the fitting function \(f(\sigma)\)
hmf_params	Model parameters for hmf_model.
how_big	Size of simulation volume in which to expect one halo of mass m (with 95% probability), ` len=len(m)` [units \(Mpch^{-1}\)]
k	Wavenumbers, [h/Mpc]
k_hm	The wave-numbers at which halo-model power spectra are calculated.
linear_power_fnc	A callable returning the linear power as a function of k (in h/Mpc).
lnk_max	Maximum (natural) log wave-number, k [h/Mpc].
lnk_min	Minimum (natural) log wave-number, k [h/Mpc].
lnsigma	Natural log of inverse mass variance, len=len(m).
m	Halo masses (defined via mdef).
mass_nonlinear	The nonlinear mass, nu(Mstar) = 1.
mdef	The halo mass-definition model instance.
mdef_model	A model to use as the mass definition.
mdef_params	Model parameters for mdef_model.
mean_density	Mean density of universe at redshift z.
mean_density0	Mean density of universe at z=0, [Msun h^2 / Mpc**3]
mean_density_in_halos
n	Spectral index of fluctuations
n_eff	Effective spectral index at scale of halo radius, len=len(m)
ngtm	The cumulative mass function above m, len=len(m) [units \(h^3 Mpc^{-3}\)]
nonlinear_delta_k	Dimensionless nonlinear power spectrum.
nonlinear_power	Non-linear log power [units \(Mpc^3/h^3\)].
nonlinear_power_fnc	A callable returning the nonlinear (halofit) power as a function of k (in h/Mpc).
normalised_filter	A normalised filter, such that filter.sigma(8) == sigma8
nu	The parameter \(\nu = \left(\frac{\delta_c}{\sigma}\right)^2\), len=len(m)
parameter_values	Dictionary of all parameters and their current values
power	Normalised log power spectrum [units \(Mpc^3/h^3\)].
power_1h_auto_matter	The halo model-derived nonlinear 1-halo dark matter auto-power spectrum.
power_1h_auto_matter_fnc	A callable returning the halo model 1-halo DM auto-power spectrum.
power_2h_auto_matter	The halo model 2-halo matter auto-power spectrum at k_hm.
power_2h_auto_matter_fnc	Return the halo model 2-halo matter auto-power spectrum at k.
power_auto_matter	The halo-model-derived nonlinear dark power auto-power spectrum.
power_auto_matter_fnc	A callable returning the halo-model DM auto-power spectrum.
r	Scales at which correlation functions are computed [Mpc/h].
radii	The radii corresponding to the masses m.
rho_gtm	Mass density in haloes >m, len=len(m) [units \(M_\odot h^2 Mpc^{-3}\)]
rho_ltm	Mass density in haloes <m, len=len(m) [units \(M_\odot h^2 Mpc^{-3}\)]
rlog	If True, r bins are logarithmically distributed.
rmax	Maximum length scale.
rmin	Minimum length scale.
rnum	Number of r bins.
sd_bias	A class containing relevant methods to calculate scale-dependent bias corrections.
sd_bias_correction	Return the correction for scale dependancy of bias.
sd_bias_model	Model of Scale Dependant Bias.
sd_bias_params	Dictionary of parameters for Scale Dependant Bias.
sigma	The sqrt of the mass variance at z, len=len(m).
sigma_8	RMS linear density fluctuations in spheres of radius 8 Mpc/h
takahashi	Whether to use updated HALOFIT coefficients from Takahashi+12.
transfer	The instantiated transfer model
transfer_function	Normalised CDM log transfer function.
transfer_model	Defines which transfer function model to use.
transfer_params	Relevant parameters of the transfer_model.
z	Redshift.