oct-to-tiff 0.4.0__tar.gz → 0.5.0__tar.gz

{oct_to_tiff-0.4.0/src/oct_to_tiff.egg-info → oct_to_tiff-0.5.0}/PKG-INFO

@@ -1,28 +1,71 @@
 Metadata-Version: 2.1
 Name: oct-to-tiff
-Version: 0.4.0
+Version: 0.5.0
 Summary: A command line tool for converting optical coherence tomography angiography (OCTA) data.
-Home-page: https://github.com/camlloyd/oct-to-tiff
-Author: Cameron Lloyd
-Author-email: lloyd@med.unideb.hu
+Author-email: Cameron Lloyd <lloyd@med.unideb.hu>
+Maintainer-email: Cameron Lloyd <lloyd@med.unideb.hu>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2021, Cameron Lloyd
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Homepage, https://github.com/camlloyd/oct-to-tiff
 Project-URL: Bug Tracker, https://github.com/camlloyd/oct-to-tiff/issues
+Project-URL: Changelog, https://github.com/camlloyd/oct-to-tiff/blob/main/CHANGELOG.md
+Keywords: angiography,cli,oct,octa
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.8
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+Requires-Dist: defusedxml
+Requires-Dist: numpy
+Requires-Dist: tifffile
+Provides-Extra: dev
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: types-defusedxml; extra == "dev"
 
 # oct-to-tiff
 
 [![DOI](https://zenodo.org/badge/382486199.svg)](https://zenodo.org/badge/latestdoi/382486199)
+[![PyPI - Version](https://img.shields.io/pypi/v/oct-to-tiff)](https://pypi.org/project/oct-to-tiff)
+[![PyPI - License](https://img.shields.io/pypi/l/oct-to-tiff)](https://github.com/camlloyd/oct-to-tiff/blob/main/LICENSE.txt)
+[![PyPI Downloads](https://static.pepy.tech/badge/oct-to-tiff)](https://pepy.tech/projects/oct-to-tiff)
+
 
 A command line tool for converting optical coherence tomography angiography (OCTA) data.
 
@@ -31,9 +74,9 @@ via pip:
 
     pip install oct-to-tiff
 
-via conda:
+via mamba:
 
-    conda install -c conda-forge oct-to-tiff
+    mamba install -c conda-forge oct-to-tiff
 
 ## Getting started
     oct-to-tiff /path/to/image.OCT
@@ -49,6 +92,12 @@ By default, the output file will be written with the same name as the input file
 
 To specify a custom output directory, see [Optional arguments](#optional-arguments) below.
 
+## Batch processing
+``` bash
+for file in *.OCT; do oct-to-tiff "${file}"; done
+```
+will convert all OCT volumes in the current directory to OME-TIFF files, including voxel size in the metadata.
+
 ## Supported scan patterns
 
 This tool has been developed by reverse engineering data from the Optovue RTVue XR Avanti System.
@@ -111,6 +160,13 @@ Sets the correct voxel size for scan patterns with adjustable length.
 
     oct-to-tiff /path/to/image.OCT --size 4.5
 
+#### `--log-level LEVEL`
+**Description**: sets the logging level (default: `WARNING`)
+
+**Usage**:
+
+    oct-to-tiff /path/to/image.OCT --log-level INFO
+
 #### `--version`
 **Description**: show program's version number and exit.
 
@@ -154,8 +210,8 @@ Requires `--size SIZE`.
 
 ## Contributing
 
-This project uses [black](https://github.com/psf/black) for formatting and [isort](https://github.com/PyCQA/isort) for sorting imports.
+This project uses [Ruff](https://github.com/astral-sh/ruff) for linting and formatting.
 
 ## Requirements
 
-Requires Python 3.8 or higher.
+Requires Python 3.10 or higher.

{oct_to_tiff-0.4.0 → oct_to_tiff-0.5.0}/README.md

@@ -1,6 +1,10 @@
 # oct-to-tiff
 
 [![DOI](https://zenodo.org/badge/382486199.svg)](https://zenodo.org/badge/latestdoi/382486199)
+[![PyPI - Version](https://img.shields.io/pypi/v/oct-to-tiff)](https://pypi.org/project/oct-to-tiff)
+[![PyPI - License](https://img.shields.io/pypi/l/oct-to-tiff)](https://github.com/camlloyd/oct-to-tiff/blob/main/LICENSE.txt)
+[![PyPI Downloads](https://static.pepy.tech/badge/oct-to-tiff)](https://pepy.tech/projects/oct-to-tiff)
+
 
 A command line tool for converting optical coherence tomography angiography (OCTA) data.
 
@@ -9,9 +13,9 @@ via pip:
 
     pip install oct-to-tiff
 
-via conda:
+via mamba:
 
-    conda install -c conda-forge oct-to-tiff
+    mamba install -c conda-forge oct-to-tiff
 
 ## Getting started
     oct-to-tiff /path/to/image.OCT
@@ -27,6 +31,12 @@ By default, the output file will be written with the same name as the input file
 
 To specify a custom output directory, see [Optional arguments](#optional-arguments) below.
 
+## Batch processing
+``` bash
+for file in *.OCT; do oct-to-tiff "${file}"; done
+```
+will convert all OCT volumes in the current directory to OME-TIFF files, including voxel size in the metadata.
+
 ## Supported scan patterns
 
 This tool has been developed by reverse engineering data from the Optovue RTVue XR Avanti System.
@@ -89,6 +99,13 @@ Sets the correct voxel size for scan patterns with adjustable length.
 
     oct-to-tiff /path/to/image.OCT --size 4.5
 
+#### `--log-level LEVEL`
+**Description**: sets the logging level (default: `WARNING`)
+
+**Usage**:
+
+    oct-to-tiff /path/to/image.OCT --log-level INFO
+
 #### `--version`
 **Description**: show program's version number and exit.
 
@@ -132,8 +149,8 @@ Requires `--size SIZE`.
 
 ## Contributing
 
-This project uses [black](https://github.com/psf/black) for formatting and [isort](https://github.com/PyCQA/isort) for sorting imports.
+This project uses [Ruff](https://github.com/astral-sh/ruff) for linting and formatting.
 
 ## Requirements
 
-Requires Python 3.8 or higher.
+Requires Python 3.10 or higher.

oct_to_tiff-0.5.0/pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "oct-to-tiff"
+version = "0.5.0"
+dependencies = [
+    "defusedxml",
+    "numpy",
+    "tifffile",
+]
+requires-python = ">=3.10"
+authors = [{name = "Cameron Lloyd", email = "lloyd@med.unideb.hu"}]
+maintainers = [{name = "Cameron Lloyd", email = "lloyd@med.unideb.hu"}]
+description = "A command line tool for converting optical coherence tomography angiography (OCTA) data."
+readme = "README.md"
+license = {file = "LICENSE.txt"}
+keywords = ["angiography", "cli", "oct", "octa"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: BSD License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+
+[project.optional-dependencies]
+dev = [
+    "mypy",
+    "ruff",
+    "types-defusedxml"
+]
+
+[project.urls]
+Homepage = "https://github.com/camlloyd/oct-to-tiff"
+"Bug Tracker" = "https://github.com/camlloyd/oct-to-tiff/issues"
+Changelog = "https://github.com/camlloyd/oct-to-tiff/blob/main/CHANGELOG.md"
+
+[project.scripts]
+oct-to-tiff = "oct_to_tiff.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.ruff.lint]
+select = [
+    "I", # isort
+    "S", # flake8-bandit
+]

oct_to_tiff-0.5.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

{oct_to_tiff-0.4.0 → oct_to_tiff-0.5.0}/src/oct_to_tiff/cli.py

@@ -1,25 +1,29 @@
 import argparse
 import logging
-import xml.etree.ElementTree as ET
+from importlib.metadata import version
 from pathlib import Path
+from typing import Any
 
+import defusedxml.ElementTree as DET
 import numpy as np
 import tifffile
+from numpy.typing import NDArray
 
-logging.basicConfig(
-    format="%(asctime)s %(name)s:%(funcName)s %(levelname)s - %(message)s"
-)
 logger = logging.getLogger(__name__)
 
 
 def reshape_volume(
-    volume, frames_per_data_group, total_data_groups, oct_window_height, xy_scan_length
-):
+    volume: NDArray[Any],
+    frames_per_data_group: int,
+    total_data_groups: int,
+    oct_window_height: int,
+    xy_scan_length: int,
+) -> NDArray[Any]:
     """Reshape a 1-dimensional array to a 3-dimensional array.
 
     Parameters
     ----------
-    volume : ndarray
+    volume : NDArray[Any]
         A 1-dimensional array.
     frames_per_data_group : int
         The number of frames per data group.
@@ -32,7 +36,7 @@ def reshape_volume(
 
     Returns
     -------
-    volume : ndarray
+    volume : NDArray[Any]
         A 3-dimensional array.
 
     """
@@ -47,17 +51,19 @@ def reshape_volume(
     return volume
 
 
-def rotate_volume(volume):
+def rotate_volume(
+    volume: NDArray[Any],
+) -> NDArray[Any]:
     """Rotate a 3-dimensional array 90 degrees left (anti-clockwise) about the z-axis.
 
     Parameters
     ----------
-    volume : ndarray
+    volume : NDArray[Any]
         A 3-dimensional array.
 
     Returns
     -------
-    volume : ndarray
+    volume : NDArray[Any]
         A rotated version of the input volume.
 
     """
@@ -65,14 +71,20 @@ def rotate_volume(volume):
     return volume
 
 
-def write_volume(output_path, volume, pixel_size_x, pixel_size_y, pixel_size_z):
+def write_volume(
+    output_path: Path,
+    volume: NDArray[Any],
+    pixel_size_x: float,
+    pixel_size_y: float,
+    pixel_size_z: float,
+) -> None:
     """Write a 3-dimensional array to the output path as an OME-TIFF file, including voxel size in the metadata.
 
     Parameters
     ----------
     output_path : Path
         The specified output path.
-    volume : ndarray
+    volume : NDArray[Any]
         A 3-dimensional array.
     pixel_size_x : float
         The pixel (voxel) width in mm.
@@ -98,21 +110,23 @@ def write_volume(output_path, volume, pixel_size_x, pixel_size_y, pixel_size_z):
     )
 
 
-def extract_boundaries(input_path):
+def extract_boundaries(input_path: str | Path) -> None:
     """Extract segmentation lines.
 
     Parameters
     ----------
-    input_path : Path
+    input_path : str | Path
         The specified input path.
 
     """
-    tree = ET.parse(input_path)
+    input_path = Path(input_path)
+    tree = DET.parse(input_path)
     root = tree.getroot()
 
-    array_size = int(root.findtext("./Curve_Set/Image/Curve/ARRAY"))
+    array_size = int(root.findtext("./Curve_Set/Image/Curve/ARRAY", 0))
     data_points = [
-        int(point.text) for point in root.findall("./Curve_Set/Image/Curve/D")
+        int(point.text) if point.text else 0
+        for point in root.findall("./Curve_Set/Image/Curve/D")
     ]
     scan_length = np.arange(len(data_points))
     num_files = len(data_points) // array_size
@@ -124,7 +138,7 @@ def extract_boundaries(input_path):
         np.savetxt(table_path, table, delimiter="\t", fmt="%d")
 
 
-def main():
+def main() -> None:
     parser = argparse.ArgumentParser(
         description="Convert optical coherence tomography angiography (OCTA) data."
     )
@@ -162,9 +176,25 @@ def main():
         action="store_true",
         help="extract segmentation lines",
     )
-    parser.add_argument("--version", action="version", version="%(prog)s 0.4.0")
+    parser.add_argument(
+        "--log-level",
+        default="WARNING",
+        metavar="LEVEL",
+        help="sets the logging level (default: %(default)s)",
+    )
+    parser.add_argument(
+        "--version", action="version", version="%(prog)s " + version("oct_to_tiff")
+    )
     args = parser.parse_args()
 
+    numeric_level = getattr(logging, args.log_level.upper(), None)
+    if not isinstance(numeric_level, int):
+        raise ValueError(f"Invalid log level: {args.log_level}")
+    logging.basicConfig(
+        level=numeric_level,
+        format="%(asctime)s %(name)s:%(funcName)s %(levelname)s - %(message)s",
+    )
+
     input_path = args.input
     if args.output:
         dir_name = args.output

{oct_to_tiff-0.4.0 → oct_to_tiff-0.5.0/src/oct_to_tiff.egg-info}/PKG-INFO

@@ -1,28 +1,71 @@
 Metadata-Version: 2.1
-Name: oct_to_tiff
-Version: 0.4.0
+Name: oct-to-tiff
+Version: 0.5.0
 Summary: A command line tool for converting optical coherence tomography angiography (OCTA) data.
-Home-page: https://github.com/camlloyd/oct-to-tiff
-Author: Cameron Lloyd
-Author-email: lloyd@med.unideb.hu
+Author-email: Cameron Lloyd <lloyd@med.unideb.hu>
+Maintainer-email: Cameron Lloyd <lloyd@med.unideb.hu>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2021, Cameron Lloyd
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Homepage, https://github.com/camlloyd/oct-to-tiff
 Project-URL: Bug Tracker, https://github.com/camlloyd/oct-to-tiff/issues
+Project-URL: Changelog, https://github.com/camlloyd/oct-to-tiff/blob/main/CHANGELOG.md
+Keywords: angiography,cli,oct,octa
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.8
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+Requires-Dist: defusedxml
+Requires-Dist: numpy
+Requires-Dist: tifffile
+Provides-Extra: dev
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: types-defusedxml; extra == "dev"
 
 # oct-to-tiff
 
 [![DOI](https://zenodo.org/badge/382486199.svg)](https://zenodo.org/badge/latestdoi/382486199)
+[![PyPI - Version](https://img.shields.io/pypi/v/oct-to-tiff)](https://pypi.org/project/oct-to-tiff)
+[![PyPI - License](https://img.shields.io/pypi/l/oct-to-tiff)](https://github.com/camlloyd/oct-to-tiff/blob/main/LICENSE.txt)
+[![PyPI Downloads](https://static.pepy.tech/badge/oct-to-tiff)](https://pepy.tech/projects/oct-to-tiff)
+
 
 A command line tool for converting optical coherence tomography angiography (OCTA) data.
 
@@ -31,9 +74,9 @@ via pip:
 
     pip install oct-to-tiff
 
-via conda:
+via mamba:
 
-    conda install -c conda-forge oct-to-tiff
+    mamba install -c conda-forge oct-to-tiff
 
 ## Getting started
     oct-to-tiff /path/to/image.OCT
@@ -49,6 +92,12 @@ By default, the output file will be written with the same name as the input file
 
 To specify a custom output directory, see [Optional arguments](#optional-arguments) below.
 
+## Batch processing
+``` bash
+for file in *.OCT; do oct-to-tiff "${file}"; done
+```
+will convert all OCT volumes in the current directory to OME-TIFF files, including voxel size in the metadata.
+
 ## Supported scan patterns
 
 This tool has been developed by reverse engineering data from the Optovue RTVue XR Avanti System.
@@ -111,6 +160,13 @@ Sets the correct voxel size for scan patterns with adjustable length.
 
     oct-to-tiff /path/to/image.OCT --size 4.5
 
+#### `--log-level LEVEL`
+**Description**: sets the logging level (default: `WARNING`)
+
+**Usage**:
+
+    oct-to-tiff /path/to/image.OCT --log-level INFO
+
 #### `--version`
 **Description**: show program's version number and exit.
 
@@ -154,8 +210,8 @@ Requires `--size SIZE`.
 
 ## Contributing
 
-This project uses [black](https://github.com/psf/black) for formatting and [isort](https://github.com/PyCQA/isort) for sorting imports.
+This project uses [Ruff](https://github.com/astral-sh/ruff) for linting and formatting.
 
 ## Requirements
 
-Requires Python 3.8 or higher.
+Requires Python 3.10 or higher.

{oct_to_tiff-0.4.0 → oct_to_tiff-0.5.0}/src/oct_to_tiff.egg-info/SOURCES.txt

@@ -1,8 +1,6 @@
 LICENSE.txt
 README.md
 pyproject.toml
-setup.cfg
-setup.py
 src/oct_to_tiff/__init__.py
 src/oct_to_tiff/cli.py
 src/oct_to_tiff.egg-info/PKG-INFO

oct_to_tiff-0.5.0/src/oct_to_tiff.egg-info/requires.txt

@@ -0,0 +1,8 @@
+defusedxml
+numpy
+tifffile
+
+[dev]
+mypy
+ruff
+types-defusedxml

oct_to_tiff-0.4.0/pyproject.toml

@@ -1,3 +0,0 @@
-[build-system]
-requires = ["setuptools>=61.0"]
-build-backend = "setuptools.build_meta"

oct_to_tiff-0.4.0/setup.cfg

@@ -1,43 +0,0 @@
-[metadata]
-name = oct_to_tiff
-version = 0.4.0
-author = Cameron Lloyd
-author_email = lloyd@med.unideb.hu
-description = A command line tool for converting optical coherence tomography angiography (OCTA) data.
-long_description = file: README.md
-long_description_content_type = text/markdown
-url = https://github.com/camlloyd/oct-to-tiff
-project_urls = 
-	Bug Tracker = https://github.com/camlloyd/oct-to-tiff/issues
-classifiers = 
-	Development Status :: 3 - Alpha
-	Intended Audience :: Science/Research
-	License :: OSI Approved :: BSD License
-	Natural Language :: English
-	Operating System :: OS Independent
-	Programming Language :: Python :: 3
-	Programming Language :: Python :: 3.8
-	Programming Language :: Python :: 3.9
-	Programming Language :: Python :: 3.10
-	Programming Language :: Python :: 3.11
-
-[options]
-packages = find:
-package_dir = 
-	=src
-python_requires = >=3.8
-install_requires = 
-	numpy
-	tifffile
-
-[options.entry_points]
-console_scripts = 
-	oct-to-tiff = oct_to_tiff.cli:main
-
-[options.packages.find]
-where = src
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

oct_to_tiff-0.4.0/setup.py

@@ -1,3 +0,0 @@
-import setuptools
-
-setuptools.setup()

oct_to_tiff-0.4.0/src/oct_to_tiff.egg-info/requires.txt

@@ -1,2 +0,0 @@
-numpy
-tifffile