large-image-source-multi 1.29.6.dev2__tar.gz → 1.29.7__tar.gz

{large-image-source-multi-1.29.6.dev2/large_image_source_multi.egg-info → large-image-source-multi-1.29.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: large-image-source-multi
-Version: 1.29.6.dev2
+Version: 1.29.7
 Summary: A tilesource for large_image to composite other tile sources
 Home-page: https://github.com/girder/large_image
 Author: Kitware, Inc.
@@ -16,14 +16,15 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.6
+Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: jsonschema
-Requires-Dist: large-image>=1.29.6.dev2
+Requires-Dist: large-image>=1.29.7
 Requires-Dist: pyyaml
 Provides-Extra: all
 Requires-Dist: scikit-image; extra == "all"
 Provides-Extra: girder
-Requires-Dist: girder-large-image>=1.29.6.dev2; extra == "girder"
+Requires-Dist: girder-large-image>=1.29.7; extra == "girder"
 
 A tilesource for large_image to composite other tile sources
 

{large-image-source-multi-1.29.6.dev2 → large-image-source-multi-1.29.7}/README.rst

@@ -39,7 +39,7 @@ Highlights
 Installation
 ------------
 
-In addition to installing the ``large-image`` package, you'll need at least one tile source (a ``large-image-source-xxx`` package).   You can install everything from the main project with one of these commands:
+In addition to installing the base ``large-image`` package, you'll need at least one tile source which corresponds to your target file format(s) (a ``large-image-source-xxx`` package).   You can install everything from the main project with one of these commands:
 
 Pip
 ~~~
@@ -52,7 +52,7 @@ Install all tile sources on linux::
 
     pip install large-image[all] --find-links https://girder.github.io/large_image_wheels
 
-Install all tile sources and all Girder plugins on linux::
+When using large-image with an instance of `Girder`_, install all tile sources and all Girder plugins on linux::
 
     pip install large-image[all] girder-large-image-annotation[tasks] --find-links https://girder.github.io/large_image_wheels
 
@@ -60,8 +60,9 @@ Install all tile sources and all Girder plugins on linux::
 Conda
 ~~~~~
 
-Conda makes dependency management a bit easier if not on Linux. Some of the source modules are available on conda-forge. You can install the following::
+Conda makes dependency management a bit easier if not on Linux. The base module, converter module, and two of the source modules are available on conda-forge. You can install the following::
 
+    conda install -c conda-forge large-image
     conda install -c conda-forge large-image-source-gdal
     conda install -c conda-forge large-image-source-tiff
     conda install -c conda-forge large-image-converter
@@ -118,7 +119,7 @@ Large Image consists of several Python modules designed to work together.  These
 
   - ``large-image-source-deepzoom``: A tile source for reading Deepzoom tiles.
 
-  - ``large-image-source-dicom``: A tile source for reading DICOM WSI images.
+  - ``large-image-source-dicom``: A tile source for reading DICOM Whole Slide Images (WSI).
 
   - ``large-image-source-gdal``: A tile source for reading geotiff files via GDAL.  This handles source data with more complex transforms than the mapnik tile source.
 
@@ -128,62 +129,41 @@ Large Image consists of several Python modules designed to work together.  These
 
   - ``large-image-source-nd2``: A tile source for reading nd2 (NIS Element) images.
 
-  - ``large-image-source-ometiff``: A tile source using the tiff library that can handle some multi-frame OMETiff files.
+  - ``large-image-source-ometiff``: A tile source using the tiff library that can handle most multi-frame OMETiff files that are compliant with the specification.
 
   - ``large-image-source-openjpeg``: A tile source using the Glymur library to read jp2 (JPEG 2000) files.
 
   - ``large-image-source-openslide``: A tile source using the OpenSlide library.  This works with svs, ndpi, Mirax, tiff, vms, and other file formats.
 
-  - ``large-image-source-pil``: A tile source for small images via the Python Imaging Library (Pillow).
+  - ``large-image-source-pil``: A tile source for small images via the Python Imaging Library (Pillow). By default, the maximum size is 4096, but the maximum size can be configured.
 
   - ``large-image-source-tiff``: A tile source for reading pyramidal tiff files in common compression formats.
 
   - ``large-image-source-tifffile``: A tile source using the tifffile library that can handle a wide variety of tiff-like files.
 
-  - ``large-image-source-vips``: A tile source for reading any files handled by libvips.  This also can be used for writing tiled images from numpy arrays.
+  - ``large-image-source-vips``: A tile source for reading any files handled by libvips.  This also can be used for writing tiled images from numpy arrays (up to 4 dimensions).
 
-  - ``large-image-source-zarr``: A tile source using the zarr library that can handle OME-Zarr (OME-NGFF) files as well as some other zarr files.
+  - ``large-image-source-zarr``: A tile source using the zarr library that can handle OME-Zarr (OME-NGFF) files as well as some other zarr files. This can also be used for writing N-dimensional tiled images from numpy arrays. Written images can be saved as any supported format.
 
   - ``large-image-source-test``: A tile source that generates test tiles, including a simple fractal pattern.  Useful for testing extreme zoom levels.
 
-  - ``large-image-source-dummy``: A tile source that does nothing.
+  - ``large-image-source-dummy``: A tile source that does nothing. This is an absolutely minimal implementation of a tile source used for testing. If you want to create a custom tile source, start with this implementation.
 
-  Most tile sources can be used with girder-large-image.  You can specific an extras_require of ``girder`` to include ``girder-large-image`` with the source.
 
-- As a Girder plugin:
+As a `Girder`_ plugin, ``large-image`` adds end points to access all of the image formats it can read both to get metadata and to act as a tile server.
+In the Girder UI, ``large-image`` shows images on item pages, and can show thumbnails in item lists when browsing folders.
+There is also cache management to balance memory use and speed of response in Girder when ``large-image`` is used as a tile server.
 
-  - ``girder-large-image``: Large Image as a Girder_ 3.x plugin.
-    You can specify extras_require of ``tasks`` to install a Girder Worker task that can convert otherwise unreadable images to pyramidal tiff files.
+Most tile sources can be used with Girder Large Image.  You can specify an extras_require of ``girder`` to install the following packages:
 
-  - ``girder-large-image-annotation``: Annotations for large images as a Girder_ 3.x plugin.
+  - ``girder-large-image``: Large Image as a Girder 3.x plugin.
+    You can install ``large-image[tasks]`` to install a Girder Worker task that can convert otherwise unreadable images to pyramidal tiff files.
+
+  - ``girder-large-image-annotation``: Adds models to the Girder database for supporting annotating large images.  These annotations can be rendered on images. Annotations can include polygons, points, image overlays, and other types. Each annotation can have a label and metadata.
 
   - ``large-image-tasks``: A utility for running the converter via Girder Worker.
     You can specify an extras_require of ``girder`` to include modules needed to work with the Girder remote worker or ``worker`` to include modules needed on the remote side of the Girder remote worker.  If neither is specified, some conversion tasks can be run using Girder local jobs.
 
 
-Developer Installation
-----------------------
-
-To install all packages from source, clone the repository::
-
-    git clone https://github.com/girder/large_image.git
-    cd large_image
-
-Install all packages and dependencies::
-
-    pip install -e . -r requirements-dev.txt
-
-If you aren't developing with Girder 3, you can skip installing those components.  Use ``requirements-dev-core.txt`` instead of ``requirements-dev.txt``::
-
-    pip install -e . -r requirements-dev-core.txt
-
-
-Tile source prerequisites
-=========================
-
-Many tile sources have complex prerequisites.  These can be installed directly using your system's package manager or from some prebuilt Python wheels for Linux.  The prebuilt wheels are not official packages, but they can be used by instructing pip to use them by preference::
-
-    pip install -e . -r requirements-dev.txt --find-links https://girder.github.io/large_image_wheels
-
 
-.. _Girder: https://github.com/girder/girder
+.. _Girder: https://girder.readthedocs.io/en/latest/

{large-image-source-multi-1.29.6.dev2 → large-image-source-multi-1.29.7}/large_image_source_multi/__init__.py

@@ -288,6 +288,18 @@ SourceEntrySchema = {
             'type': 'array',
             'items': {'type': 'integer'},
         },
+        'sampleScale': {
+            'description':
+                'Each pixel sample values is divided by this scale after any '
+                'sampleOffset has been applied',
+            'type': 'number',
+        },
+        'sampleOffset': {
+            'description':
+                'This is added to each pixel sample value before any '
+                'sampleScale is applied',
+            'type': 'number',
+        },
         'style': {'type': 'object'},
         'params': {
             'description':
@@ -806,7 +818,7 @@ class MultiFileTileSource(FileTileSource, metaclass=LruCacheMetaclass):
                         self._bands = {}
                     self._bands.update(tsMeta['bands'])
                 lastSource = source
-            self._bandcount = 1 if self._info.get('singleBand') else (
+            self._bandCount = 1 if self._info.get('singleBand') else (
                 len(self._bands) if hasattr(self, '_bands') else (bandCount or None))
             bbox = self._sourceBoundingBox(source, tsMeta['sizeX'], tsMeta['sizeY'])
             computedWidth = max(computedWidth, int(math.ceil(bbox['right'])))
@@ -875,6 +887,20 @@ class MultiFileTileSource(FileTileSource, metaclass=LruCacheMetaclass):
         if params is None:
             params = source.get('params', {})
         ts = openFunc(source['path'], **params)
+        if (self._dtype and np.dtype(ts.dtype).kind == 'f' and self._dtype.kind != 'f' and
+                'sampleScale' not in source and 'sampleOffset' not in source):
+            minval = maxval = 0
+            for f in range(ts.frames):
+                ftile = ts.getTile(x=0, y=0, z=0, frame=f, numpyAllowed='always')
+                minval = min(minval, np.amin(ftile))
+                maxval = max(maxval, np.amax(ftile))
+            if minval >= 0 and maxval <= 1:
+                source['sampleScale'] = None
+            elif minval >= 0:
+                source['sampleScale'] = 2 ** math.ceil(math.log2(maxval))
+            else:
+                source['sampleScale'] = 2 ** math.ceil(math.log2(max(-minval, maxval)) + 1)
+                source['sampleOffset'] = source['sampleScale'] / 2
         source['sourceName'] = ts.name
         with self._lastOpenSourceLock:
             self._lastOpenSource = {
@@ -1002,8 +1028,8 @@ class MultiFileTileSource(FileTileSource, metaclass=LruCacheMetaclass):
         """
         Determine where the target tile's corners are located on the source.
         Fetch that so that we have at least sqrt(2) more resolution, then use
-        scikit-image warp to transform it.  scikit-image does a better job than
-        scipy.ndimage.affine_transform.
+        scikit-image warp to transform it.  scikit-image does a better and
+        faster job than scipy.ndimage.affine_transform.
 
         :param ts: the source of the image to transform.
         :param transform: a 3x3 affine 2d matrix for transforming the source
@@ -1092,28 +1118,35 @@ class MultiFileTileSource(FileTileSource, metaclass=LruCacheMetaclass):
         x, y = int(math.floor(x)), int(math.floor(y))
         # Recompute where the source corners will land
         destcorners = (np.dot(transform, regioncorners.T).T).tolist()
-        destsize = (max(math.ceil(c[0]) for c in destcorners),
-                    max(math.ceil(c[1]) for c in destcorners))
+        destShape = [
+            max(max(math.ceil(c[1]) for c in destcorners), srcImage.shape[0]),
+            max(max(math.ceil(c[0]) for c in destcorners), srcImage.shape[1]),
+        ]
+        if max(0, -x) or max(0, -y):
+            transform[0][2] -= max(0, -x)
+            transform[1][2] -= max(0, -y)
+            destShape[0] -= max(0, -y)
+            destShape[1] -= max(0, -x)
+            x += max(0, -x)
+            y += max(0, -y)
+        destShape = [min(destShape[0], outh - y), min(destShape[1], outw - x)]
+        if destShape[0] <= 0 or destShape[1] <= 0:
+            return None, None, None
         # Add an alpha band if needed
         if srcImage.shape[2] in {1, 3}:
             _, srcImage = _makeSameChannelDepth(np.zeros((1, 1, srcImage.shape[2] + 1)), srcImage)
-        # Add enough space to warp the source image in place
-        srcImage = np.pad(srcImage, (
-            (0, max(0, destsize[1] - srcImage.shape[0])),
-            (0, max(0, destsize[0] - srcImage.shape[1])),
-            (0, 0)), mode='constant')
+        # skimage.transform.warp is faster and has less artifacts than
+        # scipy.ndimage.affine_transform.  It is faster than using cupy's
+        # version of scipy's affine_transform when the source and destination
+        # images are converted from numpy to cupy and back in this method.
         destImage = skimage.transform.warp(
+            # Although using np.float32 could reduce memory use, it doesn't
+            # provide any speed improvement
             srcImage.astype(float),
-            skimage.transform.AffineTransform(np.linalg.inv(
-                transform))).astype(srcImage.dtype)
-        # Trim to target size and location
-        destImage = destImage[max(0, -y):, max(0, -x):, :]
-        x += max(0, -x)
-        y += max(0, -y)
-        if x >= outw or y >= outh:
-            return None, None, None
-        destImage = destImage[:min(destImage.shape[0], outh - y),
-                              :min(destImage.shape[1], outw - x), :]
+            skimage.transform.AffineTransform(np.linalg.inv(transform)),
+            order=3,
+            output_shape=(destShape[0], destShape[1], srcImage.shape[2]),
+        ).astype(srcImage.dtype)
         return destImage, x, y
 
     def _addSourceToTile(self, tile, sourceEntry, corners, scale):
@@ -1190,9 +1223,20 @@ class MultiFileTileSource(FileTileSource, metaclass=LruCacheMetaclass):
                 ts, transform, corners, scale, sourceEntry.get('frame', 0),
                 source.get('position', {}).get('crop'))
         if sourceTile is not None and all(dim > 0 for dim in sourceTile.shape):
-            sourceTile = sourceTile.astype(
-                ts.dtype if not self._info.get('dtype') else
-                np.dtype(self._info['dtype']))
+            targetDtype = np.dtype(self._info.get('dtype', ts.dtype))
+            changeDtype = sourceTile.dtype != targetDtype
+            if source.get('sampleScale') or source.get('sampleOffset'):
+                sourceTile = sourceTile.astype(float)
+                if source.get('sampleOffset'):
+                    sourceTile[:, :, :-1] += source['sampleOffset']
+                if source.get('sampleScale') and source.get('sampleScale') != 1:
+                    sourceTile[:, :, :-1] /= source['sampleScale']
+            if sourceTile.dtype != targetDtype:
+                if changeDtype:
+                    sourceTile = (
+                        sourceTile.astype(float) * fullAlphaValue(targetDtype) /
+                        fullAlphaValue(sourceTile))
+                sourceTile = sourceTile.astype(targetDtype)
             tile = self._mergeTiles(tile, sourceTile, x, y)
         return tile
 

{large-image-source-multi-1.29.6.dev2 → large-image-source-multi-1.29.7/large_image_source_multi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: large-image-source-multi
-Version: 1.29.6.dev2
+Version: 1.29.7
 Summary: A tilesource for large_image to composite other tile sources
 Home-page: https://github.com/girder/large_image
 Author: Kitware, Inc.
@@ -16,14 +16,15 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.6
+Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: jsonschema
-Requires-Dist: large-image>=1.29.6.dev2
+Requires-Dist: large-image>=1.29.7
 Requires-Dist: pyyaml
 Provides-Extra: all
 Requires-Dist: scikit-image; extra == "all"
 Provides-Extra: girder
-Requires-Dist: girder-large-image>=1.29.6.dev2; extra == "girder"
+Requires-Dist: girder-large-image>=1.29.7; extra == "girder"
 
 A tilesource for large_image to composite other tile sources
 

large-image-source-multi-1.29.7/large_image_source_multi.egg-info/requires.txt

@@ -0,0 +1,9 @@
+jsonschema
+large-image>=1.29.7
+pyyaml
+
+[all]
+scikit-image
+
+[girder]
+girder-large-image>=1.29.7

{large-image-source-multi-1.29.6.dev2 → large-image-source-multi-1.29.7}/setup.py

@@ -37,6 +37,7 @@ setup(
                      'fallback_version': '0.0.0'},
     description=description,
     long_description=long_description,
+    long_description_content_type='text/x-rst',
     license='Apache Software License 2.0',
     author='Kitware, Inc.',
     author_email='kitware@kitware.com',

large-image-source-multi-1.29.6.dev2/large_image_source_multi.egg-info/requires.txt

@@ -1,9 +0,0 @@
-jsonschema
-large-image>=1.29.6.dev2
-pyyaml
-
-[all]
-scikit-image
-
-[girder]
-girder-large-image>=1.29.6.dev2