From 9f752ed358efc4e3a190d7b48535c4e598543989 Mon Sep 17 00:00:00 2001 From: Mike Jarvis Date: Wed, 5 Jun 2024 09:51:11 -0400 Subject: [PATCH] update docs about redshift in config --- docs/config_objects.rst | 3 ++- docs/config_values.rst | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/config_objects.rst b/docs/config_objects.rst index 33c2b5e210..ce5c15ba22 100644 --- a/docs/config_objects.rst +++ b/docs/config_objects.rst @@ -274,7 +274,8 @@ and not for ``psf``. * ``resolution`` = *float_value* (optional) If the base profile allows a ``half_light_radius`` parameter, and the psf is able to calculate a ``half_light_radius``, then it is permissible to specify a resolution: resolution = r_gal / r_psf (where r_gal and r_psf are the half-light radii) in lieu of specifying the ``half_light_radius`` of the galaxy explicitly. This is especially useful if the PSF size is generated randomly. * ``signal_to_noise`` = *float_value* (optional) You may specify a signal-to-noise value rather than a ``flux``. Our definition of the S/N derives from a weighted integral of the flux in the drawn image: :math:`S = \sum W(x,y) I(x,y) / \sum W(x,y)` where :math:`W(x,y)` is taken to be a matched filter, so :math:`W(x,y) = I(x,y)`. (Note: This currently requires ``draw_method = 'fft'``. It is a bit trickier to do this for photon shooting, and we have not enabled that yet.) -* ``redshift`` = *float_value* (optional) The redshift of the galaxy. This is required when using 'NFWHaloShear' or 'NFWHaloMagnification'. +* ``redshift`` = *float_value* (optional) The redshift of the galaxy. This is required when using 'NFWHaloShear' or 'NFWHaloMagnification'. But note that this is only valid for achromatic objects. For chromatic objects, the redshift should be applied to the SED instead. + Custom Object Types ------------------- diff --git a/docs/config_values.rst b/docs/config_values.rst index ac9af207ad..08d658d466 100644 --- a/docs/config_values.rst +++ b/docs/config_values.rst @@ -103,7 +103,7 @@ Options are: * 'NFWHaloMagnification' Calculate a magnification from an NFW Halo mass. This requires that ``input.nfw_halo`` be specified and uses the following fields: - * ``gal.redshift`` = *float_value* (required) Special: The ``redshift`` item must be in the ``gal`` field, not ``magnification``. + * ``gal.redshift`` = *float_value* (required) Special: The ``redshift`` item must be in the ``gal`` field, not ``magnification``. Or if the galaxy is chromatic, it should be in the galaxy's SED field. * ``max_mu`` = *float_value* (default = 5) The maximum magnification to allow. If NFWHalo returns a mu value greater than this or less than 0, then use ``max_mu`` instead. This is a sign of strong lensing, and other approximations are probably breaking down at this point anyway, so this keeps the object profile from going crazy. * ``num`` = *int_value* (default = 0) If ``input.nfw_halo`` is a list, this indicates which number halo to use. @@ -435,7 +435,7 @@ Options are: * 'NFWHaloShear' Calculate a shear from an NFW Halo mass. This requires that ``input.nfw_halo`` be specified and uses the following fields: - * ``gal.redshift`` = *float_value* (required) Special: The ``redshift`` item must be in the ``gal`` field, not ``shear``. + * ``gal.redshift`` = *float_value* (required) Special: The ``redshift`` item must be in the ``gal`` field, not ``shear``. Or if the galaxy is chromatic, it should be in the galaxy's SED field. * ``num`` = *int_value* (default = 0) If ``input.nfw_halo`` is a list, this indicates which number halo to use. * 'List' Select items from a list.