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
footprintArea.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 import numpy as np
23 
24 from .catalogCalculation import (CatalogCalculationPluginConfig,
25  CatalogCalculationPlugin)
26 from .pluginRegistry import register
27 
28 __all__ = (
29  "CatalogCalculationFootprintAreaConfig",
30  "CatalogCalculationFootprintAreaPlugin",
31 )
32 
33 
35  """Configuration for footprint area catalog calculation plugin.
36  """
37 
38  pass
39 
40 
41 @register("base_FootprintArea")
43  """Catalog calculation plugin to record the area of a source's footprint.
44  """
45 
46  ConfigClass = CatalogCalculationFootprintAreaConfig
47 
48  @classmethod
51 
52  def __init__(self, config, name, schema, metadata):
53  CatalogCalculationPlugin.__init__(self, config, name, schema, metadata)
54  self.key = schema.addField(
55  schema.join(name, "value"),
56  type=np.int32,
57  doc="Number of pixels in the source's detection footprint.",
58  units="pixel"
59  )
60 
61  def calculate(self, measRecord):
62  measRecord.set(self.key, measRecord.getFootprint().getArea())
63 
64  def fail(self, measRecord, error=None):
65  # Should be impossible for this algorithm to fail unless there is no
66  # Footprint (and that's a precondition for measurement).
67  pass
lsst::meas::base.footprintArea.CatalogCalculationFootprintAreaPlugin.fail
def fail(self, measRecord, error=None)
Definition: footprintArea.py:64
lsst::meas::base.catalogCalculation.CatalogCalculationPluginConfig
Definition: catalogCalculation.py:40
lsst::meas::base.catalogCalculation.CatalogCalculationPlugin
Definition: catalogCalculation.py:46
lsst::meas::base.footprintArea.CatalogCalculationFootprintAreaPlugin.getExecutionOrder
def getExecutionOrder(cls)
Definition: footprintArea.py:49
lsst::meas::base.pluginsBase.BasePlugin.DEFAULT_CATALOGCALCULATION
float DEFAULT_CATALOGCALCULATION
Definition: pluginsBase.py:108
lsst::meas::base.footprintArea.CatalogCalculationFootprintAreaPlugin
Definition: footprintArea.py:42
lsst::meas::base.footprintArea.CatalogCalculationFootprintAreaPlugin.calculate
def calculate(self, measRecord)
Definition: footprintArea.py:61
lsst::meas::base.footprintArea.CatalogCalculationFootprintAreaPlugin.key
key
Definition: footprintArea.py:54
lsst.gdb.ip.diffim.printers.register
def register(obj)
Definition: printers.py:20
lsst::meas::base.footprintArea.CatalogCalculationFootprintAreaPlugin.__init__
def __init__(self, config, name, schema, metadata)
Definition: footprintArea.py:52
lsst::meas::base.footprintArea.CatalogCalculationFootprintAreaConfig
Definition: footprintArea.py:34