detector 1.0.0#

Serialization model for Detector.

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

  • Raw JSON schema

Composition#

        classDiagram
  class DetectorSerializationModel["DetectorSerializationModel"] {
    +str schema_version
    +int min_read_version
    +dict~str, MetadataValue~ metadata
    +list~Any~ indirect
    +int | None visit
  }
  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 DetectorAttributes["DetectorAttributes"] {
    +str name
    +int id
    +DetectorType type
    +str serial
    +Box bbox
    +float pixel_size
    +str physical_type
  }
  class Orientation["Orientation"] {
    +float focal_plane_x
    +float focal_plane_y
    +float focal_plane_z
    +float pixel_reference_x
    +float pixel_reference_y
    +Quantity yaw
    +Quantity pitch
    +Quantity roll
  }
  class Amplifier["Amplifier"] {
    +str name
    +Box bbox
    +ReadoutCorner readout_corner
  }
  class AmplifierRawGeometry["AmplifierRawGeometry"] {
    +Box bbox
    +Box data_bbox
    +bool flip_x
    +bool flip_y
    +int x_offset
    +int y_offset
    +Box serial_overscan_bbox
    +Box parallel_overscan_bbox
    +Box prescan_bbox
    +ReadoutCorner readout_corner
  }
  class AmplifierCalibrations["AmplifierCalibrations"] {
    +float gain
    +float read_noise
    +float saturation
    +float suspect_level
    +InlineArray linearity_coefficients
    +str linearity_type
  }
  class CameraFrameSetSerializationModel["CameraFrameSetSerializationModel"] {
    +str schema_version
    +int min_read_version
    +dict~str, MetadataValue~ metadata
    +list~Any~ indirect
    +str instrument
    +str ast
  }
  DetectorSerializationModel --> ButlerInfo : butler_info?
  DetectorSerializationModel --> DetectorAttributes : attributes
  DetectorSerializationModel --> Amplifier : amplifiers*
  DetectorSerializationModel --> CameraFrameSetSerializationModel : frames?
  ButlerInfo --> SerializedDatasetRef : dataset
  ButlerInfo --> DatasetProvenance : provenance
  SerializedDatasetRef --> SerializedDatasetType : datasetType?
  SerializedDatasetRef --> SerializedDataCoordinate : dataId?
  SerializedDataCoordinate --> SerializedDimensionRecord : records?
  SerializedDimensionRecord --> Timespan : record+ (+other)
  DatasetProvenance --> SerializedDatasetRef : inputs*
  DetectorAttributes --> Orientation : orientation
  Amplifier --> AmplifierRawGeometry : assembled_raw_geometry?
  Amplifier --> AmplifierRawGeometry : unassembled_raw_geometry?
  Amplifier --> AmplifierCalibrations : nominal_calibrations?
  CameraFrameSetSerializationModel --> ButlerInfo : butler_info?
    

Fields#

Field

Type

Required

Description

amplifiers

array of Amplifier

no

Descriptions of the amplifiers.

attributes

DetectorAttributes

yes

The simple plain-old-data attributes of the detector.

butler_info

ButlerInfo | null

no

Information about the butler dataset backed by this file.

frames

camera_frame_set | null

no

Mappings to other camera coordinate systems.

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.

schema_version

string

no

Data-model schema version of this tree (major.minor.patch).

visit

integer | null

yes

ID of the visit this detector is associated with.