fixr 0.1.0__tar.gz

fixr-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Joseph D. Long
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fixr-0.1.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include src/fixr/*.dylib
+include src/fixr/*.so
+include src/fixr/_xrif.py

fixr-0.1.0/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.1
+Name: fixr
+Version: 0.1.0
+Summary: Python bindings to xrif, the extreme reordered image format
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# fiXr
+
+Open xrif archives from Python directly using the [xrif](https://github.com/jaredmales/xrif) library.
+
+## Example
+
+```python
+from fixr import xrif2numpy
+fh = open('camwfs_20240315225750994842000.xrif', 'rb')
+data = xrif2numpy(fh)
+timings = xrif2numpy(fh)
+```

fixr-0.1.0/README.md

@@ -0,0 +1,12 @@
+# fiXr
+
+Open xrif archives from Python directly using the [xrif](https://github.com/jaredmales/xrif) library.
+
+## Example
+
+```python
+from fixr import xrif2numpy
+fh = open('camwfs_20240315225750994842000.xrif', 'rb')
+data = xrif2numpy(fh)
+timings = xrif2numpy(fh)
+```

fixr-0.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+# pyproject.toml
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "fixr"
+description = "Python bindings to xrif, the extreme reordered image format"
+version = "0.1.0"
+requires-python = ">=3.10"
+readme = "README.md"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.cibuildwheel]
+before-build = "bash build_xrif_and_generate_bindings.sh"
+manylinux-x86_64-image = "quay.io/pypa/manylinux_2_28_x86_64"
+manylinux-aarch64-image = "quay.io/pypa/manylinux_2_28_aarch64"
+
+# skip pypi, 32bit windows, 32bit linux
+skip = ["pp*", "*-win32", "*-manylinux_i686", "*-musllinux*"]

fixr-0.1.0/setup.cfg

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

fixr-0.1.0/setup.py

@@ -0,0 +1,25 @@
+from setuptools import setup, Extension
+from setuptools.dist import Distribution
+
+class BinaryDistribution(Distribution):
+    """Distribution which always forces a binary package with platform name"""
+    def has_ext_modules(foo):
+        return True
+
+import sys
+
+if sys.platform == 'darwin':
+    lib_extension = 'dylib'
+else:
+    lib_extension = 'so'
+
+setup(
+    ext_modules=[
+        Extension(
+            name="fixr._xrif",
+            sources=[],  # empty list because we compile this separately
+        ),
+    ],
+    package_data={"fixr": [f"libxrif.{lib_extension}"]},
+    distclass=BinaryDistribution,
+)

fixr-0.1.0/src/fixr/__init__.py

@@ -0,0 +1,165 @@
+import typing
+import ctypes
+import numpy as np
+from . import _xrif as xrif
+import io
+
+
+XRIF2NUMPY_DTYPE = {
+    xrif.XRIF_TYPECODE_UINT8: np.uint8,
+    xrif.XRIF_TYPECODE_INT8: np.int8,
+    xrif.XRIF_TYPECODE_UINT16: np.uint16,
+    xrif.XRIF_TYPECODE_INT16: np.int16,
+    xrif.XRIF_TYPECODE_UINT32: np.uint32,
+    xrif.XRIF_TYPECODE_INT32: np.int32,
+    xrif.XRIF_TYPECODE_UINT64: np.uint64,
+    xrif.XRIF_TYPECODE_INT64: np.int64,
+}
+
+class XrifReader:
+    def __init__(self, fh):
+        if 'b' not in fh.mode:
+            raise RuntimeError("File handle must be opened in binary mode")
+        self.fh = fh
+        # allocate and initialize xrif handle
+        self._reader = xrif.xrif_t()
+        xrif.xrif_new(self._reader)
+        self._decode_from_fh()
+
+    @property
+    def difference_method(self):
+        return xrif.string_cast((xrif.xrif_difference_method_string(self._reader.contents.difference_method)))
+
+    @property
+    def reorder_method(self):
+        return xrif.string_cast(xrif.xrif_reorder_method_string(self._reader.contents.reorder_method))
+
+    @property
+    def compress_method(self):
+        return xrif.string_cast(xrif.xrif_compress_method_string(self._reader.contents.compress_method))
+
+    @property
+    def lz4_acceleration(self):
+        return int(self._reader.contents.lz4_acceleration)
+
+    @property
+    def width(self):
+        return int(self._reader.contents.width)
+
+    @property
+    def height(self):
+        return int(self._reader.contents.height)
+
+    @property
+    def depth(self):
+        return int(self._reader.contents.depth)
+
+    @property
+    def frames(self):
+        return int(self._reader.contents.frames)
+
+    @property
+    def raw_size(self):
+        return self._reader.contents.width * self._reader.contents.height * self._reader.contents.depth * self._reader.contents.frames * self._reader.contents.data_size
+
+    @property
+    def shape(self):
+        return (
+            self._reader.contents.frames,
+            self._reader.contents.depth,
+            self._reader.contents.height,
+            self._reader.contents.width,
+        )
+
+    @property
+    def compressed_size(self):
+        return int(self._reader.contents.compressed_size)
+
+    @property
+    def ratio(self):
+        return self.compressed_size / self.raw_size
+
+    @property
+    def min_raw_size(self):
+        return xrif.xrif_min_raw_size(self._reader)
+
+    @property
+    def min_reordered_size(self):
+        return xrif.xrif_min_reordered_size(self._reader)
+
+    def describe(self):
+        # construct a report like xrif2fits has
+        s = 'xrif compression details:\n'
+        s += f"  difference method:  {self.difference_method}\n"
+        s += f"  reorder method:     {self.reorder_method}\n"
+        s += f"  compression method: {self.compress_method}\n"
+        if self._reader.contents.compress_method == xrif.XRIF_COMPRESS_LZ4:
+            s += f"    LZ4 acceleration: {self.lz4_acceleration}\n"
+        s += f"  dimensions:         {self.width} x {self.height} x {self.depth} x {self.frames}\n"
+        
+        s += f"  raw size:           {self.raw_size} bytes\n"
+        s += f"  encoded size:       {self.compressed_size} bytes\n"
+        s += f"  ratio:              {self.ratio:.3f}\n"
+        return s
+
+    def __del__(self):
+        xrif.xrif_delete(self._reader)
+
+    def _decode_from_fh(self):
+        # read one header's worth of bytes
+        buf = self.fh.read(xrif.XRIF_HEADER_SIZE)
+        header_size_ptr = ctypes.c_uint32()
+        # populate header fields in reader
+        rv = xrif.xrif_read_header(self._reader, header_size_ptr, buf)
+        assert header_size_ptr.value == xrif.XRIF_HEADER_SIZE
+        if rv != xrif.XRIF_NOERROR:
+            raise RuntimeError("XRIF error reading header, check stderr")
+
+
+        rv = xrif.xrif_allocate_reordered(self._reader)
+        if rv != xrif.XRIF_NOERROR:
+            raise RuntimeError("XRIF error allocating reordered buffer")
+
+        # xrif can save you a buffer by decompressing into the raw buffer but that
+        # means it needs to be bigger than just `compressed_size`
+        min_buf_size = xrif.xrif_min_raw_size(self._reader)
+        # we need to own the raw (and then decompressed) buffer
+        buf = ctypes.c_buffer(min_buf_size)
+        # we're only filling the first `compressed_size` bytes
+        buf[:self._reader.contents.compressed_size] = self.fh.read(self._reader.contents.compressed_size)
+        # acquaint xrif with our arrangements
+        rv = xrif.xrif_set_raw(self._reader, buf, min_buf_size)
+
+        if rv != xrif.XRIF_NOERROR:
+            raise RuntimeError("XRIF error setting raw buffer, check stderr")
+
+        # do the business
+        xrif.xrif_decode(self._reader)
+
+        if rv != xrif.XRIF_NOERROR:
+            raise RuntimeError("XRIF decode error, check stderr")
+
+        # Now we need to make it intelligible to Python code.
+        # Fortunately xrif's data types are all available in NumPy
+        dtype = XRIF2NUMPY_DTYPE[self._reader.contents.type_code]
+
+        # figure out how many bytes it is now that it's decompressed
+        raw_size = self._reader.contents.width * self._reader.contents.height * self._reader.contents.depth * self._reader.contents.frames * self._reader.contents.data_size
+
+        # make a NumPy array from a buffer
+        self._decoded = np.frombuffer(buf[:raw_size], dtype).reshape(self.shape)
+        self._decoded.setflags(write=False)
+
+    @property
+    def array(self) -> np.ndarray:
+        return self._decoded
+
+    def copy_data(self) -> np.ndarray:
+        arr = self.array.copy()
+        arr.setflags(write=True)
+        return arr
+
+def xrif2numpy(fh):
+    reader = XrifReader(fh)
+    print(reader.describe())
+    return reader.copy_data()

fixr-0.1.0/src/fixr.egg-info/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.1
+Name: fixr
+Version: 0.1.0
+Summary: Python bindings to xrif, the extreme reordered image format
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# fiXr
+
+Open xrif archives from Python directly using the [xrif](https://github.com/jaredmales/xrif) library.
+
+## Example
+
+```python
+from fixr import xrif2numpy
+fh = open('camwfs_20240315225750994842000.xrif', 'rb')
+data = xrif2numpy(fh)
+timings = xrif2numpy(fh)
+```

fixr-0.1.0/src/fixr.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+setup.py
+src/fixr/__init__.py
+src/fixr.egg-info/PKG-INFO
+src/fixr.egg-info/SOURCES.txt
+src/fixr.egg-info/dependency_links.txt
+src/fixr.egg-info/top_level.txt

fixr-0.1.0/src/fixr.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fixr-0.1.0/src/fixr.egg-info/top_level.txt

@@ -0,0 +1 @@
+fixr