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

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

# This file is currently part of obs_lsst but is written to allow it 

# to be migrated to the astro_metadata_translator package at a later date. 

# 

# This product includes software developed by the LSST Project 

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

# See the LICENSE file in this directory 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. 

 

"""Metadata translation support code for LSST headers""" 

 

__all__ = ("ROLLOVERTIME", "TZERO", "LSST_LOCATION", "read_detector_ids", 

"compute_detector_exposure_id_generic", "LsstBaseTranslator") 

 

import os.path 

import yaml 

import logging 

 

import astropy.units as u 

from astropy.time import Time, TimeDelta 

from astropy.coordinates import EarthLocation 

 

from lsst.utils import getPackageDir 

 

from astro_metadata_translator import cache_translation, FitsTranslator 

 

# LSST day clock starts at UTC+8 

ROLLOVERTIME = TimeDelta(8*60*60, scale="tai", format="sec") 

TZERO = Time("2010-01-01T00:00", format="isot", scale="utc") 

 

# LSST Default location in the absence of headers 

LSST_LOCATION = EarthLocation.from_geodetic(-30.244639, -70.749417, 2663.0) 

 

obs_lsst_packageDir = getPackageDir("obs_lsst") 

 

log = logging.getLogger(__name__) 

 

 

def read_detector_ids(policyFile): 

"""Read a camera policy file and retrieve the mapping from CCD name 

to ID. 

 

Parameters 

---------- 

policyFile : `str` 

Name of YAML policy file to read, relative to the obs_lsst 

package. 

 

Returns 

------- 

mapping : `dict` of `str` to (`int`, `str`) 

A `dict` with keys being the full names of the detectors, and the 

value is a `tuple` containing the integer detector number and the 

detector serial number. 

 

Notes 

----- 

Reads the camera YAML definition file directly and extracts just the 

IDs and serials. This routine does not use the standard 

`~lsst.obs.base.yamlCamera.YAMLCamera` infrastructure or 

`lsst.afw.cameraGeom`. This is because the translators are intended to 

have minimal dependencies on LSST infrastructure. 

""" 

 

file = os.path.join(obs_lsst_packageDir, policyFile) 

try: 

with open(file) as fh: 

# Use the fast parser since these files are large 

camera = yaml.load(fh, Loader=yaml.CSafeLoader) 

except OSError as e: 

raise ValueError(f"Could not load camera policy file {file}") from e 

 

mapping = {} 

for ccd, value in camera["CCDs"].items(): 

mapping[ccd] = (int(value["id"]), value["serial"]) 

 

return mapping 

 

 

def compute_detector_exposure_id_generic(exposure_id, detector_num, max_num=1000, mode="concat"): 

"""Compute the detector_exposure_id from the exposure id and the 

detector number. 

 

Parameters 

---------- 

exposure_id : `int` 

The exposure ID. 

detector_num : `int` 

The detector number. 

max_num : `int`, optional 

Maximum number of detectors to make space for. Defaults to 1000. 

mode : `str`, optional 

Computation mode. Defaults to "concat". 

- concat : Concatenate the exposure ID and detector number, making 

sure that there is space for max_num and zero padding. 

- multiply : Multiply the exposure ID by the maximum detector 

number and add the detector number. 

 

Returns 

------- 

detector_exposure_id : `int` 

Computed ID. 

 

Raises 

------ 

ValueError 

The detector number is out of range. 

""" 

 

if detector_num is None: 

raise ValueError("Detector number must be defined.") 

if detector_num >= max_num or detector_num < 0: 

raise ValueError(f"Detector number out of range 0 <= {detector_num} <= {max_num}") 

 

if mode == "concat": 

npad = len(str(max_num)) 

return int(f"{exposure_id}{detector_num:0{npad}d}") 

elif mode == "multiply": 

return max_num*exposure_id + detector_num 

else: 

raise ValueError(f"Computation mode of '{mode}' is not understood") 

 

 

class LsstBaseTranslator(FitsTranslator): 

"""Translation methods useful for all LSST-style headers.""" 

 

_const_map = {} 

_trivial_map = {} 

 

# Do not specify a name for this translator 

cameraPolicyFile = None 

"""Path to policy file relative to obs_lsst root.""" 

 

