clmm.utils.units module

General utility functions that are used in multiple modules

clmm.utils.units.convert_units(dist1, unit1, unit2, redshift=None, cosmo=None)[source]

Convenience wrapper to convert between a combination of angular and physical units.

Supported units: radians, degrees, arcmin, arcsec, Mpc, kpc, pc (letter case independent)

To convert between angular and physical units you must provide both redshift and a CLMM Cosmology object cosmo.

Parameters:

  • dist1 (float, array_like) -- Input distances

  • unit1 (str) -- Unit for the input distances

  • unit2 (str) -- Unit for the output distances

  • redshift (float, None, optional) -- Redshift used to convert between angular and physical units. Default: None

  • cosmo (clmm.Cosmology, None, optional) -- CLMM Cosmology object to compute angular diameter distance to convert between physical and angular units. Default: None

Returns:

dist2 -- Input distances converted to unit2

Return type:

float, numpy.ndarray