Glossary
Access Token¶
Security credentials required access NeuroScale API, identifies the user, and user's privileges.
Application Programming Interface (API)¶
Code that defines the correct way for a developer to write a program that requests services from an application such as a web server.
cURL¶
Command-line tool for getting or sending files using URL syntax.
Dashboard¶
NeuroScale's graphical interface providing access to the NeuroScale API in a user friendly layout.
Desktop Clients¶
GUI programs for easy streaming and visualization of EEG data using NeuroScale platform.
JSON¶
JavaScript Object Notation, an open-standard file format that uses human-readable text to transmit data objects consisting of attribute–value pairs and array data types (or any other serializable value).
Lab Streaming Layer (LSL)¶
A system for the unified collection of measurement time series in research experiments that handles both the networking, time-synchronization, (near-) real-time access as well as optionally the centralized collection, viewing and disk recording of the data.
Metadata¶
Data that provides information about other data
MQTT¶
Message transmission protocol used by NeuroScale. The Message Queuing Telemetry Transport (MQTT) protocol is an implementation of a software architectural design commonly referred to as a publish/subscribe messaging pattern.
NeuroPype¶
NeuroPype is a platform that includes tools for building and running real-time processing pipelines of neural data and other biosignals.
Patch¶
NeuroPype processing graphs, which can be uploaded to the NeuroScale and executed as a Pipline.
Pipeline¶
Pipelines in NeuroScale are conceptually similar to a pipeline in everyday life: a route, channel, or process along which something flows through-- in NeuroScale, data flows through a sequence of processing operations. In order to enter, pipelines require input data to have a predefined structure, as the data flows through the pipeline the data is processed to produce an output, again structured in a predefined way.
RESTful Design¶
A RESTful API -- also referred to as a RESTful web service -- is based on representational state transfer (REST) technology, an architectural style and approach to communications often used in web services development
Streaming Endpoints¶
Streaming endpoints in NeuroScale are set up when an instance is created from a pipeline, and are considered unique and fixed for the duration of your processing session (while the instance exists).
Streaming Instance¶
A running pipeline and can be considered an instantiation of a specific pipeline that may be manipulated/interrogated in a number of ways.
Tasks¶
Short for batch tasks, the batch system streamlines repeatable tasks, such as automated report generation of newly uploaded datasets, with minimal user effort and setup time. Batch tasks typically involve running heavier processing pipelines that read in one or more input files and produce one or more output files containing the results. This contrasts NeuroScale's streaming i/o system, which is designed to return continuous real-time results.
XDF¶
XDF(Extensible Data Format) is a general-purpose container format for multi-channel time series data with extensive associated meta information. XDF is tailored towards biosignal data such as EEG, EMG, EOG, ECG, GSR, MEG, but it can also handle data with high sampling rate (like audio) or data with a high number of channels (like fMRI or raw video). Meta information is stored as XML.