MegaPrime¶

class lsst.obs.cfht.MegaPrime(**kwargs)¶

Bases: lsst.obs.base.Instrument

Attributes Summary

`additionalCuratedDatasetTypes`
`configPaths`
`filterDefinitions`
`obsDataPackage`
`policyName`
`standardCuratedDatasetTypes`

Methods Summary

`applyConfigOverrides`(name, config)	Apply instrument-specific overrides for a task config.
`fromName`(name, registry)	Given an instrument name and a butler, retrieve a corresponding instantiated instrument object.
`getCamera`()	Retrieve the cameraGeom representation of this instrument.
`getCuratedCalibrationNames`()	Return the names of all the curated calibration dataset types.
`getName`()	Return the short (dimension) name for this instrument.
`getObsDataPackageDir`()	The root of the obs data package that provides specializations for this instrument.
`getRawFormatter`(dataId)	Return the Formatter class that should be used to read a particular raw file.
`importAll`(registry)	Import all the instruments known to this registry.
`makeCalibrationCollectionName`(*suffixes)	Make a CALIBRATION collection name appropriate for associating calibration datasets with validity ranges.
`makeCollectionName`(*labels)	Get the instrument-specific collection string to use as derived from the supplied labels.
`makeCuratedCalibrationRunName`(calibDate, …)	Make a RUN collection name appropriate for inserting curated calibration datasets with the given `CALIBDATE` metadata value.
`makeDataIdTranslatorFactory`()	Return a factory for creating Gen2->Gen3 data ID translators, specialized for this instrument.
`makeDefaultRawIngestRunName`()	Make the default instrument-specific run collection string for raw data ingest.
`makeUnboundedCalibrationRunName`(*suffixes)	Make a RUN collection name appropriate for inserting calibration datasets whose validity ranges are unbounded.
`register`(registry)	Insert instrument, physical_filter, and detector entries into a `Registry`.
`writeAdditionalCuratedCalibrations`(butler, …)	Write additional curated calibrations that might be instrument specific and are not part of the standard set.
`writeCameraGeom`(butler, collection, suffixes)	Write the default camera geometry to the butler repository and associate it with the appropriate validity range in a calibration collection.
`writeCuratedCalibrations`(butler, collection, …)	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

additionalCuratedDatasetTypes = frozenset()¶

configPaths = ()¶

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

obsDataPackage = None¶

policyName = 'megacam'¶

standardCuratedDatasetTypes = frozenset({'crosstalk', 'qe_curve', 'defects'})¶

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.

static fromName(name: str, registry: Registry) → Instrument¶

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.

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 getCuratedCalibrationNames() → Set[str]¶

Return the names of all the curated calibration dataset types.

Returns:	names : `set` of `str` The dataset type names of all curated calibrations. This will include the standard curated calibrations even if the particular instrument does not support them.

Notes

The returned list does not indicate whether a particular dataset is present in the Butler repository, simply that these are the dataset types that are handled by writeCuratedCalibrations.

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.

classmethod getObsDataPackageDir()¶

The root of the obs data package that provides specializations for this instrument.

Returns:	dir : `str` The root of the relevat obs data package.

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.

static importAll(registry: Registry) → None¶

Import all the instruments known to this registry.

This will ensure that all metadata translators have been registered.

Parameters:	registry : `lsst.daf.butler.Registry` Butler registry to query to find the information.

Notes

It is allowed for a particular instrument class to fail on import. This might simply indicate that a particular obs package has not been setup.

classmethod makeCalibrationCollectionName(*suffixes) → str¶

Make a CALIBRATION collection name appropriate for associating calibration datasets with validity ranges.

Parameters:	*suffixes : `str` Strings to be appended to the base name, using the default delimiter for collection names.
Returns:	name : `str` Calibration collection name.

classmethod makeCollectionName(*labels) → str¶

Get the instrument-specific collection string to use as derived from the supplied labels.

Parameters:	*labels : `str` Strings to be combined with the instrument name to form a collection name.
Returns:	name : `str` Collection name to use that includes the instrument name.

classmethod makeCuratedCalibrationRunName(calibDate: str, *suffixes) → str¶

Make a RUN collection name appropriate for inserting curated calibration datasets with the given CALIBDATE metadata value.

Parameters:	calibDate : `str` The `CALIBDATE` metadata value. *suffixes : `str` Strings to be appended to the base name, using the default delimiter for collection names.
Returns:	name : `str` Run collection name.

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.

classmethod makeDefaultRawIngestRunName() → str¶

