Coverage for python / lsst / pipe / base / utils.py: 100%

1# This file is part of pipe_base. 

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 software is dual licensed under the GNU General Public License and also 

10# under a 3-clause BSD license. Recipients may choose which of these licenses 

11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt, 

12# respectively. If you choose the GPL option then the following text applies 

13# (but note that there is still no warranty even if you opt for BSD instead): 

14# 

15# This program is free software: you can redistribute it and/or modify 

16# it under the terms of the GNU General Public License as published by 

17# the Free Software Foundation, either version 3 of the License, or 

18# (at your option) any later version. 

19# 

20# This program is distributed in the hope that it will be useful, 

21# but WITHOUT ANY WARRANTY; without even the implied warranty of 

22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

23# GNU General Public License for more details. 

24# 

25# You should have received a copy of the GNU General Public License 

26# along with this program. If not, see <https://www.gnu.org/licenses/>. 

27 

28 

29from __future__ import annotations 

30 

31__all__ = [ 

32 "RegionTimeInfo", 

33] 

34 

35 

36import pydantic 

37 

38import lsst.daf.butler 

39 

40 

41class RegionTimeInfo(pydantic.BaseModel): 

42 """A serializable container for a sky region and timespan. 

43 

44 This container is intended to support translation of observation metadata 

45 between Butler dimension records, Butler datasets, and exposure headers. 

46 """ 

47 

48 region: lsst.daf.butler.pydantic_utils.SerializableRegion 

49 """The sky region stored in this object (`lsst.sphgeom.Region`).""" 

50 timespan: lsst.daf.butler.Timespan 

51 """The time interval stored in this object (`lsst.daf.butler.Timespan`)."""