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.
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
options¶
- -h, --help¶
show this help message and exit
- --path <path>¶
List of directories to search for components
- --verbose¶
How chatty should I be?
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.
options¶
- -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¶
|
Read a FITS header from a raw file and fix it up as required. |
Classes¶
|
Gen3 Butler specialization for AuxTel LATISS data. |
|
Gen3 Butler specialization for the LSST Main Camera. |
|
Gen3 Butler specialization for ImSim simulations. |
|
Gen3 Butler specialization for Phosim simulations. |
|
Gen3 Butler specialization for ComCam data. |
|
Gen3 Butler specialization for ComCamSim data. |
|
Gen3 Butler specialization for TS3 test stand data. |
|
Gen3 Butler specialization for raft test stand data. |
|
Gen3 Butler specialization for UCDCam test stand data. |
|
Configuration class for PhotodiodeIngestTask. |
|
Task to ingest photodiode data into a butler repository. |
|
A data ID packer that converts Rubin visit+detector and exposure+detector data IDs to integers. |
Class Inheritance Diagram¶
digraph inheritance568cdc07e2 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "Config" [URL="../../../py-api/lsst.pex.config.Config.html#lsst.pex.config.Config",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for configuration (*config*) objects."]; "DimensionPacker" [URL="../../../py-api/lsst.daf.butler.DimensionPacker.html#lsst.daf.butler.DimensionPacker",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class for going from `DataCoordinate` to packed integer ID and back."]; "Instrument" [URL="../../../py-api/lsst.obs.base.Instrument.html#lsst.obs.base.Instrument",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Rubin-specified base for instrument-specific logic for the Gen3 Butler."]; "Instrument" -> "Instrument" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Instrument" [URL="../../../py-api/lsst.pipe.base.Instrument.html#lsst.pipe.base.Instrument",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for instrument-specific logic for the Gen3 Butler."]; "Latiss" [URL="../../../py-api/lsst.obs.lsst.Latiss.html#lsst.obs.lsst.Latiss",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Gen3 Butler specialization for AuxTel LATISS data."]; "LsstCam" -> "Latiss" [arrowsize=0.5,style="setlinewidth(0.5)"]; "LsstCam" [URL="../../../py-api/lsst.obs.lsst.LsstCam.html#lsst.obs.lsst.LsstCam",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Gen3 Butler specialization for the LSST Main Camera."]; "Instrument" -> "LsstCam" [arrowsize=0.5,style="setlinewidth(0.5)"]; "LsstCamImSim" [URL="../../../py-api/lsst.obs.lsst.LsstCamImSim.html#lsst.obs.lsst.LsstCamImSim",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Gen3 Butler specialization for ImSim simulations."]; "LsstCam" -> "LsstCamImSim" [arrowsize=0.5,style="setlinewidth(0.5)"]; "LsstCamPhoSim" [URL="../../../py-api/lsst.obs.lsst.LsstCamPhoSim.html#lsst.obs.lsst.LsstCamPhoSim",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Gen3 Butler specialization for Phosim simulations."]; "LsstCam" -> "LsstCamPhoSim" [arrowsize=0.5,style="setlinewidth(0.5)"]; "LsstComCam" [URL="../../../py-api/lsst.obs.lsst.LsstComCam.html#lsst.obs.lsst.LsstComCam",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Gen3 Butler specialization for ComCam data."]; "LsstCam" -> "LsstComCam" [arrowsize=0.5,style="setlinewidth(0.5)"]; "LsstComCamSim" [URL="../../../py-api/lsst.obs.lsst.LsstComCamSim.html#lsst.obs.lsst.LsstComCamSim",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Gen3 Butler specialization for ComCamSim data."]; "LsstCam" -> "LsstComCamSim" [arrowsize=0.5,style="setlinewidth(0.5)"]; "LsstTS3" [URL="../../../py-api/lsst.obs.lsst.LsstTS3.html#lsst.obs.lsst.LsstTS3",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Gen3 Butler specialization for TS3 test stand data."]; "LsstCam" -> "LsstTS3" [arrowsize=0.5,style="setlinewidth(0.5)"]; "LsstTS8" [URL="../../../py-api/lsst.obs.lsst.LsstTS8.html#lsst.obs.lsst.LsstTS8",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Gen3 Butler specialization for raft test stand data."]; "LsstCam" -> "LsstTS8" [arrowsize=0.5,style="setlinewidth(0.5)"]; "LsstUCDCam" [URL="../../../py-api/lsst.obs.lsst.LsstUCDCam.html#lsst.obs.lsst.LsstUCDCam",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Gen3 Butler specialization for UCDCam test stand data."]; "LsstCam" -> "LsstUCDCam" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PhotodiodeIngestConfig" [URL="../../../py-api/lsst.obs.lsst.PhotodiodeIngestConfig.html#lsst.obs.lsst.PhotodiodeIngestConfig",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Configuration class for PhotodiodeIngestTask."]; "Config" -> "PhotodiodeIngestConfig" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PhotodiodeIngestTask" [URL="../../../py-api/lsst.obs.lsst.PhotodiodeIngestTask.html#lsst.obs.lsst.PhotodiodeIngestTask",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Task to ingest photodiode data into a butler repository."]; "Task" -> "PhotodiodeIngestTask" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RubinDimensionPacker" [URL="../../../py-api/lsst.obs.lsst.RubinDimensionPacker.html#lsst.obs.lsst.RubinDimensionPacker",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A data ID packer that converts Rubin visit+detector and"]; "DimensionPacker" -> "RubinDimensionPacker" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Task" [URL="../../../py-api/lsst.pipe.base.Task.html#lsst.pipe.base.Task",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for data processing tasks."]; }lsst.obs.lsst.testHelper Module¶
Classes¶
|
Base class shared by all tests of the butler and mapper. |
Specialist butler tests for obs_lsst. |
Class Inheritance Diagram¶
digraph inheritance6d22644984 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ButlerGetTests" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Tests of obs_* Butler get() functionality."]; "CameraTests" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Tests that the butler returns a useable Camera."]; "ObsLsstButlerTests" [URL="../../../py-api/lsst.obs.lsst.testHelper.ObsLsstButlerTests.html#lsst.obs.lsst.testHelper.ObsLsstButlerTests",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class shared by all tests of the butler and mapper."]; "TestCase" -> "ObsLsstButlerTests" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ObsLsstObsBaseOverrides" [URL="../../../py-api/lsst.obs.lsst.testHelper.ObsLsstObsBaseOverrides.html#lsst.obs.lsst.testHelper.ObsLsstObsBaseOverrides",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Specialist butler tests for obs_lsst."]; "ObsTests" -> "ObsLsstObsBaseOverrides" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ObsTests" [URL="../../../py-api/lsst.obs.base.tests.ObsTests.html#lsst.obs.base.tests.ObsTests",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Aggregator class for all of the obs_* test classes."]; "ButlerGetTests" -> "ObsTests" [arrowsize=0.5,style="setlinewidth(0.5)"]; "CameraTests" -> "ObsTests" [arrowsize=0.5,style="setlinewidth(0.5)"]; "TestCase" [URL="../../../py-api/lsst.utils.tests.TestCase.html#lsst.utils.tests.TestCase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Subclass of unittest.TestCase that adds some custom assertions for"]; "TestCase" -> "TestCase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "TestCase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A class whose instances are single test cases."]; }lsst.obs.lsst.utils Module¶
Functions¶
|
Read a raw file from fileName, assembling it nicely. |
lsst.obs.lsst.translators Package¶
Classes¶
|
Metadata translator for LSST LATISS data from AuxTel. |
|
Metadata translation class for LSSTCam imSim headers |
|
Metadata translator for LSSTCam PhoSim data. |
|
Metadata translation for the main LSST Camera. |
|
Metadata translation for the LSST Commissioning Camera. |
|
Metadata translation for the LSST Commissioning Camera. |
|
Metadata translator for LSST BNL Test Stand 3 data. |
|
Metadata translator for LSST Test Stand 8 data. |
|
Metadata translator for LSST UC Davis Test Stand. |