added documentation

This commit is contained in:
sakul-45 2021-07-15 18:31:33 +02:00
parent 82852adbbe
commit e7c2532581

View File

@ -1,7 +1,19 @@
function [params] = simulation_TREPR(params)
%SIMULATION_TREPR Summary of this function goes here
%SIMULATION_TREPR uses esfit to perform fitting of TREPR simulation
%
% Detailed explanation goes here
% Usage: [params] = SIMULATION_TREPR(params), where params is a struct
% created by the PRE_SIMULATION_TREPR function.
%
% This function will show the mean of maxima, specified in the
% NORMALIZE_DATA function and allow inputs for Variation limits of
% relevant parameters for the simulations and for fitting options.
% "Start Fit" will call esfit and perform the specified fitting. For
% possible values, please refer to the easyspin docs.
% "Save Parameters" will write the current best fitting simulation
% parameters as starting values for a possible next iteration of fitting
% and also write them to the params struct. The button may only be
% pressed after performing at least one iteration of fitting.
% "Done" will close the window.
%% setup
%create struct for passing data between callbacks