Commit 9cbfab1c authored by Simon Maretzke's avatar Simon Maretzke
Browse files

Updated docu and example

parent 23eff510
......@@ -28,7 +28,7 @@ function result = ball(N, settings)
%
% See also
% --------
% functions.generators.create3Dphantom
% functions.generators.cuboid, functions.generators.gaussian, functions.generators.create3Dphantom
%
% Example
% -------
......@@ -37,21 +37,21 @@ function result = ball(N, settings)
%
% % Example 1: (default) centered circle that just fits into image
% phantom = ball([177,228]);
% showImage(phantom)
% figure('name', 'Example 1'); showImage(phantom);
%
% % Example 2: shifted circle of fixed diameter, output as an array of logicals
% settings.diameter = 100;
% settings.center = [0,22];
% settings.outputClass = 'logical';
% phantom = ball([177,228], settings);
% showImage(phantom)
% disp(class(phantom));
% figure('name', 'Example 2'); showImage(phantom);
%
% % Example 3: ball phantom in 3D
% phantom = ball([177,228,160]);
% showStack(phantom)
% figure('name', 'Example 3'); showOrthoslices(phantom);
%
% See also CREATE3DPHANTOM
% See also CUBOID, GAUSSIAN, CREATE3DPHANTOM
% HoloTomoToolbox
% Copyright (C) 2019 Institut fuer Roentgenphysik, Universitaet Goettingen
......@@ -68,8 +68,6 @@ function result = ball(N, settings)
%
% You should have received a copy of the GNU General Public License
% along with this program. If not, see <http://www.gnu.org/licenses/>.
%
% Last modified on May 15 2019 by Simon Maretzke
% Default settings
defaults.center = [];
......
......@@ -26,6 +26,10 @@ function result = gaussian(N, settings)
% result : numerical array
% created gaussian phantom
%
% See also
% --------
% functions.generators.cuboid, functions.generators.ball
%
% Example
% -------
%
......@@ -36,11 +40,13 @@ function result = gaussian(N, settings)
% settings.center = [0,10];
% settings.sigma = [10,50];
% phantom = gaussian(N, settings);
% showImage(phantom)
% figure('name', 'Example 1'); showImage(phantom)
%
% % Example 2: Gaussian in 3D
% phantom = gaussian([177,228,160]);
% showStack(phantom);
% figure('name', 'Example 2'); showOrthoslices(phantom);
%
% See also BALL, CUBOID
% HoloTomoToolbox
% Copyright (C) 2019 Institut fuer Roentgenphysik, Universitaet Goettingen
......@@ -66,7 +72,6 @@ if nargin == 0
return
end
% Apply defaults where necessary
if nargin < 2
settings = struct;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment