Skip to main content
Ctrl+K

meeg-utils

  • Tutorials
  • Installation
  • Steps and pipelines
  • Quality control
  • Presets
    • Batch processing
    • Command line
    • API Reference
    • Contributing Guide
    • Testing
    • CI/CD
    • Release Process
    • Changelog
    • License
  • GitHub
  • PyPI
  • Tutorials
  • Installation
  • Steps and pipelines
  • Quality control
  • Presets
  • Batch processing
  • Command line
  • API Reference
  • Contributing Guide
  • Testing
  • CI/CD
  • Release Process
  • Changelog
  • License
  • GitHub
  • PyPI

Section Navigation

  • meeg_utils.Pipeline
  • meeg_utils.Step
  • meeg_utils.process
  • meeg_utils.Dataset
  • meeg_utils.process_dataset
  • meeg_utils.BatchResult
  • meeg_utils.steps.Filter
  • meeg_utils.steps.Resample
  • meeg_utils.steps.LineNoise
  • meeg_utils.steps.BadChannels
  • meeg_utils.steps.Interpolate
  • meeg_utils.steps.Reference
  • meeg_utils.steps.ICA
  • meeg_utils.steps.HeadAlign
  • meeg_utils.steps.Maxwell
  • meeg_utils.steps.ByChannelType
  • meeg_utils.steps.HFC
  • meeg_utils.steps.Regression
  • meeg_utils.steps.BadSegments
  • meeg_utils.steps.ASR
  • meeg_utils.steps.SNS
  • meeg_utils.steps.BridgedElectrodes
  • meeg_utils.steps.DropChannels
  • meeg_utils.steps.Epoch
  • meeg_utils.steps.FixedLengthEpochs
  • meeg_utils.steps.Baseline
  • meeg_utils.steps.AutoReject
  • meeg_utils.epochs.combine
  • meeg_utils.io.read
  • meeg_utils.io.save_derivative
  • meeg_utils.io.existing_derivatives
  • meeg_utils.io.detect_system
  • meeg_utils.io.get_datatypes
  • meeg_utils.io.average_dev_head_t
  • meeg_utils.qc.inspect
  • meeg_utils.qc.inspect_dataset
  • meeg_utils.qc.find_recordings
  • meeg_utils.qc.QCReport
  • meeg_utils.qc.DatasetQC
  • meeg_utils.qc.Finding
  • meeg_utils.qc.Check
  • meeg_utils.qc.Amplitude
  • meeg_utils.qc.Bridging
  • meeg_utils.qc.Impedance
  • meeg_utils.qc.OutlierChannels
  • meeg_utils.qc.NarrowbandNoise
  • meeg_utils.qc.Muscle
  • meeg_utils.qc.Blinks
  • meeg_utils.qc.HeartRate
  • meeg_utils.qc.HeadMovement
  • meeg_utils.qc.Digitization
  • meeg_utils.qc.Events
  • meeg_utils.qc.SquidJumps
  • meeg_utils.qc.ChpiSNR
  • meeg_utils.qc.EmptyRoom
  • meeg_utils.qc.BidsMetadata
  • meeg_utils.qc.Photodiode
  • meeg_utils.report.build
  • meeg_utils.report.from_derivative
  • meeg_utils.report.summarize
  • meeg_utils.report.DerivativesSummary
  • meeg_utils.presets.available
  • meeg_utils.presets.get
  • meeg_utils.presets.options
  • meeg_utils.setup_logging
  • meeg_utils.teardown_logging
  • meeg_utils.log_to_file
  • meeg_utils.testing.check_step
  • meeg_utils.testing.check_check
  • API Reference
  • meeg_utils.qc.Blinks

meeg_utils.qc.Blinks#

class meeg_utils.qc.Blinks(*, min_rate=None)[source]#

Blink rate from the EOG channel(s), a test that the EOG works.

Blinks are detected with mne.preprocessing.find_eog_events() (MNE defaults). Spontaneous blink rates of healthy adults are around 17 per minute at rest and fall to about 4.5 per minute while reading (Bentivoglio et al., 1997, Mov Disord 12:1028); a much lower rate usually means a detached or misplaced EOG electrode. A flat EOG channel is always flagged.

Parameters:

min_rate (float | None) – Blinks per minute below which the EOG is flagged. Blink rates vary widely between people and tasks (Bentivoglio et al., 1997), so the default None reports the rate without a verdict.

metrics_#

n_blinks, rate_per_min and channels.

Type:

dict

Notes

Figures: "blinks" (blink rate over time and the average blink).

__init__(*, min_rate=None)[source]#

Methods

__init__(*[, min_rate])

compute(raw)

Measure the recording.

get_metadata_routing()

Get metadata routing of this object.

get_params([deep])

Get parameters for this estimator.

not_applicable(raw)

Return why the check cannot run on raw, or None if it can.

plot([kind, inst])

Draw quality-control figures.

set_params(**params)

Set the parameters of this estimator.

Attributes

level

The worst verdict of the findings ("ok" if there are none).

modalities

Data types the check needs at least one of ("meg", "eeg").

name

Key of the check in reports.

plot_kinds

kind -> whether it needs data (inst).

systems

Acquisition systems the check applies to; None means all.

name: ClassVar[str] = 'blinks'#

Key of the check in reports.

plot_kinds: ClassVar[dict[str, bool]] = {'blinks': False}#

kind -> whether it needs data (inst). Each kind is drawn by a _plot_<kind>(inst, **kwargs) method.

Type:

Figures the object can draw once fitted

not_applicable(raw)[source]#

Return why the check cannot run on raw, or None if it can.

Parameters:

raw (Raw) – The recording.

Returns:

The reason, or None.

Return type:

str | None

previous

meeg_utils.qc.Muscle

next

meeg_utils.qc.HeartRate

On this page
  • Blinks
    • Blinks.metrics_
    • Blinks.__init__()
    • Blinks.name
    • Blinks.plot_kinds
    • Blinks.not_applicable()
Edit on GitHub

This Page

  • Show Source

© Copyright 2026, meeg-utils contributors.

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.16.1.