product_field

Serialization model for ProductField.

Versions

Version	Status
1.0.0	current

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

• Raw JSON schema

Composition

        classDiagram
  class ProductFieldSerializationModel["ProductFieldSerializationModel"] {
    +str schema_version
    +int min_read_version
    +dict~str, MetadataValue~ metadata
    +list~Any~ indirect
    +Literal~PRODUCT~ field_type
  }
  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 ChebyshevFieldSerializationModel["ChebyshevFieldSerializationModel"] {
    +str schema_version
    +int min_read_version
    +dict~str, MetadataValue~ metadata
    +list~Any~ indirect
    +InlineArray coefficients
    +Unit | None unit
    +Literal~CHEBYSHEV~ field_type
  }
  class CellGridBounds["CellGridBounds"] {
    +Box bbox
    +frozenset~CellIJ~ missing
  }
  class CellGrid["CellGrid"] {
    +Box bbox
    +YX~int~ cell_shape
  }
  class RegionSerializationModel["RegionSerializationModel"] {
    +Literal~Polygon, MultiPolygon~ type
    +list~list~tuple~float, float~ | list~tuple~float, float~~~~ coordinates
  }
  class IntersectionBoundsSerializationModel["IntersectionBoundsSerializationModel"] {
  }
  class SplineFieldSerializationModel["SplineFieldSerializationModel"] {
    +str schema_version
    +int min_read_version
    +dict~str, MetadataValue~ metadata
    +list~Any~ indirect
    +InlineArray y
    +InlineArray x
    +Unit | None unit
    +Literal~SPLINE~ field_type
  }
  class ArrayReferenceModel["ArrayReferenceModel"] {
  }
  class InlineArrayModel["InlineArrayModel"] {
  }
  class SumFieldSerializationModel["SumFieldSerializationModel"] {
    +str schema_version
    +int min_read_version
    +dict~str, MetadataValue~ metadata
    +list~Any~ indirect
    +Literal~SUM~ field_type
  }
  ProductFieldSerializationModel --> ButlerInfo : butler_info?
  ProductFieldSerializationModel --> ChebyshevFieldSerializationModel : operands*
  ProductFieldSerializationModel --> ProductFieldSerializationModel : operands*
  ProductFieldSerializationModel --> SplineFieldSerializationModel : operands*
  ProductFieldSerializationModel --> SumFieldSerializationModel : operands*
  ButlerInfo --> SerializedDatasetRef : dataset
  ButlerInfo --> DatasetProvenance : provenance
  SerializedDatasetRef --> SerializedDatasetType : datasetType?
  SerializedDatasetRef --> SerializedDataCoordinate : dataId?
  SerializedDataCoordinate --> SerializedDimensionRecord : records?
  SerializedDimensionRecord --> Timespan : record+ (+other)
  DatasetProvenance --> SerializedDatasetRef : inputs*
  ChebyshevFieldSerializationModel --> ButlerInfo : butler_info?
  ChebyshevFieldSerializationModel --> CellGridBounds : bounds (+other)
  ChebyshevFieldSerializationModel --> RegionSerializationModel : bounds (+other)
  ChebyshevFieldSerializationModel --> IntersectionBoundsSerializationModel : bounds (+other)
  CellGridBounds --> CellGrid : grid
  IntersectionBoundsSerializationModel --> CellGridBounds : a (+other)
  IntersectionBoundsSerializationModel --> RegionSerializationModel : a (+other)
  IntersectionBoundsSerializationModel --> IntersectionBoundsSerializationModel : a (+other)
  IntersectionBoundsSerializationModel --> CellGridBounds : b (+other)
  IntersectionBoundsSerializationModel --> RegionSerializationModel : b (+other)
  IntersectionBoundsSerializationModel --> IntersectionBoundsSerializationModel : b (+other)
  SplineFieldSerializationModel --> ButlerInfo : butler_info?
  SplineFieldSerializationModel --> CellGridBounds : bounds (+other)
  SplineFieldSerializationModel --> RegionSerializationModel : bounds (+other)
  SplineFieldSerializationModel --> IntersectionBoundsSerializationModel : bounds (+other)
  SplineFieldSerializationModel --> ArrayReferenceModel : data
  SplineFieldSerializationModel --> InlineArrayModel : data
  SumFieldSerializationModel --> ButlerInfo : butler_info?
  SumFieldSerializationModel --> ChebyshevFieldSerializationModel : operands*
  SumFieldSerializationModel --> ProductFieldSerializationModel : operands*
  SumFieldSerializationModel --> SplineFieldSerializationModel : operands*
  SumFieldSerializationModel --> SumFieldSerializationModel : operands*
    

Fields

Field	Type	Required	Description
butler_info	ButlerInfo | null	no	Information about the butler dataset backed by this file.
field_type	string	no
indirect	array of any	no	Serialized nested objects that may be saved or read more than once.
metadata	object	no	Additional unstructured metadata.
min_read_version	integer	no	Smallest reader major that can interpret this tree.
operands	array of FieldSerializationModel	no
schema_version	string	no	Data-model schema version of this tree (major.minor.patch).