Skip to content

Adding documentation template to function electrodePointCloudModelEstimate #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Daniel-Tojal wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Adding documentation template to function electrodePointCloudModelEstimate #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 25 additions & 11 deletions src/Functions/electrodePointCloudModelEstimate.m
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,31 @@
%% electrodePointCloudModelEstimate - extract skeleton points from given pointcloud and subsequently fit a polynomial
function [r3polynomial, tPerMm, skeleton, totalLengthMm] = electrodePointCloudModelEstimate(elecPointCloudMm, varargin)
% electrodePointCloudModelEstimate - extract skeleton points from given pointcloud and subsequently fit a polynomial
%
% USAGE:
%
% [r3polynomial, tPerMm, skeleton, totalLengthMm] = electrodePointCloudModelEstimate(elecPointCloudMm, varargin)
%
% PARAMETERS
% varargin{1} = pixelValues list got from reference image of the segmentation. When given used for intensity based
% weightig of cenroid calculation.
% varargin{2} = reverse Z direction (for special cases, e.g. certain phantom studies)
% INPUTS:
% elecPointCloudMm:
% varargin:
%
% OPTIONAL INPUTS:
% varargin Two parameters:
%
% * varargin{1} - pixelValues list received from reference image of the segmentation. When given, used for intensity based weighting of cenroid calculation.
% * varargin{2} - reverse Z direction (for special cases, e.g. certain phantom studies)
%
% Andreas Husch
% Centre Hospitalier de Luxembourg / Luxembourg Centre for Systems
% Biomedicine, University of Luxembourg
% 2014 - 2017
% mail@andreashusch.de
% OUTPUTS:
% r3polynomial:
% tPerMm:
% skeleton:
% totalLengthMm:
%
% .. AUTHOR:
% - Andreas Husch, Original file
% - Daniel Duarte, Documentation


function [r3polynomial, tPerMm, skeleton, totalLengthMm] = electrodePointCloudModelEstimate(elecPointCloudMm, varargin)
revDir = false;
INTERNAL_DEGREE = 8; % fixed, determined as sufficient by AIC analysis

Expand Down