{"id":46417,"library":"spatial-image","title":"spatial-image","description":"A multi-dimensional spatial image data structure for scientific Python, providing SpatialImage class with coordinate metadata. Current version 1.2.3. Released approximately monthly.","status":"active","version":"1.2.3","language":"python","source_language":"en","source_url":"https://github.com/spatial-image/spatial-image","tags":["spatial","image","coordinates","scientific"],"install":[{"cmd":"pip install spatial-image","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Array operations","package":"numpy","optional":false},{"reason":"Optional integration for labeled arrays","package":"xarray","optional":true}],"imports":[{"note":"Package name uses dash, not underscore","wrong":"from spatialimage import SpatialImage","symbol":"SpatialImage","correct":"from spatial_image import SpatialImage"},{"note":"Function renamed in older versions","wrong":"from spatial_image import to_spatial","symbol":"to_spatial_image","correct":"from spatial_image import to_spatial_image"}],"quickstart":{"code":"import numpy as np\nfrom spatial_image import SpatialImage, to_spatial_image\n\n# Create a simple 2D image\narray = np.random.rand(64, 64)\nspatial = to_spatial_image(array, dims=('y', 'x'))\nprint(spatial)\n\n# Access coordinates\nprint(spatial.coords)  # xarray coordinates\n\n# Convert back to numpy\noutput = np.array(spatial.data)\n","lang":"python","description":"Create a spatial image from a numpy array and inspect its coordinates."},"warnings":[{"fix":"Use `from spatial_image import SpatialImage` instead of `from spatial_image.spatial_image import SpatialImage`.","message":"Version 1.0 removed the `spatial_image.spatial_image` module and replaced it with `spatial_image.SpatialImage`. Code importing from the old path will fail.","severity":"breaking","affected_versions":"<1.0.0"},{"fix":"Ensure the length of `dims` tuple equals the number of array dimensions.","message":"The `dims` parameter in `to_spatial_image` must match the number of axes. Passing incorrect dimension names (e.g., 'x' for a 3D array) will raise a ValueError.","severity":"gotcha","affected_versions":">=0.1.0"},{"fix":"Replace `spatial_image.to_xarray()` with `spatial_image.to_xarray_dataarray()`.","message":"The `SpatialImage.to_xarray()` method is deprecated in favor of `SpatialImage.to_xarray_dataarray()` (note the 'dataarray' suffix).","severity":"deprecated","affected_versions":">=1.2.0"}],"env_vars":null,"search_vec":"'1.2.3':23 'approxim':25 'class':17 'coordin':19,29 'current':21 'data':10 'dimension':7 'imag':3,9,28 'metadata':20 'month':26 'multi':6 'multi-dimension':5 'provid':15 'python':14 'releas':24 'scientif':13,30 'spatial':2,8,27 'spatial-imag':1 'spatialimag':16 'structur':11 'version':22","created_at":"2026-06-07T12:59:49.450361+00:00","updated_at":"2026-06-07T12:59:49.450361+00:00","problems":[{"fix":"Use `from spatial_image import SpatialImage`","cause":"Old import path from versions <1.0.0","error":"ImportError: cannot import name 'SpatialImage' from 'spatial_image.spatial_image'"},{"fix":"Ensure `dims` tuple has the same length as the number of axes in the input array.","cause":"Mismatch between number of dimension names and array axes","error":"ValueError: dims length (2) does not match array dimensions (3)"},{"fix":"Use `spatial_image.to_xarray_dataarray()` instead.","cause":"Using deprecated method in newer version","error":"AttributeError: 'SpatialImage' object has no attribute 'to_xarray'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":null,"github":null,"docs":null,"changelog":null,"pypi":null,"npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["analytics"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"passing","verified_at":"2026-06-29","last_verified":"2026-06-29","next_check":"2026-07-29","install_tag":null}}