LSST Applications g04c3c9f7ca+2075667efa,g1e125bf412+5f448d5fcf,g2079a07aa2+3e9fd84d81,g2305ad1205+b635cf1488,g2bbee38e9b+6c6beb4891,g337abbeb29+6c6beb4891,g33d1c0ed96+6c6beb4891,g3a166c0a6a+6c6beb4891,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+42f171e1e6,g5c3423f6d4+d536b04327,g607f77f49a+d536b04327,g6f43f06aed+ca1339dc19,g858d7b2824+d536b04327,g8ee334c5b4+d7f9608c2f,g9963eaa53e+b3dc1655d3,g998f4353bf+d536b04327,g99cad8db69+8ef2408349,g9ddcbc5298+9a081db1e4,ga1e77700b3+2cbb763275,gadfd92a7e4+aec2f3b930,gae0086650b+585e252eca,gb0e22166c9+0e73c8378f,gb3b7280ab2+cb5fdb229e,gbb8dafda3b+a327199e22,gc120e1dc64+88074880ea,gc28159a63d+6c6beb4891,gcdd4ae20e8+bd241b2308,gcde1bda545+903e937d91,gcf0d15dbbd+bd241b2308,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+6c6beb4891,gfbcc870c63+b310236976,w.2024.23
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Static Protected Attributes | List of all members
lsst.meas.algorithms.psfDeterminer.BasePsfDeterminerTask Class Reference
Inheritance diagram for lsst.meas.algorithms.psfDeterminer.BasePsfDeterminerTask:
lsst.meas.algorithms.pcaPsfDeterminer.PcaPsfDeterminerTask lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerTask

Public Member Functions

 __init__ (self, config, schema=None, **kwds)
 
 downsampleCandidates (self, inputCandidateList)
 
 determinePsf (self, exposure, psfCandidateList, metadata=None, flagKey=None)
 

Static Public Attributes

bool usesMatches = False
 
 ConfigClass = BasePsfDeterminerConfig
 

Static Protected Attributes

str _DefaultName = "psfDeterminer"
 

Detailed Description

Base class for PSF determiners

Register all PSF determiners with the psfDeterminerRegistry using:
    psfDeterminerRegistry.register(name, class)

Parameters
----------
config : `lsst.pexConfig.Config`
    Input for configuring the algorithm
schema : `lsst.afw.table.Schema`
    Schema used for sources; passing a schema allows the
    determiner to reserve a flag field to mark stars used in
    PSF measurement, but some PSF determiners ignore this argument.

Definition at line 52 of file psfDeterminer.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.meas.algorithms.psfDeterminer.BasePsfDeterminerTask.__init__ ( self,
config,
schema = None,
** kwds )

Reimplemented in lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerTask.

Definition at line 72 of file psfDeterminer.py.

72 def __init__(self, config, schema=None, **kwds):
73 pipeBase.Task.__init__(self, config=config, **kwds)
74

Member Function Documentation

◆ determinePsf()

lsst.meas.algorithms.psfDeterminer.BasePsfDeterminerTask.determinePsf ( self,
exposure,
psfCandidateList,
metadata = None,
flagKey = None )
Determine a PSF model.

Parameters
----------
exposure : `lsst.afw.Exposure`
    Exposure containing the psf candidates.
psdCandidateList : `list` [`lsst.meas.algorithms.PsfCandidate`]
    A sequence of PSF candidates; typically obtained by
    detecting sources and then running them through a star
    selector.
metadata : `str`, optional
    A place to save interesting items.
flagKey: `lsst.afw.table.Key`, optional
    Schema key used to mark sources actually used in PSF determination.

Returns
-------
psf : `lsst.afw.detection.Psf`
    The fit PSF.
cellSet : `lsst.afw.math.SpatialCellSet`
    The spatial cell set used to determine the PSF

Reimplemented in lsst.meas.algorithms.pcaPsfDeterminer.PcaPsfDeterminerTask, and lsst.meas.extensions.piff.piffPsfDeterminer.PiffPsfDeterminerTask.

Definition at line 107 of file psfDeterminer.py.

107 def determinePsf(self, exposure, psfCandidateList, metadata=None, flagKey=None):
108 """Determine a PSF model.
109
110 Parameters
111 ----------
112 exposure : `lsst.afw.Exposure`
113 Exposure containing the psf candidates.
114 psdCandidateList : `list` [`lsst.meas.algorithms.PsfCandidate`]
115 A sequence of PSF candidates; typically obtained by
116 detecting sources and then running them through a star
117 selector.
118 metadata : `str`, optional
119 A place to save interesting items.
120 flagKey: `lsst.afw.table.Key`, optional
121 Schema key used to mark sources actually used in PSF determination.
122
123 Returns
124 -------
125 psf : `lsst.afw.detection.Psf`
126 The fit PSF.
127 cellSet : `lsst.afw.math.SpatialCellSet`
128 The spatial cell set used to determine the PSF
129 """
130 raise NotImplementedError("BasePsfDeterminerTask is abstract, subclasses must override this method")
131
132

◆ downsampleCandidates()

lsst.meas.algorithms.psfDeterminer.BasePsfDeterminerTask.downsampleCandidates ( self,
inputCandidateList )
Down-sample candidates from the input candidate list.

Parameters
----------
inputCandidateList : `list` [`lsst.meas.algorithms.PsfCandidate`]
    Input candidate list.

Returns
-------
outputCandidateList : `list` [`lsst.meas.algorithms.PsfCandidate`]
    Down-selected candidate list.

Definition at line 75 of file psfDeterminer.py.

75 def downsampleCandidates(self, inputCandidateList):
76 """Down-sample candidates from the input candidate list.
77
78 Parameters
79 ----------
80 inputCandidateList : `list` [`lsst.meas.algorithms.PsfCandidate`]
81 Input candidate list.
82
83 Returns
84 -------
85 outputCandidateList : `list` [`lsst.meas.algorithms.PsfCandidate`]
86 Down-selected candidate list.
87 """
88 if len(inputCandidateList) <= self.config.maxCandidates:
89 return inputCandidateList
90
91 rng = np.random.RandomState(seed=self.config.downsampleRandomSeed)
92
93 self.log.info(
94 "Down-sampling from %d to %d psf candidates.",
95 len(inputCandidateList),
96 self.config.maxCandidates,
97 )
98
99 selection = rng.choice(len(inputCandidateList), size=self.config.maxCandidates, replace=False)
100 selection = np.sort(selection)
101
102 outputCandidateList = [inputCandidateList[index] for index in selection]
103
104 return outputCandidateList
105

Member Data Documentation

◆ _DefaultName

str lsst.meas.algorithms.psfDeterminer.BasePsfDeterminerTask._DefaultName = "psfDeterminer"
staticprotected

Definition at line 70 of file psfDeterminer.py.

◆ ConfigClass

lsst.meas.algorithms.psfDeterminer.BasePsfDeterminerTask.ConfigClass = BasePsfDeterminerConfig
static

Definition at line 69 of file psfDeterminer.py.

◆ usesMatches

bool lsst.meas.algorithms.psfDeterminer.BasePsfDeterminerTask.usesMatches = False
static

Definition at line 68 of file psfDeterminer.py.


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