Dataset

class lsst.ap.verify.Dataset(datasetId)

Bases: object

A dataset supported by ap_verify.

Any object of this class is guaranteed to represent a ready-for-use ap_verify dataset, barring concurrent changes to the file system or EUPS operations. Constructing a Dataset does not create a compatible output repository(ies), which can be done by calling makeCompatibleRepo.

Parameters:

datasetId : str

The name of the dataset package. A tag identifying the dataset is also accepted, but this usage is deprecated.

Raises:

RuntimeError

Raised if datasetId exists, but is not correctly organized or incomplete

ValueError

Raised if datasetId could not be loaded.

Attributes Summary

calibLocation	The directory containing the calibration data (str, read-only).
camera	The name of the Gen 2 camera associated with this data (str, read-only).
configLocation	The directory containing configs that can be used to process the data (str, read-only).
datasetRoot	The parent directory containing everything related to the ap_verify dataset (str, read-only).
instrument	The Gen 3 instrument associated with this data (lsst.obs.base.Instrument, read-only).
obsPackage	The name of the obs package associated with this data (str, read-only).
rawLocation	The directory containing the “raw” input data (str, read-only).
refcatsLocation	The directory containing external astrometric and photometric reference catalogs (str, read-only).
templateLocation	The directory containing the image subtraction templates (str, read-only).

Methods Summary

getSupportedDatasets()	The ap_verify dataset IDs that can be passed to this class’s constructor.
makeCompatibleRepo(repoDir, calibRepoDir)	Set up a directory as a Gen 2 repository compatible with this ap_verify dataset.
makeCompatibleRepoGen3(repoDir)	Set up a directory as a Gen 3 repository compatible with this ap_verify dataset.

Attributes Documentation

calibLocation

The directory containing the calibration data (str, read-only).

camera

The name of the Gen 2 camera associated with this data (str, read-only).

configLocation

The directory containing configs that can be used to process the data (str, read-only).

datasetRoot

The parent directory containing everything related to the ap_verify dataset (str, read-only).

instrument

The Gen 3 instrument associated with this data (lsst.obs.base.Instrument, read-only).

obsPackage

The name of the obs package associated with this data (str, read-only).

rawLocation

The directory containing the “raw” input data (str, read-only).

refcatsLocation

The directory containing external astrometric and photometric reference catalogs (str, read-only).

templateLocation

The directory containing the image subtraction templates (str, read-only).

Methods Documentation

static getSupportedDatasets()

The ap_verify dataset IDs that can be passed to this class’s constructor.

Returns:

datasets : set of str

the set of IDs that will be accepted

Raises:

IoError

Raised if the config file does not exist or is not readable

RuntimeError

Raised if the config file exists, but does not contain the expected data

.. deprecated:: v22.0

The concept of ‘supported’ datasets is deprecated. This method will be removed after v24.0.

makeCompatibleRepo(repoDir, calibRepoDir)

Set up a directory as a Gen 2 repository compatible with this ap_verify dataset.

If the directory already exists, any files required by the dataset will be added if absent; otherwise the directory will remain unchanged.

Parameters:

repoDir : str

The directory where the output repository will be created.

calibRepoDir : str

The directory where the output calibration repository will be created.

makeCompatibleRepoGen3(repoDir)

Set up a directory as a Gen 3 repository compatible with this ap_verify dataset.

If the repository already exists, this call has no effect.

Parameters:

repoDir : str

The directory where the output repository will be created.