seismometer.configuration.model.EventDictionary

pydantic model seismometer.configuration.model.EventDictionary

The dictionary information for events data.

This is the structure of a dictionary file corresponding to the event frame. Generally, the events frame is all the information not known near model execution time - such as target, interventions, and outcomes.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "EventDictionary",
   "description": "The dictionary information for events data.\n\nThis is the structure of a dictionary file corresponding to the event frame.\nGenerally, the events frame is all the information not known near model execution time - such as target,\ninterventions, and outcomes.",
   "type": "object",
   "properties": {
      "events": {
         "default": [],
         "items": {
            "$ref": "#/$defs/DictionaryItem"
         },
         "title": "Events",
         "type": "array"
      }
   },
   "$defs": {
      "DictionaryItem": {
         "description": "Defines a generic dictionary item.",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "display_name": {
               "default": "",
               "title": "Display Name",
               "type": "string"
            },
            "dtype": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dtype"
            },
            "definition": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Definition"
            }
         },
         "required": [
            "name"
         ],
         "title": "DictionaryItem",
         "type": "object"
      }
   }
}

Fields:

• events (list[seismometer.configuration.model.DictionaryItem])

field events: list[DictionaryItem] = []

The list of all columns in the events data.

get(key, default=None)

Get the definition of an item.

Parameters:

• key (str) – The column name.

• default (Optional[Any]) – The default value to return if the key is not found, defaults to None.

Return type:

The DictionaryItem with name specified or the default value