bfio 2.3.4__tar.gz → 2.3.6__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.
@@ -1,7 +1,7 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: bfio
3
- Version: 2.3.4
4
- Summary: Simple reading and writing classes for tiled tiffs using Bioformats.
3
+ Version: 2.3.6
4
+ Summary: Simple reading and writing classes for tiled tiffs using Bio-Formats.
5
5
  Author-email: Nick Schaub <nick.schaub@nih.gov>, Sameeul Bashir Samee <sameeul.samee@axleinfo.com>
6
6
  Maintainer-email: Sameeul Bashir Samee <sameeul.samee@axleinfo.com>
7
7
  License: MIT License
@@ -46,7 +46,7 @@ Provides-Extra: dev
46
46
  Requires-Dist: ome_zarr; extra == "dev"
47
47
  Requires-Dist: requests>=2.26.0; extra == "dev"
48
48
 
49
- # **B**io**F**ormats **I**nput/**O**utput utility (bfio 2.3.4)
49
+ # **B**io**F**ormats **I**nput/**O**utput utility (bfio 2.3.6)
50
50
 
51
51
  [![Documentation Status](https://readthedocs.org/projects/bfio/badge/?version=latest)](https://bfio.readthedocs.io/en/latest/?badge=latest)
52
52
  [![PyPI](https://img.shields.io/pypi/v/bfio)](https://pypi.org/project/bfio/)
@@ -56,7 +56,7 @@ Requires-Dist: requests>=2.26.0; extra == "dev"
56
56
  ![Bower](https://img.shields.io/bower/l/MI)
57
57
 
58
58
  This tool is a simplified but powerful interface to
59
- [Bioformats](https://www.openmicroscopy.org/bio-formats/)
59
+ [Bio-Formats](https://www.openmicroscopy.org/bio-formats/)
60
60
  using jpype for direct access to the library. This tool is designed with
61
61
  scalable image analysis in mind, with a simple interface to treat any image
62
62
  like a memory mapped array.
@@ -80,10 +80,10 @@ Docker containers with all necessary components are available (see
80
80
  ### Setting up Java
81
81
 
82
82
  **Note:** `bfio` can be used without Java, but only the `python` and `zarr`
83
- backends will be usable. Only files in tiled OME Tiff or OME Zarr format can be
83
+ backends will be usable. This means only files in tiled OME Tiff or OME Zarr format can be
84
84
  read/written.
85
85
 
86
- In order to use the `Java` backend, it is necessary to first install the JDK and Maven.
86
+ In order to use the `bioformats` backend, it is necessary to first install the JDK and Maven.
87
87
  The `bfio` package is generally tested with
88
88
  [JDK 8](https://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html),
89
89
  but JDK 11 and later also appear to work.
@@ -98,15 +98,15 @@ be installed using pip:
98
98
 
99
99
  ## Docker
100
100
 
101
- ### polusai/bfio:2.3.4
101
+ ### polusai/bfio:2.3.6
102
102
 
103
103
  Ubuntu based container with bfio and all dependencies (including Java).
104
104
 
105
- ### polusai/bfio:2.3.4-imagej
105
+ ### polusai/bfio:2.3.6-imagej
106
106
 
107
107
  Same as above, except comes with ImageJ and PyImageJ.
108
108
 
109
- ### polusai/bfio:2.3.4-tensorflow
109
+ ### polusai/bfio:2.3.6-tensorflow
110
110
 
111
111
  Tensorflow container with bfio installed.
112
112
 
@@ -131,11 +131,6 @@ Sameeul B Samee (sameeul.samee@axleinfo.com)
131
131
  This project is licensed under the [MIT License](LICENSE)
132
132
  Creative Commons License - see the [LICENSE](LICENSE) file for details.
133
133
 
134
- **NOTE**
135
-
136
- Bioformats is licensed under GPL, and as a consequence so is the `bioformats_jar`
137
- package. These packages and libraries are installed when using the `bfio[bioformats]` option.
138
-
139
134
  ## Acknowledgments
140
135
 
141
136
  - Parts of this code were written/modified from existing code found in
@@ -1,4 +1,4 @@
1
- # **B**io**F**ormats **I**nput/**O**utput utility (bfio 2.3.4)
1
+ # **B**io**F**ormats **I**nput/**O**utput utility (bfio 2.3.6)
2
2
 
3
3
  [![Documentation Status](https://readthedocs.org/projects/bfio/badge/?version=latest)](https://bfio.readthedocs.io/en/latest/?badge=latest)
4
4
  [![PyPI](https://img.shields.io/pypi/v/bfio)](https://pypi.org/project/bfio/)
@@ -8,7 +8,7 @@
8
8
  ![Bower](https://img.shields.io/bower/l/MI)
9
9
 
10
10
  This tool is a simplified but powerful interface to
11
- [Bioformats](https://www.openmicroscopy.org/bio-formats/)
11
+ [Bio-Formats](https://www.openmicroscopy.org/bio-formats/)
12
12
  using jpype for direct access to the library. This tool is designed with
13
13
  scalable image analysis in mind, with a simple interface to treat any image
14
14
  like a memory mapped array.
@@ -32,10 +32,10 @@ Docker containers with all necessary components are available (see
32
32
  ### Setting up Java
33
33
 
34
34
  **Note:** `bfio` can be used without Java, but only the `python` and `zarr`
35
- backends will be usable. Only files in tiled OME Tiff or OME Zarr format can be
35
+ backends will be usable. This means only files in tiled OME Tiff or OME Zarr format can be
36
36
  read/written.
37
37
 
38
- In order to use the `Java` backend, it is necessary to first install the JDK and Maven.
38
+ In order to use the `bioformats` backend, it is necessary to first install the JDK and Maven.
39
39
  The `bfio` package is generally tested with
40
40
  [JDK 8](https://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html),
41
41
  but JDK 11 and later also appear to work.
@@ -50,15 +50,15 @@ be installed using pip:
50
50
 
51
51
  ## Docker
52
52
 
53
- ### polusai/bfio:2.3.4
53
+ ### polusai/bfio:2.3.6
54
54
 
55
55
  Ubuntu based container with bfio and all dependencies (including Java).
56
56
 
57
- ### polusai/bfio:2.3.4-imagej
57
+ ### polusai/bfio:2.3.6-imagej
58
58
 
59
59
  Same as above, except comes with ImageJ and PyImageJ.
60
60
 
61
- ### polusai/bfio:2.3.4-tensorflow
61
+ ### polusai/bfio:2.3.6-tensorflow
62
62
 
63
63
  Tensorflow container with bfio installed.
64
64
 
@@ -83,11 +83,6 @@ Sameeul B Samee (sameeul.samee@axleinfo.com)
83
83
  This project is licensed under the [MIT License](LICENSE)
84
84
  Creative Commons License - see the [LICENSE](LICENSE) file for details.
85
85
 
86
- **NOTE**
87
-
88
- Bioformats is licensed under GPL, and as a consequence so is the `bioformats_jar`
89
- package. These packages and libraries are installed when using the `bfio[bioformats]` option.
90
-
91
86
  ## Acknowledgments
92
87
 
93
88
  - Parts of this code were written/modified from existing code found in
@@ -28,7 +28,7 @@ dependencies = [
28
28
  "tifffile>=2022.8.12"
29
29
  ]
30
30
 
31
- description = "Simple reading and writing classes for tiled tiffs using Bioformats."
31
+ description = "Simple reading and writing classes for tiled tiffs using Bio-Formats."
32
32
  readme = "README.md"
33
33
  license = {file = "LICENSE"}
34
34
 
@@ -84,7 +84,7 @@ namespaces = false
84
84
 
85
85
 
86
86
  [tool.bumpversion]
87
- current_version = "2.3.4"
87
+ current_version = "2.3.6"
88
88
  commit = true
89
89
  tag = true
90
90
  commit_args = "--no-verify"
@@ -109,8 +109,8 @@ replace = "{new_version}"
109
109
 
110
110
  [[tool.bumpversion.files]]
111
111
  filename = "requirements/requirements-base.txt"
112
- search = "bfio[all]=={current_version}"
113
- replace = "bfio[all]=={new_version}"
112
+ search = "bfio=={current_version}"
113
+ replace = "bfio=={new_version}"
114
114
 
115
115
  [[tool.bumpversion.files]]
116
116
  filename = "README.md"
@@ -0,0 +1 @@
1
+ 2.3.6
@@ -1346,7 +1346,7 @@ try:
1346
1346
  class JavaWriter(bfio.base_classes.AbstractWriter):
1347
1347
  logger = logging.getLogger("bfio.backends.JavaWriter")
1348
1348
 
1349
- # For Bioformats, the first tile has to be written before any other tile
1349
+ # For Bio-Formats, the first tile has to be written before any other tile
1350
1350
  first_tile = False
1351
1351
 
1352
1352
  _classes_loaded = False
@@ -523,7 +523,7 @@ class BioBase(object, metaclass=abc.ABCMeta):
523
523
  assert not self._read_only, self._READ_ONLY_MESSAGE.format("dtype")
524
524
  if dtype in [numpy.uint64, numpy.int64]:
525
525
  self.logger.warning(
526
- f"{dtype} is not supported by Bioformats, saving as numpy.float64."
526
+ f"{dtype} is not supported by Bio-Formats, saving as numpy.float64."
527
527
  )
528
528
  dtype = numpy.float64
529
529
  assert dtype in self._DTYPE.values(), "Invalid data type."
@@ -576,10 +576,10 @@ class BioBase(object, metaclass=abc.ABCMeta):
576
576
  def metadata(self) -> ome_types.model.OME:
577
577
  """Get the metadata for the image.
578
578
 
579
- This function calls the Bioformats metadata parser, which extracts
579
+ This function calls the Bio-Formats metadata parser, which extracts
580
580
  metadata from an image. This returns a reference to an OMEXML class,
581
581
  which is a convenient handler for the complex xml metadata created by
582
- Bioformats.
582
+ Bio-Formats.
583
583
 
584
584
  Most basic metadata information have their own BioReader methods, such
585
585
  as image dimensions(i.e. x, y, etc). However, in some cases it may be
@@ -9,7 +9,6 @@ from pathlib import Path
9
9
  import numpy
10
10
  import ome_types
11
11
  import tifffile
12
- import jpype
13
12
  import scyjava
14
13
 
15
14
  from bfio import backends
@@ -21,16 +20,17 @@ try:
21
20
  """Start the jvm.
22
21
 
23
22
  This function starts the jvm and imports all the necessary Java classes
24
- to read images using the Bioformats toolbox.
23
+ to read images using the Bio-Formats toolbox.
25
24
 
26
25
  Return:
27
26
  The Bio-Formats JAR version.
28
27
  """
29
28
 
30
29
  global JAR_VERSION
31
- scyjava.config.endpoints.append("ome:formats-gpl:7.1.0")
30
+ scyjava.config.endpoints.append("ome:formats-gpl:7.2.0")
32
31
  scyjava.start_jvm()
33
- loci = jpype.JPackage("loci")
32
+ import loci
33
+
34
34
  loci.common.DebugTools.setRootLevel("ERROR")
35
35
  JAR_VERSION = loci.formats.FormatTools.VERSION
36
36
 
@@ -47,10 +47,10 @@ except ModuleNotFoundError:
47
47
 
48
48
 
49
49
  class BioReader(BioBase):
50
- """Read supported image formats using Bioformats.
50
+ """Read supported image formats using Bio-Formats.
51
51
 
52
52
  This class handles file reading of multiple formats. It can read files from
53
- any Bioformats supported file format, but is specially optimized for
53
+ any Bio-Formats supported file format, but is specially optimized for
54
54
  handling the OME tiled tiff format.
55
55
 
56
56
  There are three backends: ``bioformats``, ``python``, and ``zarr``. The
@@ -65,7 +65,7 @@ class BioReader(BioBase):
65
65
  available CPUs detected by multiprocessing.cpu_count() are used to read
66
66
  an image.
67
67
 
68
- For for information, visit the Bioformats page:
68
+ For for information, visit the Bio-Formats page:
69
69
  https://www.openmicroscopy.org/bio-formats/
70
70
 
71
71
  Note:
@@ -952,14 +952,14 @@ class BioWriter(BioBase):
952
952
  """BioWriter Write OME tiled tiff images.
953
953
 
954
954
  This class handles the writing OME tiled tif images. There is a Java backend
955
- version of this tool that directly interacts with the Bioformats java
955
+ version of this tool that directly interacts with the Bio-Formats java
956
956
  library directly, and is primarily used for testing. It is currently not
957
957
  possible to change the tile size (which is set to 1024x1024).
958
958
 
959
959
  Unlike the BioReader class, the properties of this class are settable until
960
960
  the first time the ``write`` method is called.
961
961
 
962
- For for information, visit the Bioformats page:
962
+ For for information, visit the Bio-Formats page:
963
963
  https://www.openmicroscopy.org/bio-formats/
964
964
 
965
965
  Note:
@@ -1,7 +1,7 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: bfio
3
- Version: 2.3.4
4
- Summary: Simple reading and writing classes for tiled tiffs using Bioformats.
3
+ Version: 2.3.6
4
+ Summary: Simple reading and writing classes for tiled tiffs using Bio-Formats.
5
5
  Author-email: Nick Schaub <nick.schaub@nih.gov>, Sameeul Bashir Samee <sameeul.samee@axleinfo.com>
6
6
  Maintainer-email: Sameeul Bashir Samee <sameeul.samee@axleinfo.com>
7
7
  License: MIT License
@@ -46,7 +46,7 @@ Provides-Extra: dev
46
46
  Requires-Dist: ome_zarr; extra == "dev"
47
47
  Requires-Dist: requests>=2.26.0; extra == "dev"
48
48
 
49
- # **B**io**F**ormats **I**nput/**O**utput utility (bfio 2.3.4)
49
+ # **B**io**F**ormats **I**nput/**O**utput utility (bfio 2.3.6)
50
50
 
51
51
  [![Documentation Status](https://readthedocs.org/projects/bfio/badge/?version=latest)](https://bfio.readthedocs.io/en/latest/?badge=latest)
52
52
  [![PyPI](https://img.shields.io/pypi/v/bfio)](https://pypi.org/project/bfio/)
@@ -56,7 +56,7 @@ Requires-Dist: requests>=2.26.0; extra == "dev"
56
56
  ![Bower](https://img.shields.io/bower/l/MI)
57
57
 
58
58
  This tool is a simplified but powerful interface to
59
- [Bioformats](https://www.openmicroscopy.org/bio-formats/)
59
+ [Bio-Formats](https://www.openmicroscopy.org/bio-formats/)
60
60
  using jpype for direct access to the library. This tool is designed with
61
61
  scalable image analysis in mind, with a simple interface to treat any image
62
62
  like a memory mapped array.
@@ -80,10 +80,10 @@ Docker containers with all necessary components are available (see
80
80
  ### Setting up Java
81
81
 
82
82
  **Note:** `bfio` can be used without Java, but only the `python` and `zarr`
83
- backends will be usable. Only files in tiled OME Tiff or OME Zarr format can be
83
+ backends will be usable. This means only files in tiled OME Tiff or OME Zarr format can be
84
84
  read/written.
85
85
 
86
- In order to use the `Java` backend, it is necessary to first install the JDK and Maven.
86
+ In order to use the `bioformats` backend, it is necessary to first install the JDK and Maven.
87
87
  The `bfio` package is generally tested with
88
88
  [JDK 8](https://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html),
89
89
  but JDK 11 and later also appear to work.
@@ -98,15 +98,15 @@ be installed using pip:
98
98
 
99
99
  ## Docker
100
100
 
101
- ### polusai/bfio:2.3.4
101
+ ### polusai/bfio:2.3.6
102
102
 
103
103
  Ubuntu based container with bfio and all dependencies (including Java).
104
104
 
105
- ### polusai/bfio:2.3.4-imagej
105
+ ### polusai/bfio:2.3.6-imagej
106
106
 
107
107
  Same as above, except comes with ImageJ and PyImageJ.
108
108
 
109
- ### polusai/bfio:2.3.4-tensorflow
109
+ ### polusai/bfio:2.3.6-tensorflow
110
110
 
111
111
  Tensorflow container with bfio installed.
112
112
 
@@ -131,11 +131,6 @@ Sameeul B Samee (sameeul.samee@axleinfo.com)
131
131
  This project is licensed under the [MIT License](LICENSE)
132
132
  Creative Commons License - see the [LICENSE](LICENSE) file for details.
133
133
 
134
- **NOTE**
135
-
136
- Bioformats is licensed under GPL, and as a consequence so is the `bioformats_jar`
137
- package. These packages and libraries are installed when using the `bfio[bioformats]` option.
138
-
139
134
  ## Acknowledgments
140
135
 
141
136
  - Parts of this code were written/modified from existing code found in
@@ -1 +0,0 @@
1
- 2.3.4
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes