Skip to content

Commit

Permalink
Update contributing_code.md
Browse files Browse the repository at this point in the history
  • Loading branch information
avolu authored Feb 16, 2024
1 parent c3c7f75 commit 412c79f
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion _doc/contributing_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ Cedalion is using XArrays as main data structures for processing. There are curr

## Example for contributing new functionality to Cedalion
In this example we will incorporate two new functions into the toolbox: A function that identifies motion artifacts in fNIRS data and a function to prune bad channels. Both functions are replicating the Homer3 functions "hmR_MotionArtifact" and "hmR_PruneChannels".
The corresponding jupyter notebook example to showcase the code in this file is the [Pruning and Motion Artefacts Notebook Example](https://github.com/ibs-lab/cedalion/blob/alex_working/examples/pruning_and_motion_artifacts.ipynb)

### Where do these functions belong?
The function to prune channels belongs to /siproc/quality.py and will simply be called "prune". It will then be available with
Expand Down Expand Up @@ -124,4 +125,4 @@ def prune(data: cdt.NDTimeSeries, SNRThresh: Quantity, dRange: Quantity, SDrange
return data
```
```

0 comments on commit 412c79f

Please sign in to comment.