astropy:docs

Satcen_Correlation_Polynomial_HOD_Model

class halotools.halo_occupation.Satcen_Correlation_Polynomial_HOD_Model(baseline_hod_model=<class 'halotools.halo_occupation.Zheng07_HOD_Model'>, baseline_hod_parameter_dict=None, threshold=None, assembias_parameter_dict=None)[source] [edit on github]

Bases: halotools.halo_occupation.Assembias_HOD_Model

HOD-style model in which satellite abundance is correlated with the presence of a central galaxy.

Notes

This is special case of assembly biased occupation statistics. It is implemented in HOD_Mock by setting the halo type of satellites after centrals have been assigned to halos (satellite halo type = 1 if there is a central in the halo).

Attributes Summary

baseline_hod_model
primary_halo_property_key
secondary_halo_property_centrals_key
secondary_halo_property_satellites_key

Methods Summary

halo_type1_fraction_centrals(...) Determines the fractional representation of host halo types as a function of the value of the primary halo property.
halo_type1_fraction_satellites(...) Determines the fractional representation of host halo types as a function of the value of the primary halo property.
mean_concentration(primary_halo_property, ...) Concentration-halo relation assumed by the underlying HOD_Model object.
require_correct_keys(assembias_parameter_dict)
unconstrained_central_inflection_halo_type1(...)
unconstrained_polynomial_model(abcissa, ...)
unconstrained_satellite_inflection_halo_type1(...)

Attributes Documentation

baseline_hod_model
primary_halo_property_key
secondary_halo_property_centrals_key
secondary_halo_property_satellites_key

Methods Documentation

halo_type1_fraction_centrals(primary_halo_property)[source] [edit on github]

Determines the fractional representation of host halo types as a function of the value of the primary halo property.

Halo types can be either given by fixed-Mvir rank-orderings of the host halos, or by the input occupation statistics functions.

halo_type1_fraction_satellites(primary_halo_property)[source] [edit on github]

Determines the fractional representation of host halo types as a function of the value of the primary halo property.

Halo types can be either given by fixed-Mvir rank-orderings of the host halos, or by the input occupation statistics functions.

mean_concentration(primary_halo_property, halo_type)[source] [edit on github]

Concentration-halo relation assumed by the underlying HOD_Model object. The appropriate method is already bound to the self.baseline_hod_model object.

Parameters:

primary_halo_property : array_like

array of primary halo property governing the occupation statistics

halo_type : array

array of halo types.

Returns:

concentrations : numpy array

require_correct_keys(assembias_parameter_dict)[source] [edit on github]
unconstrained_central_inflection_halo_type1(primary_halo_property)[source] [edit on github]
unconstrained_polynomial_model(abcissa, ordinates, primary_halo_property)[source] [edit on github]
unconstrained_satellite_inflection_halo_type1(primary_halo_property)[source] [edit on github]