DISPLAY PERCENTILES STEER.DAT: Difference between revisions
From BAWiki
imported>Brodhagen Tabea (Created page with "{{FileDescription |name_de=DISPLAY_PERCENTILES_STEER.DAT |filetype=display_percentiles_steer.dat |version=March 2016 |version_descr=March 2016 |significance=contains general...") |
imported>Brodhagen Tabea m (added Information concerning NetCDF Input) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 8: | Line 8: | ||
'''Input Steering Data''' | '''Input Steering Data''' | ||
* information about the file input (block ''' | * information about the file input (block '''input''') | ||
** key "'''file'''" : path to folder containing the input data | ** key "'''file'''" : path to folder containing the input data | ||
** key "'''inputformat'''" : format of the input data ( | ** key "'''inputformat'''" : format of the input data (choose between "xtrdata" for data that has been generated using [[XTRDATA]] and "netcdf") | ||
* information regarding the output (block '''Output''') | * information regarding the output (block '''Output''') | ||
** key "''' | ** key "'''directory'''" : path to folder where plots will be saved (program can create this folder if it does not exist yet during runtime) | ||
** key "'''outputformat'''" : desired format of the created plots (*.pdf,*.png,*.fig,*.eps); *.pdf is recommended | ** key "'''outputformat'''" : desired format of the created plots (*.pdf,*.png,*.fig,*.eps); *.pdf is recommended | ||
** key "'''excelfilename'''" : name of the created Excel-file that will contain the statistics (optional; comment this parameter to suppress Excel-output) | ** key "'''excelfilename'''" : name of the created Excel-file that will contain the statistics (optional; comment this parameter to suppress Excel-output) | ||
** key "''' | ** key "'''parameter'''" : name of the physical quantity that is plotted(choose "all" to plot all quantities or give the name of a quantity as it is given in the Xtrdata-output file) | ||
** key "'''profile'''" : name of the profile that should be plotted as it is given in the [[NetCDF]]-file (this key is only required when "inputformat = netcdf" is chosen) | |||
** key "'''metadata'''" : set to "1" to display metadata beneath the plot | ** key "'''metadata'''" : set to "1" to display metadata beneath the plot | ||
** key "'''fontsize'''" : fontsize of the plot | ** key "'''fontsize'''" : fontsize of the plot | ||
** key "'''font'''" : font of the plot | ** key "'''font'''" : font of the plot | ||
** key "'''figsize'''" : size of the created plot [width height] in cm | ** key "'''figsize'''" : size of the created plot [width height] in cm | ||
* information about the display of a statistical quantity as a line (block ''' | * information about the display of a statistical quantity as a line (block '''lineplot''') | ||
** key "'''linename'''" : statistical quantity that should be plotted as a line (either mean, median, minimum or maximum) | ** key "'''linename'''" : statistical quantity that should be plotted as a line (either mean, median, minimum or maximum) | ||
** key "'''linecolor'''" : color of the line (will be given as an RGB-triple with values ranging from 0 to 1) | ** key "'''linecolor'''" : color of the line (will be given as an RGB-triple with values ranging from 0 to 1) | ||
** key "'''linestyle'''" : style of the line (dotted, dashed, continuous, ...) | ** key "'''linestyle'''" : style of the line (dotted, dashed, continuous, ...) | ||
** key "'''xlimit'''" : limits of the x-axis [lower_boundary upper_boundary] | ** key "'''xlimit'''" : limits of the x-axis [lower_boundary upper_boundary] (optional) | ||
** key "'''ylimit'''" : limits of the y-axis [lower_boundary upper_boundary] (optional; can only be chosen if one physical quantity is plotted) | ** key "'''ylimit'''" : limits of the y-axis [lower_boundary upper_boundary] (optional; can only be chosen if one physical quantity is plotted) | ||
* information about the percentiles (block ''' | * information about the percentiles (block '''percentileplot'''): | ||
** key "''' | ** key "'''perccolor'''" : color of the area between the two plotted percentiles | ||
** key "''' | ** key "'''percentile'''" : desired percentile (additionally, the percentile "100-percentile" will be plotted) | ||
'''General Remarks''' | '''General Remarks''' | ||
| Line 39: | Line 40: | ||
|fileextension=.dat | |fileextension=.dat | ||
|writemodules=interactive generation (editor) | |writemodules=interactive generation (editor) | ||
|readmodules=An adapted and as a mex-file compiled version of the p_dictionary_ui.f90 is used to check the user input in the steering file. The [[MATLAB]] class | |readmodules=An adapted and as a mex-file compiled version of the p_dictionary_ui.f90 is used to check the user input in the steering file. The [[MATLAB]] class Xtrdata_Output.m is used to read the content of the steering file and make it available in [[MATLAB]]. | ||
|contact_original=[mailto:tabea.brodhagen@baw.de T. Brodhagen] | |contact_original=[mailto:tabea.brodhagen@baw.de T. Brodhagen] | ||
|contact_maintenance=[mailto:tabea.brodhagen@baw.de T. Brodhagen] | |contact_maintenance=[mailto:tabea.brodhagen@baw.de T. Brodhagen] | ||
|examplefile=siehe $PROGHOME/examples/display_percentiles/example1/display_percentiles_steer.dat}} | |examplefile=siehe $PROGHOME/examples/display_percentiles/example1/display_percentiles_steer.dat}} | ||
Latest revision as of 09:25, 12 October 2016
Basic Information
File-Type
display_percentiles_steer.dat
File-Form
FORMATTED
Version
March 2016
Description-Date
March 2016
Significance of the File
contains general input data for the program display_percentiles
File-Contents (in Catchwords)
Input Steering Data
- information about the file input (block input)
- key "file" : path to folder containing the input data
- key "inputformat" : format of the input data (choose between "xtrdata" for data that has been generated using XTRDATA and "netcdf")
- information regarding the output (block Output)
- key "directory" : path to folder where plots will be saved (program can create this folder if it does not exist yet during runtime)
- key "outputformat" : desired format of the created plots (*.pdf,*.png,*.fig,*.eps); *.pdf is recommended
- key "excelfilename" : name of the created Excel-file that will contain the statistics (optional; comment this parameter to suppress Excel-output)
- key "parameter" : name of the physical quantity that is plotted(choose "all" to plot all quantities or give the name of a quantity as it is given in the Xtrdata-output file)
- key "profile" : name of the profile that should be plotted as it is given in the NetCDF-file (this key is only required when "inputformat = netcdf" is chosen)
- key "metadata" : set to "1" to display metadata beneath the plot
- key "fontsize" : fontsize of the plot
- key "font" : font of the plot
- key "figsize" : size of the created plot [width height] in cm
- information about the display of a statistical quantity as a line (block lineplot)
- key "linename" : statistical quantity that should be plotted as a line (either mean, median, minimum or maximum)
- key "linecolor" : color of the line (will be given as an RGB-triple with values ranging from 0 to 1)
- key "linestyle" : style of the line (dotted, dashed, continuous, ...)
- key "xlimit" : limits of the x-axis [lower_boundary upper_boundary] (optional)
- key "ylimit" : limits of the y-axis [lower_boundary upper_boundary] (optional; can only be chosen if one physical quantity is plotted)
- information about the percentiles (block percentileplot):
- key "perccolor" : color of the area between the two plotted percentiles
- key "percentile" : desired percentile (additionally, the percentile "100-percentile" will be plotted)
General Remarks
- While reading this steering file the dictionary file display_percentiles_dico.dat will be automatically accessed in directory $PROGHOME/dic/.
Programs using this Type of File
Example-File
siehe $PROGHOME/examples/display_percentiles/example1/display_percentiles_steer.dat
back to: File Descriptions