halomod.cross_correlations.CrossCorrelations

class halomod.cross_correlations.CrossCorrelations(*args, **kwargs)

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.

Methods

__init__(cross_hod_model[, …])	Initialize self.
clone(**kwargs)	Create and return an updated clone of the current object.
corr_cross_fnc(r)	The tracer cross correlation function.
get_all_parameter_defaults([recursive])	Dictionary of all parameters and defaults.
get_all_parameter_names()	Yield all parameter names in the class.
get_dependencies(*q)	Determine all parameter dependencies of the quantities in q.
parameter_info([names])	Prints information about each parameter in the class.
power_cross_fnc(k)	Total tracer cross power spectrum.
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.

Attributes

corr_1h_cross	The 1-halo term of the cross correlation
corr_1h_cross_fnc	The 1-halo term of the cross correlation
corr_2h_cross	The 2-halo term of the cross-correlation.
corr_2h_cross_fnc	The 2-halo term of the cross-correlation.
corr_cross	The tracer cross correlation function.
cross_hod	HOD model of the cross-correlation
cross_hod_model	Parameter:
cross_hod_params	Parameter:
halo_model_1	Halo Model of the first tracer
halo_model_2	Halo Model of the second tracer
parameter_values	Dictionary of all parameters and their current values
power_1h_cross	Total 1-halo cross-power.
power_1h_cross_fnc	Total 1-halo cross-power.
power_2h_cross	The 2-halo term of the cross-power spectrum.
power_2h_cross_fnc	The 2-halo term of the cross-power spectrum.
power_cross	Total tracer cross power spectrum.