changeset 1785:58bebc904191

notes in ImageBuffer3D
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 14 May 2021 19:07:51 +0200
parents 42a2880d690f
children 748bfa7df18b
files OrthancStone/Sources/Volumes/ImageBuffer3D.h
diffstat 1 files changed, 16 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- 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):
 
   +---------------+
   |               |