Added example structure of params to documentation

This commit is contained in:
sakul-45 2021-07-10 13:16:29 +02:00
parent 7c143300f0
commit 8f4ea8c6ed
2 changed files with 40 additions and 0 deletions

View File

@ -10,6 +10,26 @@ function [Data,params] = load_bruker(path)
% in the command window when calling the function.
%
% Note that this funtion is dependent on easyspin.
%
% Example for params output:
% params =
%
% struct with fields:
%
% Field_Center: 3500
% Field_Sweep: 3400
% Field_Step: 5
% Accumulations: 100
% laser_shotreprate: 20
% Field_Start: 1800
% Field_End: 5200
% Field_Vector: [1×681 double]
% mwFreq: 9.6845
% mwPower: 0.2000
% QValue: 22800
% mwAtten: 30
% mwFreqs: [681×1 double]
% Name: "/some/path"
%correct \ for /
corrpath = replace(path,"\","/");

View File

@ -6,6 +6,26 @@ function [Data,params] = load_matlab(path)
% Input has to be the full path to file with forwardslashes as char or
% string. The extracted name is appended to the 'params' struct, whos
% contents are displayed in the command window afterwards.
%
% Example for params output:
% params =
%
% struct with fields:
%
% Field_Center: 3500
% Field_Sweep: 3400
% Field_Step: 5
% Accumulations: 100
% laser_shotreprate: 20
% Field_Start: 1800
% Field_End: 5200
% Field_Vector: [1×681 double]
% mwFreq: 9.6845
% mwPower: 0.2000
% QValue: 22800
% mwAtten: 30
% mwFreqs: [681×1 double]
% Name: "/some/path"
%correct \ for /
corrpath = replace(path,"\","/")