BlueM.Wave: Difference between revisions

From BlueM
Jump to navigation Jump to search
(added link to Wave project file)
(12 intermediate revisions by the same user 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 Monthly statistics]]
[[Bild:Monatsauswertung.png|thumb|Analysis function Monthly statistics]]
Line 9: Line 9:


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


==Notes==
==Notes==
===Importing time series===
===Error values===
* "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 display in the chart and when performing analysis functions.
[[File:Wave NaN visualization.png|thumb|right|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 [[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==
==Downloads==
Please refer to the [http://www.bluemodel.org/download/ Download] page.  
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==

Revision as of 05:48, 25 March 2019

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