phys2cvr

A python-based tool to generate regressor for and/or estimate CVR maps and their lag.

The project is currently under development stage alpha. Any suggestion/bug report is welcome! Feel free to open an issue.

This project follows the all-contributors specification. Contributions of any kind welcome!

Documentation

Full documentation here

Cite

If you use phys2cvr in your work, please cite either the all-time Zenodo DOI or the Zenodo DOI related to the version you are using. Please cite the following paper(s) too:

Moia, S., Stickland, R. C., Ayyagari, A., Termenon, M., Caballero-Gaudes, C., & Bright, M. G. (2020). Voxelwise optimization of hemodynamic lags to improve regional CVR estimates in breath-hold fMRI. In 2020 42nd Annual International Conference of the IEEE Engineering in Medicine & Biology Society (EMBC) (pp. 1489–1492). Montreal, QC, Canada: IEEE. https://doi.org/10.1109/EMBC44109.2020.9176225

If you are using the --brightspin configuration option:

Moia, S., Termenon, M., Uruñuela, E., Chen, G., Stickland, R. C., Bright, M. G., & Caballero-Gaudes, C. (2021). ICA-based denoising strategies in breath-hold induced cerebrovascular reactivity mapping with multi echo BOLD fMRI. NeuroImage, 233, 117914. https://doi.org/10.1016/j.neuroimage.2021.117914

If you are using the --brightspin-clinical configuration option:

Stickland, R. C., Zvolanek, K. M., Moia, S., Ayyagari, A., & Bright, M. G. (2021). A practical modification to a resting state fMRI protocol for improved characterization of cerebrovascular function. Neuroimage, 239, 118306. https://doi.org/10.1016/j.neuroimage.2021.118306

If you are using the --baltimore-lag configuration option:

Liu, P., Li, Y., Pinho, M., Park, D. C., Welch, B. G., & Lu, H. (2017). Cerebrovascular reactivity mapping without gas challenges. NeuroImage, 146, 320–326. https://doi.org/10.1016/j.neuroimage.2016.11.054

If you are using the --baltimore configuration option, please cite only the Zenodo DOI and the last listed paper.

If you are using the --fourier-set-lag configuration option:

Pinto, J., Jorge, J., Sousa, I., Vilela, P., & Figueiredo, P. (2016). Fourier modeling of the BOLD response to a breath-hold task: Optimization and reproducibility. NeuroImage, 135, 223-231. https://doi.org/10.1016/j.neuroimage.2016.02.037

If you are using the --fourier-set configuration option, please cite only the Zenodo DOI and this last paper.

Installation

Instructions here

Developer installation

(Potential) Contributors, instead see here!

Run/use `phys2cvr`

You can run the phys2cvr workflow in a shell session (or in your code) - just follow the help or see here:

phys2cvr --help

Alternatively, you can use phys2cvr as a module in a python session (or within your python script):

import phys2cvr as p2c

p2c.__version__

Full API here

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Stefano Moia} 💻 🤔 🚇 📆	_{Kristina Zvolanek} 💻 🐛 🚇	_{Becca Clements} 🐛 💻 📓	_{Andrew Vigotsky} 💻	_ccomellalue 💻 🤔
_merelvdthiel 📖	_razkin 🎨 📖 ⚠️

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Metadata

Release files for phys2cvr 0.33.0

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

Source distribution (sdist)

Source distribution for phys2cvr 0.33.0
File	Size	Uploaded
phys2cvr-0.33.0.tar.gz	75.3 kB	Sep 29, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for phys2cvr 0.33.0
File	Interpreter	ABI	Platform	Reset
phys2cvr-0.33.0-py3-none-any.whl 59.6 kB Sep 29, 2026	Python 3	none	any	Details

Total release size: 134.9 kB

Release files / phys2cvr-0.33.0.tar.gz

Download URL	phys2cvr-0.33.0.tar.gz
Size	75.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`a4d08a8625bed42c71a52519694ef6996986daba5f65ab6cb799550a1c5484b6`
BLAKE2b-256 checksum How to use checksums	`e8caf62370aae546b11fb4432fb579eb412ff9e6f26f5390ce095afb057fd406`
Upload date	Sep 29, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`

Release files / phys2cvr-0.33.0-py3-none-any.whl

Download URL	phys2cvr-0.33.0-py3-none-any.whl
Size	59.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`2f5c834b74a210303e715e1a3a2e03d417040676bbf94479ec45f509b6ab21a4`
BLAKE2b-256 checksum How to use checksums	`8fdbb21451ef832da2f481eb0a57a085e824e98c139d956487213007116e2831`
Upload date	Sep 29, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.14`