uvex_transients.utils.cosmology.core_collapse_rate_shape#

uvex_transients.utils.cosmology.core_collapse_rate_shape(z: float | NDArray[float64], shape: Literal['md14', 'mf17'] = 'md14') → float | NDArray[float64][source]#

Return the dimensionless redshift shape of the core-collapse SNe rate, normalized to 1 at z=0.

This is the shape f(z) in core_collapse_rate(z) = core_collapse_rate_coefficient() * core_collapse_rate_shape(z); see core_collapse_rate_coefficient.

Parameters:

z (float or array-like) – Redshift(s) at which to evaluate the shape.
shape ({"md14", "mf17"}, optional) – Cosmic star formation history prescription; see star_formation_rate. Must match whatever core_collapse_rate is implicitly using (currently always "md14") for the product with core_collapse_rate_coefficient to reproduce core_collapse_rate exactly. Default is "md14".

Returns:

The dimensionless rate shape at the specified redshift(s), equal to 1 at z=0.

Return type:

float or array-like

Raises:

ValueError – If shape is not one of the supported options.