ShutterMotionProfile¶
- class lsst.ip.isr.ShutterMotionProfile(**kwargs)¶
Bases:
IsrCalib
Shutter motion profile measurements.
- Parameters:
- log
logging.Logger
, optional Log to write messages to. If
None
a default logger will be used.- **kwargs
Additional parameters.
- log
Attributes Summary
Methods Summary
apply
(target)Method to apply the calibration to the target object.
calculateMidpoint
([modelName])Calculate time of midpoint of travel for this profile.
calibInfoFromDict
(dictionary)Handle common keywords.
determineCalibClass
(metadata, message)Attempt to find calibration class in metadata.
fromDetector
(detector)Modify the calibration parameters to match the supplied detector.
fromDict
(dictionary)Construct a ShutterMotionProfile from a dictionary of properties.
fromTable
(tableList)Construct calibration from a list of tables.
Retrieve metadata associated with this calibration.
readEncodeSamples
(inputSamples, formatVersion)Read a list of input samples into the calibration.
readFitResults
(fitResults)Read a list of fit results into the calibration.
readFits
(filename, **kwargs)Read calibration data from a FITS file.
readHallTransitions
(inputTransitions, ...)Read a list of input samples into the calibration.
readText
(filename, **kwargs)Read calibration representation from a yaml/ecsv file.
setMetadata
(metadata)Store a copy of the supplied metadata with this calibration.
toDict
()Return a dictionary containing the calibration properties.
toTable
()Construct a list of tables containing the information in this calibration.
updateMetadata
([camera, detector, ...])Update metadata keywords with new values.
updateMetadataFromExposures
(exposures)Extract and unify metadata information.
validate
([other])Validate that this calibration is defined and can be used.
Return list of samples as dictionaries.
Return list of samples as dictionaries.
writeFits
(filename)Write calibration data to a FITS file.
Return list of samples as dictionaries.
writeText
(filename[, format])Write the calibration data to a text file.
Attributes Documentation
- metadata¶
- requiredAttributes¶
Methods Documentation
- apply(target)¶
Method to apply the calibration to the target object.
- calculateMidpoint(modelName='hallSensorFit')¶
Calculate time of midpoint of travel for this profile.
Derived from Shuang Liang’s CTN-002 (https://ctn-002.lsst.io). Equation numbers listed are from this document. As the fits have already been done, we can ignore the raw position/Hall sensor data.
- Parameters:
- modelName
str
Fit model to use to calculate the midpoint.
- modelName
- Returns:
- tm_accel
float
The time of the midpoint from the start of motion in seconds, as derived from the point where the acceleration on the shutter is zero.
- tm_position
float
The time of the midpoint from the start of motion in seconds, as derived from the point where the shutter position is midway between its starting and ending locations.
- tm_accel
- Raises:
- RuntimeError
Raised if the requested
modelName
is not found in the calibration.
- calibInfoFromDict(dictionary)¶
Handle common keywords.
This isn’t an ideal solution, but until all calibrations expect to find everything in the metadata, they still need to search through dictionaries.
- Parameters:
- dictionary
dict
orlsst.daf.base.PropertyList
Source for the common keywords.
- dictionary
- Raises:
- RuntimeError
Raised if the dictionary does not match the expected OBSTYPE.
- classmethod determineCalibClass(metadata, message)¶
Attempt to find calibration class in metadata.
- Parameters:
- Returns:
- calibClass
object
The class to use to read the file contents. Should be an
lsst.ip.isr.IsrCalib
subclass.
- calibClass
- Raises:
- ValueError
Raised if the resulting calibClass is the base
lsst.ip.isr.IsrClass
(which does not implement the content methods).
- fromDetector(detector)¶
Modify the calibration parameters to match the supplied detector.
- Parameters:
- detector
lsst.afw.cameraGeom.Detector
Detector to use to set parameters from.
- detector
- Raises:
- NotImplementedError
Raised if not implemented by a subclass. This needs to be implemented by subclasses for each calibration type.
- classmethod fromDict(dictionary)¶
Construct a ShutterMotionProfile from a dictionary of properties.
- classmethod fromTable(tableList)¶
Construct calibration from a list of tables.
This method uses the
fromDict
method to create the calibration, after constructing an appropriate dictionary from the input tables.- Parameters:
- tableList
list
[lsst.afw.table.Table
] List of tables to use to construct the crosstalk calibration. For shutter motion profiles, the first table contains the samples, the second the Hall transition data, and the third the model fits.
- tableList
- Returns:
- calib
lsst.ip.isr.ShutterMotionProfile
The calibration defined in the tables.
- calib
- getMetadata()¶
Retrieve metadata associated with this calibration.
- Returns:
- meta
lsst.daf.base.PropertyList
Metadata. The returned
PropertyList
can be modified by the caller and the changes will be written to external files.
- meta
- readEncodeSamples(inputSamples, formatVersion)¶
Read a list of input samples into the calibration.
- readFitResults(fitResults)¶
Read a list of fit results into the calibration.
- classmethod readFits(filename, **kwargs)¶
Read calibration data from a FITS file.
- Parameters:
- Returns:
- calib
lsst.ip.isr.IsrCalib
Calibration contained within the file.
- calib
- readHallTransitions(inputTransitions, formatVersion)¶
Read a list of input samples into the calibration.
- classmethod readText(filename, **kwargs)¶
Read calibration representation from a yaml/ecsv file.
- Parameters:
- Returns:
- calib
IsrCalibType
Calibration class.
- calib
- Raises:
- RuntimeError
Raised if the filename does not end in “.ecsv” or “.yaml”.
- setMetadata(metadata)¶
Store a copy of the supplied metadata with this calibration.
- Parameters:
- metadata
lsst.daf.base.PropertyList
Metadata to associate with the calibration. Will be copied and overwrite existing metadata.
- metadata
- toDict()¶
Return a dictionary containing the calibration properties.
The dictionary should be able to be round-tripped through
fromDict
.- Returns:
- dictionary
dict
Dictionary of properties.
- dictionary
- toTable()¶
Construct a list of tables containing the information in this calibration.
The list of tables should create an identical calibration after being passed to this class’s fromTable method.
- Returns:
- tableList
list
[lsst.afw.table.Table
] List of tables containing the shutter motion profile information.
- tableList
- updateMetadata(camera=None, detector=None, filterName=None, setCalibId=False, setCalibInfo=False, setDate=False, **kwargs)¶
Update metadata keywords with new values.
- Parameters:
- camera
lsst.afw.cameraGeom.Camera
, optional Reference camera to use to set
_instrument
field.- detector
lsst.afw.cameraGeom.Detector
, optional Reference detector to use to set
_detector*
fields.- filterName
str
, optional Filter name to assign to this calibration.
- setCalibId
bool
, optional Construct the
_calibId
field from other fields.- setCalibInfo
bool
, optional Set calibration parameters from metadata.
- setDate
bool
, optional Ensure the metadata
CALIBDATE
fields are set to the current datetime.- kwargs
dict
orcollections.abc.Mapping
, optional Set of
key=value
pairs to assign to the metadata.
- camera
- updateMetadataFromExposures(exposures)¶
Extract and unify metadata information.
- Parameters:
- exposures
list
Exposures or other calibrations to scan.
- exposures
- validate(other=None)¶
Validate that this calibration is defined and can be used.
- writeEncodeSamples()¶
Return list of samples as dictionaries.
- writeFitResults()¶
Return list of samples as dictionaries.
- writeFits(filename)¶
Write calibration data to a FITS file.
- writeHallTransitions()¶
Return list of samples as dictionaries.
- writeText(filename, format='auto')¶
Write the calibration data to a text file.
- Parameters:
- Returns:
- used
str
The name of the file used to write the data. This may differ from the input if the format is explicitly chosen.
- used
- Raises:
- RuntimeError
Raised if filename does not end in a known extension, or if all information cannot be written.
Notes
The file is written to YAML/ECSV format and will include any associated metadata.