LSST Applications  21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
LSST Data Management Base Package
mockObject.py
Go to the documentation of this file.
1 #
2 # LSST Data Management System
3 # Copyright 2008, 2009, 2010, 2011, 2012 LSST Corporation.
4 #
5 # This product includes software developed by the
6 # LSST Project (http://www.lsst.org/).
7 #
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the LSST License Statement and
19 # the GNU General Public License along with this program. If not,
20 # see <http://www.lsstcorp.org/LegalNotices/>.
21 #
22 import numpy
23 
24 import lsst.pex.config
25 import lsst.afw.table
26 import lsst.geom
27 import lsst.afw.image
28 import lsst.pipe.base
29 
30 
32  minMag = lsst.pex.config.Field(dtype=float, default=18.0, doc="Minimum magnitude for mock objects")
33  maxMag = lsst.pex.config.Field(dtype=float, default=20.0, doc="Maximum magnitude for mock objects")
34  maxRadius = lsst.pex.config.Field(
35  dtype=float, default=10.0,
36  doc=("Maximum radius of an object in arcseconds; only used "
37  "when determining which objects are in an exposure.")
38  )
40  dtype=float, default=20.0,
41  doc="Distance between objects (in arcseconds)."
42  )
43  seed = lsst.pex.config.Field(dtype=int, default=1, doc="Seed for numpy random number generator")
44 
45 
47  """Task that generates simple mock objects and draws them on images, intended as a subtask of
48  MockCoaddTask.
49 
50  May be subclassed to generate things other than stars.
51  """
52 
53  ConfigClass = MockObjectConfig
54 
55  def __init__(self, **kwds):
56  lsst.pipe.base.Task.__init__(self, **kwds)
58  self.centercenter = lsst.afw.table.Point2DKey.addFields(self.schemaschema, "center",
59  "center position in tract WCS", "pixel")
60  self.magKeymagKey = self.schemaschema.addField("mag", type=float, doc="exact true magnitude")
61  self.rngrng = numpy.random.RandomState(self.configconfig.seed)
62 
63  def run(self, tractInfo, catalog=None):
64  """Add records to the truth catalog and return it, delegating to makePositions and defineObject.
65 
66  If the given catalog is not None, add records to this catalog and return it instead
67  of creating a new one.
68 
69  Subclasses should generally not need to override this method.
70  """
71  if catalog is None:
72  catalog = lsst.afw.table.SimpleCatalog(self.schemaschema)
73  else:
74  if not catalog.getSchema().contains(self.schemaschema):
75  raise ValueError("Catalog schema does not match Task schema")
76  for coord, center in self.makePositionsmakePositions(tractInfo):
77  record = catalog.addNew()
78  record.setCoord(coord)
79  record.set(self.centercenter, center)
80  self.defineObjectdefineObject(record)
81  return catalog
82 
83  def makePositions(self, tractInfo):
84  """Generate the centers (as a (coord, point) tuple) of mock objects (the point returned is
85  in the tract coordinate system).
86 
87  Default implementation puts objects on a grid that is square in the tract's image coordinate
88  system, with spacing approximately given by config.spacings.
89 
90  The return value is a Python iterable over (coord, point) pairs; the default implementation
91  is actually an iterator (i.e. the function is a "generator"), but derived-class overrides may
92  return any iterable.
93  """
94  wcs = tractInfo.getWcs()
95  spacing = self.configconfig.spacing / wcs.getPixelScale().asArcseconds() # get spacing in tract pixels
96  bbox = tractInfo.getBBox()
97  for y in numpy.arange(bbox.getMinY() + 0.5 * spacing, bbox.getMaxY(), spacing):
98  for x in numpy.arange(bbox.getMinX() + 0.5 * spacing, bbox.getMaxX(), spacing):
99  yield wcs.pixelToSky(x, y), lsst.geom.Point2D(x, y),
100 
101  def defineObject(self, record):
102  """Fill in additional fields in a truth catalog record (id and coord will already have
103  been set).
104  """
105  mag = self.rngrng.rand() * (self.configconfig.maxMag - self.configconfig.minMag) + self.configconfig.minMag
106  record.setD(self.magKeymagKey, mag)
107 
108  def drawSource(self, record, exposure, buffer=0):
109  """Draw the given truth catalog record on the given exposure, makings use of its Psf, Wcs,
110  PhotoCalib, and possibly filter to transform it appropriately.
111 
112  The mask and variance planes of the Exposure are ignored.
113 
114  The 'buffer' parameter is used to expand the source's bounding box when testing whether it
115  is considered fully part of the image.
116 
117  Returns 0 if the object does not appear on the given image at all, 1 if it appears partially,
118  and 2 if it appears fully (including the given buffer).
119  """
120  wcs = exposure.getWcs()
121  center = wcs.skyToPixel(record.getCoord())
122  try:
123  psfImage = exposure.getPsf().computeImage(center).convertF()
124  except Exception:
125  return 0
126  psfBBox = psfImage.getBBox()
127  overlap = exposure.getBBox()
128  overlap.clip(psfBBox)
129  if overlap.isEmpty():
130  return 0
131  flux = exposure.getPhotoCalib().magnitudeToInstFlux(record.getD(self.magKeymagKey))
132  normalization = flux / psfImage.getArray().sum()
133  if psfBBox != overlap:
134  psfImage = psfImage.Factory(psfImage, overlap)
135  result = 1
136  else:
137  result = 2
138  if buffer != 0:
139  bufferedBBox = lsst.geom.Box2I(psfBBox)
140  bufferedBBox.grow(buffer)
141  bufferedOverlap = exposure.getBBox()
142  bufferedOverlap.clip(bufferedBBox)
143  if bufferedOverlap != bufferedBBox:
144  result = 1
145  image = exposure.getMaskedImage().getImage()
146  subImage = image.Factory(image, overlap)
147  subImage.scaledPlus(normalization, psfImage)
148  return result
static Schema makeMinimalSchema()
Return a minimal schema for Simple tables and records.
Definition: Simple.h:140
Custom catalog class for record/table subclasses that are guaranteed to have an ID,...
Definition: SortedCatalog.h:42
An integer coordinate rectangle.
Definition: Box.h:55
def drawSource(self, record, exposure, buffer=0)
Definition: mockObject.py:108
def run(self, tractInfo, catalog=None)
Definition: mockObject.py:63
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.