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
drpDiaCalculationPipe.py
Go to the documentation of this file.
1# This file is part of pipe_tasks.
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"""Pipeline for computing DiaObject summary/light curve values.
23"""
24
25__all__ = ["DrpDiaCalculationPipeTask",
26 "DrpDiaCalculationPipeConfig",
27 "DrpDiaCalculationPipeConnections"]
28
29import pandas as pd
30
31from lsst.meas.base import DiaObjectCalculationTask
32import lsst.pex.config as pexConfig
33import lsst.pipe.base as pipeBase
34
35
36class DrpDiaCalculationPipeConnections(pipeBase.PipelineTaskConnections,
37 dimensions=("tract", "patch", "skymap"),
38 defaultTemplates={"coaddName": "deep",
39 "fakesType": ""}):
40 assocDiaSourceTable = pipeBase.connectionTypes.Input(
41 doc="Catalog of DiaSources covering the patch and associated with a "
42 "DiaObject.",
43 name="{fakesType}{coaddName}Diff_assocDiaSrcTable",
44 storageClass="DataFrame",
45 dimensions=("tract", "patch"),
46 )
47 diaObjectTable = pipeBase.connectionTypes.Input(
48 doc="Catalog of DiaObjects created from spatially associating "
49 "DiaSources.",
50 name="{fakesType}{coaddName}Diff_diaObjTable",
51 storageClass="DataFrame",
52 dimensions=("tract", "patch"),
53 )
54 fullDiaObjectTable = pipeBase.connectionTypes.Output(
55 doc="Catalog of DiaObjects created from spatially associating "
56 "DiaSources.",
57 name="{fakesType}{coaddName}Diff_fullDiaObjTable",
58 storageClass="DataFrame",
59 dimensions=("tract", "patch"),
60 )
61
62
63class DrpDiaCalculationPipeConfig(
64 pipeBase.PipelineTaskConfig,
65 pipelineConnections=DrpDiaCalculationPipeConnections):
66 filterNames = pexConfig.ListField(
67 dtype=str,
68 default=['u', 'g', 'r', 'i', 'z', 'y'],
69 doc="List of filters to attempt to calculate DiaObject summary "
70 "values."
71 )
72 diaCalculation = pexConfig.ConfigurableField(
73 target=DiaObjectCalculationTask,
74 doc="Task to compute summary statistics for DiaObjects.",
75 )
76
77 def setDefaults(self):
78 self.diaCalculation.plugins = ["ap_meanPosition",
79 "ap_diaObjectFlag",
80 "ap_meanFlux",
81 "ap_sigmaFlux",
82 "ap_minMaxFlux",
83 "ap_maxSlopeFlux",
84 "ap_meanErrFlux",
85 "ap_meanTotFlux"]
86
87
88class DrpDiaCalculationPipeTask(pipeBase.PipelineTask):
89 """Driver pipeline for loading DiaSource catalogs in a patch/tract
90 region and associating them.
91 """
92 ConfigClass = DrpDiaCalculationPipeConfig
93 _DefaultName = "drpDiaCalculation"
94
95 def __init__(self, **kwargs):
96 super().__init__(**kwargs)
97 self.makeSubtask("diaCalculation")
98
99 def run(self, assocDiaSourceTable, diaObjectTable):
100 """Compute summary statistics over the input set of DiaSources and
101 store summary statistics into the associated DiaObjects.
102
103 Parameters
104 ----------
105 assocDiaSourceTable : `pandas.DataFrame`
106 Set of DiaSources spatially associated into the DiaObjects in
107 ``diaObjectTable``.
108 diaObjectTable : `pandas.DataFrame`
109 DiaObjects created from associating the sources in
110 ``assocDiaSourceTable``. All ids in the catalog must have a
111 corresponding DiaSource in the input catalog.
112
113 Returns
114 -------
115 results : `lsst.pipe.base.Struct`
116 Struct containing
117
118 ``fullDiaObjectTable``
119 DiaObjects with computed summary statistics based on their
120 associated DiaSource light curves. (`pandas.DataFrame`).
121 """
122 # Return empty dataFrame if no DiaObjects in this patch.
123 if len(diaObjectTable) <= 0 or len(assocDiaSourceTable) <= 0:
124 return pipeBase.Struct(fullDiaObjectTable=pd.DataFrame())
125 result = self.diaCalculation.run(
126 diaObjectTable,
127 assocDiaSourceTable,
128 diaObjectTable.index.to_numpy(),
129 self.config.filterNames)
130 return pipeBase.Struct(fullDiaObjectTable=result.updatedDiaObjects)