LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
lsst.ip.diffim.computeSpatiallySampledMetrics Namespace Reference

Classes

class  SpatiallySampledMetricsConnections
 

Variables

 science : `lsst.afw.image.ExposureF`
 
 matchedTemplate : `lsst.afw.image.ExposureF`
 
 template : `lsst.afw.image.ExposureF`
 
 difference : `lsst.afw.image.ExposureF`
 
 diaSources : `lsst.afw.table.SourceCatalog`
 
 psfMatchingKernel : `~lsst.afw.math.LinearCombinationKernel`
 
 results : `lsst.pipe.base.Struct`
 
 src : `lsst.afw.table.SourceRecord`
 
 metricsMaskPlanes : `list` of `str`
 

Variable Documentation

◆ diaSources

lsst.ip.diffim.computeSpatiallySampledMetrics.diaSources : `lsst.afw.table.SourceCatalog`

Definition at line 213 of file computeSpatiallySampledMetrics.py.

◆ difference

lsst.ip.diffim.computeSpatiallySampledMetrics.difference : `lsst.afw.image.ExposureF`

Definition at line 211 of file computeSpatiallySampledMetrics.py.

◆ matchedTemplate

lsst.ip.diffim.computeSpatiallySampledMetrics.matchedTemplate : `lsst.afw.image.ExposureF`

Definition at line 205 of file computeSpatiallySampledMetrics.py.

◆ metricsMaskPlanes

lsst.ip.diffim.computeSpatiallySampledMetrics.metricsMaskPlanes : `list` of `str`

Definition at line 262 of file computeSpatiallySampledMetrics.py.

◆ psfMatchingKernel

lsst.ip.diffim.computeSpatiallySampledMetrics.psfMatchingKernel : `~lsst.afw.math.LinearCombinationKernel`

Definition at line 215 of file computeSpatiallySampledMetrics.py.

◆ results

lsst.ip.diffim.computeSpatiallySampledMetrics.results : `lsst.pipe.base.Struct`

Definition at line 220 of file computeSpatiallySampledMetrics.py.

◆ science

lsst.ip.diffim.computeSpatiallySampledMetrics.science : `lsst.afw.image.ExposureF`
metricsMaskPlanes = lsst.pex.config.ListField(
    dtype=str,
    doc="List of mask planes to include in metrics",
    default=('BAD', 'CLIPPED', 'CR', 'DETECTED', 'DETECTED_NEGATIVE', 'EDGE',
             'INEXACT_PSF', 'INJECTED', 'INJECTED_TEMPLATE', 'INTRP', 'NOT_DEBLENDED',
             'NO_DATA', 'REJECTED', 'SAT', 'SAT_TEMPLATE', 'SENSOR_EDGE', 'STREAK', 'SUSPECT',
             'UNMASKEDNAN',
             ),
)
metricSources = pexConfig.ConfigurableField(
    target=SkyObjectsTask,
    doc="Generate QA metric sources",
)

def setDefaults(self):
    self.metricSources.avoidMask = ["NO_DATA", "EDGE"]


class SpatiallySampledMetricsTask(lsst.pipe.base.PipelineTask):
ConfigClass = SpatiallySampledMetricsConfig
_DefaultName = "spatiallySampledMetrics"

def __init__(self, **kwargs):
    super().__init__(**kwargs)

    self.makeSubtask("metricSources")
    self.schema = afwTable.SourceTable.makeMinimalSchema()
    self.schema.addField(
        "x", "F",
        "X location of the metric evaluation.",
        units="pixel")
    self.schema.addField(
        "y", "F",
        "Y location of the metric evaluation.",
        units="pixel")
    self.metricSources.skySourceKey = self.schema.addField("sky_source", type="Flag",
                                                           doc="Metric evaluation objects.")
    self.schema.addField(
        "source_density", "F",
        "Density of diaSources at location.",
        units="count/degree^2")
    self.schema.addField(
        "dipole_density", "F",
        "Density of dipoles at location.",
        units="count/degree^2")
    self.schema.addField(
        "dipole_direction", "F",
        "Mean dipole orientation.",
        units="radian")
    self.schema.addField(
        "dipole_separation", "F",
        "Mean dipole separation.",
        units="pixel")
    self.schema.addField(
        "template_value", "F",
        "Median of template at location.",
        units="nJy")
    self.schema.addField(
        "science_value", "F",
        "Median of science at location.",
        units="nJy")
    self.schema.addField(
        "diffim_value", "F",
        "Median of diffim at location.",
        units="nJy")
    self.schema.addField(
        "science_psfSize", "F",
        "Width of the science image PSF at location.",
        units="pixel")
    self.schema.addField(
        "template_psfSize", "F",
        "Width of the template image PSF at location.",
        units="pixel")
    for maskPlane in self.config.metricsMaskPlanes:
        self.schema.addField(
            "%s_mask_fraction"%maskPlane.lower(), "F",
            "Fraction of pixels with %s mask"%maskPlane
        )
    self.schema.addField(
        "psfMatchingKernel_sum", "F",
        "PSF matching kernel sum at location.")
    self.schema.addField(
        "psfMatchingKernel_dx", "F",
        "PSF matching kernel centroid offset in x at location.",
        units="pixel")
    self.schema.addField(
        "psfMatchingKernel_dy", "F",
        "PSF matching kernel centroid offset in y at location.",
        units="pixel")
    self.schema.addField(
        "psfMatchingKernel_length", "F",
        "PSF matching kernel centroid offset module.",
        units="arcsecond")
    self.schema.addField(
        "psfMatchingKernel_position_angle", "F",
        "PSF matching kernel centroid offset position angle.",
        units="radian")
    self.schema.addField(
        "psfMatchingKernel_direction", "F",
        "PSF matching kernel centroid offset direction in detector plane.",
        units="radian")

@timeMethod
def run(self, science, matchedTemplate, template, difference, diaSources, psfMatchingKernel):

Definition at line 203 of file computeSpatiallySampledMetrics.py.

◆ src

lsst.ip.diffim.computeSpatiallySampledMetrics.src : `lsst.afw.table.SourceRecord`
idFactory = lsst.meas.base.IdGenerator().make_table_id_factory()

spatiallySampledMetrics = afwTable.SourceCatalog(self.schema)
spatiallySampledMetrics.getTable().setIdFactory(idFactory)

self.metricSources.run(mask=science.mask, seed=difference.info.id, catalog=spatiallySampledMetrics)

metricsMaskPlanes = []
for maskPlane in self.config.metricsMaskPlanes:
    try:
        metricsMaskPlanes.append(maskPlane)
    except InvalidParameterError:
        self.log.info("Unable to calculate metrics for mask plane %s: not in image"%maskPlane)

for src in spatiallySampledMetrics:
    self._evaluateLocalMetric(src, science, matchedTemplate, template, difference, diaSources,
                              metricsMaskPlanes=metricsMaskPlanes,
                              psfMatchingKernel=psfMatchingKernel)

return pipeBase.Struct(spatiallySampledMetrics=spatiallySampledMetrics.asAstropy())

def _evaluateLocalMetric(self, src, science, matchedTemplate, template, difference, diaSources,
                     metricsMaskPlanes, psfMatchingKernel):

Definition at line 252 of file computeSpatiallySampledMetrics.py.

◆ template

lsst.ip.diffim.computeSpatiallySampledMetrics.template : `lsst.afw.image.ExposureF`

Definition at line 208 of file computeSpatiallySampledMetrics.py.