BlueM.Wave: Difference between revisions
Jump to navigation
Jump to search
(SWMM import/export) |
(→Edit & Analyze: Added ChangeTimestep) |
||
| (39 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{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 | [[Bild:Monatsauswertung.png|thumb|Analysis function Monthly statistics]] | ||
[[Bild:Doppelsummenanalyse.png|thumb|Analysis function | [[Bild:Doppelsummenanalyse.png|thumb|Analysis function Double mass curve]] | ||
[[Bild:Wave_Statistik.png|thumb| | [[Bild:Wave_Statistik.png|thumb|Analysis function Histogram]] | ||
==Description== | ==Description== | ||
Wave is a tool for | Wave is a tool for displaying, analyzing and importing and exporting time series. | ||
==Features== | ==Features== | ||
* | ===Supported formats=== | ||
* [[WEL-Format | WEL]] ([[WEL-Format (BlueM)|BlueM]], [[WEL-Format (GISMO)|GISMO]], [[WEL-Format (TALSIM)|TALSIM]], [[WEL-Format (Hystem-Extran)|Hystem-Extran]]) | |||
* [[ZRE-Format | ZRE]] | |||
* [[ASC-Format | ASC]] | |||
* [[SMB-Format | SMB]] | |||
** | * [[REG-Format | REG]] ([[SMUSI REG-Format|SMUSI]] and [[Hystem-Extran REG-Format|Hystem-Extran]]) | ||
** and generic text files (e.g. [[CSV-Format | CSV]]) | * [[OUT-Format | OUT]] ([[SWMM binary output format|SWMM]] | ||
* ''' | * [[PRMS result files|PRMS result files]] | ||
* [[TXT-Format | TXT]] ([[SWMM]] routing interface files) | |||
* | * [[UVF-Format | UVF]] (Universelles Variables Format) | ||
* ''' | * [[DAT-Format | HYDRO_AS-2D]] result files | ||
* ''' | * [[BIN-Format | BIN]] (SYDRO binary format) | ||
* [[ZRXP-Format | ZRXP]] (ZXRP format) | |||
* and generic text files (e.g. [[CSV-Format | CSV]]) | |||
** [[ZRE-Format | ZRE]] | 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. | |||
* | |||
* | It is also possible to manually input time series, or use copy & paste from Excel. | ||
* ''' | |||
* ''' | ===Visualization & Navigation=== | ||
** [[Wave: | Display time series in a highly customizable diagram (provided by [http://www.steema.com/products/teechart/overview.html TeeChart]) | ||
** [[Wave: | |||
* '''Overview''': An overview chart shows you the full extent of the time series and the period currently displayed in the main diagram. | |||
** [[Wave: | * '''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: | |||
* 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== | ||
=== | ===Error values=== | ||
[[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== | |||
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]] | ||
* [ | * [[Wave:Release Notes|Release Notes]] | ||
* [http:// | * [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
Description
Wave is a tool for displaying, analyzing and importing and exporting time series.
Features
Supported formats
- WEL (BlueM, GISMO, TALSIM, Hystem-Extran)
- ZRE
- ASC
- SMB
- REG (SMUSI and Hystem-Extran)
- OUT (SWMM
- PRMS result files
- TXT (SWMM routing interface files)
- UVF (Universelles Variables Format)
- HYDRO_AS-2D result files
- BIN (SYDRO binary format)
- ZRXP (ZXRP format)
- and generic text files (e.g. CSV)
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.
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:
- Annual statistics: Compute various statistical parameters (min, max, average) of a 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
- Monthly statistics
- 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 documentation.
Notes
Error 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).