LSST Applications g063fba187b+fee0456c91,g0f08755f38+ea96e5a5a3,g1653933729+a8ce1bb630,g168dd56ebc+a8ce1bb630,g1a2382251a+90257ff92a,g20f6ffc8e0+ea96e5a5a3,g217e2c1bcf+937a289c59,g28da252d5a+daa7da44eb,g2bbee38e9b+253935c60e,g2bc492864f+253935c60e,g3156d2b45e+6e55a43351,g32e5bea42b+31359a2a7a,g347aa1857d+253935c60e,g35bb328faa+a8ce1bb630,g3a166c0a6a+253935c60e,g3b1af351f3+a8ce1bb630,g3e281a1b8c+c5dd892a6c,g414038480c+416496e02f,g41af890bb2+afe91b1188,g599934f4f4+0db33f7991,g7af13505b9+e36de7bce6,g80478fca09+da231ba887,g82479be7b0+a4516e59e3,g858d7b2824+ea96e5a5a3,g89c8672015+f4add4ffd5,g9125e01d80+a8ce1bb630,ga5288a1d22+bc6ab8dfbd,gb58c049af0+d64f4d3760,gc28159a63d+253935c60e,gcab2d0539d+3f2b72788c,gcf0d15dbbd+4ea9c45075,gda6a2b7d83+4ea9c45075,gdaeeff99f8+1711a396fd,ge79ae78c31+253935c60e,gef2f8181fd+3031e3cf99,gf0baf85859+c1f95f4921,gfa517265be+ea96e5a5a3,gfa999e8aa5+17cd334064,w.2024.50
LSST Data Management Base Package
|
Functions | |
remove_signal_from_variance (exposure, gain=None, gains=None, average_across_amps=False, in_place=False) | |
Utility functions related to the variance plane of Exposure objects. Tested in `ip_isr/tests/test_variance_plane.py` to avoid circular dependencies.
lsst.meas.algorithms.variance_plane.remove_signal_from_variance | ( | exposure, | |
gain = None, | |||
gains = None, | |||
average_across_amps = False, | |||
in_place = False ) |
Removes the Poisson contribution from actual sources in the variance plane of an Exposure. If neither gain nor gains are provided, the function estimates the gain(s). If ``average_across_amps`` is True, a single gain value for the entire image is estimated. If False, individual gain values for each amplifier are estimated. The estimation involves a linear fit of variance versus image plane. Parameters ---------- exposure : `~lsst.afw.image.Exposure` The background-subtracted exposure containing a variance plane to be corrected for source contributions. gain : `float`, optional The gain value for the entire image. This parameter is used if ``gains`` is not provided. If both ``gain`` and ``gains`` are None, and ``average_across_amps`` is True, ``gain`` is estimated from the image and variance planes. gains : dict[`str`, `float`], optional A dictionary mapping amplifier ID (as a string) to gain value. This parameter is used if ``gain`` is not provided. If both ``gain`` and ``gains`` are None, and ``average_across_amps`` is False, ``gains`` are estimated from the image and variance planes. average_across_amps : `bool`, optional Determines the gain estimation strategy. If True, the gain for the entire image is estimated at once. If False, individual gains for each amplifier are estimated. This parameter is ignored if either ``gain`` or ``gains`` is specified. in_place : `bool`, optional If True, the variance plane of the input Exposure is modified in place. A modified copy of the variance plane is always returned irrespective of this. Returns ------- variance_plane : `~lsst.afw.image.Image` The corrected variance plane, with the signal contribution removed. Raises ------ AttributeError If amplifiers cannot be retrieved from the exposure. ValueError If both ``gain`` and ``gains`` are provided, or if the number of provided ``gains`` does not match the number of amplifiers.
Definition at line 31 of file variance_plane.py.