Coverage for python/lsst/meas/base/footprintArea.py: 78%

19 statements  

« prev     ^ index     » next       coverage.py v6.4, created at 2022-05-25 11:34 +0000

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 

22import numpy as np 

23 

24from .catalogCalculation import (CatalogCalculationPluginConfig, 

25 CatalogCalculationPlugin) 

26from .pluginRegistry import register 

27 

28__all__ = ( 

29 "CatalogCalculationFootprintAreaConfig", 

30 "CatalogCalculationFootprintAreaPlugin", 

31) 

32 

33 

34class CatalogCalculationFootprintAreaConfig(CatalogCalculationPluginConfig): 

35 """Configuration for footprint area catalog calculation plugin. 

36 """ 

37 

38 pass 

39 

40 

41@register("base_FootprintArea") 

42class CatalogCalculationFootprintAreaPlugin(CatalogCalculationPlugin): 

43 """Catalog calculation plugin to record the area of a source's footprint. 

44 """ 

45 

46 ConfigClass = CatalogCalculationFootprintAreaConfig 

47 

48 @classmethod 

49 def getExecutionOrder(cls): 

50 return cls.DEFAULT_CATALOGCALCULATION 

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