cluster_toolkit.exclusion module

Correlation functions with halo exclusion.

cluster_toolkit.exclusion.theta_at_r(radii, rt, beta)

Truncation function.

Parameters:

• radii (float or array-like) – Radii of the profile in Mpc/h
• rt (float) – truncation radius in Mpc/h
• beta (float) – width of the truncation distribution (erfc) in Mpc/h

Returns:

Truncation function

Return type:

float or array-like

cluster_toolkit.exclusion.xi_1h_exclusion_at_r(radii, Mass, conc, alpha, rt, beta, Omega_m, delta=200)

Halo-matter correlation function with halo exclusion incorporated, but just the 1-halo term.

Parameters:

• radii (float or array-like) – Radii of the profile in Mpc/h
• Mass (float) – Mass in Msun/h
• conc (float) – concentration of the 1-halo profile
• alpha (float) – Einasto parameter
• rt (float) – truncation radius in Mpc/h
• beta (float) – width of the truncation distribution (erfc) in Mpc/h
• Omega_m (float) – Matter density fraction
• delta (float) – halo overdensity; default is 200

Returns:

1-halo of the exclusion profile at each radii

Return type:

float or array-like

cluster_toolkit.exclusion.xi_2h_exclusion_at_r(radii, r_eff, beta_eff, bias, xi_mm)

2-halo term in the halo-matter correlation function using halo exclusion theory.

Parameters:

• radii (float or array-like) – Radii of the profile in Mpc/h
• r_eff (float) – effective radius for 2-halo subtraction in Mpc/h
• beta_eff (float) – width for effective radius truncation
• bias (float) – halo bias at large scales
• xi_mm (float or array-like) – matter correlation function. Must have same shape as the radii.

Returns:

2-halo of the exclusion profile at each radii

Return type:

float or array-like

cluster_toolkit.exclusion.xi_C_at_r(radii, r_A, r_B, beta_ex, xi_2h)

Halo-matter correlation function with halo exclusion incorporated.

Parameters:

• radii (float or array-like) – Radii of the profile in Mpc/h
• r_A (float) – radius of first correction term in Mpc/h
• r_B (float) – radius of second correction term in Mpc/h
• beta_ex (float) – width parameter for exclusion terms
• xi_2h (float or array-like) – 2-halo term of the exclusion profile

Returns:

correction term for the exclusion profile

Return type:

float or array-like

cluster_toolkit.exclusion.xi_hm_exclusion_at_r(radii, Mass, conc, alpha, rt, beta, r_eff, beta_eff, r_A, r_B, beta_ex, bias, xi_mm, Omega_m, delta=200)

Halo-matter correlation function with halo exclusion incorporated.

Parameters:

• radii (float or array-like) – Radii of the profile in Mpc/h
• Mass (float) – Mass in Msun/h
• conc (float) – concentration of the 1-halo profile
• alpha (float) – Einasto parameter
• rt (float) – truncation radius in Mpc/h
• beta (float) – width of the truncation distribution (erfc) in Mpc/h
• r_eff (float) – effective radius for 2-halo subtraction in Mpc/h
• beta_eff (float) – width for effective radius truncation
• r_A (float) – radius of first correction term in Mpc/h
• r_B (float) – radius of second correction term in Mpc/h
• beta_ex (float) – width parameter for exclusion terms
• bias (float) – linear halo bias
• xi_mm (float or array-like) – matter correlation function. same shape as radii
• Omega_m (float) – matter density fraction
• delta (int) – halo overdensity. Default is 200

Returns:

exclusion profile at each radii

Return type:

float or array-like