# HG changeset patch
# User Sebastien Jodogne <s.jodogne@gmail.com>
# Date 1638012711 -3600
# Node ID ec1e9571b6455811c88f4a0276d3837cbc4e3966
# Parent  f3f93695d6df86dc94cb39b2d5a76bda3dcb522e
document number of dimensions in numpy arrays

diff -r f3f93695d6df -r ec1e9571b645 OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp
--- a/OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp	Sat Nov 27 12:27:01 2021 +0100
+++ b/OrthancServer/Sources/OrthancRestApi/OrthancRestResources.cpp	Sat Nov 27 12:31:51 2021 +0100
@@ -1259,7 +1259,8 @@
       call.GetDocumentation()
         .SetTag("Instances")
         .SetSummary("Decode frame for numpy")
-        .SetDescription("Decode one frame of interest from the given DICOM instance, for use with numpy in Python")
+        .SetDescription("Decode one frame of interest from the given DICOM instance, for use with numpy in Python. "
+                        "The numpy array has 3 dimensions: (height, width, color channel).")
         .SetUriArgument("frame", RestApiCallDocumentation::Type_Number, "Index of the frame (starts at `0`)");
     }
     else
@@ -1296,7 +1297,8 @@
       call.GetDocumentation()
         .SetTag("Instances")
         .SetSummary("Decode instance for numpy")
-        .SetDescription("Decode the given DICOM instance, for use with numpy in Python");
+        .SetDescription("Decode the given DICOM instance, for use with numpy in Python. "
+                        "The numpy array has 4 dimensions: (frame, height, width, color channel).");
     }
     else
     {
@@ -1335,7 +1337,8 @@
       call.GetDocumentation()
         .SetTag("Series")
         .SetSummary("Decode series for numpy")
-        .SetDescription("Decode the given DICOM series, for use with numpy in Python");
+        .SetDescription("Decode the given DICOM series, for use with numpy in Python. "
+                        "The numpy array has 4 dimensions: (frame, height, width, color channel).");
     }
     else
     {