]> Creatis software - creaRigidRegistration.git/blobdiff - PackRecalage/src/bbPackRecalageCalculateVectorBox.h
Feature #1766 Add licence terms for all files.
[creaRigidRegistration.git] / PackRecalage / src / bbPackRecalageCalculateVectorBox.h
index cf0922eb679ea9d91c2aff5e7ed54632117fa0f6..70ac9a9ad96309b54305cba99286788fe6ac436a 100644 (file)
@@ -1,9 +1,37 @@
+/*
+# ---------------------------------------------------------------------
+#
+# Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image 
+#                        pour la Santé)
+# Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+#
+#  This software is governed by the CeCILL-B license under French law and 
+#  abiding by the rules of distribution of free software. You can  use, 
+#  modify and/ or redistribute the software under the terms of the CeCILL-B 
+#  license as circulated by CEA, CNRS and INRIA at the following URL 
+#  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html 
+#  or in the file LICENSE.txt.
+#
+#  As a counterpart to the access to the source code and  rights to copy,
+#  modify and redistribute granted by the license, users are provided only
+#  with a limited warranty  and the software's author,  the holder of the
+#  economic rights,  and the successive licensors  have only  limited
+#  liability. 
+#
+#  The fact that you are presently reading this means that you have had
+#  knowledge of the CeCILL-B license and that you accept its terms.
+# ------------------------------------------------------------------------   
+*/
+
+
 #ifndef __bbPackRecalageCalculateVectorBox_h_INCLUDED__
 #define __bbPackRecalageCalculateVectorBox_h_INCLUDED__
 #include "bbPackRecalage_EXPORT.h"
 #include "bbtkAtomicBlackBox.h"
 #include "iostream"
 
+#include "PlanesOperations.h"
+
 namespace bbPackRecalage
 {
 
@@ -12,23 +40,57 @@ class bbPackRecalage_EXPORT CalculateVectorBox
    public bbtk::AtomicBlackBox
 {
   BBTK_BLACK_BOX_INTERFACE(CalculateVectorBox,bbtk::AtomicBlackBox);
+
+  /*Points in X for the first vector (the vector in the first image), this array should have the structure (a,b), "a" being the position in X for the starting point of the vector
+       and "b" the position in X for the ending point of the vector */
   BBTK_DECLARE_INPUT(PointsX1,std::vector<int>);
+  
+  /*Points in X for the second vector (the vector in the second image), this array should have the structure (a,b), "a" being the position in X for the starting point of the vector
+       and "b" the position in X for the ending point of the vector */
   BBTK_DECLARE_INPUT(PointsX2,std::vector<int>);
+
+  /*Points in Y for the first vector (the vector in the first image), this array should have the structure (a,b), "a" being the position in Y for the starting point of the vector
+       and "b" the position in Y for the ending point of the vector */
   BBTK_DECLARE_INPUT(PointsY1,std::vector<int>);
+
+  /*Points in Y for the second vector (the vector in the second image), this array should have the structure (a,b), "a" being the position in Y for the starting point of the vector
+       and "b" the position in Y for the ending point of the vector */
   BBTK_DECLARE_INPUT(PointsY2,std::vector<int>);
+
+  /*Points in Z for the first vector (the vector in the first image), this array should have the structure (a,b), "a" being the position in Z for the starting point of the vector
+       and "b" the position in Z for the ending point of the vector */
   BBTK_DECLARE_INPUT(PointsZ1,std::vector<int>);
+
+  /*Points in Z for the second vector (the vector in the second image), this array should have the structure (a,b), "a" being the position in Z for the starting point of the vector
+       and "b" the position in Z for the ending point of the vector */
   BBTK_DECLARE_INPUT(PointsZ2,std::vector<int>);
-  BBTK_DECLARE_INPUT(Labels1,std::vector<std::string>);
-  BBTK_DECLARE_INPUT(Labels2,std::vector<std::string>);
-  BBTK_DECLARE_OUTPUT(OutX,int);
-  BBTK_DECLARE_OUTPUT(OutY,int);
-  BBTK_DECLARE_OUTPUT(OutZ,int);
+
+  /*Origin (starting point of the vector) of the second image, this is necesary for the translation matrix of a transform filter*/
+  BBTK_DECLARE_OUTPUT(Origin, std::vector<int>);
+
+  /*Origin (starting point of the vector) of the first image, this is necesary for the imageReslicer filter*/
+  BBTK_DECLARE_OUTPUT(OriginReslicer, std::vector<int>);
+  
+  /*The rotation axis (this axis is defined by the cross product of the 2 vectors)*/
+  BBTK_DECLARE_OUTPUT(TransformAxis, std::vector<double>);
+
+  /*Scale difference in X*/
   BBTK_DECLARE_OUTPUT(OutScaleX,int);
+
+  /*Scale difference in Y*/
   BBTK_DECLARE_OUTPUT(OutScaleY,int);
+
+  /*Scale difference in Z*/
   BBTK_DECLARE_OUTPUT(OutScaleZ,int);
+
+  /*Rotation Angle*/
   BBTK_DECLARE_OUTPUT(OutAngle,double);
   BBTK_PROCESS(Process);
   void Process();
+
+  private:
+         
+         PlanesOperations *_vector;
 };
 
 BBTK_BEGIN_DESCRIBE_BLACK_BOX(CalculateVectorBox,bbtk::AtomicBlackBox);
@@ -42,11 +104,9 @@ BBTK_INPUT(CalculateVectorBox,PointsY1,"List of points in Y for the first vector
 BBTK_INPUT(CalculateVectorBox,PointsY2,"List of points in Y for the second vector",std::vector<int>,"");
 BBTK_INPUT(CalculateVectorBox,PointsZ1,"List of points in Z for the first vector",std::vector<int>,"");
 BBTK_INPUT(CalculateVectorBox,PointsZ2,"List of points in Z for the second vector",std::vector<int>,"");
-BBTK_INPUT(CalculateVectorBox,Labels1,"Labels of the points for the first vector",std::vector<std::string>,"");
-BBTK_INPUT(CalculateVectorBox,Labels2,"Labels of the points for the second vector",std::vector<std::string>,"");
-BBTK_OUTPUT(CalculateVectorBox,OutX,"Point in X for the cross multiplication",int,"");
-BBTK_OUTPUT(CalculateVectorBox,OutY,"Point in Y for the cross multiplication",int,"");
-BBTK_OUTPUT(CalculateVectorBox,OutZ,"Point in Z for the cross multiplication",int,"");
+BBTK_OUTPUT(CalculateVectorBox,Origin,"Points of Origin for the transformation",std::vector<int>,"");
+BBTK_OUTPUT(CalculateVectorBox,OriginReslicer,"Points of Origin for the transformation for the Reslicer",std::vector<int>,"");
+BBTK_OUTPUT(CalculateVectorBox,TransformAxis,"Axis used for the transformation (Result of Cross multiplication)",std::vector<double>,"");
 BBTK_OUTPUT(CalculateVectorBox,OutScaleX,"Difference in scale for X for the cross multiplication",int,"");
 BBTK_OUTPUT(CalculateVectorBox,OutScaleY,"Difference in scale for Y for the cross multiplication",int,"");
 BBTK_OUTPUT(CalculateVectorBox,OutScaleZ,"Difference in scale for Z for the cross multiplication",int,"");