`event_model`#

Members

`Datum`	Document to reference a quanta of externally-stored data
`DatumPage`	Page of documents to reference a quanta of externally-stored data
`Event`	Document to record a quanta of collected data
`PartialEvent`
`Configuration`
`DataKey`	Describes the objects in the data property of Event documents
`EventDescriptor`	Document to describe the data captured in the associated event documents
`Limits`	Epics limits: see 3.4.1 https://epics.anl.gov/base/R3-14/12-docs/AppDevGuide/node4.html
`LimitsRange`
`PerObjectHint`	The 'interesting' data keys for this device.
`EventPage`	Page of documents to record a quanta of collected data
`PartialEventPage`
`PartialResource`
`Resource`	Document to reference a collection (e.g. file or group of files) of externally-stored data.
`Calculation`
`Hints`	Start-level hints
`Projection`	Where to get the data from
`Projections`	Describe how to interperet this run as the given projection
`RunStart`	Document created at the start of run.
`RunStop`	Document for the end of a run indicating the success/fail state of the run and the end time
`StreamDatum`	Document to reference a quanta of an externally-stored stream of data.
`StreamRange`	The parameters required to describe a sequence of incrementing integers
`StreamResource`	Document to reference a collection (e.g. file or group of files) of externally-stored data streams.
`DocumentNames`
`compose_run`	Compose a RunStart document and factory functions for related documents.

class event_model.Datum[source]#: Document to reference a quanta of externally-stored data

class event_model.DatumPage[source]#: Page of documents to reference a quanta of externally-stored data

class event_model.Event[source]#: Document to record a quanta of collected data

class event_model.DataKey[source]#: Describes the objects in the data property of Event documents

class event_model.EventDescriptor[source]#: Document to describe the data captured in the associated event documents

class event_model.Limits[source]#: Epics limits: see 3.4.1 https://epics.anl.gov/base/R3-14/12-docs/AppDevGuide/node4.html

class event_model.PerObjectHint[source]#: The ‘interesting’ data keys for this device.

class event_model.EventPage[source]#: Page of documents to record a quanta of collected data

class event_model.Resource[source]#: Document to reference a collection (e.g. file or group of files) of externally-stored data

class event_model.Hints[source]#: Start-level hints

class event_model.Projection[source]#: Where to get the data from

class event_model.Projections[source]#: Describe how to interperet this run as the given projection

class event_model.RunStart[source]#: Document created at the start of run. Provides a seach target and later documents link to it

class event_model.RunStop[source]#: Document for the end of a run indicating the success/fail state of the run and the end time

class event_model.StreamDatum[source]#: Document to reference a quanta of an externally-stored stream of data.

class event_model.StreamRange[source]#: The parameters required to describe a sequence of incrementing integers

class event_model.StreamResource[source]#: Document to reference a collection (e.g. file or group of files) of externally-stored data streams

event_model.compose_run(*, uid: str | None = None, time: float | None = None, metadata: Dict | None = None, validate: bool = True, event_counters: Dict[str, int] | None = None) → ComposeRunBundle[source]#

Compose a RunStart document and factory functions for related documents.

Parameters:

uid (string, optional) – Unique identifier for this run, conventionally a UUID4. If None is given, a UUID4 will be generated.
time (float, optional) – UNIX epoch time of start of this run. If None is given, the current time will be used.
metadata (dict, optional) – Additional metadata include the document
validate (boolean, optional) – Validate this document conforms to the schema.
event_counters (dict, optional) – A dict for counting events, when an event is composed by any of the descriptors composed by this run, the element in this dict with the key of the descriptor name will be increased by 1.

Return type:

ComposeRunBundle

event_model#

`event_model`#