DISPLAY PERCENTILES
From BAWiki
Basic Information
Name of Program
display_percentiles
Version-Date
March 2016
Description-Date
March 2016
Catchwords
statistics
visualization
percentiles
mean
median
MATLAB
Short Description of Functionality
The application display_percentiles is able to calculate and plot statistics from profile data produced by XTRDATA. It is possible to plot the mean, minima and maxima, the median and additionally the desired percentiles.
Advice for usage:
The program needs a steering file and the corresponding dictionary file. The dictionary file can be found here: /net/themis/system/akprog/dic/display_percentiles_dico.dat. However, if you have a file with the same name in your working directory the local file will be used. The name and the path of the steering file will be requested by the program during run time.
Input-Files
- steering file (examples can be found here: $PROGHOME/examples/display_percentiles, filetype display_percentiles_steer.dat)
- files containing data of physical quantities along a profile respectively at one time step (Output of XTRDATA, format *.dat)
Output-Files
- plot(s) of the desired statistical quantity along the profile kilometers (possible formats: *.pdf, *.png, *.eps, *.fig)
- excel chart containing the statistics shown in the plot (optional output)
- text file error.txt containing a report of the program dictionary_ui which is used to check the steering file
Methodology
Depending on the user input in the steering file the program will calculate the mean, the maximum, the minimum or the median at every point of the profile. Additionally, two percentiles will be plotted (the user-given percentile and the calculated percentile 100 - user-given percentile). For the calculation of the statistics the following MATLAB-functions were used:
- calculation of the percentiles: prctile
- calculation of the mean: nanmean (i.e. NaNs will not be considered)
- calculation of the median: nanmedian (i.e. NaNs will not be considered)
- calculation of the maximum: nanmax (i.e. NaNs will not be considered)
- calculation of the minimum: nanmin (i.e. NaNs will not be considered)
Program(s) to run before this Program
Program(s) to run after this Program
none
Additional Information
Language
MATLAB (created with version R2015a), Fortran
Additional software
needs the MATLAB compiler runtime (usually installed under /usr/local/MATLAB/MATLAB_Runtime/v85 on Linux)
Original Version
Maintenance
Documentation/Literature
An example can be found here: $PROGHOME/examples/display_percentiles/.
A description of the MATLAB-functions mentioned under "methodology" can be found here: http://de.mathworks.com/help/stats/descriptive-statistics.html .
The fortran-module dictionary_ui which is used by this program to check the input in the steering file is documented here: \\themis\system\akprog\DHWW\diction\tool.htm .
back to Program Descriptions