Mercurial > hg > orthanc-stone

diff Framework/Volumes/ImageBuffer3D.h @ 1488:7f16987131e1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Missing include + docs + public getter for volume geometry in multiframe loader
author Benjamin Golinvaux <bgo@osimis.io>
date Tue, 23 Jun 2020 13:44:23 +0200
parents 30deba7bc8e2
children
line wrap: on
line diff
--- a/Framework/Volumes/ImageBuffer3D.h	Tue Jun 23 07:50:14 2020 +0200
+++ b/Framework/Volumes/ImageBuffer3D.h	Tue Jun 23 13:44:23 2020 +0200
@@ -29,6 +29,44 @@
 
 namespace OrthancStone
 {
+  /*
+
+  This classes stores volume images sliced across the Z axis, vertically, in the decreasing Z order :
+
+  +---------------+
+  |               |
+  |   SLICE N-1   |
+  |               |
+  +---------------+
+  |               |
+  |   SLICE N-2   |
+  |               |
+  +---------------+
+  |               |
+  |   SLICE N-3   |
+  |               |
+  .               .
+  ......     ......
+  .               .
+  |               |
+  |   SLICE   2   |
+  |               |
+  +---------------+
+  |               |
+  |   SLICE   1   |
+  |               |
+  +---------------+
+  |               |
+  |   SLICE   0   |
+  |               |
+  +---------------+
+
+  As you can see, if the 3d image has size width, height, depth, the 2d image has :
+  - 2d width  = 3d width
+  - 2d height = 3d height * 3d depth
+
+  */
+
   class ImageBuffer3D : public boost::noncopyable
   {
   private: