Skip to main content

Define your MRI sequences in pure python!

Project description

https://people.ee.ethz.ch/~mcgrathc/cmrseq/latest/_images/logo_cmrseq.svg

Define your MRI sequences in pure python!

The cmrseq frame-work is build to define MRI sequences consisting of radio-frequency pulses, gradient waveforms and sampling events. All definitions follow the concept hierarchically assemble experiments where the basic building blocks (Arbitrary Gradients, Trapezoidals, RF-pulses and ADC-events) are forming the core functionality and are all instances of SequenceBaseBlock-instances. On instantiation all base-blocks are validated against the System specifications. Composition of base-blocks is done in a Sequence object. The Sequence object implements convenient definitions for addition and composition of multiple Sequence objects as well as to perform a variety on common operations on semantically grouped base-blocks.

Several semantically connected groups of building blocks (e.g. a slice selective excitation) are allready functionally defined in the parametric_definitions module. For a complete list of available definitions checkout the API-reference.

The original motivation for cmrseq was to create a foundation to define sequences for simulation experiments. Therefore Sequences can be easily gridded onto a regular (or even unregular grids with a maximum step width) grids. Furthermore, commonly useful functionalities as plotting, evaluation of k-space-trajectories, calculation of moments, etc.

To close the gap to real-world measurements, cmrseq includes an IO module that allows loading Phillips (GVE) sequence definitions as well as reading and writing Pulseq (>= 1.4) files, which then can be used to export the sequence to multiple vendor platforms. For more information on this file format please refer to the official PulSeq web-page.

Installation

The registry contains the versioned package, which can be installed using:

pip install cmrseq

There are only few package dependencies, namely: - numpy - matplotlib to display the waveforms - pint to assign physical units and assert correctness of calculations - tqdm progressbar visualizations - scipy selected functionalities

Documentation & Getting Started

The API documentation for released versions can be found here.

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

cmrseq-0.27.1.tar.gz (169.3 kB view details)

Uploaded Source

Built Distribution

cmrseq-0.27.1-py3-none-any.whl (159.8 kB view details)

Uploaded Python 3

File details

Details for the file cmrseq-0.27.1.tar.gz.

File metadata

  • Download URL: cmrseq-0.27.1.tar.gz
  • Upload date:
  • Size: 169.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.14

File hashes

Hashes for cmrseq-0.27.1.tar.gz
Algorithm Hash digest
SHA256 83b21c4a74e8b484efc0f9c226c5e16470f5f580afd63d7c04e535efd1a5e8f8
MD5 426f095cf67966f783582fbe7c2cc550
BLAKE2b-256 1196f23dbf6df663cb90eab5bb69adbdf9e7d64ad7dea70a7796be7d125f6ce7

See more details on using hashes here.

File details

Details for the file cmrseq-0.27.1-py3-none-any.whl.

File metadata

  • Download URL: cmrseq-0.27.1-py3-none-any.whl
  • Upload date:
  • Size: 159.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.14

File hashes

Hashes for cmrseq-0.27.1-py3-none-any.whl
Algorithm Hash digest
SHA256 94c72197f12076f45204945101071a9342fe9c1099d054a0285aefb942754b57
MD5 9ea1383cd62c9f449244fcea19c276c3
BLAKE2b-256 a38be35ddad8a37e2a2b53ec76a6d0dc05c0c25df72c36fc7eb69f22f799912a

See more details on using hashes here.

Supported by

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