masked_image

Versions

Version	Status
1.0.0	current

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

• Raw JSON schema

Composition

        classDiagram
  class MaskedImageSerializationModel_ArrayReferenceModel_["MaskedImageSerializationModel~ArrayReferenceModel~"] {
    +str schema_version
    +int min_read_version
    +dict~str, MetadataValue~ metadata
    +list~Any~ indirect
  }
  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 ImageSerializationModel_ArrayReferenceModel_["ImageSerializationModel~ArrayReferenceModel~"] {
    +str schema_version
    +int min_read_version
    +dict~str, MetadataValue~ metadata
    +list~Any~ indirect
    +list~int~ yx0
  }
  class ArrayReferenceQuantityModel["ArrayReferenceQuantityModel"] {
  }
  class ArrayReferenceModel["ArrayReferenceModel"] {
  }
  class InlineArrayModel["InlineArrayModel"] {
  }
  class InlineArrayQuantityModel["InlineArrayQuantityModel"] {
  }
  class SkyProjectionSerializationModel_ArrayReferenceModel_["SkyProjectionSerializationModel~ArrayReferenceModel~"] {
    +str schema_version
    +int min_read_version
    +dict~str, MetadataValue~ metadata
    +list~Any~ indirect
  }
  class TransformSerializationModel_ArrayReferenceModel_["TransformSerializationModel~ArrayReferenceModel~"] {
    +str schema_version
    +int min_read_version
    +dict~str, MetadataValue~ metadata
    +list~Any~ indirect
  }
  class DetectorFrame["DetectorFrame"] {
    +str instrument
    +int | None visit
    +int detector
    +Box bbox
    +Literal~DETECTOR~ frame_type
  }
  class TractFrame["TractFrame"] {
    +str skymap
    +int tract
    +Box bbox
    +Literal~TRACT~ frame_type
  }
  class FocalPlaneFrame["FocalPlaneFrame"] {
    +str instrument
    +int | None visit
    +Unit unit
    +Literal~FOCAL_PLANE~ frame_type
  }
  class FieldAngleFrame["FieldAngleFrame"] {
    +str instrument
    +int | None visit
    +Literal~FIELD_ANGLE~ frame_type
  }
  class GeneralFrame["GeneralFrame"] {
    +Unit unit
    +Literal~GENERAL~ frame_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 MappingSerializationModel["MappingSerializationModel"] {
    +str ast
  }
  class MaskSerializationModel_ArrayReferenceModel_["MaskSerializationModel~ArrayReferenceModel~"] {
    +str schema_version
    +int min_read_version
    +dict~str, MetadataValue~ metadata
    +list~Any~ indirect
    +list~int~ yx0
    +list~MaskPlane | None~ planes
    +IntegerType dtype
  }
  MaskedImageSerializationModel_ArrayReferenceModel_ --> ButlerInfo : butler_info?
  MaskedImageSerializationModel_ArrayReferenceModel_ --> ImageSerializationModel_ArrayReferenceModel_ : image
  MaskedImageSerializationModel_ArrayReferenceModel_ --> MaskSerializationModel_ArrayReferenceModel_ : mask
  MaskedImageSerializationModel_ArrayReferenceModel_ --> ImageSerializationModel_ArrayReferenceModel_ : variance
  MaskedImageSerializationModel_ArrayReferenceModel_ --> SkyProjectionSerializationModel_ArrayReferenceModel_ : sky_projection?
  ButlerInfo --> SerializedDatasetRef : dataset
  ButlerInfo --> DatasetProvenance : provenance
  SerializedDatasetRef --> SerializedDatasetType : datasetType?
  SerializedDatasetRef --> SerializedDataCoordinate : dataId?
  SerializedDataCoordinate --> SerializedDimensionRecord : records?
  SerializedDimensionRecord --> Timespan : record+ (+other)
  DatasetProvenance --> SerializedDatasetRef : inputs*
  ImageSerializationModel_ArrayReferenceModel_ --> ButlerInfo : butler_info?
  ImageSerializationModel_ArrayReferenceModel_ --> ArrayReferenceQuantityModel : data
  ImageSerializationModel_ArrayReferenceModel_ --> ArrayReferenceModel : data
  ImageSerializationModel_ArrayReferenceModel_ --> InlineArrayModel : data
  ImageSerializationModel_ArrayReferenceModel_ --> InlineArrayQuantityModel : data
  ImageSerializationModel_ArrayReferenceModel_ --> SkyProjectionSerializationModel_ArrayReferenceModel_ : sky_projection?
  SkyProjectionSerializationModel_ArrayReferenceModel_ --> ButlerInfo : butler_info?
  SkyProjectionSerializationModel_ArrayReferenceModel_ --> TransformSerializationModel_ArrayReferenceModel_ : pixel_to_sky
  SkyProjectionSerializationModel_ArrayReferenceModel_ --> TransformSerializationModel_ArrayReferenceModel_ : fits_approximation?
  TransformSerializationModel_ArrayReferenceModel_ --> ButlerInfo : butler_info?
  TransformSerializationModel_ArrayReferenceModel_ --> DetectorFrame : frames* (+other)
  TransformSerializationModel_ArrayReferenceModel_ --> TractFrame : frames* (+other)
  TransformSerializationModel_ArrayReferenceModel_ --> FocalPlaneFrame : frames* (+other)
  TransformSerializationModel_ArrayReferenceModel_ --> FieldAngleFrame : frames* (+other)
  TransformSerializationModel_ArrayReferenceModel_ --> GeneralFrame : frames* (+other)
  TransformSerializationModel_ArrayReferenceModel_ --> CellGridBounds : bounds* (+other)
  TransformSerializationModel_ArrayReferenceModel_ --> RegionSerializationModel : bounds* (+other)
  TransformSerializationModel_ArrayReferenceModel_ --> IntersectionBoundsSerializationModel : bounds* (+other)
  TransformSerializationModel_ArrayReferenceModel_ --> ArrayReferenceModel : mappings*
  TransformSerializationModel_ArrayReferenceModel_ --> MappingSerializationModel : mappings*
  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)
  MaskSerializationModel_ArrayReferenceModel_ --> ButlerInfo : butler_info?
  MaskSerializationModel_ArrayReferenceModel_ --> ArrayReferenceModel : data*
  MaskSerializationModel_ArrayReferenceModel_ --> InlineArrayModel : data*
  MaskSerializationModel_ArrayReferenceModel_ --> SkyProjectionSerializationModel_ArrayReferenceModel_ : sky_projection?
    

Fields

Field	Type	Required	Description
butler_info	ButlerInfo | null	no	Information about the butler dataset backed by this file.
image	image	yes	The main data image.
indirect	array of any	no	Serialized nested objects that may be saved or read more than once.
mask	mask	yes	Bitmask that annotates the main image’s pixels.
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).
sky_projection	sky_projection | null	no	Projection that maps the pixel grid to the sky.
variance	image	yes	Per-pixel variance estimates for the main image.