halomod.hod.HOD

class halomod.hod.HOD(central: bool = False, cosmo=FlatLambdaCDM(name='Planck15', H0=<Quantity 67.74 km / (Mpc s)>, Om0=0.3075, Tcmb0=<Quantity 2.7255 K>, Neff=3.046, m_nu=<Quantity [0., 0., 0.06] eV>, Ob0=0.0486), cm_relation: ~halomod.concentration.CMRelation | None = None, profile: ~halomod.profiles.Profile | None = None, mdef: ~hmf.halos.mass_definitions.MassDefinition | None = <hmf.halos.mass_definitions.SOMean object>, **model_parameters)

Bases: Component

Halo Occupation Distribution model base class.

This class should not be called directly. The user should call a derived class.

As with all hmf._framework.Model classes, each class should specify its parameters in a _defaults dictionary at class-level.

The exception to this is the M_min parameter, which is defined for every model (it may still be defined to modify the default). This parameter acts as the one that may be set via the mean density given all the other parameters. If the model has a sharp cutoff at low mass, corresponding to M_min, the extra parameter sharp_cut may be set to True, allowing for simpler setting of M_min via this route.

See the derived classes in this module for examples of how to define derived classes of HOD.

central_condition_inherent = False

central_occupation(m)

The occupation function of the central component.

abstract cs_pairs(m)

The average amount of the tracer coupled with itself in haloes of mass m, <T_s T_c>.

classmethod get_models() → Dict[str, Type]

Get a dictionary of all implemented models for this component.

property mmin

Defines a reasonable minimum mass to set for this HOD to converge when integrated.

abstract nc(m)

Defines the average number of centrals at mass m.

Useful for populating catalogues.

abstract ns(m)

Defines the average number of satellites at mass m.

Useful for populating catalogues.

satellite_occupation(m)

The occupation function of the satellite (or profile-dependent) component.

sharp_cut = False

abstract sigma_central(m)

The standard deviation of the central tracer amount in haloes of mass m.

abstract sigma_satellite(m)

The standard deviation of the satellite tracer amount in haloes of mass m.

abstract ss_pairs(m)

The average amount of the tracer coupled with itself in haloes of mass m, <T_s T_s>.

total_occupation(m)

The total (average) occupation of the halo.

total_pair_function(m)

The total weight of the occupation paired with itself.

unit_conversion(cosmo, z)

A factor to convert the total occupation to a desired unit.