pymuster


Namepymuster JSON
Version 0.1.10 PyPI version JSON
download
home_pagehttps://github.com/CRAI-OUS/MUSTER
SummaryA registration tool for longitudinal medical images
upload_time2024-09-11 13:28:43
maintainerNone
docs_urlNone
authorEdvard Grødem
requires_python<3.13,>=3.11
licenseMIT
keywords registration medical mri ct 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 tool designed for the registration 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
```
## Instructions
**MUSTER** can be used in two ways, either as a command line tool or as a Python package. See the full documentation on: https://crai-ous.github.io/MUSTER 

### 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": null,
    "docs_url": null,
    "requires_python": "<3.13,>=3.11",
    "maintainer_email": null,
    "keywords": "registration, medical, MRI, CT, non-rigid, deformation",
    "author": "Edvard Gr\u00f8dem",
    "author_email": "edvard.grodem@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/42/bc/820f1f5a812a5c32ba401e8f50659bcb2e870a1820972115ee1a7d64d25b/pymuster-0.1.10.tar.gz",
    "platform": null,
    "description": "# MUSTER: Multi Session Temporal Registration\n**MUSTER** is a tool designed for the registration 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## Instructions\n**MUSTER** can be used in two ways, either as a command line tool or as a Python package. See the full documentation on: https://crai-ous.github.io/MUSTER \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 longitudinal medical images",
    "version": "0.1.10",
    "project_urls": {
        "Homepage": "https://github.com/CRAI-OUS/MUSTER",
        "Repository": "https://github.com/CRAI-OUS/MUSTER"
    },
    "split_keywords": [
        "registration",
        " medical",
        " mri",
        " ct",
        " non-rigid",
        " deformation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ffd353028ef09ef630e1a554895e275c30e3967288dd50ebb4e7512b478c7707",
                "md5": "a4830a2eef31d958f6e2786c2de5c2e5",
                "sha256": "b119cd2202215a01adefbc5a2e69b592971dbe04b5273724c2e80fa594b48d9c"
            },
            "downloads": -1,
            "filename": "pymuster-0.1.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a4830a2eef31d958f6e2786c2de5c2e5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.13,>=3.11",
            "size": 38519,
            "upload_time": "2024-09-11T13:28:42",
            "upload_time_iso_8601": "2024-09-11T13:28:42.245574Z",
            "url": "https://files.pythonhosted.org/packages/ff/d3/53028ef09ef630e1a554895e275c30e3967288dd50ebb4e7512b478c7707/pymuster-0.1.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "42bc820f1f5a812a5c32ba401e8f50659bcb2e870a1820972115ee1a7d64d25b",
                "md5": "dedeb07401362e2b1d7cf4c9ac69a415",
                "sha256": "8b72764f6b128198822f349d3953b90cd036a0c5415e72a23ae6b98b8bdcdc82"
            },
            "downloads": -1,
            "filename": "pymuster-0.1.10.tar.gz",
            "has_sig": false,
            "md5_digest": "dedeb07401362e2b1d7cf4c9ac69a415",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.13,>=3.11",
            "size": 36290,
            "upload_time": "2024-09-11T13:28:43",
            "upload_time_iso_8601": "2024-09-11T13:28:43.263138Z",
            "url": "https://files.pythonhosted.org/packages/42/bc/820f1f5a812a5c32ba401e8f50659bcb2e870a1820972115ee1a7d64d25b/pymuster-0.1.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-11 13:28:43",
    "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.59561s