ndi_document_subjectmeasurement (ndi.document class)¶
Class definition¶
Class name: ndi_document_subjectmeasurement
Short name: ndi_document_subjectmeasurement
Superclasses: ndi_document, ndi_document_subject
Definition: $NDIDOCUMENTPATH/ndi_document_subjectmeasurement.json
Schema for validation: $NDISCHEMAPATH/ndi_document_subjectmeasurement_schema.json
Property_list_name: subjectmeasurement
Class_version: 1
ndi_document_subjectmeasurement fields¶
Accessed by subjectmeasurement.field where field is one of the field names below
| field | default_value | data type | description |
|---|---|---|---|
| measurement | |||
| value | |||
| datestamp |
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_subject fields¶
Accessed by subject.field where field is one of the field names below
| field | default_value | data type | description |
|---|---|---|---|
| local_identifier | - | A globally unique identifier that is meaningful to a local group | The identifier is usually constructed by concatenating a local identifier with the name of the group, such as mouse123@vhlab.org |
| description | character string (ASCII) | A character string that is free for the user to choose |