matlab func docs

Author: ZPYin

lib/io/ceilo_bsc_ModelSonde.m include/ceilo_bsc_ModelSonde.mlib/io/ceilo_bsc_ModelSonde.m renamed to include/ceilo_bsc_ModelSonde.m

@@ -1,8 +1,10 @@
 function [data] = PLidar_read_data(mDate, folder, dVersion, hRange, tRange)
 % PLIDAR_READ_DATA read Polarization lidar data.
-% Example:
-%    [data] = PLidar_read_data(mDate, folder, dVersion, hRange)
-% Inputs:
+%
+% USAGE:
+%    [data] = PLidar_read_data(mDate, folder, dVersion, hRange, tRange)
+%
+% INPUTS:
 %    mDate: datenum
 %        measurement date.
 %    folder: char
@@ -17,7 +19,8 @@
 %        bottom and top of the range you want to load. (m)
 %    tRange: 2-element array
 %        temporal range for data profiles.
-% Outputs:
+%
+% OUTPUTS:
 %    data: struct
 %        height: array
 %            height of each bin above ground. (m)
@@ -39,12 +42,14 @@
 %            overflow flag for CH1. ('1' means overflowed)
 %        overflowCH2: matrix (height * time)
 %            overflow flag for CH2. ('1' means overflowed)
-% History:
-%    2020-03-15. First Edition by Zhenping
-%    2022-05-20. Add CMA polarization data by Zhenping
-%    2025-05-09. Add WHU 1030 vis lidar data by Zhenping
-% Contact:
-%    zp.yin@whu.edu.cn
+%
+% EXAMPLE:
+%
+% HISTORY:
+%    2020-03-15: First Edition by Zhenping
+%    2022-05-20: Add CMA polarization data by Zhenping
+%    2025-05-09: Add WHU 1030 vis lidar data by Zhenping
+% .. Authors: - zp.yin@whu.edu.cn
 
 if nargin < 4
     error('Not enough inputs');

lib/io/PLidar_read_data.m

@@ -1,24 +1,26 @@
 function data = PLidar_readdata(folder, tRange, hRange, varargin)
 % PLIDAR_READDATA read PLidar data in the given temporal and spatial range.
-% Examples:
-%    data = PLidar_readdata('/data/PLidar', ...
-%                   [datenum(2011, 1, 1), datenum(2011, 1, 2, 12, 0, 0)], ...
-%                   [300, 5000]);
-% Inputs:
+%
+% USAGE:
+%    data = PLidar_readdata(folder, tRange, hRange)
+%
+% INPUTS:
 %    folder: char
 %        base directory of the PLidar data.
 %    tRange: 2-element array
 %        start and stop time of the data that you want to load.
 %    hRange: 2-element array
 %        bottom and top height of the data that you want to load. [m]
-% Keywords:
+%
+% KEYWORDS:
 %    dVersion: integer
 %        data version (default: 2).
 %        1: glued by old algorithm with 30-m resolution
 %        2: glued by new algorithm with 3.75-m resolution (default)
 %        3: CMA polarization lidar
 %        4: WHU 1030 vis lidar
-% Returns:
+%
+% OUTPUTS:
 %    data: struct
 %        time: (datenum) array
 %            measurement time of each data profile.
@@ -38,8 +40,10 @@
 %            background signal for each profile at channel 1.
 %        BGCH2: array
 %            background signal for each profile at channel 2.
-% History:
-%    2020-03-03 First version by Zhenping
+%
+% HISTORY:
+%    2020-03-03: first edition by Zhenping
+% .. Authors: - zp.yin@whu.edu.cn
 
 p = inputParser;
 p.KeepUnmatched = true;

lib/io/PLidar_readdata.m

@@ -1,14 +1,23 @@
 function convert_mat_2_txt(matFile, txtFile)
 % CONVERT_MAT_2_TXT convert mat file to txt file.
-% Inputs:
+%
+% USAGE:
+%    [output] = convert_mat_2_txt(matFile, txtFile)
+%
+% INPUTS:
 %    matFile: char
 %        absolute path of the MAT file.
 %    txtFile: char
 %        absolute path of the TXT file.
