lsst.obs.base

The lsst.obs.base module provides the framework and common API for telescope/camera specific “obs” packages. New cameras will derive from the classes defined here. lsst.obs.base.tests provides the tests that all “obs” packages should pass.

Changes

• obs_base v30.0.2 (2026-02-06)
• obs_base v30.0.0 (2026-01-16)
• obs_base v29.0.0 (2025-03-26)
• obs_base v28.0.0 (2024-11-21)
• obs_base v27.0.0 (2024-06-05)
• obs_base v26.0.0 (2023-08-03)
• obs_base v25.0.0 (2023-03-02)
• obs_base v24.0.0 (2022-08-30)
• obs_base v23.0.0 (2021-12-10)
• obs_base v22.0 (2021-04-01)

Using lsst.obs.base

• How to create a new LSST obs package

Contributing

lsst.obs.base is developed at lsst/obs_base. You can find Jira issues for this module under the obs_base component.

Command Line Interface

daf_butler implements a command line interface command called butler. The following subcommands are implemented by this package and available to the butler command when this package is setup.

Python API reference

lsst.obs.base Package

Functions

add_provenance_to_fits_header(hdr, ref[, ...])	Modify the given header to include provenance headers.
bboxFromIraf(irafBBoxStr)	Return a Box2I corresponding to an IRAF-style BBOX.
createInitialSkyWcs(visitInfo, detector[, flipX])	Create a SkyWcs from the visit information and detector geometry.
createInitialSkyWcsFromBoresight(boresight, ...)	Create a SkyWcs from the telescope boresight and detector geometry.
iso_date_to_curated_calib_file_root(valid_start)	Parse an ISO time, potentially from a calibration valid start time, and convert to form suitable for use in a curated calibration filename.
loadCamera(butler, dataId, *[, collections])	Attempt to load versioned camera geometry from a butler, but fall back to obtaining a nominal camera from the Instrument class if that fails.
makeExposureRecordFromObsInfo(obsInfo, ...)	Construct an exposure DimensionRecord from astro_metadata_translator.ObservationInfo.
makeTransferChoiceField([doc, default])	Create a Config field with options for transferring data between repos.
strip_provenance_from_fits_header(hdr)	Remove all FITS headers relating to butler provenance.

Classes

ComputeVisitRegionsConfig(*args, **kw)	Configure visit region calculations.
ComputeVisitRegionsTask(config, *, butler, ...)	Abstract base class for the subtask of DefineVisitsTask that is responsible for extracting spatial regions for visits and visit+detector combinations.
DefineVisitsConfig(*args, **kw)	Configure visit definition.
DefineVisitsTask(config, *, butler, **kwargs)	Driver Task for defining visits (and their spatial regions) in Gen3 Butler repositories.
FilterDefinition(physical_filter[, band, ...])	The definition of an instrument's filter bandpass.
FilterDefinitionCollection(*filters)	An order-preserving collection of multiple FilterDefinition.
FitsRawFormatterBase(*args, **kwargs)	Abstract base class for reading and writing raw data to and from FITS files.
GroupExposuresConfig(*args, **kw)	Configure exposure grouping.
GroupExposuresTask(config, **kwargs)	Abstract base class for the subtask of DefineVisitsTask that is responsible for grouping exposures into visits.
InitialSkyWcsError	For handling failures when creating a SkyWcs from a camera geometry and boresight.
Instrument([collection_prefix])	Rubin-specified base for instrument-specific logic for the Gen3 Butler.
MakeRawVisitInfoViaObsInfo([log, doStripHeader])	Base class functor to make a VisitInfo from the FITS header of a raw image using ObservationInfo translators.
RawExposureData(dataId, files, universe, ...)	Information about a complete raw exposure, used during ingest.
RawFileData(datasets, filename, ...)	Information about a single raw file, used during ingest.
RawFileDatasetInfo(dataId, obsInfo)	Information about a single dataset within a raw file.
RawIngestConfig(*args, **kw)	Configuration class for RawIngestTask.
RawIngestTask(config, *, butler, on_success, ...)	Driver Task for ingesting raw data into Gen3 Butler repositories.
TableVStack(capacity)	A helper class for stacking astropy tables without having them all in memory at once.
VisitDefinitionData(instrument, id, name, ...)	Struct representing a group of exposures that will be used to define a visit.
VisitSystem(value[, names, module, ...])	Enumeration used to label different visit systems.

Class Inheritance Diagram

lsst.obs.base.tests Module

Functions

make_ramp_array(bbox, pedestal)	Make a 2-d ramp array.
make_ramp_exposure_trimmed(detector[, dtype])	Create a trimmed, assembled exposure with different ramps for each amplifier region.
make_ramp_exposure_untrimmed(detector[, dtype])	Create an untrimmed, assembled exposure with different ramps for each sub-amplifier region.

Classes

ObsTests()

Aggregator class for all of the obs_* test classes.

Class Inheritance Diagram

lsst.obs.base.formatters.fitsExposure Module

Functions

standardizeAmplifierParameters(parameters, ...)

Preprocess the Exposure storage class's "amp" and "detector" parameters.

Classes

FitsExposureFormatter(file_descriptor, *, ref)	Concrete formatter for reading/writing Exposure from/to FITS.
FitsImageFormatter(file_descriptor, *, ref)	Concrete formatter for reading/writing Image from/to FITS.
FitsImageFormatterBase(file_descriptor, *, ref)	Base class formatter for image-like storage classes stored via FITS.
FitsMaskFormatter(file_descriptor, *, ref[, ...])	Concrete formatter for reading/writing Mask from/to FITS.
FitsMaskedImageFormatter(file_descriptor, *, ref)	Concrete formatter for reading/writing MaskedImage from/to FITS.
StandardFitsImageFormatterBase(...[, ...])	Base class interface for image-like storage stored via FITS, written using LSST code.

Class Inheritance Diagram

lsst.obs.base.formatters.fitsGeneric Module

Classes

FitsGenericFormatter(file_descriptor, *, ref)

Interface for reading and writing objects that support the standard afw I/O readFits/writeFits methods.

Class Inheritance Diagram

lsst.obs.base.camera_tests Module

Classes

CameraTests()

Tests that the butler returns a useable Camera.

Class Inheritance Diagram

lsst.obs.base.butler_tests Module

Classes

ButlerGetTests()

Tests of obs_* Butler get() functionality.

Class Inheritance Diagram

lsst.obs.base.instrument_tests Module

Classes

CuratedCalibration(*, metadata, values)	Class that implements minimal read/write interface needed to support curated calibration ingest.
DummyCam([collection_prefix])	Instrument class used for testing.
DummyCamYamlWcsFormatter(file_descriptor, *, ref)	Specialist formatter for tests that can make a WCS.
InstrumentTestData(name, nDetectors, ...)	Values to test against in subclasses of InstrumentTests.
InstrumentTests()	Tests of subclasses of Instrument.

Class Inheritance Diagram

lsst.obs.base.ingest_tests Module

Classes

IngestTestBase()

Base class for tests of gen3 ingest.

Class Inheritance Diagram