BlueM.Wave: Difference between revisions

From BlueM
Jump to navigation Jump to search
(44 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 months evaluation]]
[[Image:TimeSeriesValues.png|thumb|Time series values and markers ([[Media:TimeSeriesValues_animation.gif|animation]])]]
[[Bild:Doppelsummenanalyse.png|thumb|Analysis function double sum analysis]]
[[Bild:Monatsauswertung.png|thumb|Analysis function Monthly statistics]]
[[Bild:Wave_Statistik.png|thumb|Statistical analysis function]]
[[Bild:Doppelsummenanalyse.png|thumb|Analysis function Double mass curve]]
[[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]], [[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]])
** [[ASC-Format | ASC]]  
* [[BIN-Format | SYDRO binary format (BIN)]]
** [[SMB-Format | SMB]]  
* [[DFS0-Format | DHI MIKE DFS0 format]]
** [[REG-Format | REG]] ([[SMUSI REG-Format|SMUSI]] and [[Hystem-Extran REG-Format|Hystem-Extran]])
* [[HYDRO_AS-2D result files]]
** OUT ([[SWMM]] binary result files)
* [[Hystem-Extran file formats]]: "Regendatei" and "Wellendatei"
** [[TXT-Format | TXT]] ([[SWMM]] Routing interface files)
* [[PRMS result files]]
** [[UVF-Format | UVF]] (Universelles Variables Format)
* [[SMUSI file formats]]: ASC result files and REG files
** [[DAT-Format | Q_Strg.dat and Pegel.dat]] ([[HYDRO_AS-2D]] result files)
* [[SWMM file formats]]: SWMM5 binary output format, routing interface files, LID report files, DAT interface files
** [[BIN-Format | BIN]] (SYDRO binary format)
* [[SMB-Format | SMB]]  
** and generic text files (e.g. [[CSV-Format | CSV]])
* [[UVF-Format | UVF]] (Universelles Variables Format)
* '''Input time series:''' manual input, or copy & paste from Excel
* [[ZRE-Format | ZRE format]]
* '''Display time series''' in a [http://www.steema.com/products/teechart/overview.html TeeChart] diagram with any number of axes, etc.
* [[ZRXP-Format | ZRXP format]]
** When importing time series, series are automatically assigned to different axes depending on their unit.  
* and generic text files (e.g. [[CSV-Format|CSV]] and [[TXT-Format|TXT]])
* '''Save diagrams''' (TEN-File)
 
* '''Drag&Drop''' files onto the form and "Open with ...", or double-click on file (if file extension is associated with Wave.exe)
Use a '''[[Wave project file]]''' (<code>*.wvp</code>) to quickly import multiple series from multiple files at once.
* '''Time series overview''' for navigating through long time series
 
* '''API''', used by [[BlueM.Opt]] and [[BlueM.Win]].
'''Drag&Drop''' files onto Wave to import them quickly.
* '''Export time series:'''
 
** [[ZRE-Format | ZRE]]
It is also possible to manually input time series, or use copy & paste from Excel.
** [[SMUSI REG-Format | SMUSI REG]]
 
** [[SWMM]] DAT
===Visualization & Navigation===
** <del>[[WEL-Format | WEL]]</del> (not yet - Bug 318)
Display time series in a highly customizable diagram (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])
** CSV and XLS made available by TeeChart
 
