Mercurial > hg > orthanc-stone

changeset 799:a6ba676a93e2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added doc
author Benjamin Golinvaux <bgo@osimis.io>
date Tue, 28 May 2019 14:13:18 +0200
parents 11fc84650e4b
children 98a89b116b62
files Framework/Volumes/VolumeImageGeometry.h
diffstat 1 files changed, 9 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/Framework/Volumes/VolumeImageGeometry.h	Tue May 28 14:13:10 2019 +0200
+++ b/Framework/Volumes/VolumeImageGeometry.h	Tue May 28 14:13:18 2019 +0200
@@ -115,6 +115,15 @@
     bool DetectProjection(VolumeProjection& projection,
                           const Vector& planeNormal) const;
 
+    /**
+    Being given a cutting plane, this method will determine if it is an
+    axial, sagittal or coronal cut and returns 
+    the slice number corresponding to this cut.
+
+    If the cutting plane is not parallel to the tree x = 0, y = 0 or z = 0
+    planes, it is considered as arbitrary and the method returns false. 
+    Otherwise, it returns true.
+    */
     bool DetectSlice(VolumeProjection& projection,
                      unsigned int& slice,
                      const CoordinateSystem3D& plane) const;