psfex_psf

Serialization model for PSFEx PSFs.

Versions

Version	Status
1.0.0	current

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

• Raw JSON schema

Composition

        classDiagram
  class PSFExSerializationModel["PSFExSerializationModel"] {
    +str schema_version
    +int min_read_version
    +dict~str, MetadataValue~ metadata
    +list~Any~ indirect
    +float average_x
    +float average_y
    +float pixel_step
    +list~int~ group
    +list~int~ degree
    +list~float~ basis
    +list~float~ coeff
    +InlineArray context
  }
  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 ArrayReferenceModel["ArrayReferenceModel"] {
  }
  class InlineArrayModel["InlineArrayModel"] {
  }
  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"] {
  }
  PSFExSerializationModel --> ButlerInfo : butler_info?
  PSFExSerializationModel --> ArrayReferenceModel : parameters
  PSFExSerializationModel --> InlineArrayModel : parameters
  PSFExSerializationModel --> CellGridBounds : bounds (+other)
  PSFExSerializationModel --> RegionSerializationModel : bounds (+other)
  PSFExSerializationModel --> IntersectionBoundsSerializationModel : bounds (+other)
  ButlerInfo --> SerializedDatasetRef : dataset
  ButlerInfo --> DatasetProvenance : provenance
  SerializedDatasetRef --> SerializedDatasetType : datasetType?
  SerializedDatasetRef --> SerializedDataCoordinate : dataId?
  SerializedDataCoordinate --> SerializedDimensionRecord : records?
  SerializedDimensionRecord --> Timespan : record+ (+other)
  DatasetProvenance --> SerializedDatasetRef : inputs*
  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)
    

Fields

Field	Type	Required	Description
average_x	number	yes	Average X position of the stars used to build this PSF model.
average_y	number	yes	Average Y position of the stars used to build this PSF model.
basis	array of number	yes	Basis function values.
bounds	BoundsSerializationModel	yes	Validity range for this PSF model.
butler_info	ButlerInfo | null	no	Information about the butler dataset backed by this file.
coeff	array of number	yes	Polynomial coefficients.
context	InlineArray	yes	Internal PSFEx context array.
degree	array of integer	yes	Polynomial degree for each model group.
group	array of integer	no	Number of model groups in each dimension.
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.
parameters	ArrayReferenceModel | InlineArrayModel	yes	Reference to an array with the complete model parameters.
pixel_step	number	yes	Size of a model pixel, as a fraction or multiple of the native pixel size.
schema_version	string	no	Data-model schema version of this tree (major.minor.patch).