a ߙfb2@sdZddlmZddlmZgdZddgiZe Z ej dgde d d d id Z ej d ge ddd didZ ddZd ddZd!ddZd"ddZd#dddddddZd$ddZeeedureee 7ZdS)%z&Cosmological units and equivalencies. N)generate_unit_summary)littlehredshiftdimensionless_redshift with_redshiftredshift_distanceredshift_hubbleredshift_temperaturewith_H0)rrZscipyrFzCosmological redshift.Zlatex)prefixes namespacedocformatrz'Reduced/"dimensionless" Hubble constantzh_{100})r r rrcCsttdfgdS)aNAllow redshift to be 1-to-1 equivalent to dimensionless. It is special compared to other equivalency pairs in that it allows this independent of the power to which the redshift is raised, and independent of whether it is part of a more complicated unit. It is similar to u.dimensionless_angles() in this respect. Nr)u Equivalencyrrr6lib/python3.9/site-packages/astropy/cosmology/units.pyr,srcomovingc sddlm}m|dur|n|}|||}Wdn1sL0Yd}||vrptd|t||dfdd}fd d }tt tj ||fgd ||d S) aConvert quantities between redshift and distance. Care should be taken to not misinterpret a relativistic, gravitational, etc redshift as a cosmological one. Parameters ---------- cosmology : `~astropy.cosmology.Cosmology`, str, or None, optional A cosmology realization or built-in cosmology's name (e.g. 'Planck18'). If None, will use the default cosmology (controlled by :class:`~astropy.cosmology.default_cosmology`). kind : {'comoving', 'lookback', 'luminosity'} or None, optional The distance type for the Equivalency. Note this does NOT include the angular diameter distance as this distance measure is not monotonic. **atzkw keyword arguments for :func:`~astropy.cosmology.z_at_value` Returns ------- `~astropy.units.equivalencies.Equivalency` Equivalency between redshift and temperature. Examples -------- >>> import astropy.units as u >>> import astropy.cosmology.units as cu >>> from astropy.cosmology import WMAP9 >>> z = 1100 * cu.redshift >>> z.to(u.Mpc, cu.redshift_distance(WMAP9, kind="comoving")) # doctest: +FLOAT_CMP rdefault_cosmology z_at_valueN)rZlookbackZ luminosityz`kind` is not one of Z _distancecs|S)zRedshift to distance.rz)methodrr z_to_distancefsz(redshift_distance..z_to_distancecs|tj>fiS)zDistance to redshift.)rMpc)datzkwrrrr distance_to_zjsz(redshift_distance..distance_to_zr) cosmologydistance) astropy.cosmologyrrgetset ValueErrorgetattrrrrr)r!kindrrZ allowed_kindsrr rrrr7s" & rc sddlm}mdurn|||Wdn1sL0Yfddfddfdd }fd d }tttjtj tj ftt ||fgd d iS)aConvert quantities between redshift and Hubble parameter and little-h. Care should be taken to not misinterpret a relativistic, gravitational, etc redshift as a cosmological one. Parameters ---------- cosmology : `~astropy.cosmology.Cosmology`, str, or None, optional A cosmology realization or built-in cosmology's name (e.g. 'Planck18'). If None, will use the default cosmology (controlled by :class:`~astropy.cosmology.default_cosmology`). **atzkw keyword arguments for :func:`~astropy.cosmology.z_at_value` Returns ------- `~astropy.units.equivalencies.Equivalency` Equivalency between redshift and Hubble parameter and little-h unit. Examples -------- >>> import astropy.units as u >>> import astropy.cosmology.units as cu >>> from astropy.cosmology import WMAP9 >>> z = 1100 * cu.redshift >>> equivalency = cu.redshift_hubble(WMAP9) # construct equivalency >>> z.to(u.km / u.s / u.Mpc, equivalency) # doctest: +FLOAT_CMP >>> z.to(cu.littleh, equivalency) # doctest: +FLOAT_CMP rrNcs |S)zRedshift to Hubble parameter.Hrr!rr z_to_hubblesz$redshift_hubble..z_to_hubblecs&j|tjtjtj>fiS)zHubble parameter to redshift.)r*rkmsrr)rr!rrr hubble_to_zsz$redshift_hubble..hubble_to_zcs$|tjtjtjdtS)z$Redshift to :math:`h`-unit Quantity.d)to_valuerr-r.rrr)r,rr z_to_littlehsz%redshift_hubble..z_to_littlehcs |dS)z$:math:`h`-unit Quantity to redshift.r1r)h)r0rr littleh_to_zsz%redshift_hubble..littleh_to_zrr!) r#rrr$r%rrrr-r.rr)r!rrr3r5r)rr!r0rr,rrss# &    rc sddlm}mdurn|||Wdn1sL0Yfdd}fdd}tttj||fgdd iS) aConvert quantities between redshift and CMB temperature. Care should be taken to not misinterpret a relativistic, gravitational, etc redshift as a cosmological one. Parameters ---------- cosmology : `~astropy.cosmology.Cosmology`, str, or None, optional A cosmology realization or built-in cosmology's name (e.g. 'Planck18'). If None, will use the default cosmology (controlled by :class:`~astropy.cosmology.default_cosmology`). **atzkw keyword arguments for :func:`~astropy.cosmology.z_at_value` Returns ------- `~astropy.units.equivalencies.Equivalency` Equivalency between redshift and temperature. Examples -------- >>> import astropy.units as u >>> import astropy.cosmology.units as cu >>> from astropy.cosmology import WMAP9 >>> z = 1100 * cu.redshift >>> z.to(u.K, cu.redshift_temperature(WMAP9)) rrNcs |SN)Tcmbrr+rr z_to_Tcmbsz'redshift_temperature..z_to_Tcmbcsj|tj>fiSr6)r7rK)Tr/rr Tcmb_to_zsz'redshift_temperature..Tcmb_to_zr r!) r#rrr$r%rrrr9)r!rrr8r;rr/rr s & r T)r"hubbler7rc Csddlm}m}|dur|n|}|||}Wdn1sL0Y|durb|ni}g}|r|t|fi||r|t|fi||dur|t|fd|i|t |d||||dS)aConvert quantities between measures of cosmological distance. Note: by default all equivalencies are on and must be explicitly turned off. Care should be taken to not misinterpret a relativistic, gravitational, etc redshift as a cosmological one. Parameters ---------- cosmology : `~astropy.cosmology.Cosmology`, str, or None, optional A cosmology realization or built-in cosmology's name (e.g. 'Planck18'). If `None`, will use the default cosmology (controlled by :class:`~astropy.cosmology.default_cosmology`). distance : {'comoving', 'lookback', 'luminosity'} or None (optional, keyword-only) The type of distance equivalency to create or `None`. Default is 'comoving'. hubble : bool (optional, keyword-only) Whether to create a Hubble parameter <-> redshift equivalency, using ``Cosmology.H``. Default is `True`. Tcmb : bool (optional, keyword-only) Whether to create a CMB temperature <-> redshift equivalency, using ``Cosmology.Tcmb``. Default is `True`. atzkw : dict or None (optional, keyword-only) keyword arguments for :func:`~astropy.cosmology.z_at_value` Returns ------- `~astropy.units.equivalencies.Equivalency` With equivalencies between redshift and distance / Hubble / temperature. Examples -------- >>> import astropy.units as u >>> import astropy.cosmology.units as cu >>> from astropy.cosmology import WMAP9 >>> equivalency = cu.with_redshift(WMAP9) >>> z = 1100 * cu.redshift Redshift to (comoving) distance: >>> z.to(u.Mpc, equivalency) # doctest: +FLOAT_CMP Redshift to the Hubble parameter: >>> z.to(u.km / u.s / u.Mpc, equivalency) # doctest: +FLOAT_CMP >>> z.to(cu.littleh, equivalency) # doctest: +FLOAT_CMP Redshift to CMB temperature: >>> z.to(u.K, equivalency) rrNr(r)r!r"r<r7) r#rrr$r%extendrr rrr)r!r"r<r7rrrZequivsrrrrs"= &rcCs^|durddlm}|j}td|tjtjtj t }tj |dfgdd|idS)aD Convert between quantities with little-h and the equivalent physical units. Parameters ---------- H0 : None or `~astropy.units.Quantity` ['frequency'] The value of the Hubble constant to assume. If a `~astropy.units.Quantity`, will assume the quantity *is* ``H0``. If `None` (default), use the ``H0`` attribute from :mod:`~astropy.cosmology.default_cosmology`. References ---------- For an illuminating discussion on why you may or may not want to use little-h at all, see https://arxiv.org/pdf/1308.4150.pdf N)rr1r H0)kwargs) Z realizationsrr$r?rZUnitr2r-r.rrr)r?rZ h100_val_unitrrrr >s   &r )Nr)N)N)N)N)__doc__Z astropy.unitsZunitsrZastropy.units.utilsrZ_generate_unit_summary__all__Z__doctest_requires__globalsZ_nsZdef_unitrrrrrr rr Zadd_enabled_equivalenciesrrrrs0       < @ 0 [