LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
classification.py
Go to the documentation of this file.
1 # This file is part of meas_base.
2 #
3 # Developed for the LSST Data Management System.
4 # This product includes software developed by the LSST Project
5 # (https://www.lsst.org).
6 # See the COPYRIGHT file at the top-level directory of this distribution
7 # for details of code ownership.
8 #
9 # This program is free software: you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
13 #
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
18 #
19 # You should have received a copy of the GNU General Public License
20 # along with this program. If not, see <https://www.gnu.org/licenses/>.
21 
22 """Definition and registration of classification plugins.
23 """
24 
25 import numpy as np
26 
27 import lsst.pex.config
28 from .catalogCalculation import CatalogCalculationPluginConfig, CatalogCalculationPlugin
29 from .pluginRegistry import register
30 
31 __all__ = (
32  "CatalogCalculationClassificationConfig", "CatalogCalculationClassificationPlugin",
33 )
34 
35 
37  """Configuration for catalog classification plugin.
38  """
39 
40  fluxRatio = lsst.pex.config.Field(dtype=float, default=.925, optional=True,
41  doc="critical ratio of model to psf flux")
42  modelErrFactor = lsst.pex.config.Field(dtype=float, default=0.0, optional=True,
43  doc="correction factor for modelFlux error")
44  psfErrFactor = lsst.pex.config.Field(dtype=float, default=0.0, optional=True,
45  doc="correction factor for psfFlux error")
46 
47 
48 @register("base_ClassificationExtendedness")
50  """Plugin which calculates a binary measure of source extendedness.
51 
52  Extendedness is based on a simple cut of the ratio of the PSF flux to the
53  model flux.
54 
55  Notes
56  -----
57  Because the fluxes on which this algorithm is based on are slot
58  measurements, they can be provided by different algorithms, and the
59  `~CatalogCalculationClassificationConfig.fluxRatio` threshold used by this
60  algorithm should generally be set differently for different algorithms.
61  To do this, plot the difference between the PSF magnitude and the model
62  magnitude vs. the PSF magnitude, and look for where the cloud of galaxies
63  begins.
64  """
65 
66  ConfigClass = CatalogCalculationClassificationConfig
67 
68  @classmethod
71 
72  def __init__(self, config, name, schema, metadata):
73  CatalogCalculationPlugin.__init__(self, config, name, schema, metadata)
74  self.keyProbability = schema.addField(name + "_value", type="D",
75  doc="Set to 1 for extended sources, 0 for point sources.")
76  self.keyFlag = schema.addField(name + "_flag", type="Flag", doc="Set to 1 for any fatal failure.")
77 
78  def calculate(self, measRecord):
79  modelFlux = measRecord.getModelInstFlux()
80  psfFlux = measRecord.getPsfInstFlux()
81  modelFluxFlag = (measRecord.getModelFluxFlag()
82  if measRecord.table.getModelFluxSlot().isValid()
83  else False)
84  psfFluxFlag = (measRecord.getPsfFluxFlag()
85  if measRecord.table.getPsfFluxSlot().isValid()
86  else False)
87  flux1 = self.config.fluxRatio*modelFlux
88  if self.config.modelErrFactor != 0:
89  flux1 += self.config.modelErrFactor*measRecord.getModelInstFluxErr()
90  flux2 = psfFlux
91  if not self.config.psfErrFactor == 0:
92  flux2 += self.config.psfErrFactor*measRecord.getPsfInstFluxErr()
93 
94  # A generic failure occurs when either FluxFlag is set to True
95  # A generic failure also occurs if either calculated flux value is NaN:
96  # this can occur if the Flux field itself is NaN,
97  # or the ErrFactor != 0 and the FluxErr is NaN
98  if np.isnan(flux1) or np.isnan(flux2) or modelFluxFlag or psfFluxFlag:
99  self.fail(measRecord)
100  else:
101  measRecord.set(self.keyProbability, 0.0 if flux1 < flux2 else 1.0)
102 
103  def fail(self, measRecord, error=None):
104  measRecord.set(self.keyFlag, True)
lsst::meas::base.catalogCalculation.CatalogCalculationPluginConfig
Definition: catalogCalculation.py:40
lsst::meas::base.catalogCalculation.CatalogCalculationPlugin
Definition: catalogCalculation.py:46
lsst::meas::base.classification.CatalogCalculationClassificationPlugin
Definition: classification.py:49
lsst::meas::base.classification.CatalogCalculationClassificationPlugin.keyProbability
keyProbability
Definition: classification.py:74
lsst::meas::base.classification.CatalogCalculationClassificationPlugin.calculate
def calculate(self, measRecord)
Definition: classification.py:78
lsst.pex.config
Definition: __init__.py:1
lsst::meas::base.pluginsBase.BasePlugin.DEFAULT_CATALOGCALCULATION
float DEFAULT_CATALOGCALCULATION
Definition: pluginsBase.py:108
lsst::meas::base.classification.CatalogCalculationClassificationConfig
Definition: classification.py:36
lsst::meas::base.pluginsBase.BasePlugin.config
config
Definition: pluginsBase.py:130
lsst::meas::base.classification.CatalogCalculationClassificationPlugin.fail
def fail(self, measRecord, error=None)
Definition: classification.py:103
lsst::meas::base.classification.CatalogCalculationClassificationPlugin.keyFlag
keyFlag
Definition: classification.py:76
lsst.gdb.ip.diffim.printers.register
def register(obj)
Definition: printers.py:20
lsst::meas::base.classification.CatalogCalculationClassificationPlugin.__init__
def __init__(self, config, name, schema, metadata)
Definition: classification.py:72
isValid
bool isValid
Definition: fits.cc:399
lsst.pex.config.config.Field
Definition: config.py:247
lsst::meas::base.classification.CatalogCalculationClassificationPlugin.getExecutionOrder
def getExecutionOrder(cls)
Definition: classification.py:69