BlueM.Wave: Difference between revisions

From BlueM
Jump to navigation Jump to search
(→‎Features: added HYDRO_AS-2D import format)
(→‎Edit & Analyze: Added ChangeTimestep)
(35 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
{{Wave_nav}}
{{Wave_nav}}
<div style="float:right; margin:0.5em 0 0.5em 0.5em;">__TOC__</div>
[[Bild:Wave_screenshot.png|thumb|Screenshot]]
[[Bild:Wave_screenshot.png|thumb|Screenshot]]
[[Bild:Monatsauswertung.png|thumb|Analysis function months evaluation]]
[[Bild:Monatsauswertung.png|thumb|Analysis function Monthly statistics]]
[[Bild:Doppelsummenanalyse.png|thumb|Analysis function double sum analysis]]
[[Bild:Doppelsummenanalyse.png|thumb|Analysis function Double mass curve]]
[[Bild:Wave_Statistik.png|thumb|Statistical analysis function]]
[[Bild:Wave_Statistik.png|thumb|Analysis function Histogram]]
==Description==
==Description==
Wave is a tool for importing, exporting, analyzing and displaying time series.
Wave is a tool for displaying, analyzing and importing and exporting time series.


==Features==
==Features==
* '''Import time series:'''
 
** [[WEL-Format | WEL]] ([[WEL-Format (BlueM)|BlueM]] and [[WEL-Format (Hystem-Extran)|Hystem-Extran]])
===Supported formats===
** [[ZRE-Format | ZRE]]
* [[WEL-Format | WEL]] ([[WEL-Format (BlueM)|BlueM]], [[WEL-Format (GISMO)|GISMO]], [[WEL-Format (TALSIM)|TALSIM]], [[WEL-Format (Hystem-Extran)|Hystem-Extran]])
** [[ASC-Format | ASC]]  
* [[ZRE-Format | ZRE]]
** [[SMB-Format | SMB]]  
* [[ASC-Format | ASC]]  
** [[REG-Format | REG]] ([[SMUSI REG-Format|SMUSI]] and [[Hystem-Extran REG-Format|Hystem-Extran]])
* [[SMB-Format | SMB]]  
** OUT ([[SWMM]] binary result files)
* [[REG-Format | REG]] ([[SMUSI REG-Format|SMUSI]] and [[Hystem-Extran REG-Format|Hystem-Extran]])
** [[TXT-Format | TXT]] ([[SWMM]] Routing interface files)
* [[OUT-Format | OUT]] ([[SWMM binary output format|SWMM]]
** [[DAT-Format | Q_Strg.dat and Pegel.dat]] ([[HYDRO_AS-2D]] result files)
* [[PRMS result files|PRMS result files]]
** and generic text files (e.g. [[CSV-Format | CSV]])
* [[TXT-Format | TXT]] ([[SWMM]] routing interface files)
* '''Input time series:''' manual input, or copy & paste from Excel
* [[UVF-Format | UVF]] (Universelles Variables Format)
* '''Display time series''' in a [http://www.steema.com/products/teechart/overview.html TeeChart] diagram with any number of axes, etc.
* [[DAT-Format | HYDRO_AS-2D]] result files
** When importing time series, series are automatically assigned to different axes depending on their unit.  
* [[BIN-Format | BIN]] (SYDRO binary format)
* '''Save diagrams''' (TEN-File)
* [[ZRXP-Format | ZRXP]] (ZXRP format)
* '''Drag&Drop''' files onto the form and "Open with ...", or double-click on file (if file extension is associated with Wave.exe)
* and generic text files (e.g. [[CSV-Format | CSV]])
* '''Time series overview''' for navigating through long time series
 
* '''API''', used by [[BlueM.Opt]] and [[BlueM.Win]].
Use a '''[[Wave project file]]''' (<code>*.wvp</code>) to quickly import multiple series from multiple files at once.
* '''Export time series:'''
 
** [[ZRE-Format | ZRE]]
'''Drag&Drop''' files onto Wave to import them quickly.
** [[SMUSI REG-Format | SMUSI REG]]
 
** [[SWMM]] DAT
It is also possible to manually input time series, or use copy & paste from Excel.
** <del>[[WEL-Format | WEL]]</del> (not yet - Bug 318)
 
** CSV and XLS made available by TeeChart
===Visualization & Navigation===
* '''Crop time series'''
Display time series in a highly customizable diagram (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])
* '''Time series analysis:'''
 
** [[Wave:Monatsauswertung|Monthly statistics]]
* '''Overview''': An overview chart shows you the full extent of the time series and the period currently displayed in the main diagram.
** [[Wave:Doppelsummenanalyse|Double mass curve]]
* '''Axes''': When importing time series, series are automatically assigned to different axes depending on their unit.  
** [[Wave:GoodnessOfFit|Goodness of Fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* '''Zoom & pan''': Use the mouse to zoom or pan.
** [[Wave:Statistik|Statistics]]
* '''Navigation bar''': Use the navigation bar to set a custom display period and to navigate by a fixed time period.
** [[Wave:Gegenueberstellung|Plot two time series against each other]]
* Quickly switch time series on and off using the '''check boxes''' in the legend.
 
===Save & Export===
'''Save diagrams''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).
 
'''Export diagrams''' as image files (PNG, JPG, BMP)
 
'''Export time series''' to the following formats:
* CSV
* [[ZRE-Format | ZRE]]
* [[SMUSI REG-Format | SMUSI REG]]
* [[SWMM]] DAT
* [[UVF-Format | UVF]]
* XLS (made available by TeeChart)
 
===Edit & Analyze===
Editing functions:
* '''Cut''' time series to a specified time period or to another series' extent
* '''Convert error values''' of a time series
* '''Merge''' multiple time series into one while respecting priorities
 
'''Analysis functions:'''
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[Wave:ChangeTimestep|ChangeTimestep]]: Make a time series equidistant with a user-specified timestep
* [[Wave:Gegenueberstellung|Comparison]]: Plot two time series against each other and compute a linear regression line
* [[Wave:Cumulative|Cumulative]]: Compute a new time series that contains the cumulative values of the original series
* [[Wave:DoubleSumCurve|Double sum curve]]
* [[Wave:GoodnessOfFit|Goodness of fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* [[Wave:Histogram|Histogram]]
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:TimestepAnalysis|Timestep analysis]]: Calculate the timestep between nodes in a user-specified unit
 
==API==
The '''API''' is used by [[BlueM.Opt]] and [[BlueM.Win]].
 
See the [[Wave:API|documentation]].


==Notes==
==Notes==
===Importing time series===
===Error values===
* WEL and ZRE files have to adhere to the file format: see [[WEL-Format|WEL]], [[ZRE-Format|ZRE]].
[[File:Wave NaN visualization.png|thumb|right|Visualization of NaN values]]
* '''Number format:'''
* "NaN", "Infinity" and "-Infinity" in import files are recognized and accepted.
** Decimal point should be represented by a dot (<code>.</code>) (Bug 351)
* Unreadable values are converted to NaN during import.
** "NaN", "Infinity" and "-Infinity" in import files are recognized and accepted.<br/> Unreadable values are converted to NaN.<br/>Values of NaN or Infinity are removed before displaying or performing analysis functions.
* If a file format has a specified error value (e.g. -777 for [[ZRXP]] and [[UVF]]), then any corresponding entries are also converted to NaN.
* '''Date format'''
* NaN values are removed before displaying a series in the chart and when performing analysis functions.
:{| border="0" cellpadding="5" cellspacing="0"
* Custom, user-specified values can be converted to NaN after import.
| TXT, CSV, ASC and WEL || &rarr; || <code>DD.MM.YYYY HH:MM</code>
* NaN values can be visualized in the chart by pressing a button (see screenshot to the right).
|-
 
| ZRE || &rarr; || <code>YYYYMMDD HH:MM</code>
===Volume property===
|}
Wave can calculate and display the volume of a time series (e.g. for [[Wave:GoodnessOfFit|GoodnessOfFit]] analysis or in the properties window). The volume is usually calculated by simply computing the sum of all individual values of a time series (in this case it is equal to the "Sum" property). However, if a time series' unit ends with "/s" (e.g. "m³/s"), the volume is calculated by actually integrating the values over time.  
 
Which method is used to calculate the volume is always written to the log.
 
==Downloads==
Please refer to the [http://www.bluemodel.org/download/ Download] page.
 
==Known Issues==
* When saving a chart to the native TEN format of TeeChart, any NaN values contained in the series are lost (i.e. the nodes with the NaN values are omitted from the series).


==Development==
==Development==
* [[Wave:Code|Code documentation]]
* [[Wave:Code|Code documentation]]
* [http://130.83.196.154/svn/Wave/trunk/WAVE_RELEASE-NOTES.txt RELEASE-NOTES]
* [[Wave:Release Notes|Release Notes]]
* [http://bugs.bluemodel.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&content=&product=Wave&query_format=specific&order=bug_severity%2Cpriority%20ASC&query_based_on= Bugzilla:Wave]
* [http://bugs.bluemodel.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&content=&product=Wave&query_format=specific&order=bug_severity%2Cpriority%20ASC&query_based_on= Bugzilla:Wave]


[[Category:Wave]]
[[Category:BlueM.Wave]]

Revision as of 03:25, 6 June 2020

Wave.png Wave | Development

Screenshot
Analysis function Monthly statistics
Analysis function Double mass curve
Analysis function Histogram

Description

Wave is a tool for displaying, analyzing and importing and exporting time series.

Features

Supported formats

Use a Wave project file (*.wvp) to quickly import multiple series from multiple files at once.

Drag&Drop files onto Wave to import them quickly.

It is also possible to manually input time series, or use copy & paste from Excel.

Visualization & Navigation

Display time series in a highly customizable diagram (provided by TeeChart)

  • Overview: An overview chart shows you the full extent of the time series and the period currently displayed in the main diagram.
  • Axes: When importing time series, series are automatically assigned to different axes depending on their unit.
  • Zoom & pan: Use the mouse to zoom or pan.
  • Navigation bar: Use the navigation bar to set a custom display period and to navigate by a fixed time period.
  • Quickly switch time series on and off using the check boxes in the legend.

Save & Export

Save diagrams to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).

Export diagrams as image files (PNG, JPG, BMP)

Export time series to the following formats:

Edit & Analyze

Editing functions:

  • Cut time series to a specified time period or to another series' extent
  • Convert error values of a time series
  • Merge multiple time series into one while respecting priorities

Analysis functions:

API

The API is used by BlueM.Opt and BlueM.Win.

See the documentation.

Notes

Error values

Visualization of NaN values
  • "NaN", "Infinity" and "-Infinity" in import files are recognized and accepted.
  • Unreadable values are converted to NaN during import.
  • If a file format has a specified error value (e.g. -777 for ZRXP and UVF), then any corresponding entries are also converted to NaN.
  • NaN values are removed before displaying a series in the chart and when performing analysis functions.
  • Custom, user-specified values can be converted to NaN after import.
  • NaN values can be visualized in the chart by pressing a button (see screenshot to the right).

Volume property

Wave can calculate and display the volume of a time series (e.g. for GoodnessOfFit analysis or in the properties window). The volume is usually calculated by simply computing the sum of all individual values of a time series (in this case it is equal to the "Sum" property). However, if a time series' unit ends with "/s" (e.g. "m³/s"), the volume is calculated by actually integrating the values over time.

Which method is used to calculate the volume is always written to the log.

Downloads

Please refer to the Download page.

Known Issues

  • When saving a chart to the native TEN format of TeeChart, any NaN values contained in the series are lost (i.e. the nodes with the NaN values are omitted from the series).

Development

Retrieved from "https://wiki.bluemodel.org/index.php?title=BlueM.Wave&oldid=7462"