halomod.cross_correlations.CrossCorrelations¶

class halomod.cross_correlations.CrossCorrelations(*args, **kwargs)[source]¶

Bases: Framework

The Framework for cross-correlations.

This class generates two TracerHaloModel, and calculates their cross-correlation according to the cross-correlation model given.

Parameters:

cross_hod_model (class) – Model for the HOD of cross correlation.
cross_hod_params (dict) – Parameters for HOD used in cross-correlation.
halo_model_1_params (dict) – Parameters for the tracers used in cross-correlation.
halo_model_2_params (dict) – Parameters for the tracers used in cross-correlation.

clone(**kwargs)¶: Create and return an updated clone of the current object.

property corr_1h_cross¶: The 1-halo term of the cross correlation.

property corr_1h_cross_fnc¶: The 1-halo term of the cross correlation.

property corr_2h_cross¶: The 2-halo term of the cross-correlation.

property corr_2h_cross_fnc¶: The 2-halo term of the cross-correlation.

property corr_cross¶: The tracer cross correlation function.

corr_cross_fnc(r)[source]¶: The tracer cross correlation function.

property cross_hod¶: HOD model of the cross-correlation.

property cross_hod_model¶: Parameter:

property cross_hod_params¶: Parameter:

classmethod get_all_parameter_defaults(recursive=True)¶: Dictionary of all parameters and defaults.

classmethod get_all_parameter_names()¶: Yield all parameter names in the class.

get_dependencies(*q)¶

Determine all parameter dependencies of the quantities in q.

Parameters:: q (str) – String(s) labelling a quantity
Returns:: deps – A set containing all parameters on which quantities in q are dependent.
Return type:: set

property halo_model_1: TracerHaloModel¶: Halo Model of the first tracer.

property halo_model_2: TracerHaloModel¶: Halo Model of the second tracer.

classmethod parameter_info(names=None)¶

Prints information about each parameter in the class.

Optionally, restrict printed parameters to those found in the list of names provided.

property parameter_values¶: Dictionary of all parameters and their current values

property power_1h_cross¶: Total 1-halo cross-power.

property power_1h_cross_fnc¶: Total 1-halo cross-power.

property power_2h_cross¶: The 2-halo term of the cross-power spectrum.

property power_2h_cross_fnc¶: The 2-halo term of the cross-power spectrum.

property power_cross¶: Total tracer cross power spectrum.

power_cross_fnc(k)[source]¶: Total tracer cross power spectrum.

classmethod quantities_available()¶: Obtain a list of all available output quantities.

update(**kwargs)¶: Update parameters of the framework with kwargs.

validate()¶: Perform validation of the input parameters as they relate to each other.