BlueM.Wave: Difference between revisions

From BlueM
Jump to navigation Jump to search
(→‎Edit & Analyze: added Merge)
(→‎Edit & Analyze: added Calculation analysis function)
(15 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 16: Line 16:
* [[SMB-Format | SMB]]  
* [[SMB-Format | SMB]]  
* [[REG-Format | REG]] ([[SMUSI REG-Format|SMUSI]] and [[Hystem-Extran REG-Format|Hystem-Extran]])
* [[REG-Format | REG]] ([[SMUSI REG-Format|SMUSI]] and [[Hystem-Extran REG-Format|Hystem-Extran]])
* [[OUT-Format | OUT]] ([[SWMM]] binary output files)
* [[OUT-Format | OUT]] ([[SWMM binary output format|SWMM]]
* [[PRMS result files|PRMS result files]]
* [[TXT-Format | TXT]] ([[SWMM]] routing interface files)
* [[TXT-Format | TXT]] ([[SWMM]] routing interface files)
* [[UVF-Format | UVF]] (Universelles Variables Format)
* [[UVF-Format | UVF]] (Universelles Variables Format)
Line 40: Line 41:


===Save & Export===
===Save & Export===
'''Save diagrams''' to the native TeeChart format (TEN-File) to preserve all data and formatting.
'''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 diagrams''' as image files (PNG, JPG, BMP)
Line 49: Line 50:
* [[SMUSI REG-Format | SMUSI REG]]
* [[SMUSI REG-Format | SMUSI REG]]
* [[SWMM]] DAT
* [[SWMM]] DAT
* [[UVF-Format | UVF]]
* XLS (made available by TeeChart)
* XLS (made available by TeeChart)


===Edit & Analyze===
===Edit & Analyze===
Editing functions:
Editing functions:
* '''Cut''' time series to a specified time perios or to another series' extent
* '''Cut''' time series to a specified time period or to another series' extent
* '''Remove error values''' from a time series
* '''Convert error values''' of a time series
* '''Merge''' multiple time series into one while respecting priorities
* '''Merge''' multiple time series into one while respecting priorities


'''Analysis functions:'''
'''Analysis functions:'''
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[Wave:Doppelsummenanalyse|Double mass curve]]
* [[Wave:Calculator|Calculator]]: Performs a mathematical operation on one or more 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:GoodnessOfFit|Goodness of fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* [[Wave:Histogram|Histogram]]
* [[Wave:Histogram|Histogram]]
* [[Wave:Gegenueberstellung|Comparison]]: Plot two time series against each other and compute a linear regression line
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[Wave:TimestepAnalysis|Timestep analysis]]: Calculate the timestep between nodes in a user-specified unit


==API==
==API==
Line 71: Line 77:


==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 displayed as gaps in the chart and are ignored 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===
===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.  
Wave calculates and displays the volume of a time series (e.g. for [[Wave:GoodnessOfFit|GoodnessOfFit]] analysis or in the properties window), if a time series' unit ends with "/s" (e.g. "m³/s"), by integrating the values over time. Time series with other units only have the Sum property.
 
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==
* <s>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).</s> ''fixed in v1.9.1''


==Development==
==Development==

Revision as of 17:34, 16 April 2021

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 displayed as gaps in the chart and are ignored 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 calculates and displays the volume of a time series (e.g. for GoodnessOfFit analysis or in the properties window), if a time series' unit ends with "/s" (e.g. "m³/s"), by integrating the values over time. Time series with other units only have the Sum property.

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). fixed in v1.9.1

Development