Modules

This guide documents all the necessary information needed to use the modules in the CEAMSModules package. Modules are the building blocks of Snooz processes. Each module performs a specific operation on signals, events, files, or parameters.

Modules are grouped by category as they appear in the Snooz Module Library. Select a category below to browse module documentation.

How to use modules

1. In Snooz, go to Dev Tools -> New process.

2. Open the Module Library and enable the CEAMSModules package if needed.

3. Drag modules from a category onto the process canvas.

4. Connect module inputs and outputs to define your analysis pipeline.

5. Configure each module via its Settings tab and run the process.

For a hands-on introduction to processes and modules, see Explore examples.

Categories

Module categories:

• Connectivity Analysis
  • Dpli Connectivity
  • Wpli Connectivity
  • Quick reference
• Detectors
  • A4Precise Events
  • Amplitude Detector
  • Amplitude Var Detector
  • Detection View
  • Oxygen Desaturation Detector
  • REMs Detection Yasa
  • Slow Wave Detector
  • Spectral Detector
  • Spindle Detector A7
  • Spindle Detector Sumo
  • Quick reference
• Events Analysis
  • Event Sleep Report
  • Event Temporal Link
  • Quick reference
• Events Utilities
  • Connectivity Details
  • Define Event Group
  • Discard Events
  • Drop/Rename Events
  • Event Combine
  • Event Compare
  • Event Creator
  • Event Subdivision
  • Events Splitter
  • Extend Events
  • Filter Events
  • Performance By Event
  • PSA Pics Generator
  • REMs Details
  • REMs to mini-epochs
  • Replace Event In Signals
  • Scoring Completeness
  • Signals From Events
  • Sleep Stage Events
  • Sleep Stage Rename
  • Slow Wave Pics Generator
  • Slow Waves Details
  • Spindles Details
  • Windows To Samples
  • Quick reference
• Files I/O
  • Csv Reader Master
  • Detections Cohort Review
  • Domino Converter
  • EDF Annotations Reader
  • Edf Xml Reader
  • Edf Xml Reader Master
  • Edf Xml Writer
  • Event Reader
  • Json Path Editor Master
  • PSA Cohort Review
  • PSGReader
  • PSGWriter
  • Rename File List
  • Sleep Stages Importer
  • TSV Validator Master
  • Tsv Writer
  • Quick reference
• Hypnogram Analysis
  • Hypnogram
  • Sleep Bouts
  • Sleep Cycles Delimiter
  • Sleep Report
  • Quick reference
• Parameters
  • Alias Signals
  • Constant
  • Create Dictionary
  • Create List of Group Name
  • Create Tuple
  • Dictionary
  • String Manip
  • Quick reference
• Signal Processing
  • Epoch Signal
  • Filter Signal
  • Ica Components
  • Ica Restore
  • Invert Signals
  • IRASA YASA
  • Moving RMS
  • PSA Compilation FOOOF
  • Remove Channel Artefact
  • Resample
  • Rescale Signal
  • Reset Signal Artefact
  • Score Sleep Stages YASA
  • Stft
  • Subtract Signals
  • Trim Signal
  • Quick reference
• Statistics
  • Mutual Info
  • PSA Compilation
  • PSA on Events
  • Signal Stats
  • Sleep Staging Export Results
  • Slow Wave Classifier
  • Threshold Computation
  • Quick reference

All modules

