plima.models.halo_model#

Halo model intrinsic alignment parameter models.

Functions

halo_model_ia_parameters(z, *[, a_ia, ...])

Return redshift dependent halo model IA parameters.

plima.models.halo_model.halo_model_ia_parameters(z, *, a_ia=1.0, eta_ia=0.0, a1h=0.001, eta_1h=0.0, b=-2.0, z_pivot=0.62, k_1h=None, k_2h=None)[source]#

Return redshift dependent halo model IA parameters.

Parameters:
  • z (ArrayLike) – Redshift values.

  • a_ia (float) – Large scale intrinsic alignment amplitude at the pivot redshift.

  • eta_ia (float) – Redshift evolution index for a_ia.

  • a1h (float) – Satellite one halo alignment amplitude at the pivot redshift.

  • eta_1h (float) – Redshift evolution index for a1h.

  • b (float) – Satellite shear radial power law slope.

  • z_pivot (float) – Pivot redshift.

  • k_1h (float | None) – One halo transition scale. If None, this parameter is omitted.

  • k_2h (float | None) – Two halo damping scale. If None, this parameter is omitted.

Returns:

Dictionary containing halo model IA parameter arrays.

Raises:
  • ValueError – If any numerical input is not finite.

  • ValueError – If any redshift value is less than or equal to -1.

  • ValueError – If z_pivot is less than or equal to -1.

  • ValueError – If k_1h or k_2h is not positive.

Return type:

dict[str, ndarray[tuple[Any, …], dtype[float64]]]