doc: Updated README & docstrings

README.md

@@ -6,6 +6,23 @@
 
 A wrapper for loading medical 3D image volumes such as NIFTI or NRRD images.
 
+Features:
+- Supports loading and saving of 2D, 3D and 4D Nifti and NRRD images
+    - (Saving 4D images is currently not supported due to a SimpleITK bug)
+- Simple access to image array
+- Simple access to image metadata
+    - Affine
+    - Spacing
+    - Origin
+    - Direction
+    - Translation
+    - Rotation
+    - Scale (Same as spacing)
+    - Shear
+    - Header (The raw header)
+- Copying/Modification of all or selected metadata across MedVol images
+
+
 ## Installation
 
 You can install `medvol` via [pip](https://pypi.org/project/medvol/):
@@ -23,6 +40,7 @@ image = MedVol("path/to/image.nifti")
 # Print some metadata
 print("Spacing: ", image.spacing)
 print("Affine: ", image.affine)
+print("Rotation: ", image.rotation)
 print("Header: ", image.header)
 
 # Access and modify the image array

medvol/medvol.py

@@ -6,12 +6,10 @@
 # TODO:
 # - Enable user to set affine
 #   - Reflect changes in affine in all other parameters
-# - Add affine_3d function?
-# - Create docstrings and docs
+# - Create docs
 # - Write tests
 # - Rename into MedImg
 # - Fix is_seg
-# - Fix napari-nifti loading of 2D and 4D images
 
 
 class MedVol:
@@ -122,13 +120,7 @@ def affine(self) -> np.ndarray:
 
         Returns:
             np.ndarray: The affine matrix representing the translation, scaling, and rotation of the image.
-
-        Raises:
-            ValueError: If spacing, origin, or direction are not set.
-        """
-        if self.spacing is None or self.origin is None or self.direction is None:
-            raise ValueError("Spacing, origin, and direction must all be set to compute the affine.")
-
+        """        
         affine = np.eye(self.ndims+1)
         affine[:self.ndims, :self.ndims] = self.direction @ np.diag(self.spacing)
         affine[:self.ndims, self.ndims] = self.origin
@@ -186,9 +178,6 @@ def ndims(self) -> int:
 
         Returns:
             int: The number of dimensions of the image (2D, 3D, or 4D).
-
-        Raises:
-            ValueError: If the array is not set.
         """        
         return len(self.array.shape)