piff_psf

Serialization model for a Piff PSF.

Versions

Version	Status
1.0.0	current

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

• Raw JSON schema

Composition

        classDiagram
  class PiffSerializationModel["PiffSerializationModel"] {
    +str schema_version
    +int min_read_version
    +dict~str, MetadataValue~ metadata
    +list~Any~ indirect
    +int stamp_size
  }
  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 PiffObjectModel["PiffObjectModel"] {
    +dict~str, PiffDict~ structs
  }
  class PiffTableModel["PiffTableModel"] {
    +PiffDict metadata
  }
  class TableModel["TableModel"] {
  }
  class GalSimPixelScaleModel["GalSimPixelScaleModel"] {
    +float scale
    +Literal~pixel_scale~ wcs_type
  }
  class MinimalStar["MinimalStar"] {
    +XY~float~ image_pos
    +bool is_flagged
    +bool is_reserve
  }
  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"] {
  }
  PiffSerializationModel --> ButlerInfo : butler_info?
  PiffSerializationModel --> PiffObjectModel : piff
  PiffSerializationModel --> MinimalStar : stars*
  PiffSerializationModel --> CellGridBounds : bounds (+other)
  PiffSerializationModel --> RegionSerializationModel : bounds (+other)
  PiffSerializationModel --> 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*
  PiffObjectModel --> PiffTableModel : tables+
  PiffObjectModel --> GalSimPixelScaleModel : wcs+
  PiffObjectModel --> PiffObjectModel : objects+
  PiffTableModel --> TableModel : table
  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
bounds	BoundsSerializationModel	yes	The bounds object that represents the PSF’s validity region.
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.
metadata	object	no	Additional unstructured metadata.
min_read_version	integer	no	Smallest reader major that can interpret this tree.
piff	PiffObjectModel	yes	The Piff PSF object itself.
schema_version	string	no	Data-model schema version of this tree (major.minor.patch).
stamp_size	integer	yes	Width of the (square) images returned by this PSF’s methods.
stars	array of MinimalStar	yes	Minimal information about the stars that went into the PSF model.