PhotodiodeCalib¶
- class lsst.ip.isr.PhotodiodeCalib(timeSamples=None, currentSamples=None, **kwargs)¶
Bases:
IsrCalib
Independent current measurements from photodiode for linearity calculations.
- Parameters:
- timeSamples
list
ornumpy.ndarray
List of samples the photodiode was measured at.
- currentSamples
list
ornumpy.ndarray
List of current measurements at each time sample.
- log
lsst.log.Log
, optional Log to write messages to.
- **kwargs
Additional parameters. These will be passed to the parent constructor with the exception of:
"integrationMethod"
Name of the algorithm to use to integrate the current samples. Allowed values are
DIRECT_SUM
,TRIMMED_SUM
, andCHARGE_SUM
(str
)."currentScale"
Scale factor to apply to the current samples for the
CHARGE_SUM
integration method. A typical value would be-1
, to flip the sign of the integrated charge.
- timeSamples
Attributes Summary
Methods Summary
apply
(target)Method to apply the calibration to the target object.
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 PhotodiodeCalib from a dictionary of properties.
fromTable
(tableList)Construct calibration from a list of tables.
Retrieve metadata associated with this calibration.
Integrate the current.
For this method, the values in .currentSamples are actually the integrated charge values as measured by the ammeter for each sampling interval.
Integrate points.
Integrate points with a baseline level subtracted.
readFits
(filename, **kwargs)Read calibration data from a FITS file.
readText
(filename, **kwargs)Read calibration representation from a yaml/ecsv file.
readTwoColumnPhotodiodeData
(filename)Construct a PhotodiodeCalib by reading the simple column format.
setMetadata
(metadata)Store a copy of the supplied metadata with this calibration.
toDict
()Return a dictionary containing the photodiode 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.
writeFits
(filename)Write calibration data to a FITS file.
writeText
(filename[, format])Write the calibration data to a text file.
Attributes Documentation
- requiredAttributes¶
Methods Documentation
- apply(target)¶
Method to apply the calibration to the target object.
- 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 PhotodiodeCalib from a dictionary of properties.
- Parameters:
- dictionary
dict
Dictionary of properties.
- dictionary
- Returns:
- calib
lsst.ip.isr.PhotodiodeCalib
Constructed photodiode data.
- calib
- Raises:
- RuntimeError
Raised if the supplied dictionary is for a different calibration type.
- 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
[astropy.table.Table
] List of tables to use to construct the crosstalk calibration.
- tableList
- Returns:
- calib
lsst.ip.isr.PhotodiodeCalib
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
- integrate()¶
Integrate the current.
- Raises:
- RuntimeError
Raised if the integration method is not known.
- integrateChargeSum()¶
For this method, the values in .currentSamples are actually the integrated charge values as measured by the ammeter for each sampling interval. We need to do a baseline subtraction, based on the charge values when the LED is off, then sum up the corrected signals.
- Returns:
- sum
float
Total charge measured.
- sum
- integrateDirectSum()¶
Integrate points.
This uses numpy’s trapezoidal integrator.
- Returns:
- sum
float
Total charge measured.
- sum
- integrateTrimmedSum()¶
Integrate points with a baseline level subtracted.
This uses numpy’s trapezoidal integrator.
- Returns:
- sum
float
Total charge measured.
- sum
See also
lsst.eotask.gen3.eoPtc
- classmethod readFits(filename, **kwargs)¶
Read calibration data from a FITS file.
- Parameters:
- Returns:
- calib
lsst.ip.isr.IsrCalib
Calibration contained within the file.
- calib
- 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”.
- classmethod readTwoColumnPhotodiodeData(filename)¶
Construct a PhotodiodeCalib by reading the simple column format.
- Parameters:
- filename
str
File to read samples from.
- filename
- Returns:
- calib
lsst.ip.isr.PhotodiodeCalib
The calibration defined in the file.
- calib
- 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 photodiode 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
[astropy.table.Table
] List of tables containing the photodiode calibration 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.
- writeFits(filename)¶
Write calibration data to a FITS file.
- 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.