BlueM.Wave: Difference between revisions

From BlueM
Jump to navigation Jump to search
(→‎Development: better link for viewing changelog)
(→‎Features: update text, add icons)
Line 11: Line 11:
==Features==
==Features==


===Supported formats===
===[[File:Icon_chart_line_add.png|link=]] Import time series===
'''Supported file formats:'''
* [[WEL-Format | WEL]] ([[WEL-Format (BlueM)|BlueM]], [[WEL-Format (GISMO)|GISMO]], [[WEL-Format (TALSIM)|TALSIM]])
* [[WEL-Format | WEL]] ([[WEL-Format (BlueM)|BlueM]], [[WEL-Format (GISMO)|GISMO]], [[WEL-Format (TALSIM)|TALSIM]])
* [[BIN-Format | SYDRO binary format (BIN)]]
* [[BIN-Format | SYDRO binary format (BIN)]]
Line 26: Line 27:
* and generic text files (e.g. [[CSV-Format|CSV]] and [[TXT-Format|TXT]])
* and generic text files (e.g. [[CSV-Format|CSV]] and [[TXT-Format|TXT]])


Use a '''[[Wave project file]]''' (<code>*.wvp</code>) to quickly import multiple series from multiple files at once.
[[File:Icon_chart_curve_link.png|link=]] Use a '''[[Wave project file]]''' (<code>*.wvp</code>) to quickly import multiple series from multiple files at once.


'''Drag&Drop''' files onto Wave to import them quickly.
'''Drag&Drop''' files onto Wave to import them quickly.


It is also possible to manually input time series, or use copy & paste from Excel.
It is also possible to manually [[File:Icon_chart_line_edit.png|link=]] '''enter time series''', or [[File:Icon_page_paste.png|link=]] '''paste clipboard data''' from Excel and [http://www.talsim.de Talsim-NG].


===Visualization & Navigation===
===Visualization & Navigation===
Display time series in a highly customizable diagram (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])
Display time series in a highly [[File:Icon_chart_curve_edit.png|link=]] '''customizable chart''' (provided by [http://www.steema.com/products/teechart/overview.html TeeChart])


* '''Overview''': An overview chart shows you the full extent of the time series and the period currently displayed in the main diagram.
* [[File:Icon_application_split.png|link=]] An '''overview''' chart shows you the full extent of the time series and the period currently displayed in the main chart.
* '''Axes''': When importing time series, series are automatically assigned to different axes depending on their unit.  
* [[File:Icon_shape_align_bottom.png|link=]] 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.
* [[File:Icons_zoom.png|link=]] Use the toolbar buttons or the mouse to '''zoom or pan''' either in the main chart or the overview chart. Use the left mouse button or the mouse scroll wheel to zoom, hold the right mouse button to pan.
* '''Navigation bar''': Use the navigation bar to set a custom display period and to navigate by a fixed time period.
* [[File:Icons_navigate.png|link=]] 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.
* &check; 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
* [[File:Icon_table.png|link=]] Display tabular '''Time series values''' and optionally [[File:Icon_comments.png|link=]] show markers for selected rows in the main chart
* [[File:Icon_table_edit.png|link=]] Display '''Time series properties''' in a table with optional statistics


===Save & Export===
===Save & Export===
'''Save charts''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).
[[File:Icon_chart_curve_link.png|link=]] '''Save [[Wave project file|project files]]''' (<code>*.wvp</code>) with references to time series from file sources.


[[File:Wave export TEN.png|frame|none|How to save a chart in TEN format]]
[[File:Icon_chart_pie.png|link=]] '''Save charts''' to the native TeeChart format (TEN-File) to preserve all data and formatting (for exceptions, see known issues below).


'''Export charts''' as image files (PNG, JPG, BMP)
[[File:Icon_chart_pie.png|link=]] '''Export charts''' as image files (PNG, JPG, BMP).


'''Export time series''' to the following formats:
[[File:Icon page copy.png|link=]] '''Copy''' the chart to the clipboard as a PNG image.
 
'''[[File:Icon_page_white_go.png|link=]] Export time series''' to the following formats:
* [[CSV-Format | CSV]]
* [[CSV-Format | CSV]]
* [[ZRE-Format | ZRE]]
* [[BIN-Format | BIN]]
* [[DFS0-Format | DFS0]]
* [[SWMM]] DAT
* [[SMUSI REG-Format | SMUSI REG]]
* [[SMUSI REG-Format | SMUSI REG]]
* [[SWMM]] DAT
* [[UVF-Format | UVF]]
* [[UVF-Format | UVF]]
* XLS (made available by TeeChart)
* [[ZRE-Format | ZRE]]
* [[ZRXP-Format | ZRXP]]


===Edit & Analyze===
===Edit & Analyze===
Editing functions:
Editing functions:
* '''Cut''' time series to a specified time period or to another series' extent
* [[File:Icon_cut.png|link=]] '''Cut''' time series to a specified time period or to another series' extent
* '''Convert error values''' of a time series
* [[File:Icon_error_convert.png|link=]] '''Convert error values''' of a time series
* '''Merge''' multiple time series into one while respecting priorities
* [[File:Icon_arrow_join_right.png|link=]] '''Merge''' multiple time series into one while respecting priorities


'''Analysis functions:'''
'''[[File:Icon_calculator.png|link=]] Analysis functions:'''
* [[Wave:Autocorrelation|Autocorrelation]]: Autocorrelation analysis for analyzing time series periodicity
* [[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: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: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: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:Comparison|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:Cumulative|Cumulative]]: Compute a new time series that contains the cumulative values of the original series
* [[Wave:DoubleSumCurve|Double sum curve]]
* [[Wave:DoubleSumCurve|Double sum curve]]

Revision as of 12:41, 24 June 2023

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

Icon chart line add.png Import time series

Supported file formats:

Icon chart curve link.png 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 Icon chart line edit.png enter time series, or Icon page paste.png paste clipboard data from Excel and Talsim-NG.

Visualization & Navigation

Display time series in a highly Icon chart curve edit.png customizable chart (provided by TeeChart)

  • Icon application split.png An overview chart shows you the full extent of the time series and the period currently displayed in the main chart.
  • Icon shape align bottom.png When importing time series, series are automatically assigned to different axes depending on their unit.
  • Icons zoom.png Use the toolbar buttons or the mouse to zoom or pan either in the main chart or the overview chart. Use the left mouse button or the mouse scroll wheel to zoom, hold the right mouse button to pan.
  • Icons navigate.png 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.
  • Icon table.png Display tabular Time series values and optionally Icon comments.png show markers for selected rows in the main chart
  • Icon table edit.png Display Time series properties in a table with optional statistics

Save & Export

Icon chart curve link.png Save project files (*.wvp) with references to time series from file sources.

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

Icon chart pie.png Export charts as image files (PNG, JPG, BMP).

Icon page copy.png Copy the chart to the clipboard as a PNG image.

Icon page white go.png Export time series to the following formats:

Edit & Analyze

Editing functions:

  • Icon cut.png Cut time series to a specified time period or to another series' extent
  • Icon error convert.png Convert error values of a time series
  • Icon arrow join right.png Merge multiple time series into one while respecting priorities

Icon calculator.png 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 API docs here: https://bluemodel.github.io/BlueM.Wave/api/

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
  • more issues: https://github.com/bluemodel/BlueM.Wave/issues

Development