-% History:
-%    2020-07-06. First edition by Zhenping
-% Contact:
-%    zp.yin@whu.edu.cn
+%
+% OUTPUTS:
+%    output
+%
+% EXAMPLE:
+%
+% HISTORY:
+%    2020-07-06: First edition by Zhenping
+% .. Authors: - zp.yin@whu.edu.cn
 
 if exist(matFile, 'file') ~= 2
     return;

lib/io/convert_mat_2_txt.m

@@ -1,7 +1,9 @@
 function [data] = loadLidarData(lidarFolder, stationID, tRange, varargin)
 % LOADLIDARDATA load lidar data.
+%
 % USAGE:
-%    [data] = loadLidarData(lidarFolder, stationID, tRange, varargin)
+%    [data] = loadLidarData(lidarFolder, stationID, tRange)
+%
 % INPUTS:
 %    lidarFolder: char
 %        folder of lidar data.
@@ -11,19 +13,21 @@
 %        start/stop time of lidar data request.
 %    channelIndex: array
 %        channel index.
+%
 % KEYWORDS:
 %    hRange: 2-element array
 %        vertical range of lidar data request (default: [0, 15000]). (m)
+%
 % OUTPUTS:
 %    data: struct
 %        altitude: numeric
 %        height: array
 %        mTime: array
 %        rawSig: matrix (height x time)
-% EXAMPLE:
+%
 % HISTORY:
 %    2021-07-21: first edition by Zhenping
-% .. Authors: - zhenping@tropos.de
+% .. Authors: - zp.yin@whu.edu.cn
 
 p = inputParser;
 p.KeepUnmatched = true;

lib/io/loadLidarData.m

@@ -1,17 +1,22 @@
 function config = load_settings(settingFile, settingTemplate)
 % LOAD_SETTINGS load setting file and overwrite the template settings.
-% Inputs:
+%
+% USAGE:
+%    config = load_settings(settingFile, settingTemplate)
+%
+% INPUTS:
 %    settingFile: char
 %        absolute path of the setting file (YAML).
 %    settingTemplate: char
 %        absolute path of the template setting file (YAML).
-% Outputs:
+%
+% OUTPUTS:
 %    config: struct
 %        settings.
-% History:
-%    2020-07-08. First edition by Zhenping.
-% Contact:
-%    zp.yin@whu.edu.cn
+%
+% HISTORY:
+%    2020-07-08: First edition by Zhenping.
+% .. Authors: - zp.yin@whu.edu.cn
 
 if exist(settingFile, 'file') ~= 2
     error('setting file does not exist.\n%s', settingFile);

lib/io/load_settings.m

@@ -1,13 +1,16 @@
 function [alt, temp, pres, relh, ERA5file, wind, wins] = read_ERA5(measTime, ERA5site, folder)
 % READ_ERA5 read the ERA5 file
-% Example:
-%    [alt, temp, pres, relh] = read_ERA5(measTime, ERA5site, folder)
-% Inputs:
+%
+% USAGE:
+%    [alt, temp, pres, relh, ERA5file, wind, wins] = read_ERA5(measTime, ERA5site, folder)
+%
+% INPUTS:
 %    measTime: datenum
 %        measurement time. 
 %    ERA5site: char
 %        the location for ERA5 site.
-% Outputs:
+%
+% OUTPUTS:
 %    alt: array
 %        altitute for each range bin. [m]
 %    temp: array
@@ -25,10 +28,12 @@
 %        wind direction. [degree]
 %    wins: array
 %        wind speed. [m/s]
