pymuster


Namepymuster JSON
Version 0.1.4 PyPI version JSON
download
home_pagehttps://github.com/CRAI-OUS/MUSTER
SummaryA registration tool for medical images
upload_time2023-10-04 07:59:46
maintainer
docs_urlNone
authorEdvard Grødem
requires_python>=3.11,<3.13
licenseMIT
keywords registration medical mri ct pet spect non-rigid deformation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # MUSTER: Multi Session Temporal Registration
**MUSTER** is a robust tool designed for the registration and analysis of longitudinal 3D medical images. Built on PyTorch, MUSTER leverages GPU acceleration for fast and efficient processing. For instance, a timeseries of 8 images at a ``[160, 160, 160]`` resolution can typically be processed in just 2 minutes.

![Divergence and Jacobi Determinant](docs/figures/muster_div_detjac.png)

## Installation
Ensure that Python is installed on your machine. Then execute the following command to install **MUSTER**:

```bash
pip install pymuster
```
## Inctructions
**MUSTER** can be used in two ways, either as a command line tool or as a Python package

### Command Line Interface
TO BE IMPLEMENTED
After installing the package via pip, execute the following command to perform registration:
```bash
muster registration <in_dir> <out_dir>
```
Here ``<in_dir>`` refers to the directory path where your subject's data in BIDS format is stored. Each session should be in its own subfolder. Ensure that the session folders are named in a way that their alphabetical sorting aligns with the correct temporal order.

``<out_dir>`` is the directory where the output will be saved. Deformation data for each session relative to all other sessions will be stored in this directory.

### Python Package
For more flexibility and access to advanced settings, you can also use **MUSTER** as a Python package. Please refer to the in-code documentation for details on how to use it.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/CRAI-OUS/MUSTER",
    "name": "pymuster",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11,<3.13",
    "maintainer_email": "",
    "keywords": "registration,medical,MRI,CT,PET,SPECT,non-rigid,deformation",
    "author": "Edvard Gr\u00f8dem",
    "author_email": "edvard.grodem@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/c3/e8/f0528c205f1740fc45349c3906367b8efa1516d972ee207b86683dae83de/pymuster-0.1.4.tar.gz",
    "platform": null,
    "description": "# MUSTER: Multi Session Temporal Registration\n**MUSTER** is a robust tool designed for the registration and analysis of longitudinal 3D medical images. Built on PyTorch, MUSTER leverages GPU acceleration for fast and efficient processing. For instance, a timeseries of 8 images at a ``[160, 160, 160]`` resolution can typically be processed in just 2 minutes.\n\n![Divergence and Jacobi Determinant](docs/figures/muster_div_detjac.png)\n\n## Installation\nEnsure that Python is installed on your machine. Then execute the following command to install **MUSTER**:\n\n```bash\npip install pymuster\n```\n## Inctructions\n**MUSTER** can be used in two ways, either as a command line tool or as a Python package\n\n### Command Line Interface\nTO BE IMPLEMENTED\nAfter installing the package via pip, execute the following command to perform registration:\n```bash\nmuster registration <in_dir> <out_dir>\n```\nHere ``<in_dir>`` refers to the directory path where your subject's data in BIDS format is stored. Each session should be in its own subfolder. Ensure that the session folders are named in a way that their alphabetical sorting aligns with the correct temporal order.\n\n``<out_dir>`` is the directory where the output will be saved. Deformation data for each session relative to all other sessions will be stored in this directory.\n\n### Python Package\nFor more flexibility and access to advanced settings, you can also use **MUSTER** as a Python package. Please refer to the in-code documentation for details on how to use it.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A registration tool for medical images",
    "version": "0.1.4",
    "project_urls": {
        "Homepage": "https://github.com/CRAI-OUS/MUSTER",
        "Repository": "https://github.com/CRAI-OUS/MUSTER"
    },
    "split_keywords": [
        "registration",
        "medical",
        "mri",
        "ct",
        "pet",
        "spect",
        "non-rigid",
        "deformation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "90055da18c3abec482f0b5243962f5b2f426672f3b4525da907eb60f9e91f305",
                "md5": "196c355d10d1b82362abc75c4d9208d5",
                "sha256": "2e4d6b715d2c3a2c280c5b08df725556f5d693bf26bfab6dd8a9b17c8e0a2c09"
            },
            "downloads": -1,
            "filename": "pymuster-0.1.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "196c355d10d1b82362abc75c4d9208d5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11,<3.13",
            "size": 18286,
            "upload_time": "2023-10-04T07:59:45",
            "upload_time_iso_8601": "2023-10-04T07:59:45.322107Z",
            "url": "https://files.pythonhosted.org/packages/90/05/5da18c3abec482f0b5243962f5b2f426672f3b4525da907eb60f9e91f305/pymuster-0.1.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c3e8f0528c205f1740fc45349c3906367b8efa1516d972ee207b86683dae83de",
                "md5": "009bd703defb098f65881b1c53d4731e",
                "sha256": "24bb0dd68322daaadc02f9fbb928c061ee7bb3b6b37261360da549428efb4f88"
            },
            "downloads": -1,
            "filename": "pymuster-0.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "009bd703defb098f65881b1c53d4731e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11,<3.13",
            "size": 16934,
            "upload_time": "2023-10-04T07:59:46",
            "upload_time_iso_8601": "2023-10-04T07:59:46.808716Z",
            "url": "https://files.pythonhosted.org/packages/c3/e8/f0528c205f1740fc45349c3906367b8efa1516d972ee207b86683dae83de/pymuster-0.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-04 07:59:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "CRAI-OUS",
    "github_project": "MUSTER",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pymuster"
}
        
Elapsed time: 0.18340s