# HG changeset patch
# User Sebastien Jodogne <s.jodogne@gmail.com>
# Date 1621012071 -7200
# Node ID 58bebc9041910d4c20caf749a9cc2bed45a31f1c
# Parent  42a2880d690f1492db1af1aa5fb844e5dd6bd6a6
notes in ImageBuffer3D

diff -r 42a2880d690f -r 58bebc904191 OrthancStone/Sources/Volumes/ImageBuffer3D.h
--- a/OrthancStone/Sources/Volumes/ImageBuffer3D.h	Fri May 14 18:48:55 2021 +0200
+++ b/OrthancStone/Sources/Volumes/ImageBuffer3D.h	Fri May 14 19:07:51 2021 +0200
@@ -32,9 +32,22 @@
 {
   /*
 
-  This classes stores volume images sliced across the Z axis,
-  vertically, in the DECREASING Z-order along the normal (this is the
-  REVERSE of the intuitive order):
+    IMPORTANT: The "ImageBuffer3D" class is *not* meant to be accessed
+    directly by the end users using the "GetVoxelXXX()" methods,
+    because of the swapping of the Z-axis (see below). The public
+    interactions with this class should be limited to:
+
+    1- Using "SliceReader" and "SliceWriter" to access the raw slices,
+       but only on the axial projection, *and* using the "z"
+       coordinates returned by some "SlicesSorter" object
+
+    2- Extracting slices using a cutting plane through class deriving
+      from the "IVolumeSlicer" interface
+
+
+  IMPLEMENTATION NOTE: This classes stores volume images sliced across
+  the Z axis, vertically, in the DECREASING Z-order along the normal
+  (this is the REVERSE of the intuitive order):
 
   +---------------+
   |               |