data_types

class aind_behavior_services.data_types.DataType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: StrEnum

ARRAY = 'array'

BOOLEAL = 'boolean'

NULL = 'null'

NUMBER = 'number'

OBJECT = 'object'

STRING = 'string'

pydantic model aind_behavior_services.data_types.DataTypes

Bases: SchemaVersionedModel

Config:

• json_schema_extra: dict = {‘x-abstract’: ‘True’}

Fields:

• render_synch_state (aind_behavior_services.data_types.RenderSynchState)

• software_event (aind_behavior_services.data_types.SoftwareEvent)

• version (Literal['0.1.1'])

Validators:

• coerce_version » version

field render_synch_state: RenderSynchState [Required]

field software_event: SoftwareEvent [Required]

field version: Literal['0.1.1'] = '0.1.1'

Validated by:

• coerce_version

class Config

Bases: object

json_schema_extra = {'x-abstract': 'True'}

pydantic model aind_behavior_services.data_types.RenderSynchState

Bases: BaseModel

Fields:

• frame_index (int | None)

• frame_timestamp (float | None)

• sync_quad_value (float | None)

field frame_index: int | None = None

The frame index of the event

Constraints:

• ge = 0

field frame_timestamp: float | None = None

The timestamp of the frame

Constraints:

• ge = 0

field sync_quad_value: float | None = None

The synchronization quad value

Constraints:

• ge = 0

• le = 1

pydantic model aind_behavior_services.data_types.SoftwareEvent

Bases: BaseModel

A software event is a generic event that can be used to track any event that occurs in the software.

Fields:

• data (Any | None)

• data_type (aind_behavior_services.data_types.DataType)

• data_type_hint (str | None)

• frame_index (int | None)

• frame_timestamp (float | None)

• name (str)

• timestamp (float | None)

• timestamp_source (aind_behavior_services.data_types.TimestampSource)

field data: Any | None = None

The data of the event

field data_type: DataType = DataType.NULL (alias 'dataType')

The data type of the event

field data_type_hint: str | None = None

The data type hint of the event

field frame_index: int | None = None

The frame index of the event

Constraints:

• ge = 0

field frame_timestamp: float | None = None

The timestamp of the frame

field name: str [Required]

The name of the event

field timestamp: float | None = None

The timestamp of the event

field timestamp_source: TimestampSource = TimestampSource.NULL

The source of the timestamp

class aind_behavior_services.data_types.TimestampSource(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: StrEnum

HARP = 'harp'

NULL = 'null'

RENDER = 'render'