Module	Category	Version	Description
Dpli Connectivity	Connectivity Analysis	2.1.0	Computes per-epoch, surrogate-corrected Directed Phase Lag Index (dPLI) matrices from EEG epochs.
Wpli Connectivity	Connectivity Analysis	2.1.0	Computes per-epoch, surrogate-corrected Weighted Phase Lag Index (wPLI) matrices from EEG epochs.
A4Precise Events	Detectors	2.0.0	Refines onset and duration of events detected by the a4 spindle detector.
Amplitude Detector	Detectors	2.0.0	Detects events based on the absolute signal amplitude.
Amplitude Var Detector	Detectors	2.0.0	Detects events based on maximum amplitude variation in a narrow time windows.
Detection View	Detectors	2.0.0	Organizes detection information and saves it into the cache in order to plot it.
Oxygen Desaturation Detector	Detectors	2.4.0	Analyzes the oxygen channel, detect oxygen desaturations and export oxygen saturation report.
REMs Detection Yasa	Detectors	3.1.0	Detects Rapid Eye Movements (REMs) in EOG sleep recordings using YASA REM detection algorithm.
Slow Wave Detector	Detectors	2.2.0	Detects slow wave events based on the Carrier method.
Spectral Detector	Detectors	2.2.0	Detects events based on the spectrum.
Spindle Detector A7	Detectors	3.0.0	Detects spindles based on the a7 algorithm.
Spindle Detector Sumo	Detectors	3.0.0	Detects spindles based on the SUMO deep learning algorithm.
Event Sleep Report	Events Analysis	2.0.0	Generates event sleep report.
Event Temporal Link	Events Analysis	2.0.0	Generates temporal links listed in the input temporal_links.
Connectivity Details	Events Utilities	2.0.0	Saving connectivity results to disk.
Define Event Group	Events Utilities	2.0.0	Defines groups to events.
Discard Events	Events Utilities	2.1.0	Discards too long, too short or events that occur during artefacts.
Drop/Rename Events	Events Utilities	2.0.0	Drops events and/or rename events group and/or name.
Event Combine	Events Utilities	2.0.0	Combines two lists of events, with or without selection.
Event Compare	Events Utilities	2.0.0	Compares two sets of events .
Event Creator	Events Utilities	2.0.0	Creates a pandas Dataframe of events.
Event Subdivision	Events Utilities	0.0.0	Creates a new pandas DataFrame of events with subwindow of every input events named events_names.
Events Splitter	Events Utilities	2.0.0	Used to split too long events.
Extend Events	Events Utilities	2.0.0	Extend or shrink events by a percentage of their duration, applied to each side.
Filter Events	Events Utilities	2.0.0	Selects events from specific sleep stages.
Performance By Event	Events Utilities	2.0.0	Compares two sets of events .
PSA Pics Generator	Events Utilities	2.0.1	Used to generate figures of Power Spectral Analysis (PSA) data from PSA report files.
REMs Details	Events Utilities	2.2.0	Averages REMs events characteristics such as duration, amplitude and density per stage and sleep cycle.
REMs to mini-epochs	Events Utilities	0.0.0	Used to generate a list of mini-epochs identified as a Phasic or Tonic based on the list of detected REMs.
Replace Event In Signals	Events Utilities	2.1.0	Inserts samples from event dataframe inside a signals.
Scoring Completeness	Events Utilities	2.0.0	Evaluates if the scoring (events) is unique, complete and specific to the sleep staging.
Signals From Events	Events Utilities	3.0.0	Manages a list of SignalModel from specific events during a recording.
Sleep Stage Events	Events Utilities	2.1.0	Creates a list of event from specific sleep stages during a recording.
Sleep Stage Rename	Events Utilities	2.0.0	Renames sleep stage annotation.
Slow Wave Pics Generator	Events Utilities	3.0.0	Used to generate pictures of slow wave events.
Slow Waves Details	Events Utilities	2.2.0	Averages slow wave events characteristics such as duration, amplitude, frequency and so on per stage and sleep cycle.
Spindles Details	Events Utilities	2.2.0	Computes spindles events characteristics such as duration, amplitude, frequency and so on.
Windows To Samples	Events Utilities	2.0.0	Converts information based on windows (i.e. RMS energy) into a time series.
Csv Reader Master	Files I/O	2.0.0	Reads events from a CSV file.
Detections Cohort Review	Files I/O	2.1.0	Reads the spindle/sw output files and generates the “Detected events cohort report” file clean or transposed.
Domino Converter	Files I/O	2.1.0	Converts DOMINO accessory files (ASCII) in one Snooz accessory tsv file.
EDF Annotations Reader	Files I/O	2.0.0	Used to read the EDF Annotations signal and create a pandas dataframe with the events.
Edf Xml Reader	Files I/O	2.0.0	Reads events from a EDF.XML file.
Edf Xml Reader Master	Files I/O	2.0.0	Reads events from a EDF.XML files or .XML files.
Edf Xml Writer	Files I/O	2.0.0	Creates an XML file based on compumedic format.
Event Reader	Files I/O	3.0.0	Reads events from a Tsv file.
Json Path Editor Master	Files I/O	2.0.0	Edits JSON files by replacing paths within the JSON structure.
PSA Cohort Review	Files I/O	2.5.0	Reads the PSA output file and generates the PSA file clean or transposed.
PSGReader	Files I/O	2.3.0	Reads a PSG file.
PSGWriter	Files I/O	2.2.0	Writes a PSG file.
Rename File List	Files I/O	2.1.0	Renames files based on input parameters such as prefix.
Sleep Stages Importer	Files I/O	2.1.0	Imports sleep stages from a textfile into the sleep_stages dataframe.
TSV Validator Master	Files I/O	2.0.0	Validates TSV files by checking their encoding and structure.
Tsv Writer	Files I/O	2.0.0	Saves events to a CSV file.
Hypnogram	Hypnogram Analysis	2.1.0	Displays in the results view an hypnogram and its sleep cycles.
Sleep Bouts	Hypnogram Analysis	2.0.0	Supports sleep bouts operations within a Snooz process.
Sleep Cycles Delimiter	Hypnogram Analysis	2.4.0	Compute the sleep cycles.
Sleep Report	Hypnogram Analysis	2.1.0	Generates a sleep report in CSV file.
Alias Signals	Parameters	2.0.0	Extract only the signals with a specific Alias.
Constant	Parameters	2.0.0	Passes a value to the next node.
Create Dictionary	Parameters	2.0.0	Transforms key-value inputs into a dictionary output while preserving the original value.
Create List of Group Name	Parameters	2.0.0	Creates a list of tuples that has two values of group and name.
Create Tuple	Parameters	2.0.0	Creates a tuple from two input values.
Dictionary	Parameters	2.0.0	Returns a value based on a key received in input.
String Manip	Parameters	2.0.0	Allows string manipulaiton.
Epoch Signal	Signal Processing	2.0.0	Segments EEG signals into overlapping or non-overlapping epochs of fixed duration.
Filter Signal	Signal Processing	2.1.0	Applies a FIR/IIR filter to EEG signals.
Ica Components	Signal Processing	2.0.0	Find components of a signal with idependant component analysis.
Ica Restore	Signal Processing	2.0.0	Reconstructs signal from ICA components.
Invert Signals	Signal Processing	2.0.0	Inverts signals.
IRASA YASA	Signal Processing	0.0.0	Spectral power decomposition using IRASA algorithm.
Moving RMS	Signal Processing	2.0.0	Computes RMS value on a moving window.
PSA Compilation FOOOF	Signal Processing	0.0.0	Analyses and reports the PSD output designed specifically for FOOOF analysis.
Remove Channel Artefact	Signal Processing	2.0.0	Removes full-channel artefacts from signals and events.
Resample	Signal Processing	2.0.0	Resamples a signal.
Rescale Signal	Signal Processing	2.1.0	Creates a list of dictionaries with the channels from specific epochs during a recording.
Reset Signal Artefact	Signal Processing	2.1.0	Resets the signal that occurs during an artefact.
Score Sleep Stages YASA	Signal Processing	2.0.0	Automatic sleep stage classification using YASA’s machine learning model.
Stft	Signal Processing	2.1.0	Computes the STFT on the signal split into sliding windows.
Subtract Signals	Signal Processing	2.0.0	Subtracts signals from a specific channel from the signals of a list of channels.
Trim Signal	Signal Processing	2.0.0	Trims continuous/discontinuous signal segments and their associated events to a time window defined by.
Mutual Info	Statistics	2.0.0	Finds the mutual information between two lists of signals.
PSA Compilation	Statistics	2.2.0	Analyses and reports the PSD output.
PSA on Events	Statistics	2.1.0	Compiles the PSA run on selected events.
Signal Stats	Statistics	2.0.0	Computes the mean and standard deviation of the input signals per epoch, per channel.
Sleep Staging Export Results	Statistics	2.0.0	Processes and visualizes sleep staging results.
Slow Wave Classifier	Statistics	2.0.0	Classifies slow wave events based on a gaussian mixture.
Threshold Computation	Statistics	2.1.0	Computes the value to threshold (i.e. µV) from a signals (i.e. EEG time series)