hmf.mass_definitions

Models defining various definitions of halo mass.

This is primarily inspired by Benedikt Diemer’s COLOSSUS code: https://bdiemer.bitbucket.io/colossus/halo_mass_defs.html.

Definitions include both spherical overdensity (with various overdensities) and friends-of-friends (with various linking lengths). The main class is BaseMassDefinition, which defines the interface for all mass definitions.

Base Component(s)

BaseMassDefinition(**model_params)

A base class for a Mass Definition.

Models

FOF(**model_params)	A mass definition based on FroF networks with given linking length.
MassDefinition
SOCritical(**model_params)	A mass definition based on spherical overdensity wrt critical density.
SOGeneric([preferred])	A generic SO definition which can claim equality with any SO.
SOMean(**model_params)	A mass definition based on spherical overdensity wrt mean background density.
SOVirial(**model_params)	A mass definition based on spherical overdensity.
SphericalOverdensity(**model_params)	An abstract base class for all spherical overdensity mass definitions.

Functions

from_colossus_name(name)

Exceptions

OptimizationError

Exception class related to failed optimization.