* '''Crop time series'''
* '''Overview''': An overview chart shows you the full extent of the time series and the period currently displayed in the main diagram.
* '''Time series analysis:'''
* '''Axes''': When importing time series, series are automatically assigned to different axes depending on their unit.  
** [[Wave:Monatsauswertung|Monthly statistics]]
* '''Zoom & pan''': Use the mouse to zoom or pan  either in the main chart or the overview chart. Left mouse button zooms, right mouse button pans.
** [[Wave:Doppelsummenanalyse|Double mass curve]]
* '''Navigation bar''': Use the navigation bar to set a custom display period and to navigate by a fixed time period.
** [[Wave:GoodnessOfFit|Goodness of Fit]] (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
* Quickly switch time series on and off using the '''check boxes''' in the legend.
** [[Wave:Histogram|Histogram]]
* Display tabular '''Time series values''' and optionally show markers for selected rows in the main chart
** [[Wave:Gegenueberstellung|Plot two time series against each other]]
 
===Save & Export===
'''Save charts''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).
 
[[File:Wave export TEN.png|frame|none|How to save a chart in TEN format]]
 
'''Export charts''' as image files (PNG, JPG, BMP)
 
'''Export time series''' to the following formats:
* [[CSV-Format | 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:Autocorrelation|Autocorrelation]]: Autocorrelation analysis for analyzing time series periodicity
* [[Wave:AnnualStatistics|Annual statistics]]: Compute various statistical parameters (min, max, average) of a time series
* [[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:Histogram|Histogram]]
* [[Wave:LinearRegression|LinearRegression]]: Fills gaps (NaN values and missing timestamps) in one time series by applying a linear regression relationship with a second time series
* [[Wave:MonthlyStatistics|Monthly statistics]]
* [[Wave:TimestepAnalysis|Timestep analysis]]: Calculate the timestep between nodes in a user-specified unit
 
==Comandline interface==
Wave has a commandline interface for importing and converting time series, see [[Wave:CLI]] for details.
 
==API==
The '''API''' is used e.g. by [[BlueM.Opt]] and [[BlueM.Win]] but allows using Wave from within any .NET project.
 
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 displayed as gaps in the chart and are ignored 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 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.
 
===Supported date range===
Wave supports dates between 01.01.0001 and 31.12.9999.
 
The chart display can only show dates between 01.01.0100 and 31.12.9000. Time series with dates before 01.01.0100 and after 31.12.9000 are cut for display purposes, but all nodes are still available for analysis and export and are shown in the properties and time series values dialogs. (#68)


==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, certain Timeseries properties such as Interpretation, Datasource and sometimes Unit are lost.
* <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==
* [[Wave:Code|Code documentation]]
* [https://downloads.bluemodel.org/BlueM.Wave/BlueM.Wave_Release-notes.txt Release Notes]
* [http://svn.bluemodel.org/Wave/trunk/WAVE_RELEASE-NOTES.txt RELEASE-NOTES]
* [[Wave:Development|Development]]
* [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:BlueM.Wave]]
[[Category:BlueM.Wave]]

Revision as of 03:29, 19 July 2022

Wave.png Wave | Development

Screenshot
Time series values and markers (animation)
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 either in the main chart or the overview chart. Left mouse button zooms, right mouse button pans.
  • 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.
  • Display tabular Time series values and optionally show markers for selected rows in the main chart

Save & Export

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

How to save a chart in TEN format

Export charts 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:

  • Autocorrelation: Autocorrelation analysis for analyzing time series periodicity
  • Annual statistics: Compute various statistical parameters (min, max, average) of a time series
  • Calculator: Performs a mathematical operation on one or more time series
  • ChangeTimestep: Make a time series equidistant with a user-specified timestep
  • Comparison: Plot two time series against each other and compute a linear regression line
  • Cumulative: Compute a new time series that contains the cumulative values of the original series
  • Double sum curve
  • Goodness of fit (volume error, sum of squares error, Nash-Sutcliffe efficiency, etc.)
  • Histogram
  • LinearRegression: Fills gaps (NaN values and missing timestamps) in one time series by applying a linear regression relationship with a second time series
  • Monthly statistics
  • Timestep analysis: Calculate the timestep between nodes in a user-specified unit

Comandline interface

Wave has a commandline interface for importing and converting time series, see Wave:CLI for details.

API

The API is used e.g. by BlueM.Opt and BlueM.Win but allows using Wave from within any .NET project.

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.

Supported date range

Wave supports dates between 01.01.0001 and 31.12.9999.

The chart display can only show dates between 01.01.0100 and 31.12.9000. Time series with dates before 01.01.0100 and after 31.12.9000 are cut for display purposes, but all nodes are still available for analysis and export and are shown in the properties and time series values dialogs. (#68)

Downloads

Please refer to the Download page.

Known Issues

  • When saving a chart to the native TEN format of TeeChart, certain Timeseries properties such as Interpretation, Datasource and sometimes Unit are lost.
  • 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

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