Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

# This file is part of astro_metadata_translator. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (http://www.lsst.org). 

# See the LICENSE file at the top-level directory of this distribution 

# for details of code ownership. 

# 

# Use of this source code is governed by a 3-clause BSD-style 

# license that can be found in the LICENSE file. 

 

"""Properties calculated by this package. 

 

Defines all properties in one place so that both `ObservationInfo` and 

`MetadataTranslator` can use them. In particular, the translator 

base class can use knowledge of these properties to predefine translation 

stubs with documentation attached, and `ObservationInfo` can automatically 

define the getter methods. 

 

""" 

 

__all__ = ("PROPERTIES", ) 

 

import astropy.coordinates 

import astropy.time 

import astropy.units 

 

 

# Dict of properties to tuple where tuple is: 

# - description of property 

# - Python type of property as a string (suitable for docstrings) 

PROPERTIES = {"telescope": ("Full name of the telescope.", "str", str), 

"instrument": ("The instrument used to observe the exposure.", "str", str), 

"location": ("Location of the observatory.", "astropy.coordinates.EarthLocation", 

astropy.coordinates.EarthLocation), 

"exposure_id": ("Unique (with instrument) integer identifier for this observation.", "int", 

int), 

"visit_id": ("""ID of the Visit this Exposure is associated with. 

 

Science observations should essentially always be 

associated with a visit, but calibration observations 

may not be.""", "int", int), 

"physical_filter": ("The bandpass filter used for this observation.", "str", str), 

"datetime_begin": ("Time of the start of the observation.", "astropy.time.Time", 

astropy.time.Time), 

"datetime_end": ("Time of the end of the observation.", "astropy.time.Time", 

astropy.time.Time), 

"exposure_time": ("Duration of the exposure with shutter open (seconds).", 

"astropy.units.Quantity", astropy.units.Quantity), 

"dark_time": ("Duration of the exposure with shutter closed (seconds).", 

"astropy.units.Quantity", astropy.units.Quantity), 

"boresight_airmass": ("Airmass of the boresight of the telescope.", "float", float), 

"boresight_rotation_angle": ("Angle of the instrument in boresight_rotation_coord frame.", 

"astropy.coordinates.Angle", astropy.coordinates.Angle), 

"boresight_rotation_coord": ("Coordinate frame of the instrument rotation angle" 

" (options: sky, unknown).", "str", str), 

"detector_num": ("Unique (for instrument) integer identifier for the sensor.", "int", int), 

"detector_name": ("Name of the detector within the instrument (might not be unique" 

" if there are detector groups).", 

"str", str), 

"detector_unique_name": ("Unique name of the detector within the focal plane, generally" 

" combining detector_group with detector_name.", 

"str", str), 

"detector_serial": ("Serial number/string associated with this detector.", "str", str), 

"detector_group": ("Collection name of which this detector is a part. " 

"Can be None if there are no detector groupings.", "str", str), 

"detector_exposure_id": ("Unique integer identifier for this detector in this exposure.", 

"int", int), 

"object": ("Object of interest or field name.", "str", str), 

"temperature": ("Temperature outside the dome.", "astropy.units.Quantity", 

astropy.units.Quantity), 

"pressure": ("Atmospheric pressure outside the dome.", "astropy.units.Quantity", 

astropy.units.Quantity), 

"relative_humidity": ("Relative humidity outside the dome.", "float", float), 

"tracking_radec": ("Requested RA/Dec to track.", "astropy.coordinates.SkyCoord", 

astropy.coordinates.SkyCoord), 

"altaz_begin": ("Telescope boresight azimuth and elevation at start of observation.", 

"astropy.coordinates.AltAz", astropy.coordinates.AltAz), 

"science_program": ("Observing program (survey or proposal) identifier.", "str", str), 

"observation_type": ("Type of observation (currently: science, dark, flat, bias, focus).", 

"str", str), 

"observation_id": ("Label uniquely identifying this observation " 

"(can be related to 'exposure_id').", 

"str", str)}