camera_frame_set

Serialization model for CameraFrameSet.

Versions

Version	Status
1.0.0	current

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

• Raw JSON schema

Composition

        classDiagram
  class CameraFrameSetSerializationModel["CameraFrameSetSerializationModel"] {
    +str schema_version
    +int min_read_version
    +dict~str, MetadataValue~ metadata
    +list~Any~ indirect
    +str instrument
    +str ast
  }
  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
  }
  CameraFrameSetSerializationModel --> ButlerInfo : butler_info?
  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
ast	string	yes	A serialized Starlink AST FrameSet, using the AST native encoding.
butler_info	ButlerInfo | null	no	Information about the butler dataset backed by this file.
indirect	array of any	no	Serialized nested objects that may be saved or read more than once.
instrument	string	yes	Name of the instrument.
metadata	object	no	Additional unstructured metadata.
min_read_version	integer	no	Smallest reader major that can interpret this tree.
schema_version	string	no	Data-model schema version of this tree (major.minor.patch).