standardizeAmplifierParameters

lsst.obs.base.formatters.fitsExposure.standardizeAmplifierParameters(parameters, on_disk_detector)

Preprocess the Exposure storage class’s “amp” and “detector” parameters

This checks the given objects for consistency with the on-disk geometry and converts amplifier IDs/names to Amplifier instances.

Parameters:

parameters : dict

Dictionary of parameters passed to formatter. See the Exposure storage class definition in daf_butler for allowed keys and values.

on_disk_detector : lsst.afw.cameraGeom.Detector or None

Detector that represents the on-disk image being loaded, or None if this is unknown (and hence the user must provide one in parameters if “amp” is in parameters).

Returns:

amplifier : lsst.afw.cameraGeom.Amplifier or None

An amplifier object that defines a subimage to load, or None if there was no “amp” parameter.

detector : lsst.afw.cameraGeom.Detector or None

A detector object whose amplifiers are in the same s/orientation state as the on-disk image. If there is no “amp” parameter, on_disk_detector is simply passed through.

regions_differ : bool

True if the on-disk detector and the detector given in the parameters had different bounding boxes for one or more regions. This can happen if the true overscan region sizes can only be determined when the image is actually read, but otherwise it should be considered user error.