Bases: object
Composite HOD model object. The primary methods are for assigning the mean occupation of a galaxy population to a halo, the intra-halo radial profile of that population, and the accompanying methods to generate Monte Carlo realizations of those methods.
All behavior is derived from external classes passed to the constructor via component_model_dict, which serves as a set of instructions for how the composite model is to be built from the components.
The methods of this class derives their behavior from other, external classes, passed in the form of the component_model_dict, a dictionary whose keys are the galaxy types found in the halos, e.g., ‘centrals’, ‘satellites’, ‘orphans’, etc. The values of the component_model_dict are themselves dictionaries whose keys are strings specifying the type of model being passed, e.g., ‘occupation_model’, and values are instances of that type of model. The component_model_dict dictionary is built by the hod_designer interface. The input halo_prof_model is an instance of the class governing the assumed profile of the underlying halos.
Methods Summary
| mc_coords(gal_type, *args) | Method returning a Monte Carlo realization of the radial profile. |
| mc_occupation(gal_type, halo_table) | Method providing a Monte Carlo realization of the mean occupation. |
| mean_occupation(gal_type, *args) | Method supplying the mean abundance of gal_type galaxies. |
| mean_profile_parameters(gal_type, *args) | Method returning the mean value of the parameters governing the radial profile of gal_type galaxies. |
| retrieve_all_inherited_parameters(...) | |
| retrieve_component_behavior(...) | Wrapper method whose purpose is solely to call the component model methods using the correct number of arguments. |
| test_component_consistency(gal_type, ...) | Simple tests to run to make sure that the desired behavior can be found in the component model. |
| test_model_redundancy(...) | Check whether the new_model_component dictionary contains keys that duplicate the keys in the existing_composite_model dictionary. |
Methods Documentation
Method returning a Monte Carlo realization of the radial profile. The behavior of this method is inherited from one of the component models.
Method providing a Monte Carlo realization of the mean occupation. The behavior of this method is inherited from one of the component models.
Method supplying the mean abundance of gal_type galaxies. The behavior of this method is inherited from one of the component models.
Method returning the mean value of the parameters governing the radial profile of gal_type galaxies. The behavior of this method is inherited from one of the component models.
Wrapper method whose purpose is solely to call the component model methods using the correct number of arguments. Purely for user convenience.
Simple tests to run to make sure that the desired behavior can be found in the component model.
Check whether the new_model_component dictionary contains keys that duplicate the keys in the existing_composite_model dictionary.