Skip to main content

A software package for group-level rs-fMRI analysis.

Project description

multiseed

multiseed runs unsupervised group-level resting-state fMRI network extraction using a many-seed-based approach combined with dimensionality reduction.

In practice, it:

  1. loads multiple rs-fMRI datasets grouped into cohorts,
  2. builds one combined brain mask from all non-zero voxels,
  3. samples random seed locations inside that mask,
  4. turns each voxel into a vector of seed-correlation values,
  5. reduces those vectors with PCA or ICA, and
  6. writes one 3D map per extracted network/component for every dataset.

Because the mask, seed set, and reduction model are built jointly across all cohorts, the resulting feature maps are directly comparable across subjects/datasets.

Quick start

Generate a template config (which contains several explanatory comments):

python -m multiseed --write-default-config analysis.cfg

Edit analysis.cfg, then run the analysis:

python -m multiseed analysis.cfg

If you installed a console entry point, the same command is:

multiseed analysis.cfg

The CLI uses a fixed random seed, so repeated runs with the same inputs/config are reproducible.

Programmatic use

The multiseed library exposes an extensive API encompassing almost all parts of its algorithm. See the documentation for more details.

Simple config example

N_SEEDS = 1000
SEED_RADIUS = 10
REDUCTION_ALGORITHM = PCA
RESULTS_FOLDER = results

[Controls]
/data/controls/sub01
/data/controls/sub02

[Patients]
/data/patients/*

Each dataset is one folder containing the 3D volumes from a single scan. Supported image formats are:

  • .img, .img.gz, .img.z
  • .nii, .nii.gz

A cohort (e.g. Controls or Patients in this example) is a named list of dataset folders.

See the template config for more parameters and information.

What gets written

Resulting networks are written to the RESULTS_FOLDER, organized by cohort and dataset. The exact structure is:

results/
  mask.hdr.gz
  mask.img.gz
  seed_visualization.hdr.gz
  seed_visualization.img.gz
  network_001/
    average_visualization.hdr.gz
    average_visualization.img.gz
    <Cohort Name>/
      result_for_dataset_000001.hdr.gz
      result_for_dataset_000001.img.gz

Notes

  • All datasets are assumed to have matching spatial dimensions.
  • The combined mask is built from voxels that are nonzero in at least one dataset.
  • The exported average visualizations are display-oriented summaries; for downstream numeric work, use the saved float results.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

multiseed-1.0.0.tar.gz (35.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

multiseed-1.0.0-py3-none-any.whl (41.6 kB view details)

Uploaded Python 3

File details

Details for the file multiseed-1.0.0.tar.gz.

File metadata

  • Download URL: multiseed-1.0.0.tar.gz
  • Upload date:
  • Size: 35.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for multiseed-1.0.0.tar.gz
Algorithm Hash digest
SHA256 364a2aba96ef303a52bb7f5b8c8ac549eed5b0acbab41eec1ff4821a0a2eb40e
MD5 72cfbdffc2e042ae7aa28941681c76b1
BLAKE2b-256 2f4b3ada078531f0ebed7455f58464a77f0831d7e9a1d5d9a7a4d86e85296822

See more details on using hashes here.

File details

Details for the file multiseed-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: multiseed-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 41.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for multiseed-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dd5c3a1d5a1a5e14c26b6778d2c86fe62e3ae9d1914a3d8fb6bc1d3ab02d0b19
MD5 e3df406e3e966d0dcb01814353357157
BLAKE2b-256 95a3efa2f552361bcb702e38c4fddebc088831a080376298ca87c553dd3ab068

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page