DatasetAssociation¶
- class lsst.daf.butler.DatasetAssociation(ref: DatasetRef, collection: str, timespan: Timespan | None)¶
Bases:
objectClass representing the membership of a dataset in a single collection.
One dataset is associated with one collection, possibly including a timespan.
Attributes Summary
Name of a collection (
str).Resolved reference to a dataset (
DatasetRef).Validity range of the dataset if this is a
CALIBRATIONcollection (TimespanorNone).Methods Summary
from_query_result(result, dataset_type[, ...])Construct dataset associations from the result of general query.
Attributes Documentation
- ref: DatasetRef¶
Resolved reference to a dataset (
DatasetRef).
- timespan: Timespan | None¶
Validity range of the dataset if this is a
CALIBRATIONcollection (TimespanorNone).
Methods Documentation
- classmethod from_query_result(result: GeneralQueryResults, dataset_type: DatasetType, collection_info: Mapping[str, CollectionInfo] | None = None) Iterator[DatasetAssociation]¶
Construct dataset associations from the result of general query.
- Parameters:
- result
GeneralQueryResults General query result returned by
Query.generalmethod. The result has to include “dataset_id”, “run”, “collection”, and “timespan” dataset fields fordataset_type.- dataset_type
DatasetType Dataset type, query has to include this dataset type.
- collection_info
Mapping[str,CollectionInfo], optional Mapping from collection name to information about it for all collections that may appear in the query results. If not provided, timespans for
RUNandTAGGEDcollections will be bounded, instead ofNone; this is actually more consistent with how those timespans are used elsewhere in the query system, but is a change from howDatasetAssocationhas historically worked.
- result