Skip to main content

# niphlem

niphlem is a toolbox that extracts physiological recordings during MRI scanning and estimates the signal phases so that they can be used as a covariate in your general linear model (GLM) with fMRI data.

niphlem can generate multiple models of physiological noise to include as regressors in your GLM model from either ECG, pneumatic breathing belt or pulse-oximetry data. These are described in Verstynen and Deshpande (2011).

Briefly, niphlem implements two physiological models for regressors generation:

  • RETROICOR: A phasic decomposition method that isolates the fourier series that best describes the spectral properties of the input signal. This was first described by Glover and colleagues.

  • Variation Models: For low frequency signals (like the pneumatic belt and low-pass filtered pulse-oximetry) this does the combined respiration variance and response function described by Birn and colleagues (2008). For high frequency signals (i.e., ECG or high-pass filtered pulse-oximetry), this generates the heart-rate variance and cardiac response function described by Chang and colleagues (2009).

niphlem can also extract cardiac and respiratory signals from the pulse-oximitry data stream itself, as described in Verstynen and Deshpande (2011).

## Dependencies

Python 3.6 or greater is required. Any of the below dependencies compatible wth such versions of Python should be OK:

  • numpy

  • matplotlib

  • pandas

  • scipy

  • scikit_learn

  • outlier_utils

## Install

pip install niphlem

## References: - Verstynen TD, Deshpande V. Using pulse oximetry to account for high and low frequency physiological artifacts in the BOLD signal. Neuroimage. 2011 Apr 15;55(4):1633-44. - Chang C, Cunningham JP, Glover GH. Influence of heart rate on the BOLD signal: the cardiac response function. Neuroimage. 2009 Feb 1;44(3):857-69. - Birn RM, Smith MA, Jones TB, Bandettini PA. The respiration response function: the temporal dynamics of fMRI signal fluctuations related to changes in respiration. Neuroimage. 2008;40(2):644-654.

Metadata

Release files for niphlem 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for niphlem 0.0.3
File Size Uploaded Provenance Actions
niphlem-0.0.3.tar.gz 29.1 kB Without provenance Details for niphlem-0.0.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for niphlem 0.0.3
File Interpreter ABI Platform Actions
niphlem-0.0.3-py3-none-any.whl Python 3 none any Details for niphlem-0.0.3-py3-none-any.whl

Total release size: 65.7 kB

Release files / niphlem-0.0.3.tar.gz

Download URL niphlem-0.0.3.tar.gz
Size 29.1 kB
Tags Source
SHA-256 checksum
How to use checksums
f3e283d1a33b07f7b65d3200a1f55efc08fcca8ff2c9da1990192106777979cb
BLAKE2b-256 checksum
How to use checksums
71f66985fbf843f60c157a696695190ad5259146284bff1a4f46d9769af7d48d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.8.2 keyring/23.4.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.7

Release files / niphlem-0.0.3-py3-none-any.whl

Download URL niphlem-0.0.3-py3-none-any.whl
Size 36.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cab1ec8c6f353487812b0e8102f3cff01e2ba75fc32d412431fdf60b32fa07d9
BLAKE2b-256 checksum
How to use checksums
f4ea12cfe3808e9fe04c38e09e35f7131bea6e12a96e27527dbcd4c0b0cef19e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.8.2 keyring/23.4.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.7

Security for niphlem 0.0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page