lsst.obs.lsst

The obs_lsst module defines LSST camera specific configuration.

Contributing

lsst.obs.lsst is developed at https://github.com/lsst/obs_lsst. You can find Jira issues for this module under the obs_lsst component.

• Adding a new camera
• Testing the Package

Command Line Scripts

generateCamera.py

Generate a camera.yaml file for a camera by assembling descriptions of rafts, sensors, etc.

Because we have many similar cameras, the assembly uses a :-separated search path of directories to find desired information. The _first_ occurrence of a filename is used.

usage: generateCamera.py [-h] [--path PATH] [--verbose] outputFile

positional arguments

outputfile

Name of generated file

optional arguments

-h, --help

show this help message and exit

--path <path>

List of directories to search for components

--verbose

How chatty should I be?

phossimToRafts.py

Read phoSim headers and write the per-raft datafiles

usage: phossimToRafts.py [-h] [--id ID] [--visit VISIT] [--log LOG]
                         [--output_dir OUTPUT_DIR]
                         input

positional arguments

input

Path to input data repository

optional arguments

-h, --help

show this help message and exit

--id <id>

ID for data (visit=XXX)

--visit <visit>

visit to read

--log <log>

Specify logging level to use

--output_dir <output_dir>

Path to output data directory (must exist)

rewrite_ts8_qe_files.py

Rewrite native FITS files from the test stand to a standard format

usage: rewrite_ts8_qe_files.py [-h] [--out_root OUT_ROOT]
                               [--valid_start VALID_START]
                               picklefile

positional arguments

picklefile

Pickle file to read.

optional arguments

-h, --help

show this help message and exit

--out_root <out_root>

Root directory to which to write outputs

--valid_start <valid_start>

ISO format date string stating the start of the validity range.

Python API reference

lsst.obs.lsst Package

Functions

readRawFitsHeader(fileName[, translator_class])

Read a FITS header from a raw file and fix it up as required.

Classes

Latiss(collection_prefix)	Gen3 Butler specialization for AuxTel LATISS data.
LsstCam(collection_prefix)	Gen3 Butler specialization for the LSST Main Camera.
LsstCamImSim(collection_prefix)	Gen3 Butler specialization for ImSim simulations.
LsstCamMakeRawVisitInfo([log, doStripHeader])	Make a VisitInfo from the FITS header of a raw image.
LsstCamMapper([inputPolicy])	The mapper for lsstCam.
LsstCamPhoSim(collection_prefix)	Gen3 Butler specialization for Phosim simulations.
LsstComCam(collection_prefix)	Gen3 Butler specialization for ComCam data.
LsstTS3(collection_prefix)	Gen3 Butler specialization for TS3 test stand data.
LsstTS8(collection_prefix)	Gen3 Butler specialization for raft test stand data.
LsstUCDCam(collection_prefix)	Gen3 Butler specialization for UCDCam test stand data.

Class Inheritance Diagram

lsst.obs.lsst.latiss Module

Classes

LatissMapper([inputPolicy])	The Mapper for the LATISS camera.
LatissParseTask(config, *args, **kwargs)	Parser suitable for LATISS raw data.

Class Inheritance Diagram

lsst.obs.lsst.imsim Module

Classes

ImsimMapper([inputPolicy])	The Mapper for the imsim simulations of the LsstCam.
ImsimParseTask(config, *args, **kwargs)	Parser suitable for imsim data.

Class Inheritance Diagram

lsst.obs.lsst.ts8 Module

Classes

Ts8Mapper([inputPolicy])	The Mapper for the ts8 camera.
Ts8ParseTask(config, *args, **kwargs)	Parser suitable for ts8 data.

Class Inheritance Diagram

lsst.obs.lsst.ts3 Module

Classes

Ts3Mapper([inputPolicy])	The Mapper for the ts3 camera.
Ts3ParseTask(config, *args, **kwargs)	Parser suitable for ts3 data.

Class Inheritance Diagram

lsst.obs.lsst.ucd Module

Classes

UcdMapper([inputPolicy])	The Mapper for the UCDavis camera.
UcdParseTask(config, *args, **kwargs)	Parser suitable for UCD data.

Class Inheritance Diagram

lsst.obs.lsst.phosim Module

Classes

PhosimMapper([inputPolicy])	The Mapper for the phosim simulations of the LsstCam.
PhosimParseTask(config, *args, **kwargs)	Parser suitable for phosim data.
PhosimEimgParseTask(config, *args, **kwargs)	Parser suitable for phosim eimage data.

Class Inheritance Diagram

lsst.obs.lsst.ingest Module

Classes

LsstCamParseTask(config, *args, **kwargs)	Parser suitable for lsstCam data.
LsstCamEimgParseTask(config, *args, **kwargs)	Parser suitable for phosim LsstCam eimage data.

Class Inheritance Diagram

lsst.obs.lsst.testHelper Module

Classes

ObsLsstButlerTests([methodName])	Base class shared by all tests of the butler and mapper.
ObsLsstObsBaseOverrides	Specialist butler tests for obs_lsst.

Class Inheritance Diagram

lsst.obs.lsst.utils Module

Functions

readRawFile(fileName, detector[, dataId])

Read a raw file from fileName, assembling it nicely.

lsst.obs.lsst.translators Package

Classes

LatissTranslator(header[, filename])	Metadata translator for LSST LATISS data from AuxTel.
LsstCamImSimTranslator(header[, filename])	Metadata translation class for LSSTCam imSim headers
LsstCamPhoSimTranslator(header[, filename])	Metadata translator for LSSTCam PhoSim data.
LsstCamTranslator(header[, filename])	Metadata translation for the main LSST Camera.
LsstComCamTranslator(header[, filename])	Metadata translation for the LSST Commissioning Camera.
LsstTS3Translator(header[, filename])	Metadata translator for LSST BNL Test Stand 3 data.
LsstTS8Translator(header[, filename])	Metadata translator for LSST Test Stand 8 data.
LsstUCDCamTranslator(header[, filename])	Metadata translator for LSST UC Davis test camera data.

Class Inheritance Diagram