-% History:
-%    2020-10-26. First Edition by Zhenping
-% Contact:
-%    zp.yin@whu.edu.cn
+%
+% EXAMPLE:
+%
+% HISTORY:
+%    2020-10-26: first edition by Zhenping
+% .. Authors: - zp.yin@whu.edu.cn
 
 [thisyear, thismonth, thisday, ~, ~, ~] = datevec(measTime);
 dirInfo = dir(fullfile(folder, ERA5site, sprintf('%04d', thisyear), ...

lib/io/read_ERA5.m

@@ -1,15 +1,18 @@
 function [alt, temp, pres, relh, gdas1file] = read_gdas1(measTime, gdas1site, folder)
 % READ_GDAS1 read the gdas1 file
-% Example:
-%    [alt, temp, pres, relh] = read_gdas1(measTime, gdas1site, folder)
-% Inputs:
+%
+% USAGE:
+%    [alt, temp, pres, relh, gdas1file] = read_gdas1(measTime, gdas1site, folder)
+%
+% INPUTS:
 %    measTime: datenum
 %        measurement time. 
 %    gdas1site: char
 %        the location for gdas1. Our server will automatically produce the 
 %        gdas1 products for all our pollynet location. You can find it in 
 %        /lacroshome/cloudnet/data/model/gdas1
-% Outputs:
+%
+% OUTPUTS:
 %    alt: array
 %        altitute for each range bin. [m]
 %    temp: array
@@ -22,11 +25,11 @@
 %        relative humidity for each range bin. If no valid data, NaN will be 
 %        filled. [%]
 %    gdas1file: char
-%        filename of gdas1 file. 
-% History:
-%    2018-12-22. First Edition by Zhenping
-% Contact:
-%    zhenping@tropos.de
+%        filename of gdas1 file.
+%
+% HISTORY:
+%    2018-12-22: First Edition by Zhenping
+% .. Authors: - zp.yin@whu.edu.cn
 
 [thisyear, thismonth, thisday, thishour, ~, ~] = ...
             datevec(round(measTime / datenum(0, 1, 0, 3, 0, 0)) * ...

lib/io/read_gdas1.m

@@ -1,18 +1,21 @@
 function [temp2D] = read_gridTemp(mTime, altitude, varargin)
-% READ_GRIDTEMP read gridded temperature field.
-% Example:
+% READ_GRIDTEMP description
+%
+% USAGE:
 %    % Usecase 1: read GDAS1 data
 %    temp2D = read_gridTemp(mTime, altitude, 'meteor_data', 'GDAS1', 'station', 'wuhan', 'GDAS1Folder', '/GDAS1');
 %    % Usecase 2: read Radiosonde data
 %    temp2D = read_gridTemp(mTime, altitude, 'meteor_data', 'Radiosonde', 'RadiosondeFolder', '/Radiosonde', 'station', 'wuhan');
 %    % Usecase 3: read ERA-5 data.
 %    temp2D = read_gridTemp(mTime, altitude, 'meteor_data', 'ERA-5', 'ERA5Folder', '/ERA-5', 'station', 'wuhan');
-% Inputs:
+%
+% INPUTS:
 %    mTime: array
 %        measurement time. (UTC)
 %    altitude: array
 %        height above mean sea level. (m)
-% Keywords:
+%
+% KEYWORDS:
 %    meteor_data: char
 %        meteorological data source. 
 %        'GDAS1' (default), 'Radiosonde', or 'ERA-5'
@@ -28,13 +31,14 @@
 %        - 2: radiosonde file for MUA (default)
 %    ERA5Folder: char
 %        ERA-5 data folder.
-% Outputs:
+%
+% OUTPUTS:
 %    temp2D: matrix (altitude * time)
 %        gridded temperature.
-% History:
-%    2020-05-28. First Edition by Zhenping
-% Contact:
-%    zp.yin@whu.edu.cn
+%
+% HISTORY:
+%    2020-05-28: first edition by Zhenping
+% .. Authors: - zp.yin@whu.edu.cn
 
 p = inputParser;
 p.KeepUnmatched = true;

lib/io/read_gridTemp.m

@@ -1,8 +1,10 @@
 function temp2D = read_gridTemp_ERA5(mTime, altitude, folder, ERA5site, deltaTime)
 % READ_GRIDTEMP_ERA5 read gridded ERA5 data
-% Example:
+%
+% USAGE:
 %    temp2D = read_gridTemp_ERA5(mTime, altitude, folder, ERA5site, deltaTime)
-% Inputs:
+%
+% INPUTS:
 %    mTime: array
 %        measurement time. (UTC)
 %    altitude: array
@@ -13,14 +15,15 @@
 %        ERA5 site (default: 'wuhan').
 %    deltaTime: numeric
 %        delta time for profile searching.
-% Outputs:
+%
+% OUTPUTS:
 %    temp: matrix (altitude * time)
 %        temperature for each range bin. If no valid data, NaN will be 
 %        filled. [C]
-% History:
-%    2020-10-26. First Edition by Zhenping
-% Contact:
-%    zp.yin@whu.edu.cn
+%
+% HISTORY:
+%    2020-10-26: First Edition by Zhenping
+% .. Authors: - zp.yin@whu.edu.cn
 
 if ~ exist('ERA5site', 'var')
     ERA5site = 'wuhan';