detectorMapping = None 

"""Mapping of detector name to detector number and serial.""" 

 

detectorSerials = None 

"""Mapping of detector serial number to raft, number, and name.""" 

 

@staticmethod 

def compute_detector_exposure_id(exposure_id, detector_num): 

"""Compute the detector exposure ID from detector number and 

exposure ID. 

 

This is a helper method to allow code working outside the translator 

infrastructure to use the same algorithm. 

 

Parameters 

---------- 

exposure_id : `int` 

Unique exposure ID. 

detector_num : `int` 

Detector number. 

 

Returns 

------- 

detector_exposure_id : `int` 

The calculated ID. 

""" 

return compute_detector_exposure_id_generic(exposure_id, detector_num, max_num=999, 

mode="concat") 

 

@classmethod 

def detector_mapping(cls): 

"""Returns the mapping of full name to detector ID and serial. 

 

Returns 

------- 

mapping : `dict` of `str`:`tuple` 

Returns the mapping of full detector name (group+detector) 

to detector number and serial. 

 

Raises 

------ 

ValueError 

Raised if no camera policy file has been registered with this 

translation class. 

 

Notes 

----- 

Will construct the mapping if none has previously been constructed. 

""" 

if cls.cameraPolicyFile is not None: 

if cls.detectorMapping is None: 

cls.detectorMapping = read_detector_ids(cls.cameraPolicyFile) 

else: 

raise ValueError(f"Translation class '{cls.__name__}' has no registered camera policy file") 

 

return cls.detectorMapping 

 

@classmethod 

def detector_serials(cls): 

"""Obtain the mapping of detector serial to detector group, name, 

and number. 

 

Returns 

------- 

info : `dict` of `tuple` of (`str`, `str`, `int`) 

A `dict` with the serial numbers as keys and values of detector 

group, name, and number. 

""" 

if cls.detectorSerials is None: 

detector_mapping = cls.detector_mapping() 

 

if detector_mapping is not None: 

# Form mapping to go from serial number to names/numbers 

serials = {} 

for fullname, (id, serial) in cls.detectorMapping.items(): 

raft, detector_name = fullname.split("_") 

if serial in serials: 

raise RuntimeError(f"Serial {serial} is defined in multiple places") 

serials[serial] = (raft, detector_name, id) 

cls.detectorSerials = serials 

else: 

raise RuntimeError("Unable to obtain detector mapping information") 

 

return cls.detectorSerials 

 

@classmethod 

def compute_detector_num_from_name(cls, detector_group, detector_name): 

"""Helper method to return the detector number from the name. 

 

Parameters 

---------- 

detector_group : `str` 

Name of the detector grouping. This is generally the raft name. 

detector_name : `str` 

Detector name. 

 

Returns 

------- 

num : `int` 

Detector number. 

""" 

fullname = f"{detector_group}_{detector_name}" 

 

num = None 

detector_mapping = cls.detector_mapping() 

if detector_mapping is None: 

raise RuntimeError("Unable to obtain detector mapping information") 

 

if fullname in detector_mapping: 

num = detector_mapping[fullname] 

else: 

log.warning(f"Unable to determine detector number from detector name {fullname}") 

return None 

 

return num[0] 

 

@classmethod 

def compute_detector_info_from_serial(cls, detector_serial): 

"""Helper method to return the detector information from the serial. 

 

Parameters 

---------- 

detector_serial : `str` 

Detector serial ID. 

 

Returns 

------- 

info : `tuple` of (`str`, `str`, `int`) 

Detector group, name, and number. 

""" 

serial_mapping = cls.detector_serials() 

if serial_mapping is None: 

raise RuntimeError("Unable to obtain serial mapping information") 

 

if detector_serial in serial_mapping: 

info = serial_mapping[detector_serial] 

else: 

raise RuntimeError("Unable to determine detector information from detector serial" 

f" {detector_serial}") 

 

return info 

 

@staticmethod 

def compute_exposure_id(dayobs, seqnum): 

"""Helper method to calculate the AuxTel exposure_id. 

 

Parameters 

---------- 

dayobs : `str` 

Day of observation in either YYYYMMDD or YYYY-MM-DD format. 

seqnum : `int` or `str` 

Sequence number. 

 

Returns 

------- 

exposure_id : `int` 

Exposure ID in form YYYYMMDDnnnnn form. 

""" 

dayobs = dayobs.replace("-", "") 

 

if len(dayobs) != 8: 

raise ValueError(f"Malformed dayobs: {dayobs}") 

 

# Expect no more than 99,999 exposures in a day 

maxdigits = 5 

if seqnum >= 10**maxdigits: 

raise ValueError(f"Sequence number ({seqnum}) exceeds limit") 

 

# Form the number as a string zero padding the sequence number 

idstr = f"{dayobs}{seqnum:0{maxdigits}d}" 

return int(idstr) 

 

def _is_on_mountain(self): 

"""Indicate whether these data are coming from the instrument 

installed on the mountain. 

 

Returns 

------- 

is : `bool` 

`True` if instrument is on the mountain. 

""" 

if "TSTAND" in self._header: 

return False 

return True 

 

@cache_translation 

def to_location(self): 

# Docstring will be inherited. Property defined in properties.py 

location = None 

if not self._is_on_mountain(): 

return location 

try: 

# Try standard FITS headers 

return super().to_location() 

except KeyError: 

return LSST_LOCATION 

 

@cache_translation 

def to_datetime_begin(self): 

# Docstring will be inherited. Property defined in properties.py 

self._used_these_cards("MJD-OBS") 

return Time(self._header["MJD-OBS"], scale="tai", format="mjd") 

 

@cache_translation 

def to_datetime_end(self): 

# Docstring will be inherited. Property defined in properties.py 

if self.is_key_ok("DATE-END"): 

return super().to_datetime_end() 

 

return self.to_datetime_begin() + self.to_exposure_time() 

 

@cache_translation 

def to_detector_num(self): 

# Docstring will be inherited. Property defined in properties.py 

raft = self.to_detector_group() 

detector = self.to_detector_name() 

return self.compute_detector_num_from_name(raft, detector) 

 

@cache_translation 

def to_detector_exposure_id(self): 

# Docstring will be inherited. Property defined in properties.py 

exposure_id = self.to_exposure_id() 

num = self.to_detector_num() 

return self.compute_detector_exposure_id(exposure_id, num) 

 

@cache_translation 

def to_observation_type(self): 

# Docstring will be inherited. Property defined in properties.py 

obstype = self._header["IMGTYPE"] 

self._used_these_cards("IMGTYPE") 

obstype = obstype.lower() 

if obstype == "skyexp": 

obstype = "science" 

return obstype 

 

@cache_translation 

def to_dark_time(self): 

"""Calculate the dark time. 

 

If a DARKTIME header is not found, the value is assumed to be 

identical to the exposure time. 

 

Returns 

------- 

dark : `astropy.units.Quantity` 

The dark time in seconds. 

""" 

if self.is_key_ok("DARKTIME"): 

darktime = self._header("DARKTIME")*u.s 

else: 

log.warning("Unable to determine dark time. Setting from exposure time.") 

darktime = self.to_exposure_time() 

return darktime 

 

@cache_translation 

def to_exposure_id(self): 

"""Generate a unique exposure ID number 

 

This is a combination of DAYOBS and SEQNUM. 

 

Returns 

------- 

exposure_id : `int` 

Unique exposure number. 

""" 

if "CALIB_ID" in self._header: 

self._used_these_cards("CALIB_ID") 

return None 

 

dayobs = self._header["DAYOBS"] 

seqnum = self._header["SEQNUM"] 

self._used_these_cards("DAYOBS", "SEQNUM") 

 

return self.compute_exposure_id(dayobs, seqnum) 

 

# For now "visits" are defined to be identical to exposures. 

to_visit_id = to_exposure_id 

 

@cache_translation 

def to_physical_filter(self): 

"""Calculate the physical filter name. 

 

Returns 

------- 

filter : `str` 

Name of filter. Can be a combination of FILTER, FILTER1 and FILTER2 

headers joined by a "+". Returns "NONE" if no filter is declared. 

""" 

joined = self._join_keyword_values(["FILTER", "FILTER1", "FILTER2"], delim="+") 

if not joined: 

joined = "NONE" 

 

return joined