lsst.meas.algorithms g1d3acf762d+f7d6f6868b
Loading...
Searching...
No Matches
lsst.meas.algorithms.computeExPsf.ComputeExPsfTask Class Reference
Inheritance diagram for lsst.meas.algorithms.computeExPsf.ComputeExPsfTask:

Public Member Functions

pipeBase.Struct run (self, npt.NDArray de1, npt.NDArray de2, npt.NDArray ra, npt.NDArray dec, str units="arcmin")
 

Static Public Attributes

 ConfigClass = ComputeExPsfConfig
 

Static Protected Attributes

str _DefaultName = "computeExPsf"
 

Detailed Description

Compute Ex for PSF.

Compute scalar correlation function from
PSF ellipticity residuals to compute TEx
metrics.

Parameters
----------
de1: `np.ndarray`
    PSF ellipticity residuals component 1.
de2: `np.ndarray`
    PSF ellipticity residuals component 2.
ra: `np.ndarray`
    Right ascension coordinate.
dec: `np.ndarray`
    Declination coordinate.
units: `str`
    In which units are ra and dec. units supported
    are the same as the one in treecorr.

Returns
-------
struct : `lsst.pipe.base.Struct`
        The struct contains the following data:
    ``E1``: `float`
        <de1 de1> scalar correlation function, compute
        in an angular bin define in TreecorrConfig.
    ``E2``: `float`
        <de2 de2> scalar correlation function, compute
        in an angular bin define in TreecorrConfig.
    ``Ex``: `float`
        <de1 de2> scalar cross-correlation function, compute
        in an angular bin define in TreecorrConfig.

Definition at line 53 of file computeExPsf.py.

Member Function Documentation

◆ run()

pipeBase.Struct lsst.meas.algorithms.computeExPsf.ComputeExPsfTask.run ( self,
npt.NDArray de1,
npt.NDArray de2,
npt.NDArray ra,
npt.NDArray dec,
str units = "arcmin" )

Definition at line 92 of file computeExPsf.py.

Member Data Documentation

◆ _DefaultName

str lsst.meas.algorithms.computeExPsf.ComputeExPsfTask._DefaultName = "computeExPsf"
staticprotected

Definition at line 90 of file computeExPsf.py.

◆ ConfigClass

lsst.meas.algorithms.computeExPsf.ComputeExPsfTask.ConfigClass = ComputeExPsfConfig
static

Definition at line 89 of file computeExPsf.py.


The documentation for this class was generated from the following file: