CommonFields

pydantic model lstcam_calib.io.database.CommonFields

Pydantic schema with fields common to all calibration files.

Show JSON schema

{
   "title": "CommonFields",
   "description": "Pydantic schema with fields common to all calibration files.",
   "type": "object",
   "properties": {
      "product_id": {
         "title": "Product Id",
         "type": "string"
      },
      "status": {
         "title": "Status",
         "type": "string"
      },
      "usage_start": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Usage Start"
      },
      "usage_stop": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Usage Stop"
      },
      "processing_time": {
         "format": "date-time",
         "title": "Processing Time",
         "type": "string"
      },
      "path": {
         "format": "path",
         "title": "Path",
         "type": "string"
      },
      "provenance_path": {
         "format": "path",
         "title": "Provenance Path",
         "type": "string"
      },
      "lstcam_calib_version": {
         "title": "Lstcam Calib Version",
         "type": "string"
      },
      "last_modified": {
         "format": "date-time",
         "title": "Last Modified",
         "type": "string"
      }
   },
   "required": [
      "product_id",
      "status",
      "processing_time",
      "path",
      "provenance_path",
      "lstcam_calib_version",
      "last_modified"
   ]
}

Fields:

• last_modified (datetime.datetime)

• lstcam_calib_version (str)

• path (pathlib.Path)

• processing_time (datetime.datetime)

• product_id (str)

• provenance_path (pathlib.Path)

• status (str)

• usage_start (datetime.datetime | None)

• usage_stop (datetime.datetime | None)

field last_modified: datetime [Required]

Timestamp when this calibration document was last updated

field lstcam_calib_version: str [Required]

Version of lstcam_calib used for processing

field path: Annotated[Path, PlainSerializer(func=str, return_type=str, when_used=always)] [Required]

Path of the calibration file in the data-tree

Constraints:

• func = <class ‘str’>

• return_type = <class ‘str’>

• when_used = always

field processing_time: datetime [Required]

Time of production of the calibration

field product_id: str [Required]

Provenance production id

field provenance_path: Annotated[Path, PlainSerializer(func=str, return_type=str, when_used=always)] [Required]

Path of the proveance file in the data-tree

Constraints:

• func = <class ‘str’>

• return_type = <class ‘str’>

• when_used = always

field status: str [Required]

Status of the file

field usage_start: datetime | None = None

Start time in which calibration is used

field usage_stop: datetime | None = None

End time in which calibration is used