Creating composite profiles
This unit implements a constructor for profiles that consist of an inner (orbiting, or 1-halo) term and one ore more outer (infalling, 2-halo) terms. Please see Halo Density Profiles for a general introduction and a list of implemented profile forms, as well as Tutorials for coding examples.
Module contents
|
A wrapper function to create a profile with or without outer profile term(s). |
|
Utility function that translates the name of a profile model into its class. |
Module reference
- halo.profile_composite.compositeProfile(inner_name=None, outer_names=['mean', 'pl'], **kwargs)
A wrapper function to create a profile with or without outer profile term(s).
At large radii, fitting functions for halo density profiles only make sense if they are combined with a description of the profile of infalling matter and/or the two-halo term, that is, the statistical contribution from other halos. This function provides a convenient way to construct such profiles without having to set the properties of the outer terms manually. Valid short codes for the inner and outer terms are listed in Halo Density Profiles.
The function can take any combination of keyword arguments that is accepted by the constructors of the various profile terms. Note that some parameters, such as
z, can be accepted by multiple constructors; this is by design.- Parameters
- inner_name: str
A shortcode for a density profile class (see Halo Density Profiles for a list).
- outer_names: array_like
A list of shortcodes for one or more outer (infalling) terms (see Halo Density Profiles for a list).
- kwargs: kwargs
The arguments passed to the profile constructors.
- halo.profile_composite.getProfileClass(name)
Utility function that translates the name of a profile model into its class.
This function does not distinguish between inner and outer profiles.
- Parameters
- name: str
A shortcode for a density profile class (see Halo Density Profiles for a list).
- Returns
- cls: class
The profile class.