dcm-ball-detector


Namedcm-ball-detector JSON
Version 0.0.7 PyPI version JSON
download
home_pageNone
Summarygiven a .dcm format image sequence, identify the positions of all spherical markers from this image sequence.
upload_time2024-10-22 14:56:39
maintainerNone
docs_urlNone
authorNone
requires_python>=3.12
licenseMIT License Copyright (c) 2024 GGN_2015 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # dcm_ball_detector
given a `.dcm` format image sequence, identify the positions of all spherical markers from this image sequence.

## install

- it is recommended that this module should be installed in a python virtual environment (venv).

```bash
pip install dcm-ball-detector
```

## usage

- we assume that you have put your `.dcm` files into a folder of which the path is `<folder path>`.

- we assume that your `.dcm` files are named under **alphabetical order**.

- use the following command to get a prediction of the position of the marker balls.

```bash
python3 -m dcm_ball_detector <folder path>
```

- the program will output something like below to stdout:

```json
[{"zmm": 132.5840302807579, "xmm": 121.99777985982264, "ymm": 349.02488432862555}, {"zmm": 161.7956332082969, "xmm": 175.8402398543241, "ymm": 331.0029681581956}, {"zmm": 176.0079302709168, "xmm": 108.66976835102449, "ymm": 388.61439982471455}, {"zmm": 201.8262056427377, "xmm": 169.0084087325416, "ymm": 364.3212735729133}]
```

## debug

- if you want to show the debug info of the marker balls, use the following command:

```bash
python3 -m dcm_ball_detector --debug <folder path>
```

- after the program has been finished, in stderr there will be a line like:

```bash
   tips: relevant images in: .../dcm_ball_detector/log_image
```

- relevant images for debugging will be listed in folder `.../dcm_ball_detector/log_image`.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "dcm-ball-detector",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "GGN_2015 <premierbob@qq.com>",
    "download_url": "https://files.pythonhosted.org/packages/ae/e1/257410668be1fed1b9b7a6f8ff26a23773c70f8edd04054ae34c40a1cb6c/dcm_ball_detector-0.0.7.tar.gz",
    "platform": null,
    "description": "# dcm_ball_detector\ngiven a `.dcm` format image sequence, identify the positions of all spherical markers from this image sequence.\n\n## install\n\n- it is recommended that this module should be installed in a python virtual environment (venv).\n\n```bash\npip install dcm-ball-detector\n```\n\n## usage\n\n- we assume that you have put your `.dcm` files into a folder of which the path is `<folder path>`.\n\n- we assume that your `.dcm` files are named under **alphabetical order**.\n\n- use the following command to get a prediction of the position of the marker balls.\n\n```bash\npython3 -m dcm_ball_detector <folder path>\n```\n\n- the program will output something like below to stdout:\n\n```json\n[{\"zmm\": 132.5840302807579, \"xmm\": 121.99777985982264, \"ymm\": 349.02488432862555}, {\"zmm\": 161.7956332082969, \"xmm\": 175.8402398543241, \"ymm\": 331.0029681581956}, {\"zmm\": 176.0079302709168, \"xmm\": 108.66976835102449, \"ymm\": 388.61439982471455}, {\"zmm\": 201.8262056427377, \"xmm\": 169.0084087325416, \"ymm\": 364.3212735729133}]\n```\n\n## debug\n\n- if you want to show the debug info of the marker balls, use the following command:\n\n```bash\npython3 -m dcm_ball_detector --debug <folder path>\n```\n\n- after the program has been finished, in stderr there will be a line like:\n\n```bash\n   tips: relevant images in: .../dcm_ball_detector/log_image\n```\n\n- relevant images for debugging will be listed in folder `.../dcm_ball_detector/log_image`.\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 GGN_2015  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "given a .dcm format image sequence, identify the positions of all spherical markers from this image sequence.",
    "version": "0.0.7",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ed9f080d5bda551ff0e2c93db74b2e47d4d613839dc67f6308ac416927fb1eea",
                "md5": "69135a4129c8a0c8ccd496f9a973aba1",
                "sha256": "e6abf95c2db76e02987d8f4cbcd7abdd492137333e9bf753cf9e89728c2f4db9"
            },
            "downloads": -1,
            "filename": "dcm_ball_detector-0.0.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "69135a4129c8a0c8ccd496f9a973aba1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 9885236,
            "upload_time": "2024-10-22T14:56:33",
            "upload_time_iso_8601": "2024-10-22T14:56:33.844268Z",
            "url": "https://files.pythonhosted.org/packages/ed/9f/080d5bda551ff0e2c93db74b2e47d4d613839dc67f6308ac416927fb1eea/dcm_ball_detector-0.0.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "aee1257410668be1fed1b9b7a6f8ff26a23773c70f8edd04054ae34c40a1cb6c",
                "md5": "09d6c5e4ba962e3ec7a4cc9f2498f6b7",
                "sha256": "33add927e0d67c977f128c91c5396761addac4c9c6f66a41c3ca565a2c391d68"
            },
            "downloads": -1,
            "filename": "dcm_ball_detector-0.0.7.tar.gz",
            "has_sig": false,
            "md5_digest": "09d6c5e4ba962e3ec7a4cc9f2498f6b7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 4931371,
            "upload_time": "2024-10-22T14:56:39",
            "upload_time_iso_8601": "2024-10-22T14:56:39.953982Z",
            "url": "https://files.pythonhosted.org/packages/ae/e1/257410668be1fed1b9b7a6f8ff26a23773c70f8edd04054ae34c40a1cb6c/dcm_ball_detector-0.0.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-22 14:56:39",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "dcm-ball-detector"
}
        
Elapsed time: 0.75254s