coadd_provenance

A Pydantic model used to represent a serialized CoaddProvenance.

Versions

Version	Status
1.0.0	current

• Canonical URL: https://images.lsst.io/schemas/coadd_provenance-1.0.0

• Raw JSON schema

Composition

        classDiagram
  class CoaddProvenanceSerializationModel["CoaddProvenanceSerializationModel"] {
    +str schema_version
    +int min_read_version
    +dict~str, MetadataValue~ metadata
    +list~Any~ indirect
    +str | dict~str, int~ instrument
    +str | dict~str, int~ physical_filter
  }
  class ButlerInfo["ButlerInfo"] {
  }
  class SerializedDatasetRef["SerializedDatasetRef"] {
    +UUID id
    +str | None run
    +str | None component
  }
  class SerializedDatasetType["SerializedDatasetType"] {
    +str name
    +str | None storageClass
    +list~str~ | None dimensions
    +str | None parentStorageClass
    +bool isCalibration
  }
  class SerializedDataCoordinate["SerializedDataCoordinate"] {
    +dict~str, int | str~ dataId
  }
  class SerializedDimensionRecord["SerializedDimensionRecord"] {
    +str definition
  }
  class Timespan["Timespan"] {
    +tuple~int, int~ nsec
  }
  class DatasetProvenance["DatasetProvenance"] {
    +UUID | None quantum_id
    +dict~UUID, dict~str, str | int | float | bool | UUID~~ extras
  }
  class TableModel["TableModel"] {
  }
  CoaddProvenanceSerializationModel --> ButlerInfo : butler_info?
  CoaddProvenanceSerializationModel --> TableModel : inputs
  CoaddProvenanceSerializationModel --> TableModel : contributions
  ButlerInfo --> SerializedDatasetRef : dataset
  ButlerInfo --> DatasetProvenance : provenance
  SerializedDatasetRef --> SerializedDatasetType : datasetType?
  SerializedDatasetRef --> SerializedDataCoordinate : dataId?
  SerializedDataCoordinate --> SerializedDimensionRecord : records?
  SerializedDimensionRecord --> Timespan : record+ (+other)
  DatasetProvenance --> SerializedDatasetRef : inputs*
    

Fields

Field	Type	Required	Description
butler_info	ButlerInfo | null	no	Information about the butler dataset backed by this file.
contributions	TableModel	yes	Table of per-cell contributions to the coadd.
indirect	array of any	no	Serialized nested objects that may be saved or read more than once.
inputs	TableModel	yes	Table of all inputs to the coadd.
instrument	string | object	yes	Instrument name for all inputs to this coadd, or a mapping from instrument name to the integer used in its place in the tables.
metadata	object	no	Additional unstructured metadata.
min_read_version	integer	no	Smallest reader major that can interpret this tree.
physical_filter	string | object	yes	Physical filter name for all inputs to this coadd.
schema_version	string	no	Data-model schema version of this tree (major.minor.patch).