Make the default instrument-specific run collection string for raw data ingest.

Returns:	coll : `str` Run collection name to be used as the default for ingestion of raws.

classmethod makeUnboundedCalibrationRunName(*suffixes) → str¶

Make a RUN collection name appropriate for inserting calibration datasets whose validity ranges are unbounded.

Parameters:	*suffixes : `str` Strings to be appended to the base name, using the default delimiter for collection names.
Returns:	name : `str` Run collection name.

register(registry)¶: Insert instrument, physical_filter, and detector entries into a Registry.

writeAdditionalCuratedCalibrations(butler: lsst.daf.butler._butler.Butler, collection: Optional[str] = None, suffixes: Sequence[str] = ()) → None¶

Write additional curated calibrations that might be instrument specific and are not part of the standard set.

Default implementation does nothing.

Parameters:

butler : lsst.daf.butler.Butler: Butler to use to store these calibrations.
collection : str, optional: Name to use for the calibration collection that associates all datasets with a validity range. If this collection already exists, it must be a CALIBRATION collection, and it must not have any datasets that would conflict with those inserted by this method. If None, a collection name is worked out automatically from the instrument name and other metadata by calling makeCalibrationCollectionName, but this default name may not work well for long-lived repositories unless one or more suffixes are also provided (and changed every time curated calibrations are ingested).
suffixes : Sequence [ str ], optional: Name suffixes to append to collection names, after concatenating them with the standard collection name delimeter. If provided, these are appended to the names of the RUN collections that datasets are inserted directly into, as well the CALIBRATION collection if it is generated automatically (i.e. if collection is None).

writeCameraGeom(butler: lsst.daf.butler._butler.Butler, collection: Optional[str] = None, suffixes: Sequence[str] = ()) → None¶

Write the default camera geometry to the butler repository and associate it with the appropriate validity range in a calibration collection.

Parameters:

butler : lsst.daf.butler.Butler: Butler to use to store these calibrations.
collection : str, optional: Name to use for the calibration collection that associates all datasets with a validity range. If this collection already exists, it must be a CALIBRATION collection, and it must not have any datasets that would conflict with those inserted by this method. If None, a collection name is worked out automatically from the instrument name and other metadata by calling makeCalibrationCollectionName, but this default name may not work well for long-lived repositories unless one or more suffixes are also provided (and changed every time curated calibrations are ingested).
suffixes : Sequence [ str ], optional: Name suffixes to append to collection names, after concatenating them with the standard collection name delimeter. If provided, these are appended to the names of the RUN collections that datasets are inserted directly into, as well the CALIBRATION collection if it is generated automatically (i.e. if collection is None).

writeCuratedCalibrations(butler: lsst.daf.butler._butler.Butler, collection: Optional[str] = None, suffixes: Sequence[str] = ()) → None¶

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.
collection : str, optional: Name to use for the calibration collection that associates all datasets with a validity range. If this collection already exists, it must be a CALIBRATION collection, and it must not have any datasets that would conflict with those inserted by this method. If None, a collection name is worked out automatically from the instrument name and other metadata by calling makeCalibrationCollectionName, but this default name may not work well for long-lived repositories unless one or more suffixes are also provided (and changed every time curated calibrations are ingested).
suffixes : Sequence [ str ], optional: Name suffixes to append to collection names, after concatenating them with the standard collection name delimeter. If provided, these are appended to the names of the RUN collections that datasets are inserted directly into, as well the CALIBRATION collection if it is generated automatically (i.e. if collection is None).

Notes

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

writeStandardTextCuratedCalibrations(butler: lsst.daf.butler._butler.Butler, collection: Optional[str] = None, suffixes: Sequence[str] = ()) → None¶

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

Parameters:

butler : lsst.daf.butler.Butler: Butler to receive these calibration datasets.
collection : str, optional: Name to use for the calibration collection that associates all datasets with a validity range. If this collection already exists, it must be a CALIBRATION collection, and it must not have any datasets that would conflict with those inserted by this method. If None, a collection name is worked out automatically from the instrument name and other metadata by calling makeCalibrationCollectionName, but this default name may not work well for long-lived repositories unless one or more suffixes are also provided (and changed every time curated calibrations are ingested).
suffixes : Sequence [ str ], optional: Name suffixes to append to collection names, after concatenating them with the standard collection name delimeter. If provided, these are appended to the names of the RUN collections that datasets are inserted directly into, as well the CALIBRATION collection if it is generated automatically (i.e. if collection is None).

Navigation

MegaPrime¶