some marginal gains + added documentation

1 files changed, 109 insertions, 44 deletions

diff --git a/include/astra/ParallelBeamLinearKernelProjector2D.inl b/include/astra/ParallelBeamLinearKernelProjector2D.inl
index 79b82d4..ecbdeb3 100644
--- a/include/astra/ParallelBeamLinearKernelProjector2D.inl
+++ b/include/astra/ParallelBeamLinearKernelProjector2D.inl
@@ -25,6 +25,7 @@ along with the ASTRA Toolbox. If not, see <http://www.gnu.org/licenses/>.
 -----------------------------------------------------------------------
 $Id$
 */
+#define policy_weight(p,rayindex,volindex,weight) if (p.pixelPrior(volindex)) { p.addWeight(rayindex, volindex, weight); p.pixelPosterior(volindex); }
 
 template <typename Policy>
 void CParallelBeamLinearKernelProjector2D::project(Policy& p)
@@ -51,6 +52,79 @@ void CParallelBeamLinearKernelProjector2D::projectSingleRay(int _iProjection, in
 
 //----------------------------------------------------------------------------------------
 // PROJECT BLOCK - vector projection geometry
+// 
+// Kernel limitations: isotropic pixels (PixelLengthX == PixelLengthY)
+//
+// For each angle/detector pair:
+// 
+// Let D=(Dx,Dy) denote the centre of the detector (point) in volume coordinates, and
+// let R=(Rx,Ry) denote the direction of the ray (vector).
+// 
+// For mainly vertical rays (|Rx|<=|Ry|), 
+// let E=(Ex,Ey) denote the centre of the most upper left pixel:
+//    E = (WindowMinX +  PixelLengthX/2, WindowMaxY - PixelLengthY/2),
+// and let F=(Fx,Fy) denote a vector to the next pixel 
+//    F = (PixelLengthX, 0)
+// 
+// The intersection of the ray (D+aR) with the centre line of the upper row of pixels (E+bF) is
+//    { Dx + a*Rx = Ex + b*Fx
+//    { Dy + a*Ry = Ey + b*Fy
+// Solving for (a,b) results in:
+//    a = (Ey + b*Fy - Dy)/Ry
+//      = (Ey - Dy)/Ry
+//    b = (Dx + a*Rx - Ex)/Fx
+//      = (Dx + (Ey - Dy)*Rx/Ry - Ex)/Fx
+//
+// Define c as the x-value of the intersection of the ray with the upper row in pixel coordinates. 
+//    c = b 
+//
+// The intersection of the ray (D+aR) with the centre line of the second row of pixels (E'+bF) with
+//    E'=(WindowMinX + PixelLengthX/2, WindowMaxY - 3*PixelLengthY/2)
+// expressed in x-value pixel coordinates is
+//    c' = (Dx + (Ey' - Dy)*Rx/Ry - Ex)/Fx.
+// And thus:
+//    deltac = c' - c = (Dx + (Ey' - Dy)*Rx/Ry - Ex)/Fx - (Dx + (Ey - Dy)*Rx/Ry - Ex)/Fx
+//                    = [(Ey' - Dy)*Rx/Ry - (Ey - Dy)*Rx/Ry]/Fx
+//                    = [Ey' - Ey]*(Rx/Ry)/Fx
+//                    = [Ey' - Ey]*(Rx/Ry)/Fx
+//                    = -PixelLengthY*(Rx/Ry)/Fx.
+// 
+// Given c on a certain row, its pixel directly on its left (col), and the distance (offset) to it, can be found: 
+//    col = floor(c)
+//    offset = c - col
+//
+// The index of this pixel is
+//    volumeIndex = row * colCount + col
+//
+// The projection kernel is defined by
+//
+//                LengthPerRow
+//       /|\
+//      / | \
+//   __/  |  \__ 0
+//     p0 p1 p2
+//
+// And thus
+//    W_(rayIndex,volIndex) = (1 - offset) * lengthPerRow
+//    W_(rayIndex,volIndex+1) = offset * lengthPerRow
+//
+//
+// Mainly horizontal rays (|Rx|<=|Ry|) are handled in a similar fashion:
+//
+//    E = (WindowMinX +  PixelLengthX/2, WindowMaxY - PixelLengthY/2),
+//    F = (0, -PixelLengthX)
+//
+//    a = (Ex + b*Fx - Dx)/Rx = (Ex - Dx)/Rx
+//    b = (Dy + a*Ry - Ey)/Fy = (Dy + (Ex - Dx)*Ry/Rx - Ey)/Fy
+//    r = b
+//    deltar = PixelLengthX*(Ry/Rx)/Fy.
+//    row = floor(r+1/2)
+//    offset = r - row
+//    LengthPerCol = pixelLengthY * sqrt(Rx^2+Ry^2) / |Rx|
+//
+//    W_(rayIndex,volIndex) = (1 - offset) * lengthPerCol
+//    W_(rayIndex,volIndex+colcount) = offset * lengthPerCol
+//
 template <typename Policy>
 void CParallelBeamLinearKernelProjector2D::projectBlock_internal(int _iProjFrom, int _iProjTo, int _iDetFrom, int _iDetTo, Policy& p)
 {
@@ -63,8 +137,10 @@ void CParallelBeamLinearKernelProjector2D::projectBlock_internal(int _iProjFrom,
 	}
 
 	// precomputations
-	const float32 inv_pixelLengthX = 1.0f / m_pVolumeGeometry->getPixelLengthX();
-	const float32 inv_pixelLengthY = 1.0f / m_pVolumeGeometry->getPixelLengthY();
+	const float32 pixelLengthX = m_pVolumeGeometry->getPixelLengthX();
+	const float32 pixelLengthY = m_pVolumeGeometry->getPixelLengthY();
+	const float32 inv_pixelLengthX = 1.0f / pixelLengthX;
+	const float32 inv_pixelLengthY = 1.0f / pixelLengthY;
 	const int colCount = m_pVolumeGeometry->getGridColCount();
 	const int rowCount = m_pVolumeGeometry->getGridRowCount();
 	const int detCount = pVecProjectionGeometry->getDetectorCount();
@@ -74,21 +150,26 @@ void CParallelBeamLinearKernelProjector2D::projectBlock_internal(int _iProjFrom,
 	for (int iAngle = _iProjFrom; iAngle < _iProjTo; ++iAngle) {
 
 		// variables
-		float32 detX, detY, x, y, c, r, update_c, update_r, offset;
-		float32 lengthPerRow, lengthPerCol;
+		float32 Dx, Dy, Ex, Ey, x, y, c, r, deltac, deltar, offset;
+		float32 RxOverRy, RyOverRx, lengthPerRow, lengthPerCol;
 		int iVolumeIndex, iRayIndex, row, col, iDetector;
 
 		const SParProjection * proj = &pVecProjectionGeometry->getProjectionVectors()[iAngle];
 
 		bool vertical = fabs(proj->fRayX) < fabs(proj->fRayY);
 		if (vertical) {
+			RxOverRy = proj->fRayX/proj->fRayY;
 			lengthPerRow = m_pVolumeGeometry->getPixelLengthX() * sqrt(proj->fRayY*proj->fRayY + proj->fRayX*proj->fRayX) / abs(proj->fRayY);
-			update_c = -m_pVolumeGeometry->getPixelLengthY() * (proj->fRayX/proj->fRayY) * inv_pixelLengthX;
+			deltac = -pixelLengthY * RxOverRy * inv_pixelLengthX;
 		} else {
+			RyOverRx = proj->fRayY/proj->fRayX;
 			lengthPerCol = m_pVolumeGeometry->getPixelLengthY() * sqrt(proj->fRayY*proj->fRayY + proj->fRayX*proj->fRayX) / abs(proj->fRayX);
-			update_r = -m_pVolumeGeometry->getPixelLengthX() * (proj->fRayY/proj->fRayX) * inv_pixelLengthY;
+			deltar = -pixelLengthX * RyOverRx * inv_pixelLengthY;
 		}
 
+		Ex = m_pVolumeGeometry->getWindowMinY() + pixelLengthX*0.5f;
+		Ey = m_pVolumeGeometry->getWindowMaxY() - pixelLengthY*0.5f;
+
 		// loop detectors
 		for (iDetector = _iDetFrom; iDetector < _iDetTo; ++iDetector) {
 			
@@ -97,70 +178,54 @@ void CParallelBeamLinearKernelProjector2D::projectBlock_internal(int _iProjFrom,
 			// POLICY: RAY PRIOR
 			if (!p.rayPrior(iRayIndex)) continue;
 	
-			detX = proj->fDetSX + (iDetector+0.5f) * proj->fDetUX;
-			detY = proj->fDetSY + (iDetector+0.5f) * proj->fDetUY;
+			Dx = proj->fDetSX + (iDetector+0.5f) * proj->fDetUX;
+			Dy = proj->fDetSY + (iDetector+0.5f) * proj->fDetUY;
+
+			bool isin = false;
 
 			// vertically
 			if (vertical) {
 
-				// calculate x for row 0
-				x = detX + (proj->fRayX/proj->fRayY)*(m_pVolumeGeometry->pixelRowToCenterY(0)-detY);
-				c = (x - m_pVolumeGeometry->getWindowMinX()) * inv_pixelLengthX - 0.5f;
+				// calculate c for row 0
+				c = (Dx + (Ey - Dy)*RxOverRy - Ex) * inv_pixelLengthX;
 
-				// for each row
-				for (row = 0; row < rowCount; ++row, c += update_c) {
+				// loop rows
+				for (row = 0; row < rowCount; ++row, c += deltac) {
 
 					col = int(c);
+					if (col <= 0 || col >= colCount-1) { if (!isin) continue; else break; }
 					offset = c - float32(col);
 
-					if (col <= 0 || col >= colCount-1) continue;
-
 					iVolumeIndex = row * colCount + col;
-					// POLICY: PIXEL PRIOR + ADD + POSTERIOR
-					if (p.pixelPrior(iVolumeIndex)) {
-						p.addWeight(iRayIndex, iVolumeIndex, (1.0f - offset) * lengthPerRow);
-						p.pixelPosterior(iVolumeIndex);
-					}
+					policy_weight(p, iRayIndex, iVolumeIndex, (1.0f - offset) * lengthPerRow)
 					
 					iVolumeIndex++;
-					// POLICY: PIXEL PRIOR + ADD + POSTERIOR
-					if (p.pixelPrior(iVolumeIndex)) {
-						p.addWeight(iRayIndex, iVolumeIndex, offset * lengthPerRow);
-						p.pixelPosterior(iVolumeIndex);
-					}
+					policy_weight(p, iRayIndex, iVolumeIndex, offset * lengthPerRow)
 
+					isin = true;
 				}
 			}
 
 			// horizontally
 			else {
 
-				// calculate y for col 0
-				y = detY + (proj->fRayY/proj->fRayX)*(m_pVolumeGeometry->pixelColToCenterX(0)-detX);
-				r = (m_pVolumeGeometry->getWindowMaxY() - y) * inv_pixelLengthY - 0.5f;
+				// calculate r for col 0
+				r = -(Dy + (Ex - Dx)*RyOverRx - Ey) * inv_pixelLengthY;
 
-				// for each col
-				for (col = 0; col < colCount; ++col, r += update_r) {
+				// loop columns
+				for (col = 0; col < colCount; ++col, r += deltar) {
 
-					int row = int(r);
+					row = int(r);
+					if (row <= 0 || row >= rowCount-1) { if (!isin) continue; else break; }
 					offset = r - float32(row);
 
-					if (row <= 0 || row >= rowCount-1) continue;
-
 					iVolumeIndex = row * colCount + col;
-					// POLICY: PIXEL PRIOR + ADD + POSTERIOR
-					if (p.pixelPrior(iVolumeIndex)) {
-						p.addWeight(iRayIndex, iVolumeIndex, (1.0f - offset) * lengthPerCol);
-						p.pixelPosterior(iVolumeIndex);
-					}
+					policy_weight(p, iRayIndex, iVolumeIndex, (1.0f - offset) * lengthPerCol)
 
 					iVolumeIndex += colCount;
-					// POLICY: PIXEL PRIOR + ADD + POSTERIOR
-					if (p.pixelPrior(iVolumeIndex)) {
-						p.addWeight(iRayIndex, iVolumeIndex, offset * lengthPerCol);
-						p.pixelPosterior(iVolumeIndex);
-					}
-
+					policy_weight(p, iRayIndex, iVolumeIndex, offset * lengthPerCol)
+					
+					isin = true;
 				}
 			}