From b3393ec49bbe2ffc3eb3b6c7512bb12b8b8d2e52 Mon Sep 17 00:00:00 2001
From: Willem Jan Palenstijn <Willem.Jan.Palenstijn@cwi.nl>
Date: Tue, 9 Jan 2018 15:45:34 +0100
Subject: Fix comments for postalignment function
---
matlab/tools/astra_geom_postalignment.m | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
(limited to 'matlab/tools')
diff --git a/matlab/tools/astra_geom_postalignment.m b/matlab/tools/astra_geom_postalignment.m
index c16f8ed..c85a7a0 100644
--- a/matlab/tools/astra_geom_postalignment.m
+++ b/matlab/tools/astra_geom_postalignment.m
@@ -5,9 +5,15 @@ function proj_geom = astra_geom_postalignment(proj_geom, factor)
%
% Apply a postalignment to a vector-based projection geometry. Can be used to model the rotation axis offset.
%
+% For 2D geometries, the argument factor is a single float specifying the
+% distance to shift the detector (measured in detector pixels).
+%
+% For 3D geometries, factor is a pair of floats specifying the horizontal
+% resp. vertical distances to shift the detector.
+%
% proj_geom: input projection geometry (vector-based only, use astra_geom_2vec to convert conventional projection geometries)
-% dim (optional): which dimension
-% s: output
+% factor: number of pixels to shift the detector
+% proj_geom: output
%--------------------------------------------------------------------------
% This file is part of the ASTRA Toolbox
%
@@ -33,4 +39,4 @@ function proj_geom = astra_geom_postalignment(proj_geom, factor)
error('Projection geometry not suited for postalignment correction.')
end
-end
\ No newline at end of file
+end
--
cgit v1.2.3