Coverage for python / lsst / obs / base / visit_geometry.py: 100%

1# This file is part of obs_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 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__ = ("VisitGeometry",) 

25 

26 

27import pydantic 

28 

29from lsst.daf.butler.pydantic_utils import SerializableRegion 

30 

31 

32class VisitGeometry(pydantic.BaseModel): 

33 """A serializable struct that holds geometry information for a visit. 

34 

35 This is intended to be used as a butler output dataset intermediary between 

36 a tasks that fit coordinate mappings from stars to reference catalogs and 

37 tool that update butler dimension record regions. 

38 """ 

39 

40 boresight_ra: float 

41 """Re-fit boresight right ascension in degrees.""" 

42 

43 boresight_dec: float 

44 """Re-fit boresight declination in degrees.""" 

45 

46 orientation: float 

47 """Re-fit rotation angle in degress.""" 

48 

49 visit_region: SerializableRegion 

50 """Updated region for the visit.""" 

51 

52 detector_regions: dict[int, SerializableRegion] = pydantic.Field(default_factory=dict) 

53 """Updated region for each detector in this visit."""