sorting_parameters (ndi.document class)¶
Class definition¶
Class name: ndi_document_apps_spikesorter_sorting_parameters
Short name: sorting_parameters
Superclasses: ndi_document, ndi_document_app
Definition: $NDIDOCUMENTPATH/apps/spikesorter/sorting_parameters.json
Schema for validation: $NDISCHEMAPATH/apps/spikesorter/sorting_parameters_schema.json
Property_list_name: sorting_parameters
Class_version: 1
sorting_parameters fields¶
Accessed by sorting_parameters.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 | |||
| graphical_mode | 1 | Integer | 0/1 Should we bring up the graphical user interface to let the user manually specify the clusters? (0=no, 1=yes) |
| num_pca_features | 10 | Integer | Number of principle component analysis features to use for sorting in automatic mode |
| interpolation | 3 | Integer | The number of times to oversample each spike waveform with cubic splines (minimum 1, maximum 10; must be an integer) |
| min_clusters | 3 | Integer | Minimum number of clusters to find when using automatic mode (this is passed to KlustaKwik) |
| max_clusters | 10 | Integer | Maximum number of clusters to find when using automatic mode (this is passed to KlustaKwik) |
| num_start | 5 | Integer | Number of random starting positions to try when using automatic mode (this is passed to KlustaKwik) |
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_app fields¶
Accessed by app.field where field is one of the field names below
| field | default_value | data type | description |
|---|---|---|---|
| name | ndi.app | character array (ASCII) | The name of the application |
| version | - | character array (ASCII) | The version of the app according to the app's own version schedule; often this is a Git commit identifier |
| url | URL as a character array (ASCII) | The home page of the application | |
| os | character array (ASCII) | The operating system that ran the application | |
| os_version | character array (ASCII) | The operating system version | |
| interpreter | character array (ASCII) | If applicable, the name of the interpreter (Matlab, python3, etc) | |
| interpreter_version | character array (ASCII) | If applicable, the version of the interpreter |