Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • D Documentation
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Analytics
    • Analytics
    • CI/CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • anywave
  • Documentation
  • Wiki
  • plugin_spectral_cli

plugin_spectral_cli · Changes

Page history
transferring wiki from anywave to documentation authored Jun 06, 2024 by Bruno Colombet's avatar Bruno Colombet
Show whitespace changes
Inline Side-by-side
Showing with 43 additions and 0 deletions
+43 -0
  • plugin_spectral_cli.md plugin_spectral_cli.md +43 -0
  • No files found.
plugin_spectral_cli.md 0 → 100644
View page @ 2d1e05f5
# Using the plugin from the command line
The plugin will requires the following options:
| option | type | description/value |
| :---: | :---: | :---: |
| --run spectral | **MANDATORY** | name of the plugin |
| --time_window value | **MANDATORY** | length of fft window in s |
| --overlap value | **MANDATORY** | overlap length for next fft window |
| --windowing type | optional | a string containing either Hanning, Hamming or None |
This plugin also supports the following common options:
| option | type |
| :---: | :---: |
| --input_file | **MANDATORY** |
| --use_markers | optional |
| --skip_markers | optional |
| --output_dir | optional |
| --output_suffix | optional |
| --output_prefix | optional |
## command line examples
### Basic usage
```bash
anywave --run spectral --input_file d:\data\myfile.eeg --time_window 1 --overlap 0.5
```
PSD will be computed for all channels in myfile.eeg, unless there is a myfile.eeg.mgt file.
PSD will be computed on the whole data unless there is a myfile.eeg.mrk file containing markers with durations.
The fft window will be 1s, and the fft overlap will be 0.5s.
The result file will go in d:\data.
### force to compute on the whole data
```bash
anywave --run spectral --input_file d:\data\myfile.eeg --time_window 1 --overlap 0.5 --use_markers all_data
```
### avoid artefacts (assuming we have a myfile.eeg.mrk file)
```bash
anywave --run spectral --input_file d:\data\myfile.eeg --time_window 1 --overlap 0.5 --skip_markers artefact
```
### Customize output file name
```bash
anywave --run spectral --input_file d:\data\myfile.eeg --time_window 1 --overlap 0.5 --output_prefix psd --output_suffix custom
```
That will generate *d:\data\psd_fftwindow-1024_fftoverlap-512_windowing-hanning_custom.mat*
\ No newline at end of file
Clone repository
  • Build_AnyWave
  • CLI
  • CLI_List
  • Changes
  • ExportData
  • MATLAB_API
  • MATLAB_BIDS
  • MATLAB_debug
  • MATLAB_functions
  • MATLAB_get_data
  • MATLAB_get_data_ex
  • MATLAB_get_markers
  • MATLAB_get_props
  • MATLAB_init
  • MATLAB_run
View All Pages