LsstPhoSim

class lsst.obs.lsst.LsstPhoSim(*args, **kwargs)

Bases: lsst.obs.lsst.LsstCam

Gen3 Butler specialization for Phosim simulations.

Attributes Summary

configPaths	Built-in immutable sequence.
filterDefinitions
instrument
obsDataPackage
obsDataPackageDir
policyName
standardCuratedDatasetTypes

Methods Summary

applyConfigOverrides(name, config)	Apply instrument-specific overrides for a task config.
extractDetectorRecord(camGeomDetector)	Create a Gen3 Detector entry dict from a cameraGeom.Detector.
getCamera()	Retrieve the cameraGeom representation of this instrument.
getName()
getRawFormatter(dataId)	Return the Formatter class that should be used to read a particular raw file.
register(registry)	Insert instrument, physical_filter, and detector entries into a Registry.
writeCameraGeom(butler)	Write the default camera geometry to the butler repository with an infinite validity range.
writeCuratedCalibrations(butler)	Write human-curated calibration Datasets to the given Butler with the appropriate validity ranges.
writeStandardTextCuratedCalibrations(butler)	Write the set of standardized curated text calibrations to the repository.

Attributes Documentation

configPaths

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable’s items.

If the argument is a tuple, the return value is the same object.

filterDefinitions = <lsst.obs.base.filters.FilterDefinitionCollection object>

instrument = 'LSST-PhoSim'

obsDataPackage = 'obs_lsst_data'

obsDataPackageDir

policyName = 'phosim'

standardCuratedDatasetTypes = ('defects', 'qe_curve')

Methods Documentation

applyConfigOverrides(name, config)

Apply instrument-specific overrides for a task config.

Parameters:

name : str

Name of the object being configured; typically the _DefaultName of a Task.

config : lsst.pex.config.Config

Config instance to which overrides should be applied.

extractDetectorRecord(camGeomDetector)

Create a Gen3 Detector entry dict from a cameraGeom.Detector.

classmethod getCamera()

Retrieve the cameraGeom representation of this instrument.

This is a temporary API that should go away once obs_ packages have a standardized approach to writing versioned cameras to a Gen3 repo.

classmethod getName()

getRawFormatter(dataId)

Return the Formatter class that should be used to read a particular raw file.

Parameters:

dataId : DataCoordinate

Dimension-based ID for the raw file or files being ingested.

Returns:

formatter : Formatter class

Class to be used that reads the file into an lsst.afw.image.Exposure instance.

register(registry)

Insert instrument, physical_filter, and detector entries into a Registry.

writeCameraGeom(butler)

Write the default camera geometry to the butler repository with an infinite validity range.

Parameters:

butler : lsst.daf.butler.Butler

Butler to receive these calibration datasets.

writeCuratedCalibrations(butler)

Write human-curated calibration Datasets to the given Butler with the appropriate validity ranges.

Parameters:

butler : lsst.daf.butler.Butler

Butler to use to store these calibrations.

Notes

Expected to be called from subclasses. The base method calls writeCameraGeom and writeStandardTextCuratedCalibrations.

writeStandardTextCuratedCalibrations(butler)

Write the set of standardized curated text calibrations to the repository.

Parameters:

butler : lsst.daf.butler.Butler

Butler to receive these calibration datasets.