ndi_document_element_epoch (ndi.document class)¶
Class definition¶
Class name: ndi_document_element_epoch
Short name: ndi_document_element_epoch
Superclasses: ndi_document_binaryseries, ndi_document, ndi_document_epochid
Definition: $NDIDOCUMENTPATH/ndi_document_element_epoch.json
Schema for validation: $NDISCHEMAPATH/ndi_document_element_epoch_schema.json
Property_list_name: element_epoch
Class_version: 1
ndi_document_element_epoch fields¶
Accessed by element_epoch.field where field is one of the field names below
| field | default_value | data type | description |
|---|---|---|---|
| depends_on | - | structure | Each document that this document depends on is listed; its document ID is given by the value, and the name indicates the type of dependency that exists. Note that the index for each dependency in the list below is arbitrary and can change. Use ndi.document methods dependency, dependency_value,add_dependency_value_n,dependency_value_n,remove_dependency_value_n, and set_dependency_value to read and edit depends_on fields of an ndi.document. |
| depends_on: element_id | |||
| epoch_clock | 'dev_local_time' | character array (ASCII) | The clock type (of the ndi.time.clocktype object) that describes this epoch. |
| t0_t1 | [0 1] | 1x2 float | The start time and the stop time of this epoch, in time units of the epoch_clock. |
ndi_document_binaryseries fields¶
Accessed by binary_series_parameters.field where field is one of the field names below
| field | default_value | data type | description |
|---|---|---|---|
| time_size | 1 | Integer array [n m] | Number of independent variable entries (often time) |
| time_type | character array (ASCII) | Type of the time variable ('float64', 'uint32', etc) (note: make better) | |
| data_size | 1 | Integer array [n m] | Number of data entries) |
| data_type | character array (ASCII) | Type of the time variable ('float64', 'uint32', etc) (note: make better) | |
| data_dim | 1 | Integer array [n m] | Dimensions of each data series |
| samples_regular_intervals | 1 | Integer (0 or 1) | is the data always sampled at regular intervals? |
ndi_document fields¶
Accessed by ndi_document.field where field is one of the field names below
| field | default_value | data type | description |
|---|---|---|---|
| session_id | - | NDI ID string | The globally unique identifier of any data session that produced this document |
| id | - | NDI ID string | The globally unique identifier of this document |
| name | character array (ASCII) | A user-specified name, free for users/developers to use as they like | |
| type | character array (ASCII) | A user-specified type, free for users/developers to use as they like (deprecated, will be removed) | |
| datestamp | (current time) | ISO-8601 date string, time zone must be UTC leap seconds | Time of document creation |
| database_version | - | character array (ASCII) | Version of this document in the database |
ndi_document_epochid fields¶
Accessed by epochid_fix.field where field is one of the field names below
| field | default_value | data type | description |
|---|---|---|---|
| epochid | character array (ASCII) | The epoch id that is referred to |