Correcting several typos in descriptions of functions

LucaDeSiena · Jun 5, 2024 · 44285cb · 44285cb
1 parent c9904fe
commit 44285cb
Show file tree

Hide file tree

Showing 13 changed files with 33 additions and 24 deletions.
diff --git a/bin/Murat_checks.m b/bin/Murat_checks.m
@@ -1,9 +1,7 @@
 % ADDITIONAL input variables that are not set by the user.
 function Murat                  =   Murat_checks(Murat)
 
-% INPUTS
-%dataDirectory                   =   ['./' Murat.input.dataDirectory];
-dataDirectory                   =   [Murat.input.dataDirectory]; %if data is outside of current folder
+dataDirectory                   =   [Murat.input.dataDirectory];
 FPath                           =   './';
 FLabel                          =   Murat.input.label;
 PTime                           =   ['SAChdr.times.' Murat.input.PTime];

diff --git a/bin/Murat_cornering.m b/bin/Murat_cornering.m
@@ -14,8 +14,8 @@
 % Output parameters:
 %    ip:        index of minimum x grid coord - West;
 %    jp:        index of minimum y grid coord - South;
-%    kp:     i  ndex of maximum z grid coord - shallowest.
-
+%    kp:        index of maximum z grid coord - shallowest.
+%    flag:      flags if ray outside of grid
 
 % Coordinates of the propagation grid are unwrapped
 xGrid                       =   gridD.x;

diff --git a/bin/Murat_dataWarning.m b/bin/Murat_dataWarning.m
@@ -19,6 +19,7 @@
 %    rapspcn:           coda to noise ratio
 %    comp:           	components
 %    flag:           	flag to change between one or more components
+%    QcM:           	chosen method to measure Qc between Lin e NonLin
 %
 % Output parameters:
 %    problempd:         stores the data not used because of peak delays

diff --git a/bin/Murat_declustering.m b/bin/Murat_declustering.m
@@ -1,11 +1,14 @@
 function Murat = Murat_declustering(Murat,factor)
 % function Murat = Murat_declustering(Murat,factor)
 %
-% PLOTS rays before and after declustering
+% SAVES declustered variables and PLOTS rays before and after declustering.
+% The declustering is based on dividing the original grid into finer node
+% spacing and selecting those with the best coda decay. 
 %
 % Input parameters:
 %    Murat:                Murat structure variable
-%    factor:               factor by which original grid is divided into
+%    factor:               input factor used to divide the original grid
+
 components                  =   Murat.input.components;
 origin                      =   Murat.input.origin;
 ending                      =   Murat.input.end;

diff --git a/bin/Murat_image3D.m b/bin/Murat_image3D.m
@@ -1,7 +1,7 @@
 function [image,mVp,xp,yp,zp,Xp,Yp,Zp]                    = ...
     Murat_image3D(X,Y,Z,V,color,sections,evestaz,x,y,z,divi,name)
 % function image          = ...
-%     Murat_image3D(X,Y,Z,V,color,sections,evestaz,x,y,z,name)
+%     Murat_image3D(X,Y,Z,V,color,sections,evestaz,x,y,z,divi,name)
 %
 % PLOTS a 3D image of a field on slices.
 %
@@ -50,13 +50,13 @@
 if max_scale            <   1
     max_scale           =   round(max_scale,2);
     if max_scale        ==  0
-        caxis([-1 1])
+        clim([-1 1])
     else
-        caxis([-max_scale max_scale])
+        clim([-max_scale max_scale])
     end
 elseif max_scale        >   5
     max_scale           =   ceil(max_scale);
-    caxis([-max_scale max_scale])
+    clim([-max_scale max_scale])
 end
 
 colormap(color);

diff --git a/bin/Murat_image3D_2panels.m b/bin/Murat_image3D_2panels.m
@@ -1,7 +1,7 @@
 function image          = ...
     Murat_image3D_2panels(X,Y,Z,V,color,sections,evestaz,x,y,z)
 % function image          = ...
-%     Murat_image3D(X,Y,Z,V,color,sections,evestaz,x,y,z,name)
+%     Murat_image3D(X,Y,Z,V,color,sections,evestaz,x,y,z)
 %
 % PLOTS a 3D image of a field on slices on two subpanels.
 %
@@ -16,7 +16,6 @@
 %    x:         x vector
 %    y:         y vector
 %    z:         z vector
-%    name:      name of the title of the figure
 %
 % Output parameters:
 %    image:     image produced in one panel

