# aim2numpy
`aim2numpy` is a Python library designed to convert AIM files, specifically CT scan data from Scanco, into numpy arrays.
## Installation
You can install the library using pip:
```bash
pip install aim2numpy
```
## Usage
Here's a basic example of how to use the library:
```python
import aim2numpy
mynumpy = aim2numpy.extract("myaimfile.aim")
```
## AIM File Format
The AIM file format is used by Scanco Medical for storing CT scan data. These files contain volumetric data that can be used for various analyses in medical imaging and research.
## Features
- **Easy Conversion**: Convert AIM files to numpy arrays with a single function call.
- **Compatibility**: Works with CT scan data from Scanco.
- **Extensible**: Easily integrate with other Python libraries for further data processing and analysis.
## Example
```python
import aim2numpy
import matplotlib.pyplot as plt
# Extract the numpy array from the AIM file
ct_scan_data = aim2numpy.extract("myaimfile.aim")
# Display a slice of the CT scan data
plt.imshow(ct_scan_data[:, :, ct_scan_data.shape[2] // 2], cmap='gray')
plt.title('CT Scan Slice')
plt.show()
```
## Requirements
- numpy
- struct
- matplotlib
## Installation for Development
If you want to install the library for development purposes, you can clone the repository and install it locally:
```bash
git clone https://github.com/Alexhal9000/aim2numpy.git
cd aim2numpy
pip install -e .
```
## Running Tests
To run the tests, use the following command:
```bash
python -m unittest discover tests
```
## Contributing
Contributions are welcome! Please open an issue or submit a pull request on GitHub.
## License
This project is licensed under the MIT License. See the `LICENSE` file for details.
## Contact
For any questions or inquiries, please contact your.email@example.com.
Raw data
{
"_id": null,
"home_page": "https://github.com/Alexhal9000/aim2numpy",
"name": "aim2numpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Alejandro Gutierrez",
"author_email": "alejandro.gutierrez@ucalgary.ca",
"download_url": "https://files.pythonhosted.org/packages/a7/fe/7be6b11afeee6ab0f4d5afc6f68074753f17b1a5cb1643c7eb2864d6e497/aim2numpy-0.1.tar.gz",
"platform": null,
"description": "# aim2numpy\n\n`aim2numpy` is a Python library designed to convert AIM files, specifically CT scan data from Scanco, into numpy arrays.\n\n## Installation\n\nYou can install the library using pip:\n\n```bash\npip install aim2numpy\n```\n\n## Usage\n\nHere's a basic example of how to use the library:\n\n```python\nimport aim2numpy\n\nmynumpy = aim2numpy.extract(\"myaimfile.aim\")\n```\n\n## AIM File Format\n\nThe AIM file format is used by Scanco Medical for storing CT scan data. These files contain volumetric data that can be used for various analyses in medical imaging and research.\n\n## Features\n\n- **Easy Conversion**: Convert AIM files to numpy arrays with a single function call.\n- **Compatibility**: Works with CT scan data from Scanco.\n- **Extensible**: Easily integrate with other Python libraries for further data processing and analysis.\n\n## Example\n\n```python\nimport aim2numpy\nimport matplotlib.pyplot as plt\n\n# Extract the numpy array from the AIM file\nct_scan_data = aim2numpy.extract(\"myaimfile.aim\")\n\n# Display a slice of the CT scan data\nplt.imshow(ct_scan_data[:, :, ct_scan_data.shape[2] // 2], cmap='gray')\nplt.title('CT Scan Slice')\nplt.show()\n```\n\n## Requirements\n\n- numpy\n- struct\n- matplotlib\n\n## Installation for Development\n\nIf you want to install the library for development purposes, you can clone the repository and install it locally:\n\n```bash\ngit clone https://github.com/Alexhal9000/aim2numpy.git\ncd aim2numpy\npip install -e .\n```\n\n## Running Tests\n\nTo run the tests, use the following command:\n\n```bash\npython -m unittest discover tests\n```\n\n## Contributing\n\nContributions are welcome! Please open an issue or submit a pull request on GitHub.\n\n## License\n\nThis project is licensed under the MIT License. See the `LICENSE` file for details.\n\n## Contact\n\nFor any questions or inquiries, please contact your.email@example.com.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A library to convert AIM image files to numpy arrays",
"version": "0.1",
"project_urls": {
"Homepage": "https://github.com/Alexhal9000/aim2numpy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5f7c0c6ce1e929573f47f29028aef9ba658f6a836674a3d670ed1f8e5dc576ac",
"md5": "8fec89e506ec6b3f9166e72ab13f389a",
"sha256": "7b0782efa716470faa2936b5e9e4193851c2f2df468911824e2cb0660403469a"
},
"downloads": -1,
"filename": "aim2numpy-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8fec89e506ec6b3f9166e72ab13f389a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4705,
"upload_time": "2024-07-30T23:20:17",
"upload_time_iso_8601": "2024-07-30T23:20:17.854482Z",
"url": "https://files.pythonhosted.org/packages/5f/7c/0c6ce1e929573f47f29028aef9ba658f6a836674a3d670ed1f8e5dc576ac/aim2numpy-0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a7fe7be6b11afeee6ab0f4d5afc6f68074753f17b1a5cb1643c7eb2864d6e497",
"md5": "21582c0e6408a2f205777d876a8dd228",
"sha256": "dbf03d51160c2cd46b4325b3a892ee666db2f1891fb8ebb5b66439b3527a2399"
},
"downloads": -1,
"filename": "aim2numpy-0.1.tar.gz",
"has_sig": false,
"md5_digest": "21582c0e6408a2f205777d876a8dd228",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4501,
"upload_time": "2024-07-30T23:20:19",
"upload_time_iso_8601": "2024-07-30T23:20:19.005763Z",
"url": "https://files.pythonhosted.org/packages/a7/fe/7be6b11afeee6ab0f4d5afc6f68074753f17b1a5cb1643c7eb2864d6e497/aim2numpy-0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-30 23:20:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Alexhal9000",
"github_project": "aim2numpy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "aim2numpy"
}
JSON
