medvol 0.0.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
medvol-0.0.2/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "{}"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright {yyyy} {name of copyright owner}
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,5 @@
1
+ include LICENSE
2
+ include README.md
3
+
4
+ recursive-exclude * __pycache__
5
+ recursive-exclude * *.py[co]
medvol-0.0.2/PKG-INFO ADDED
@@ -0,0 +1,91 @@
1
+ Metadata-Version: 2.1
2
+ Name: medvol
3
+ Version: 0.0.2
4
+ Summary: A wrapper for loading medical 3D image volumes such as NIFTI or NRRD images.
5
+ Author: Karol Gotkowski
6
+ Author-email: karol.gotkowski@dkfz.de
7
+ License: Apache-2.0
8
+ Classifier: Development Status :: 2 - Pre-Alpha
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: License :: OSI Approved :: Apache Software License
11
+ Classifier: Operating System :: OS Independent
12
+ Classifier: Programming Language :: Python
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3 :: Only
15
+ Classifier: Programming Language :: Python :: 3.8
16
+ Classifier: Programming Language :: Python :: 3.9
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Topic :: Scientific/Engineering :: Image Processing
19
+ Requires-Python: >=3.8
20
+ Description-Content-Type: text/markdown
21
+ License-File: LICENSE
22
+ Requires-Dist: numpy
23
+ Provides-Extra: testing
24
+ Requires-Dist: tox; extra == "testing"
25
+ Requires-Dist: pytest; extra == "testing"
26
+ Requires-Dist: pytest-cov; extra == "testing"
27
+
28
+ # MedVol
29
+
30
+ [![License Apache Software License 2.0](https://img.shields.io/pypi/l/medvol.svg?color=green)](https://github.com/Karol-G/medvol/raw/main/LICENSE)
31
+ [![PyPI](https://img.shields.io/pypi/v/medvol.svg?color=green)](https://pypi.org/project/medvol)
32
+ [![Python Version](https://img.shields.io/pypi/pyversions/medvol.svg?color=green)](https://python.org)
33
+
34
+ A wrapper for loading medical 3D image volumes such as NIFTI or NRRD images.
35
+
36
+ ## Installation
37
+
38
+ You can install `medvol` via [pip](https://pypi.org/project/medvol/):
39
+
40
+ pip install medvol
41
+
42
+ ## Example
43
+
44
+ ```python
45
+ from medvol import MedVol
46
+
47
+ # Load NIFTI image
48
+ image = MedVol("path/to/image.nifti")
49
+
50
+ # Print some metadata
51
+ print("Spacing: ", image.spacing)
52
+ print("Affine: ", image.affine)
53
+ print("Header: ", image.header)
54
+
55
+ # Access and modify the image array
56
+ arr = image.array
57
+ arr[0, 0, 0] = 1
58
+
59
+ # Create a new image with the new array, a new spacing, but copy all remaining metadata
60
+ new_image = MedVol(arr, spacing=[2, 2, 2], copy=image)
61
+
62
+ # Save the new image as NRRD
63
+ new_image.save("path/to/new_image.nrrd")
64
+ ```
65
+
66
+
67
+ ## Contributing
68
+
69
+ Contributions are very welcome. Tests can be run with [tox], please ensure
70
+ the coverage at least stays the same before you submit a pull request.
71
+
72
+ ## License
73
+
74
+ Distributed under the terms of the [Apache Software License 2.0] license,
75
+ "medvol" is free and open source software
76
+
77
+ ## Issues
78
+
79
+ If you encounter any problems, please file an issue along with a detailed description.
80
+
81
+ [Cookiecutter]: https://github.com/audreyr/cookiecutter
82
+ [MIT]: http://opensource.org/licenses/MIT
83
+ [BSD-3]: http://opensource.org/licenses/BSD-3-Clause
84
+ [GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt
85
+ [GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt
86
+ [Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0
87
+ [Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt
88
+
89
+ [tox]: https://tox.readthedocs.io/en/latest/
90
+ [pip]: https://pypi.org/project/pip/
91
+ [PyPI]: https://pypi.org/
medvol-0.0.2/README.md ADDED
@@ -0,0 +1,64 @@
1
+ # MedVol
2
+
3
+ [![License Apache Software License 2.0](https://img.shields.io/pypi/l/medvol.svg?color=green)](https://github.com/Karol-G/medvol/raw/main/LICENSE)
4
+ [![PyPI](https://img.shields.io/pypi/v/medvol.svg?color=green)](https://pypi.org/project/medvol)
5
+ [![Python Version](https://img.shields.io/pypi/pyversions/medvol.svg?color=green)](https://python.org)
6
+
7
+ A wrapper for loading medical 3D image volumes such as NIFTI or NRRD images.
8
+
9
+ ## Installation
10
+
11
+ You can install `medvol` via [pip](https://pypi.org/project/medvol/):
12
+
13
+ pip install medvol
14
+
15
+ ## Example
16
+
17
+ ```python
18
+ from medvol import MedVol
19
+
20
+ # Load NIFTI image
21
+ image = MedVol("path/to/image.nifti")
22
+
23
+ # Print some metadata
24
+ print("Spacing: ", image.spacing)
25
+ print("Affine: ", image.affine)
26
+ print("Header: ", image.header)
27
+
28
+ # Access and modify the image array
29
+ arr = image.array
30
+ arr[0, 0, 0] = 1
31
+
32
+ # Create a new image with the new array, a new spacing, but copy all remaining metadata
33
+ new_image = MedVol(arr, spacing=[2, 2, 2], copy=image)
34
+
35
+ # Save the new image as NRRD
36
+ new_image.save("path/to/new_image.nrrd")
37
+ ```
38
+
39
+
40
+ ## Contributing
41
+
42
+ Contributions are very welcome. Tests can be run with [tox], please ensure
43
+ the coverage at least stays the same before you submit a pull request.
44
+
45
+ ## License
46
+
47
+ Distributed under the terms of the [Apache Software License 2.0] license,
48
+ "medvol" is free and open source software
49
+
50
+ ## Issues
51
+
52
+ If you encounter any problems, please file an issue along with a detailed description.
53
+
54
+ [Cookiecutter]: https://github.com/audreyr/cookiecutter
55
+ [MIT]: http://opensource.org/licenses/MIT
56
+ [BSD-3]: http://opensource.org/licenses/BSD-3-Clause
57
+ [GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt
58
+ [GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt
59
+ [Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0
60
+ [Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt
61
+
62
+ [tox]: https://tox.readthedocs.io/en/latest/
63
+ [pip]: https://pypi.org/project/pip/
64
+ [PyPI]: https://pypi.org/
@@ -0,0 +1,3 @@
1
+ __version__ = "0.0.2"
2
+
3
+ from medvol.medvol import MedVol
@@ -0,0 +1,82 @@
1
+ import SimpleITK as sitk
2
+ from dataclasses import dataclass, field
3
+ from typing import Dict, Optional, Union
4
+ import numpy as np
5
+
6
+
7
+ @dataclass
8
+ class MedVol:
9
+ array: Union[np.ndarray, str]
10
+ spacing: Optional[np.ndarray] = None
11
+ origin: Optional[np.ndarray] = None
12
+ direction: Optional[np.ndarray] = None
13
+ header: Optional[Dict] = None
14
+ copy: Optional['MedVol'] = field(default=None, repr=False)
15
+
16
+ def __post_init__(self):
17
+ # Validate array: Must be a 3D array
18
+ if not ((isinstance(self.array, np.ndarray) and self.array.ndim == 3) or isinstance(self.array, str)):
19
+ raise ValueError("array must be a 3D numpy array or a filepath string")
20
+
21
+ if isinstance(self.array, str):
22
+ self._load(self.array)
23
+
24
+ # Validate spacing: Must be None or a 1D array with three floats
25
+ if self.spacing is not None:
26
+ if not (isinstance(self.spacing, np.ndarray) and self.spacing.shape == (3,) and np.issubdtype(self.spacing.dtype, np.floating)):
27
+ raise ValueError("spacing must be None or a 1D numpy array with three floats")
28
+
29
+ # Validate origin: Must be None or a 1D array with three floats
30
+ if self.origin is not None:
31
+ if not (isinstance(self.origin, np.ndarray) and self.origin.shape == (3,) and np.issubdtype(self.origin.dtype, np.floating)):
32
+ raise ValueError("origin must be None or a 1D numpy array with three floats")
33
+
34
+ # Validate direction: Must be None or a 3x3 array of floats
35
+ if self.direction is not None:
36
+ if not (isinstance(self.direction, np.ndarray) and self.direction.shape == (3, 3) and np.issubdtype(self.direction.dtype, np.floating)):
37
+ raise ValueError("direction must be None or a 3x3 numpy array of floats")
38
+
39
+ # Validate header: Must be None or a dictionary
40
+ if self.header is not None and not isinstance(self.header, dict):
41
+ raise ValueError("header must be None or a dictionary")
42
+
43
+ # If copy is set, copy fields from the other Nifti instance
44
+ if self.copy is not None:
45
+ self._copy_fields_from(self.copy)
46
+
47
+ @property
48
+ def affine(self) -> np.ndarray:
49
+ if self.spacing is None or self.origin is None or self.direction is None:
50
+ raise ValueError("spacing, origin, and direction must all be set to compute the affine.")
51
+
52
+ affine = np.eye(4)
53
+ affine[:3, :3] = self.direction @ np.diag(self.spacing)
54
+ affine[:3, 3] = self.origin
55
+ return affine
56
+
57
+ def _copy_fields_from(self, other: 'MedVol'):
58
+ if self.spacing is None:
59
+ self.spacing = other.spacing
60
+ if self.origin is None:
61
+ self.origin = other.origin
62
+ if self.direction is None:
63
+ self.direction = other.direction
64
+ if self.header is None:
65
+ self.header = other.header
66
+
67
+ def _load(self, filepath):
68
+ image_sitk = sitk.ReadImage(filepath)
69
+ self.array = sitk.GetArrayFromImage(image_sitk)
70
+ self.spacing = np.array(image_sitk.GetSpacing()[::-1])
71
+ self.origin = np.array(image_sitk.GetOrigin()[::-1])
72
+ self.direction = np.array(image_sitk.GetDirection()[::-1]).reshape(3, 3)
73
+ self.header = {key: image_sitk.GetMetaData(key) for key in image_sitk.GetMetaDataKeys()}
74
+
75
+ def save(self, filepath):
76
+ image_sitk = sitk.GetImageFromArray(self.array)
77
+ image_sitk.SetSpacing(self.spacing.tolist()[::-1])
78
+ image_sitk.SetOrigin(self.origin.tolist()[::-1])
79
+ image_sitk.SetDirection(self.direction.flatten().tolist()[::-1])
80
+ for key, value in self.header.items():
81
+ image_sitk.SetMetaData(key, value)
82
+ sitk.WriteImage(image_sitk, filepath)
@@ -0,0 +1,91 @@
1
+ Metadata-Version: 2.1
2
+ Name: medvol
3
+ Version: 0.0.2
4
+ Summary: A wrapper for loading medical 3D image volumes such as NIFTI or NRRD images.
5
+ Author: Karol Gotkowski
6
+ Author-email: karol.gotkowski@dkfz.de
7
+ License: Apache-2.0
8
+ Classifier: Development Status :: 2 - Pre-Alpha
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: License :: OSI Approved :: Apache Software License
11
+ Classifier: Operating System :: OS Independent
12
+ Classifier: Programming Language :: Python
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3 :: Only
15
+ Classifier: Programming Language :: Python :: 3.8
16
+ Classifier: Programming Language :: Python :: 3.9
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Topic :: Scientific/Engineering :: Image Processing
19
+ Requires-Python: >=3.8
20
+ Description-Content-Type: text/markdown
21
+ License-File: LICENSE
22
+ Requires-Dist: numpy
23
+ Provides-Extra: testing
24
+ Requires-Dist: tox; extra == "testing"
25
+ Requires-Dist: pytest; extra == "testing"
26
+ Requires-Dist: pytest-cov; extra == "testing"
27
+
28
+ # MedVol
29
+
30
+ [![License Apache Software License 2.0](https://img.shields.io/pypi/l/medvol.svg?color=green)](https://github.com/Karol-G/medvol/raw/main/LICENSE)
31
+ [![PyPI](https://img.shields.io/pypi/v/medvol.svg?color=green)](https://pypi.org/project/medvol)
32
+ [![Python Version](https://img.shields.io/pypi/pyversions/medvol.svg?color=green)](https://python.org)
33
+
34
+ A wrapper for loading medical 3D image volumes such as NIFTI or NRRD images.
35
+
36
+ ## Installation
37
+
38
+ You can install `medvol` via [pip](https://pypi.org/project/medvol/):
39
+
40
+ pip install medvol
41
+
42
+ ## Example
43
+
44
+ ```python
45
+ from medvol import MedVol
46
+
47
+ # Load NIFTI image
48
+ image = MedVol("path/to/image.nifti")
49
+
50
+ # Print some metadata
51
+ print("Spacing: ", image.spacing)
52
+ print("Affine: ", image.affine)
53
+ print("Header: ", image.header)
54
+
55
+ # Access and modify the image array
56
+ arr = image.array
57
+ arr[0, 0, 0] = 1
58
+
59
+ # Create a new image with the new array, a new spacing, but copy all remaining metadata
60
+ new_image = MedVol(arr, spacing=[2, 2, 2], copy=image)
61
+
62
+ # Save the new image as NRRD
63
+ new_image.save("path/to/new_image.nrrd")
64
+ ```
65
+
66
+
67
+ ## Contributing
68
+
69
+ Contributions are very welcome. Tests can be run with [tox], please ensure
70
+ the coverage at least stays the same before you submit a pull request.
71
+
72
+ ## License
73
+
74
+ Distributed under the terms of the [Apache Software License 2.0] license,
75
+ "medvol" is free and open source software
76
+
77
+ ## Issues
78
+
79
+ If you encounter any problems, please file an issue along with a detailed description.
80
+
81
+ [Cookiecutter]: https://github.com/audreyr/cookiecutter
82
+ [MIT]: http://opensource.org/licenses/MIT
83
+ [BSD-3]: http://opensource.org/licenses/BSD-3-Clause
84
+ [GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt
85
+ [GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt
86
+ [Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0
87
+ [Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt
88
+
89
+ [tox]: https://tox.readthedocs.io/en/latest/
90
+ [pip]: https://pypi.org/project/pip/
91
+ [PyPI]: https://pypi.org/
@@ -0,0 +1,12 @@
1
+ LICENSE
2
+ MANIFEST.in
3
+ README.md
4
+ pyproject.toml
5
+ setup.cfg
6
+ medvol/__init__.py
7
+ medvol/medvol.py
8
+ medvol.egg-info/PKG-INFO
9
+ medvol.egg-info/SOURCES.txt
10
+ medvol.egg-info/dependency_links.txt
11
+ medvol.egg-info/requires.txt
12
+ medvol.egg-info/top_level.txt
@@ -0,0 +1,6 @@
1
+ numpy
2
+
3
+ [testing]
4
+ tox
5
+ pytest
6
+ pytest-cov
@@ -0,0 +1 @@
1
+ medvol
@@ -0,0 +1,56 @@
1
+ [build-system]
2
+ requires = ["setuptools>=42.0.0", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+
6
+
7
+ [tool.black]
8
+ line-length = 79
9
+ target-version = ['py38', 'py39', 'py310']
10
+
11
+
12
+ [tool.ruff]
13
+ line-length = 79
14
+ select = [
15
+ "E", "F", "W", #flake8
16
+ "UP", # pyupgrade
17
+ "I", # isort
18
+ "BLE", # flake8-blind-exception
19
+ "B", # flake8-bugbear
20
+ "A", # flake8-builtins
21
+ "C4", # flake8-comprehensions
22
+ "ISC", # flake8-implicit-str-concat
23
+ "G", # flake8-logging-format
24
+ "PIE", # flake8-pie
25
+ "SIM", # flake8-simplify
26
+ ]
27
+ ignore = [
28
+ "E501", # line too long. let black handle this
29
+ "UP006", "UP007", # type annotation. As using magicgui require runtime type annotation then we disable this.
30
+ "SIM117", # flake8-simplify - some of merged with statements are not looking great with black, reanble after drop python 3.9
31
+ ]
32
+
33
+ exclude = [
34
+ ".bzr",
35
+ ".direnv",
36
+ ".eggs",
37
+ ".git",
38
+ ".mypy_cache",
39
+ ".pants.d",
40
+ ".ruff_cache",
41
+ ".svn",
42
+ ".tox",
43
+ ".venv",
44
+ "__pypackages__",
45
+ "_build",
46
+ "buck-out",
47
+ "build",
48
+ "dist",
49
+ "node_modules",
50
+ "venv",
51
+ "*vendored*",
52
+ "*_vendor*",
53
+ ]
54
+
55
+ target-version = "py38"
56
+ fix = true
medvol-0.0.2/setup.cfg ADDED
@@ -0,0 +1,43 @@
1
+ [metadata]
2
+ name = medvol
3
+ version = attr: medvol.__version__
4
+ description = A wrapper for loading medical 3D image volumes such as NIFTI or NRRD images.
5
+ long_description = file: README.md
6
+ long_description_content_type = text/markdown
7
+ author = Karol Gotkowski
8
+ author_email = karol.gotkowski@dkfz.de
9
+ license = Apache-2.0
10
+ license_files = LICENSE
11
+ classifiers =
12
+ Development Status :: 2 - Pre-Alpha
13
+ Intended Audience :: Developers
14
+ License :: OSI Approved :: Apache Software License
15
+ Operating System :: OS Independent
16
+ Programming Language :: Python
17
+ Programming Language :: Python :: 3
18
+ Programming Language :: Python :: 3 :: Only
19
+ Programming Language :: Python :: 3.8
20
+ Programming Language :: Python :: 3.9
21
+ Programming Language :: Python :: 3.10
22
+ Topic :: Scientific/Engineering :: Image Processing
23
+
24
+ [options]
25
+ packages = find:
26
+ install_requires =
27
+ numpy
28
+ python_requires = >=3.8
29
+ include_package_data = True
30
+
31
+ [options.extras_require]
32
+ testing =
33
+ tox
34
+ pytest # https://docs.pytest.org/en/latest/contents.html
35
+ pytest-cov # https://pytest-cov.readthedocs.io/en/latest/
36
+
37
+ [options.package_data]
38
+ * = *.yaml
39
+
40
+ [egg_info]
41
+ tag_build =
42
+ tag_date = 0
43
+