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	The root of the obs package that provides specializations for this instrument (str).
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.
fromName(name, registry)	Given an instrument name and a butler, retrieve a corresponding instantiated instrument object.
getCamera()	Retrieve the cameraGeom representation of this instrument.
getName()	Return the short (dimension) name for this instrument.
getRawFormatter(dataId)	Return the Formatter class that should be used to read a particular raw file.
makeDataIdTranslatorFactory()	Return a factory for creating Gen2->Gen3 data ID translators, specialized for this instrument.
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

The root of the obs package that provides specializations for this instrument (str).

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 fromName(name, registry)

Given an instrument name and a butler, retrieve a corresponding instantiated instrument object.

Parameters:

name : str

Name of the instrument (must match the return value of getName).

registry : lsst.daf.butler.Registry

Butler registry to query to find the information.

Returns:

instrument : Instrument

An instance of the relevant Instrument.

Raises:

LookupError

Raised if the instrument is not known to the supplied registry.

ModuleNotFoundError

Raised if the class could not be imported. This could mean that the relevant obs package has not been setup.

TypeError

Raised if the class name retrieved is not a string.

Notes

The instrument must be registered in the corresponding butler.

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()

Return the short (dimension) name for this instrument.

This is not (in general) the same as the class name - it’s what is used as the value of the “instrument” field in data IDs, and is usually an abbreviation of the full name.

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.

makeDataIdTranslatorFactory() → lsst.obs.base.gen2to3.translators.TranslatorFactory

Return a factory for creating Gen2->Gen3 data ID translators, specialized for this instrument.

Derived class implementations should generally call TranslatorFactory.addGenericInstrumentRules with appropriate arguments, but are not required to (and may not be able to if their Gen2 raw data IDs are sufficiently different from the HSC/DECam/CFHT norm).

Returns:

factory : TranslatorFactory.

Factory for Translator objects.

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.