LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
Public Member Functions | |
def | run (self, measCat, exposure, noiseImage=None, exposureId=None, beginOrder=None, endOrder=None) |
def | runPlugins (self, noiseReplacer, measCat, exposure, beginOrder=None, endOrder=None) |
def | measure (self, measCat, exposure) |
def | initializePlugins (self, **kwds) |
def | callMeasure (self, measRecord, *args, **kwds) |
def | doMeasurement (self, plugin, measRecord, *args, **kwds) |
def | callMeasureN (self, measCat, *args, **kwds) |
def | doMeasurementN (self, plugin, measCat, *args, **kwds) |
Public Attributes | |
schema | |
doBlendedness | |
blendPlugin | |
undeblendedPlugins | |
Static Public Attributes | |
ConfigClass = DipoleMeasurementConfig | |
string | NOISE_SEED_MULTIPLIER = "NOISE_SEED_MULTIPLIER" |
string | NOISE_SOURCE = "NOISE_SOURCE" |
string | NOISE_OFFSET = "NOISE_OFFSET" |
string | NOISE_EXPOSURE_ID = "NOISE_EXPOSURE_ID" |
plugins = None | |
algMetadata = None | |
Measurement of Sources, specifically ones from difference images, for characterization as dipoles Parameters ---------- sources : 'lsst.afw.table.SourceCatalog' Sources that will be measured badFlags : `list` of `dict` A list of flags that will be used to determine if there was a measurement problem Notes ----- The list of badFlags will be used to make a list of keys to check for measurement flags on. By default the centroid keys are added to this list Description This class provides a default configuration for running Source measurement on image differences. .. code-block:: py class DipoleMeasurementConfig(SingleFrameMeasurementConfig): "Measurement of detected diaSources as dipoles" def setDefaults(self): SingleFrameMeasurementConfig.setDefaults(self) self.plugins = ["base_CircularApertureFlux", "base_PixelFlags", "base_SkyCoord", "base_PsfFlux", "ip_diffim_NaiveDipoleCentroid", "ip_diffim_NaiveDipoleFlux", "ip_diffim_PsfDipoleFlux", "ip_diffim_ClassificationDipole", ] self.slots.calibFlux = None self.slots.modelFlux = None self.slots.instFlux = None self.slots.shape = None self.slots.centroid = "ip_diffim_NaiveDipoleCentroid" self.doReplaceWithNoise = False These plugins enabled by default allow the user to test the hypothesis that the Source is a dipole. This includes a set of measurements derived from intermediate base classes DipoleCentroidAlgorithm and DipoleFluxAlgorithm. Their respective algorithm control classes are defined in DipoleCentroidControl and DipoleFluxControl. Each centroid and flux measurement will have _neg (negative) and _pos (positive lobe) fields. The first set of measurements uses a "naive" alrogithm for centroid and flux measurements, implemented in NaiveDipoleCentroidControl and NaiveDipoleFluxControl. The algorithm uses a naive 3x3 weighted moment around the nominal centroids of each peak in the Source Footprint. These algorithms fill the table fields ip_diffim_NaiveDipoleCentroid* and ip_diffim_NaiveDipoleFlux* The second set of measurements undertakes a joint-Psf model on the negative and positive lobe simultaneously. This fit simultaneously solves for the negative and positive lobe centroids and fluxes using non-linear least squares minimization. The fields are stored in table elements ip_diffim_PsfDipoleFlux*. Because this Task is just a config for SingleFrameMeasurementTask, the same result may be acheived by manually editing the config and running SingleFrameMeasurementTask. For example: .. code-block:: py config = SingleFrameMeasurementConfig() config.plugins.names = ["base_PsfFlux", "ip_diffim_PsfDipoleFlux", "ip_diffim_NaiveDipoleFlux", "ip_diffim_NaiveDipoleCentroid", "ip_diffim_ClassificationDipole", "base_CircularApertureFlux", "base_SkyCoord"] config.slots.calibFlux = None config.slots.modelFlux = None config.slots.instFlux = None config.slots.shape = None config.slots.centroid = "ip_diffim_NaiveDipoleCentroid" config.doReplaceWithNoise = False schema = afwTable.SourceTable.makeMinimalSchema() task = SingleFrameMeasurementTask(schema, config=config)- Debug variables The ``lsst.pipe.base.cmdLineTask.CmdLineTask`` command line task interface supports a flag-d/--debug to import debug.py from your PYTHONPATH. The relevant contents of debug.py for this Task include: .. code-block:: py import sys import lsstDebug def DebugInfo(name): di = lsstDebug.getInfo(name) if name == "lsst.ip.diffim.dipoleMeasurement": di.display = True # enable debug output di.maskTransparency = 90 # display mask transparency di.displayDiaSources = True # show exposure with dipole results return di lsstDebug.Info = DebugInfo lsstDebug.frame = 1 config.slots.calibFlux = None config.slots.modelFlux = None config.slots.gaussianFlux = None config.slots.shape = None config.slots.centroid = "ip_diffim_NaiveDipoleCentroid" config.doReplaceWithNoise = False This code is dipoleMeasTask.py in the examples directory, and can be run as e.g. .. code-block:: none examples/dipoleMeasTask.py examples/dipoleMeasTask.py --debug examples/dipoleMeasTask.py --debug --image /path/to/image.fits Start the processing by parsing the command line, where the user has the option of enabling debugging output and/or sending their own image for demonstration (in case they have not downloaded the afwdata package). .. code-block:: py if __name__ == "__main__": import argparse parser = argparse.ArgumentParser( description="Demonstrate the use of SourceDetectionTask and DipoleMeasurementTask") parser.add_argument('--debug', '-d', action="store_true", help="Load debug.py?", default=False) parser.add_argument("--image", "-i", help="User defined image", default=None) args = parser.parse_args() if args.debug: try: import debug debug.lsstDebug.frame = 2 except ImportError as e: print(e, file=sys.stderr) run(args) The processing occurs in the run function. We first extract an exposure from disk or afwdata, displaying it if requested: .. code-block:: py def run(args): exposure = loadData(args.image) if args.debug: afwDisplay.Display(frame=1).mtv(exposure) Create a default source schema that we will append fields to as we add more algorithms: .. code-block:: py schema = afwTable.SourceTable.makeMinimalSchema() Create the detection and measurement Tasks, with some minor tweaking of their configs: .. code-block:: py # Create the detection task config = SourceDetectionTask.ConfigClass() config.thresholdPolarity = "both" config.background.isNanSafe = True config.thresholdValue = 3 detectionTask = SourceDetectionTask(config=config, schema=schema) # And the measurement Task config = DipoleMeasurementTask.ConfigClass() config.plugins.names.remove('base_SkyCoord') algMetadata = dafBase.PropertyList() measureTask = DipoleMeasurementTask(schema, algMetadata, config=config) Having fully initialied the schema, we create a Source table from it: .. code-block:: py # Create the output table tab = afwTable.SourceTable.make(schema) Run detection: .. code-block:: py # Process the data results = detectionTask.run(tab, exposure) Because we are looking for dipoles, we need to merge the positive and negative detections: .. code-block:: py # Merge the positve and negative sources fpSet = results.fpSets.positive growFootprint = 2 fpSet.merge(results.fpSets.negative, growFootprint, growFootprint, False) diaSources = afwTable.SourceCatalog(tab) fpSet.makeSources(diaSources) print("Merged %s Sources into %d diaSources (from %d +ve, %d -ve)" % (len(results.sources), len(diaSources), results.fpSets.numPos, results.fpSets.numNeg)) Finally, perform measurement (both standard and dipole-specialized) on the merged sources: .. code-block:: py measureTask.run(diaSources, exposure) Optionally display debugging information: .. code-block:: py # Display dipoles if debug enabled if args.debug: dpa = DipoleAnalysis() dpa.displayDipoles(exposure, diaSources)
Definition at line 123 of file dipoleMeasurement.py.
|
inherited |
Call ``measure`` on all plugins and consistently handle exceptions. Parameters ---------- measRecord : `lsst.afw.table.SourceRecord` The record corresponding to the object being measured. Will be updated in-place with the results of measurement. *args Positional arguments forwarded to ``plugin.measure`` **kwds Keyword arguments. Two are handled locally: beginOrder : `int` Beginning execution order (inclusive). Measurements with ``executionOrder`` < ``beginOrder`` are not executed. `None` for no limit. endOrder : `int` Ending execution order (exclusive). Measurements with ``executionOrder`` >= ``endOrder`` are not executed. `None` for no limit. Others are forwarded to ``plugin.measure()``. Notes ----- This method can be used with plugins that have different signatures; the only requirement is that ``measRecord`` be the first argument. Subsequent positional arguments and keyword arguments are forwarded directly to the plugin. This method should be considered "protected": it is intended for use by derived classes, not users.
Definition at line 295 of file baseMeasurement.py.
|
inherited |
Call ``measureN`` on all plugins and consistently handle exceptions. Parameters ---------- measCat : `lsst.afw.table.SourceCatalog` Catalog containing only the records for the source family to be measured, and where outputs should be written. *args Positional arguments forwarded to ``plugin.measure()`` **kwds Keyword arguments. Two are handled locally: beginOrder: Beginning execution order (inclusive): Measurements with ``executionOrder`` < ``beginOrder`` are not executed. `None` for no limit. endOrder: Ending execution order (exclusive): measurements with ``executionOrder`` >= ``endOrder`` are not executed. `None` for no ``limit``. Others are are forwarded to ``plugin.measure()``. Notes ----- This method can be used with plugins that have different signatures; the only requirement is that ``measRecord`` be the first argument. Subsequent positional arguments and keyword arguments are forwarded directly to the plugin. This method should be considered "protected": it is intended for use by derived classes, not users.
Definition at line 381 of file baseMeasurement.py.
|
inherited |
Call ``measure`` on the specified plugin. Exceptions are handled in a consistent way. Parameters ---------- plugin : subclass of `BasePlugin` Plugin that will be executed. measRecord : `lsst.afw.table.SourceRecord` The record corresponding to the object being measured. Will be updated in-place with the results of measurement. *args Positional arguments forwarded to ``plugin.measure()``. **kwds Keyword arguments forwarded to ``plugin.measure()``. Notes ----- This method can be used with plugins that have different signatures; the only requirement is that ``plugin`` and ``measRecord`` be the first two arguments. Subsequent positional arguments and keyword arguments are forwarded directly to the plugin. This method should be considered "protected": it is intended for use by derived classes, not users.
Definition at line 339 of file baseMeasurement.py.
|
inherited |
Call ``measureN`` on the specified plugin. Exceptions are handled in a consistent way. Parameters ---------- plugin : subclass of `BasePlugin` Plugin that will be executed. measCat : `lsst.afw.table.SourceCatalog` Catalog containing only the records for the source family to be measured, and where outputs should be written. *args Positional arguments forwarded to ``plugin.measureN()``. **kwds Keyword arguments forwarded to ``plugin.measureN()``. Notes ----- This method can be used with plugins that have different signatures; the only requirement is that the ``plugin`` and ``measCat`` be the first two arguments. Subsequent positional arguments and keyword arguments are forwarded directly to the plugin. This method should be considered "protected": it is intended for use by derived classes, not users.
Definition at line 424 of file baseMeasurement.py.
|
inherited |
Initialize plugins (and slots) according to configuration. Parameters ---------- **kwds Keyword arguments forwarded directly to plugin constructors. Notes ----- Derived class constructors should call this method to fill the `plugins` attribute and add corresponding output fields and slot aliases to the output schema. In addition to the attributes added by `BaseMeasurementTask.__init__`, a ``schema``` attribute holding the output schema must be present before this method is called. Keyword arguments are forwarded directly to plugin constructors, allowing derived classes to use plugins with different signatures.
Definition at line 240 of file baseMeasurement.py.
|
inherited |
|
inherited |
Run single frame measurement over an exposure and source catalog. Parameters ---------- measCat : `lsst.afw.table.SourceCatalog` Catalog to be filled with the results of measurement. Must contain all the `lsst.afw.table.SourceRecord`\ s to be measured (with `lsst.afw.detection.Footprint`\ s attached), and have a schema that is a superset of ``self.schema``. exposure : `lsst.afw.image.ExposureF` Image containing the pixel data to be measured together with associated PSF, WCS, etc. noiseImage : `lsst.afw.image.ImageF`, optional Can be used to specify the a predictable noise replacement field for testing purposes. exposureId : `int`, optional Unique exposure identifier used to calculate the random number generator seed during noise replacement. beginOrder : `float`, optional Start execution order (inclusive): measurements with ``executionOrder < beginOrder`` are not executed. `None` for no limit. endOrder : `float`, optional Final execution order (exclusive): measurements with ``executionOrder >= endOrder`` are not executed. `None` for no limit.
Definition at line 214 of file sfm.py.
|
inherited |
Call the configured measument plugins on an image. Parameters ---------- noiseReplacer : `NoiseReplacer` Used to fill sources not being measured with noise. measCat : `lsst.afw.table.SourceCatalog` Catalog to be filled with the results of measurement. Must contain all the `lsst.afw.table.SourceRecord`\ s to be measured (with `lsst.afw.detection.Footprint`\ s attached), and have a schema that is a superset of ``self.schema``. exposure : `lsst.afw.image.ExposureF` Image containing the pixel data to be measured together with associated PSF, WCS, etc. beginOrder : `float`, optional Start execution order (inclusive): measurements with ``executionOrder < beginOrder`` are not executed. `None` for no limit. endOrder : `float`, optional Final execution order (exclusive): measurements with ``executionOrder >= endOrder`` are not executed. `None` for no limit.
|
staticinherited |
Definition at line 225 of file baseMeasurement.py.
|
inherited |
|
static |
Definition at line 343 of file dipoleMeasurement.py.
|
inherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
Definition at line 218 of file baseMeasurement.py.
|
inherited |
|
inherited |
Definition at line 235 of file baseMeasurement.py.