Small documentation issues

Wrong Input/Output variables in the descriptions.
LucaDeSiena · May 21, 2024 · 4f9e2cb · 4f9e2cb
1 parent 907a735
commit 4f9e2cb
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 28 deletions.
diff --git a/bin/Murat_imageCheckCN.m b/bin/Murat_imageCheckCN.m
@@ -6,17 +6,14 @@
 % PLOTS the Qc checks
 %
 % Input parameters:
-%    rtQk:          retained Q data
-%    cfk:           central frequency
-%    outputLCurve:  decide if you want to see the L curve
-%    energyRatio_k: energy ratios at all frequencies
-%    residualQ_k:   residuals of Q inversions
-%    const_Qc_k:    the constants coming from Qc analysis
+%    equationQ:     sum of all three terms of the CN equation for average Q
+%    d1:            data for average Q inversion
+%    spreadAverageQ:values of average spreading and Q for labels
+%    luntot_k:      total length of ray
+%    time0_k:       travel time
+%    energyRatio_k: energy ratios
+%    A_k:         	CN inversion matrix
 %    Edirect_k:     direct energy
-%    luntot:        total length of ray
-%    time0:         travel time
-%    A_i:         	CN inversion matrix
-%    lcurveQ:       damping parameter
 %    CN_title:      title of the figure
 %
 % Output parameters:

diff --git a/bin/Murat_lsqlinQmean.m b/bin/Murat_lsqlinQmean.m
@@ -6,25 +6,21 @@
 % INVERTS with weighted tikhonov and creates L-curve and data for Q.
 %
 % Input parameters:
-%    cfk:           central frequency
-%    rtQ:           selected Q waveforms
-%    outputLCurve:  flag to output the L curve
-%    rapsp_k:       energy ratios
-%    const_Qc_k:    constant from the average Qc
-%    luntot:        total length
-%    time0:         travel time
-%    A:             CN inversion matrix
-%    lCurveQ:       damping parameter input from start
-%    flagShow:      flag to decide if show L-curve
-%
+%    tCm:           lapse time
+%    tWm:           coda window
+%    Q_k:           inverse Qc
+%    cf_k:          central frequency
+%    sped:          spectral decay
+%    luntot_k:      total ray length
+%    time0_k:       total travel time
+%    rapsp_k:       energy ratio
+%    
 % Output parameters:
-%    mtik0:         inversion parameter
-%    residualQ_k:   residuals for Q inversion
-%    LcCN:          figure of L curve for the CN method
-%    tik0_reg:      regularization parameters
-%    d1k:           data of the inversion
-%    constQmean_k:  constant for the method
-
+%    d1:            data for average Q inversion
+%    const_Qc_k:    constant for average Q inversion depending on Qc
+%    constQmean_k:  average geometrical spreading and Q
+%    equationQ:     sum of all three terms of the CN equation
+%
 %%
 % Data creation for the true inversion, removing the pre-calculated
 % parameters.