halomod.hod.HODPoisson

class halomod.hod.HODPoisson(central: bool = False, cosmo=FlatLambdaCDM(name="Planck15", H0=67.7 km / (Mpc s), Om0=0.307, Tcmb0=2.725 K, Neff=3.05, m_nu=[0.   0.   0.06] eV, Ob0=0.0486), cm_relation: Optional[halomod.concentration.CMRelation] = None, profile: Optional[halomod.profiles.Profile] = None, mdef: Optional[hmf.halos.mass_definitions.MassDefinition] = <hmf.halos.mass_definitions.SOMean object>, **model_parameters)[source]

Base class for discrete HOD’s with poisson-distributed satellite population.

Also assumes that the amount of the tracer is statistically independent of the number counts, but its average is directly proportional to it.

This accounts for all Poisson-distributed number-count HOD’s (which is all traditional HODs).

Methods

__init__([central, cosmo, Om0, Tcmb0, Neff, …])

Initialize self.

central_occupation(m)

The occupation function of the central component.

cs_pairs(m)

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

get_models()

Get a dictionary of all implemented models for this component.

nc(m)

Amplitude of central tracer per tracer source

ns(m)

Amplitude of satellite tracer per tracer source

satellite_occupation(m)

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

sigma_central(m)

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

sigma_satellite(m)

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

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.

Attributes

central_condition_inherent

mmin

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

sharp_cut