async-tiff 0.4.0__cp310-cp310-macosx_11_0_arm64.whl → 0.5.0b4__cp310-cp310-macosx_11_0_arm64.whl

async_tiff/__init__.py

@@ -1,8 +1,8 @@
-from typing import TYPE_CHECKING
-
+from . import enums
 from ._async_tiff import (
     TIFF,
     Array,
+    Colormap,
     DecoderRegistry,
     GeoKeyDirectory,
     ImageFileDirectory,
@@ -13,14 +13,12 @@ from ._async_tiff import (
 from ._decoder_runtime import Decoder
 from ._input import ObspecInput
 
-if TYPE_CHECKING:
-    from . import store
-
 __version__: str = ___version()
 
 __all__ = [
-    "store",
+    "enums",
     "Array",
+    "Colormap",
     "Decoder",
     "DecoderRegistry",
     "GeoKeyDirectory",

async_tiff/_array.pyi

@@ -1,4 +1,9 @@
-from collections.abc import Buffer
+import sys
+
+if sys.version_info >= (3, 12):
+    from collections.abc import Buffer
+else:
+    from typing_extensions import Buffer
 
 class Array(Buffer):
     """A 3D array that implements Python's buffer protocol.

async_tiff/_async_tiff.pyi

@@ -1,4 +1,5 @@
 from ._array import Array
+from ._colormap import Colormap
 from ._decoder import DecoderRegistry
 from ._geo import GeoKeyDirectory
 from ._ifd import ImageFileDirectory
@@ -8,6 +9,7 @@ from ._tile import Tile
 
 __all__ = [
     "Array",
+    "Colormap",
     "DecoderRegistry",
     "GeoKeyDirectory",
     "ImageFileDirectory",

async_tiff/_colormap.pyi

@@ -0,0 +1,14 @@
+import sys
+
+if sys.version_info >= (3, 12):
+    from collections.abc import Buffer
+else:
+    from typing_extensions import Buffer
+
+class Colormap(Buffer):
+    """A 1D array of u16 values representing a TIFF colormap.
+
+    Implements Python's buffer protocol for zero-copy access via `np.asarray()`.
+    """
+    def __buffer__(self, flags: int) -> memoryview[int]: ...
+    def __len__(self) -> int: ...

async_tiff/_decoder.pyi

@@ -1,10 +1,10 @@
 from ._decoder_runtime import Decoder
-from .enums import CompressionMethod
+from .enums import Compression
 
 class DecoderRegistry:
     """A registry holding multiple decoder methods."""
     def __init__(
-        self, custom_decoders: dict[CompressionMethod | int, Decoder] | None = None
+        self, custom_decoders: dict[Compression | int, Decoder] | None = None
     ) -> None:
         """Construct a new decoder registry.
 

async_tiff/_ifd.pyi

@@ -1,9 +1,11 @@
-from collections.abc import Iterable
+from collections.abc import Iterable, Sequence
 from typing import Any
 
+from ._colormap import Colormap
 from ._geo import GeoKeyDirectory
+from ._tile import Tile
 from .enums import (
-    CompressionMethod,
+    Compression,
     PhotometricInterpretation,
     PlanarConfiguration,
     Predictor,
@@ -35,11 +37,11 @@ class ImageFileDirectory:
     @property
     def bits_per_sample(self) -> list[int]: ...
     @property
-    def compression(self) -> CompressionMethod | int:
+    def compression(self) -> Compression | int:
         """Access the compression tag.
 
         An `int` will be returned if the compression is not one of the values in
-        `CompressionMethod`.
+        `Compression`.
         """
     @property
     def photometric_interpretation(self) -> PhotometricInterpretation: ...
@@ -122,3 +124,26 @@ class ImageFileDirectory:
     def gdal_metadata(self) -> str | None: ...
     @property
     def other_tags(self) -> dict[int, Value]: ...
+    @property
+    def colormap(self) -> Colormap | None:
+        """The colormap for palette-color images."""
+        ...
+    async def fetch_tile(self, x: int, y: int) -> Tile:
+        """Fetch a single tile.
+
+        Args:
+            x: The column index within the ifd to read from.
+            y: The row index within the ifd to read from.
+
+        Returns:
+            Tile response.
+        """
+    async def fetch_tiles(self, xy: Sequence[tuple[int, int]]) -> list[Tile]:
+        """Fetch multiple tiles concurrently.
+
+        Args:
+            xy: The (column, row) indexes within the ifd to read from.
+
+        Returns:
+            Tile responses.
+        """

async_tiff/_input.py

@@ -1,8 +1,11 @@
 from typing import Protocol
 
-# Fix exports
-from obspec._get import GetRangeAsync, GetRangesAsync
+from obspec import GetRangeAsync, GetRangesAsync
 
 
 class ObspecInput(GetRangeAsync, GetRangesAsync, Protocol):
-    """Supported obspec input to reader."""
+    """Supported obspec input to reader.
+
+    Anything that implements [GetRangeAsync][obspec.GetRangeAsync] and
+    [GetRangesAsync][obspec.GetRangesAsync] can be used as an input to the TIFF reader.
+    """

async_tiff/_tiff.pyi

@@ -1,3 +1,5 @@
+from typing import Sequence
+
 from ._ifd import ImageFileDirectory
 from ._input import ObspecInput
 from ._tile import Tile
@@ -32,6 +34,17 @@ class TIFF:
     @property
     def endianness(self) -> Endianness:
         """The endianness of this TIFF file."""
+
+    def ifd(self, index: int) -> ImageFileDirectory:
+        """Access a specific IFD by index.
+
+        Args:
+            index: The IFD index to access.
+
+        Returns:
+            The requested IFD.
+        """
+
     @property
     def ifds(self) -> list[ImageFileDirectory]:
         """Access the underlying IFDs of this TIFF.
@@ -50,12 +63,11 @@ class TIFF:
         Returns:
             Tile response.
         """
-    async def fetch_tiles(self, x: list[int], y: list[int], z: int) -> list[Tile]:
+    async def fetch_tiles(self, xy: Sequence[tuple[int, int]], z: int) -> list[Tile]:
         """Fetch multiple tiles concurrently.
 
         Args:
-            x: The column indexes within the ifd to read from.
-            y: The row indexes within the ifd to read from.
+            xy: The (column, row) indexes within the ifd to read from.
             z: The IFD index to read from.
 
         Returns:

async_tiff/_tile.pyi

@@ -3,7 +3,7 @@ from collections.abc import Buffer
 from ._array import Array
 from ._decoder import DecoderRegistry
 from ._thread_pool import ThreadPool
-from .enums import CompressionMethod
+from .enums import Compression
 
 class Tile:
     """A representation of a TIFF image tile."""
@@ -17,7 +17,7 @@ class Tile:
     def compressed_bytes(self) -> Buffer:
         """The compressed bytes underlying this tile."""
     @property
-    def compression_method(self) -> CompressionMethod | int:
+    def compression_method(self) -> Compression | int:
         """The compression method used by this tile."""
     def decode_sync(
         self,

async_tiff/enums.py

@@ -1,7 +1,7 @@
 from enum import IntEnum
 
 
-class CompressionMethod(IntEnum):
+class Compression(IntEnum):
     """
     See [TIFF compression
     tags](https://www.awaresystems.be/imaging/tiff/tifftags/compression.html) for
@@ -19,6 +19,10 @@ class CompressionMethod(IntEnum):
     Deflate = 8
     OldDeflate = 0x80B2
     PackBits = 0x8005
+    WebP = 50001
+    LZMA = 34925
+    JPEG2k = 34712
+    ZSTD = 0xC350
 
 
 class Endianness(IntEnum):

async_tiff-0.5.0b4.dist-info/METADATA

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: async-tiff
+Version: 0.5.0b4
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Dist: obspec>=0.1.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# async-tiff
+
+[![PyPI][pypi_badge]][pypi_link]
+
+[pypi_badge]: https://badge.fury.io/py/async-tiff.svg
+[pypi_link]: https://pypi.org/project/async-tiff/
+
+Fast, low-level async TIFF reader for Python.
+
+This documentation is for the Python bindings. [Refer here for the Rust crate documentation](https://docs.rs/async-tiff).
+
+For a higher-level API to read GeoTIFF files, visit [`async-geotiff`][async-geotiff].
+
+[async-geotiff]: https://developmentseed.org/async-geotiff
+
+## Examples
+
+### Reading NAIP
+
+```py
+from async_tiff import TIFF
+from async_tiff.store import S3Store
+
+# You'll also need to provide credentials to access a requester pays bucket
+store = S3Store("naip-visualization", region="us-west-2", request_payer=True)
+path = "ny/2022/60cm/rgb/40073/m_4007307_sw_18_060_20220803.tif"
+
+tiff = await TIFF.open(path, store=store)
+primary_ifd = tiff.ifds[0]
+
+primary_ifd.geo_key_directory.citation
+# 'NAD83 / UTM zone 18N'
+
+primary_ifd.geo_key_directory.projected_type
+# 26918
+# (EPSG code)
+
+primary_ifd.sample_format
+# [<SampleFormat.Uint: 1>, <SampleFormat.Uint: 1>, <SampleFormat.Uint: 1>]
+
+primary_ifd.bits_per_sample
+# [8, 8, 8]
+
+tile = await tiff.fetch_tile(0, 0, 4)
+array = await tile.decode()
+
+# Use rasterio and matplotlib for visualization
+import numpy as np
+from rasterio.plot import reshape_as_raster, show
+
+# Zero-copy conversion of the rust array into a numpy array
+np_array = np.asarray(array)
+
+# Then we need to reshape the "image" axes into "raster" axes
+# https://rasterio.readthedocs.io/en/stable/topics/image_processing.html
+show(reshape_as_raster(np_array), adjust=True)
+```
+
+![](assets/naip-example.jpg)
+
+
+### Reading Sentinel 2 L2A
+
+```py
+import numpy as np
+from async_tiff import TIFF
+from async_tiff.store import S3Store
+
+store = S3Store("sentinel-cogs", region="us-west-2", skip_signature=True)
+path = "sentinel-s2-l2a-cogs/12/S/UF/2022/6/S2B_12SUF_20220609_0_L2A/B04.tif"
+
+tiff = await TIFF.open(path, store=store)
+primary_ifd = tiff.ifds[0]
+# Text readable citation
+primary_ifd.geo_key_directory.citation
+# EPSG code
+primary_ifd.geo_key_directory.projected_type
+
+primary_ifd.sample_format[0]
+# <SampleFormat.Uint: 1>
+primary_ifd.bits_per_sample[0]
+# 16
+
+tile = await tiff.fetch_tile(0, 0, 0)
+array = await tile.decode()
+
+# Zero-copy conversion of the rust array into a numpy array
+np_array = np.asarray(array)
+np_array.shape
+# (1024, 1024, 1)
+```
+
+

async_tiff-0.5.0b4.dist-info/RECORD

@@ -0,0 +1,18 @@
+async_tiff/__init__.py,sha256=gdLgfl7BLntXTceX9JdojgOwy_8sH7-YuEuQedBr3o4,559
+async_tiff/_array.pyi,sha256=muitV2BmObMPBF1O1mgo9a89posx7-ubsl4XftG5WO4,1257
+async_tiff/_async_tiff.cpython-310-darwin.so,sha256=dd82Uy38oDZZ4yMURNiWE2NesTq0UgTM-zmtYDyTbqo,7960256
+async_tiff/_async_tiff.pyi,sha256=I0Z9ey5GYZYfjJB4ZEyPUzHTsw0GcA5KBrAbTiThMc8,410
+async_tiff/_colormap.pyi,sha256=NrXLqUq3U81bI0zG8OLgQwv_JM0YS-MrVgx-1nD6j3g,402
+async_tiff/_decoder.pyi,sha256=tRHzZbZj1V6lDireFpNQ-f2h2tPFqh2ExYu4L6v0Cqc,709
+async_tiff/_decoder_runtime.py,sha256=N2IC7XTgC1TmGmB7ZXCJbrVVSbn6G85cWgJ6k87XpT8,553
+async_tiff/_geo.pyi,sha256=h71Y9zZ5vYxXaXAR4QAYmBJ0FOhLfXMMJA85p474eTE,3451
+async_tiff/_ifd.pyi,sha256=zjU_fENQr8roZMyTFRJpClLzOpHJHHeNhO--iN0XwMA,4698
+async_tiff/_input.py,sha256=CXgxr2kCxmKWQ3Ev3Jud6N5R1Vpl1r4YXpnr7485c8U,349
+async_tiff/_thread_pool.pyi,sha256=fbDu9kbo8RNlq7bBBxuuu_6ub20L5cAfXBM-J7Y0PC8,181
+async_tiff/_tiff.pyi,sha256=-TSMH4-k6moaDE1zoXPDkzGF1xLfd_1DzYMzAcALVu0,2178
+async_tiff/_tile.pyi,sha256=NBUciMH6nan6qQLt30p9msUiY4BKh4ZmW4r9CsqtYho,1961
+async_tiff/enums.py,sha256=81S3s7eKtCgxuLxuI2pw5K_43S7I3wJ8m7LRpKAzj_I,1047
+async_tiff/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+async_tiff-0.5.0b4.dist-info/METADATA,sha256=HP-ILZqvAvK-1GAhkTTnzw1Qyq17dZfdJ1-lgpYiX8Q,2741
+async_tiff-0.5.0b4.dist-info/WHEEL,sha256=lgXxQDOXaD3ZlhS7NozX7pozuWR_5xphTDPgxH3-aMg,105
+async_tiff-0.5.0b4.dist-info/RECORD,,

async_tiff-0.4.0.dist-info/METADATA

@@ -1,8 +0,0 @@
-Metadata-Version: 2.4
-Name: async-tiff
-Version: 0.4.0
-Classifier: Programming Language :: Rust
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Dist: obspec>=0.1.0
-Requires-Python: >=3.10

async_tiff-0.4.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-async_tiff/__init__.py,sha256=EAs0ZXh393JFZeO_mpt69rDHQdv-cnZkU4rgqvUGf7A,586
-async_tiff/_array.pyi,sha256=uuJLjpoGF6wk_VS4kfTJIS_mhQ29RBEYGyy40cn5E28,1162
-async_tiff/_async_tiff.cpython-310-darwin.so,sha256=ndWyZq848BbonNICtai-J3g2eLD6hYUOrq41BKhw1yA,7679248
-async_tiff/_async_tiff.pyi,sha256=9Jbj2DFNpmo4BqBUU9p9-Z-8Ea_warzn-LPE2m3SzBM,362
-async_tiff/_decoder.pyi,sha256=T1600oX7eWwzulo3uxWvqZ0CFwcMgQ_iAA7NzaQc5Hg,721
-async_tiff/_decoder_runtime.py,sha256=N2IC7XTgC1TmGmB7ZXCJbrVVSbn6G85cWgJ6k87XpT8,553
-async_tiff/_geo.pyi,sha256=h71Y9zZ5vYxXaXAR4QAYmBJ0FOhLfXMMJA85p474eTE,3451
-async_tiff/_ifd.pyi,sha256=X6eAFIc6jBIR9nnLnjQFNVFnQ6fr9zoUJeQjZAdv494,3981
-async_tiff/_input.py,sha256=f6FCam4uyKaWXy-npUQ-nePaXeOsWMdXt2WcyH5fhq0,203
-async_tiff/_thread_pool.pyi,sha256=fbDu9kbo8RNlq7bBBxuuu_6ub20L5cAfXBM-J7Y0PC8,181
-async_tiff/_tiff.pyi,sha256=aR7qtsfKBqYcdF-Jf6weZl9CE1owM9GgXu5gU2nAlIo,1980
-async_tiff/_tile.pyi,sha256=1JlhrXGq4xB9gbSrmMt4aUR5Bufr1LhFCFwOCdgf5X8,1973
-async_tiff/enums.py,sha256=uz6EUnLeLpbtD40vxXsd4VnFNQBMaC_o5bslqF8gJv0,982
-async_tiff/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-async_tiff-0.4.0.dist-info/METADATA,sha256=2Hkh524tDGJ0nOYlHcFnyMcMgKvSQFoS9C-39cl-Ma0,289
-async_tiff-0.4.0.dist-info/WHEEL,sha256=lgXxQDOXaD3ZlhS7NozX7pozuWR_5xphTDPgxH3-aMg,105
-async_tiff-0.4.0.dist-info/RECORD,,