[doc] add roi intensities stats to doc

Inria-Empenn · Feb 2, 2021 · c5c5acb · c5c5acb
1 parent 440239d
commit c5c5acb
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/source/basic_processing.rst b/docs/source/basic_processing.rst
@@ -12,6 +12,17 @@ Image arithmetic
 
 	animaImageArithmetic -i Image1.nii.gz -s Image2.nii.gz -o Diff.nii.gz
 
+ROI intensities statistics
+--------------------------
+
+**animaROIIntensitiesStats** provides statistics (mean, max, median, variance) in regions of interests on an image or a list of images in a text file.
+
+*Example:* this computes the median in each label of roi_image.nii.gz of the input image image.nii.gz. The output is given in a csv file data.csv
+
+.. code-block:: sh
+
+	animaROIIntensitiesStats -i image.nii.gz -r roi_image.nii.gz -o data.csv -s median
+
 Image averaging
 ---------------