update: 1.0.2; Interface cleanup; Documentation fixes; Added ijk2xyz and xyz2ijk functions

Author: Plasma-Blue

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "nii-rs"
-version = "0.1.1"
+version = "0.1.2"
 edition = "2021"
 license = "MIT OR Apache-2.0"
 description = "Rust library for reading/writing NIfTI files, with SimpleITK/Nibabel-like APIs, native Rust support, and Python bindings for cross-language performance."
@@ -27,6 +27,6 @@ nifti = { version = "0.16.0", features = [
 ] }
 num-traits = "0.2.19"
 rayon = "1.10.0"
-simba = "0.8.1"
+simba = "0.9.0"
 numpy = "0.23.0"
 paste = "1.0.15"

Cargo.toml

@@ -2,23 +2,36 @@
 
 Rust library for reading/writing NIfTI-1 (nii.gz) files, with SimpleITK/NiBabel-like APIs, native Rust support, and Python bindings for cross-language performance.
 
-If you have used SimpleITK/NiNabel, you will definitely love this and get started right away! 🕶
+If you have used SimpleITK/NiBabel, you will definitely love this and get started right away! 🕶
 
 ## 🎨Features
 
 - 🚀**Pure Rust Implementation**: Thanks to [nifti-rs](https://github.com/Enet4/nifti-rs), I/O speed is comparable to SimpleITK and slightly faster than NiBabel.
 
-- ✨ **Carefully Designed API**: *Super easy to use*, with no learning curve; enjoy a consistent experience in Rust as in Python.
+- ✨ **Carefully Designed API**: _Super easy to use_, with no learning curve; enjoy a consistent experience in Rust as in Python. Ideal for developers familiar with ITK-style libraries.
 
-- 🛠️**Rust-Python bindings**: you can write heavy operations in Rust and easily call them in Python. 
+- 🛠️**Rust-Python bindings**: Write heavy operations in Rust and easily call them in Python, combining the performance of Rust with the flexibility of Python.
 
 ## 🔨Install
 
-`cargo add nii-rs` for rust project and `pip install niirs` for python.
+For Rust projects, add the following to your `Cargo.toml`:
+
+```toml
+[dependencies]
+nii-rs = "*"
+```
+
+For Python, install via pip:
+
+```sh
+pip install niirs
+```
 
 ## 🥒Develop
 
-`maturin dev`
+To start developing with nii-rs, use the following command:
+
+`maturin dev -r`
 
 ## 📘Examples
 
@@ -48,11 +61,12 @@ nii::write_image(&im, "result.nii.gz")
 ```
 
 ### 🐍Python
+
 ```python
-import niirs
+import nii
 
 # read image
-im = niirs.read_image("test.nii.gz")
+im = nii.read_image("test.nii.gz")
 
 # get attrs, style same as like SimpleITK
 spacing = im.get_spacing()
@@ -66,7 +80,7 @@ affine = im.get_affine()
 arr = im.ndarray()
 
 # write image
-niirs.write_image(im, "result.nii.gz")
+nii.write_image(im, "result.nii.gz")
 ```
 
 ## 🔒License

README.md

@@ -1,9 +1,9 @@
-import niirs
+import nii
 import numpy as np
 
 pth = rf"test_data\test.nii.gz"
 
-im = niirs.read_image(pth, dtype=np.float32)
+im = nii.read_image(pth, dtype=np.float32)
 
 # get attrs, style same as like ITK
 spacing = im.get_spacing()
@@ -20,19 +20,19 @@
 print(arr)
 
 # set attrs, style same as ITK; 
-im = niirs.read_image(pth, dtype=np.float32)
+im = nii.read_image(pth, dtype=np.float32)
 im.set_origin([0.0, 1.0, 2.0])
 im.set_spacing([1.0, 2.0, 3.0])
 im.set_direction([[1.0, 0.0, 0.0], [0.0, 1.0, 0.0], [0.0, 0.0, 1.0]])
 print(im)
 
 # or copy information from another image
-im2 = niirs.read_image(pth)
+im2 = nii.read_image(pth)
 im.copy_infomation(im2)
 
 # write image
 pth = rf"test_data\result.nii.gz"
-niirs.write_image(im, pth)
+nii.write_image(im, pth)
 
 # get affine, if you are more familiar with affine matrix
 # nibabel style
@@ -41,15 +41,15 @@
 
 # make new image, based on ndarray + affine
 # nibabel style
-new_affine = im.get_affine();
-new_arr = im.ndarray();
-new_im = niirs.new(new_arr, new_affine);
-print(new_im);
+new_affine = im.get_affine()
+new_arr = im.ndarray()
+new_im = nii.new(new_arr, new_affine)
+print(new_im)
 
 # or simpleitk style
 new_arr = im.ndarray()
-new_im = niirs.get_image_from_array(new_arr);
-new_im.copy_infomation(im);
-print(new_im);
+new_im = nii.get_image_from_array(new_arr)
+new_im.copy_infomation(im)
+print(new_im)
 
 # that's all

examples/tutorial.py

@@ -1,9 +1,9 @@
+use ndarray::{Array2, Array3};
 use nii;
-use ndarray::{Array3, Array2};
 
-fn main () {
+fn main() {
     let pth = r"test_data\test.nii.gz";
-    
+
     // Read Image, needs to specific type, eg: f32, u8, ...
     let im = nii::read_image::<f32>(pth);
 
@@ -12,7 +12,10 @@ fn main () {
     let origin: [f32; 3] = im.get_origin();
     let direction: [[f32; 3]; 3] = im.get_direction();
     let size: [u16; 3] = im.get_size();
-    println!("spacing: {:?}, origin: {:?}, direction: {:?}, size: {:?}", spacing, origin, direction, size);
+    println!(
+        "spacing: {:?}, origin: {:?}, direction: {:?}, size: {:?}",
+        spacing, origin, direction, size
+    );
 
     // or print directly
     println!("{:?}", im);
@@ -25,7 +28,7 @@ fn main () {
     let arr: Array3<f32> = im.into_ndarray();
     println!("{:?}", arr);
 
-    // set attrs, style same as ITK; 
+    // set attrs, style same as ITK;
     // let im as **mut**
     let mut im = nii::read_image::<f32>(pth);
     im.set_origin([0.0, 1.0, 2.0]);
@@ -60,5 +63,4 @@ fn main () {
     println!("{:?}", new_im);
 
     // That's all
-
-}
+}

examples/tutorial.rs

@@ -16,4 +16,4 @@ readme = "README.md"
 [tool.maturin]
 features = ["pyo3/extension-module"]
 python-source = "python"
-module-name = "niirs._niirs"
+module-name = "nii._nii"