LSST Applications g013ef56533+b8d55c8942,g083dd6704c+a047e97985,g199a45376c+0ba108daf9,g1fd858c14a+7a3b874d60,g210f2d0738+7416ca6900,g262e1987ae+1d557ba9a3,g29ae962dfc+519d34895e,g2cef7863aa+aef1011c0b,g30d7c61c20+36d16ea71a,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+cb326ad149,g47891489e3+f459a6810c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+890c8e1e5d,g5a60e81ecd+6240c63dbc,g64539dfbff+7416ca6900,g67b6fd64d1+f459a6810c,g6ebf1fc0d4+8c5ae1fdc5,g74acd417e5+0bae3c876a,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+f459a6810c,g8d7436a09f+dee7680868,g8ea07a8fe4+81eaaadc04,g90f42f885a+34c0557caf,g97be763408+14b8164b5b,g98a1a72a9c+8389601a76,g98df359435+fff771c62d,gb8cb2b794d+6728931916,gbf99507273+8c5ae1fdc5,gc2a301910b+7416ca6900,gca7fc764a6+f459a6810c,gd7ef33dd92+f459a6810c,gdab6d2f7ff+0bae3c876a,ge410e46f29+f459a6810c,ge41e95a9f2+7416ca6900,geaed405ab2+e3b4b2a692,gf9a733ac38+8c5ae1fdc5,w.2025.43
LSST Data Management Base Package
Loading...
Searching...
No Matches
apdbAdmin.py
Go to the documentation of this file.
1# This file is part of dax_apdb.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (http://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 <http://www.gnu.org/licenses/>.
21
22from __future__ import annotations
23
24__all__ = ["ApdbAdmin", "DiaForcedSourceLocator", "DiaObjectLocator", "DiaSourceLocator"]
25
26from abc import ABC, abstractmethod
27from collections.abc import Iterable
28from typing import NamedTuple
29
30
31class DiaObjectLocator(NamedTuple):
32 """Collection of facts necessary to locate DiaObject."""
33
34 diaObjectId: int
35 ra: float # degrees
36 dec: float # degrees
37
38
39class DiaSourceLocator(NamedTuple):
40 """Collection of facts necessary to locate DiaSource."""
41
42 diaSourceId: int
43 diaObjectId: int # This is not identifying, but needed for other reasons.
44 ra: float # degrees
45 dec: float # degrees
46 midpointMjdTai: float
47
48
49class DiaForcedSourceLocator(NamedTuple):
50 """Collection of facts necessary to locate DiaForcedSource."""
51
52 diaObjectId: int
53 visit: int
54 detector: int
55 ra: float # degrees
56 dec: float # degrees
57 midpointMjdTai: float
58
59
60class ApdbAdmin(ABC):
61 """Abstract interface for administrative tasks for APDB."""
62
63 @abstractmethod
64 def apdb_part(self, ra_deg: float, dec_deg: float) -> int:
65 """Return spatial partition index for given coordinates.
66
67 Parameters
68 ----------
69 ra_deg, dec_deg : `float`
70 Spatial coordinates, in degrees.
71
72 Returns
73 -------
74 index : `int`
75 Spatial partition index.
76 """
77 raise NotImplementedError()
78
79 @abstractmethod
80 def apdb_time_part(self, midpointMjdTai: float) -> int:
81 """Return temporal partition index for given time.
82
83 Parameters
84 ----------
85 midpointMjdTai : `float`
86 Time in MJD.
87
88 Returns
89 -------
90 index : `int`
91 Temporal partition index.
92 """
93 raise NotImplementedError()
94
95 @abstractmethod
97 self,
98 objects: Iterable[DiaObjectLocator],
99 sources: Iterable[DiaSourceLocator],
100 forced_sources: Iterable[DiaForcedSourceLocator],
101 ) -> None:
102 """Remove DiaObjects and all their associated DiaSources and
103 DiaForcedSources from database.
104
105 Parameters
106 ----------
107 objects : `~collections.abc.Iterable` [`DiaObjectLocator`]
108 Locators for DiaObject records to remove.
109 sources : `~collections.abc.Iterable` [`DiaSourceLocator`]
110 Locators for DiaSource records to remove.
111 forced_sources : `~collections.abc.Iterable` [`DiaSourceLocator`]
112 Locators for DiaForcedSource records to remove.
113
114 Notes
115 -----
116 The list of sources has to include all sources associated with objects
117 in ``objects`` list. Sources that are not associated with any object
118 from ``objects`` are not removed.
119 """
120 raise NotImplementedError()
int apdb_part(self, float ra_deg, float dec_deg)
Definition apdbAdmin.py:64
None delete_records(self, Iterable[DiaObjectLocator] objects, Iterable[DiaSourceLocator] sources, Iterable[DiaForcedSourceLocator] forced_sources)
Definition apdbAdmin.py:101
int apdb_time_part(self, float midpointMjdTai)
Definition apdbAdmin.py:80