diff --git a/bin/Murat_image3Dparameters.m b/bin/Murat_image3Dparameters.m
@@ -46,10 +46,10 @@
 max_scale               =   max(scale_mVp);
 if max_scale            <   1
     max_scale           =   round(max_scale,2);
-    caxis([-max_scale max_scale])
+    clim([-max_scale max_scale])
 elseif max_scale        >   5
     max_scale           =   ceil(max_scale);
-    caxis([-max_scale max_scale])
+    clim([-max_scale max_scale])
 end
 
 colormap(color);

diff --git a/bin/Murat_imageCheckQc.m b/bin/Murat_imageCheckQc.m
@@ -12,7 +12,7 @@
 %    Ac:            inverse coda attenuation matrix
 %    sizeTitle:     size of title font
 %    Qc_title:      title of Qc figure
-%    QcM:           Linearized or Non Linear measurement
+%    QcM:           Linearized or Non Linear Qc measurement
 %
 % Output parameters:
 %    Qc_analysis:   figure for Qc check

diff --git a/bin/Murat_imageDeclustering.m b/bin/Murat_imageDeclustering.m
@@ -1,7 +1,7 @@
 function clustering       =   Murat_imageDeclustering(locDegOriginal,...
     locDegrees,origin,ending,name)
 % function clustering       =...
-%     Murat_imageDeclustering(locDegOriginal,locDegrees,origin,ending)
+%     Murat_imageDeclustering(locDegOriginal,locDegrees,origin,ending,name)
 %
 % PLOTS 2D rays before and after declustering.
 %

diff --git a/bin/Murat_imageParameters.m b/bin/Murat_imageParameters.m
@@ -10,6 +10,7 @@
 %    z:                 z vector
 %    modv_pd_k:         results of peak delay imaging
 %    modv_Qc_k:         results of Qc imaging
+%    sizeTitle:         size of the title font
 %
 % Output parameters:
 %    image:             image produced

diff --git a/bin/Murat_imageParametersMaps.m b/bin/Murat_imageParametersMaps.m
@@ -5,18 +5,24 @@
 %     Murat_imageParametersMaps(par,para_map,x,y,z,X,Y,Z,evestaz_Qc,...
 %     sections,sizeTitle,FName_Parameters)
 %
-% PLOTS the parameter models in their space and on a 3D map
+% PLOTS the parameter models in a 3D map
 %
 % Input parameters:
+%    par:               condition on the parameters to image
+%    para_map:          parameter map
 %    x:                 x vector
 %    y:                 y vector
 %    z:                 z vector
-%    modv_pd_k:         results of peak delay imaging
-%    modv_Qc_k:         results of Qc imaging
+%    X:                 X matrix
+%    y:                 Y matrix
+%    z:                 Z matrix
+%    evestaz_Qc:        events and stations for Qc
+%    sections:          input sections
+%    sizeTitle:         font size for title
+%    FName_Parameters:  title of the image
 %
 % Output parameters:
-%    image:             image produced
-%    para_condition:    condition on the parameters to image
+%    ParaMap:           parameter map 3D image
 %    para_map:          parameter map
 
 for n = 1:length(par(:,1))

diff --git a/bin/Murat_modv1D.m b/bin/Murat_modv1D.m
@@ -1,7 +1,7 @@
 function [modv,pvel,modvPlot]...
                             =...
                             Murat_modv1D(modvXYZ,modvOriginal,PorS,origin)
-% function [modv,pvel]      =...
+% function [modv,pvel,modvPlot]=...
 %                           Murat_modv1D(modvXYZ,modvOriginal,PorS,origin)
 % CREATES the velocity models when using a 1D input
 %
@@ -14,6 +14,7 @@
 % Output parameters:
 %    modv:                  propagation and inversion velocity model
 %    pvel:                  propagation velocity model in matrix
+%    modvPlot:              velocity model to be plot
 
 modv                        =   modvXYZ;
 z1D                         =   -modvOriginal(:,1)*1000;
@@ -42,4 +43,3 @@
 modvPlot                    =   [lon2 lat2 modv(:,3:4)];
 
 end
-
diff --git a/bin/Murat_modv3D.m b/bin/Murat_modv3D.m
@@ -13,6 +13,7 @@
 %    mLon:                  min/max longitudes of earthquakes
 %    nLat:                  number nodes latitude
 %    nLon:                  number nodes longitude
+%    nzc:                   number nodes vertical
 %
 % Output parameters:
 %    modvP:                 propagation velocity model in standard format