lfkit.utils.validators module#

Validation utilities.

lfkit.utils.validators.validate_array(x, *, name, allow_negative=True)[source]#

Return a finite float array.

Parameters:

  • x (float | Sequence[float] | ndarray[tuple[Any, ...], dtype[float64]])

  • name (str)

  • allow_negative (bool)

Return type:

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

lfkit.utils.validators.validate_luminosity_distance(luminosity_distance_mpc)[source]#

Return finite positive luminosity distances in Mpc.

Parameters:

luminosity_distance_mpc (float | Sequence[float] | ndarray[tuple[Any, ...], dtype[float64]])

Return type:

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

lfkit.utils.validators.validate_magnitude_range(*, m_bright, m_faint)[source]#

Validate bright and faint magnitude bounds.

Parameters:

  • m_bright (float)

  • m_faint (float)

Return type:

None