Skip to content

Tools

Properties of a tool (if any) can be specified in the Properties window in MIKE Workbench.

Accumulation

This tool calculates the accumulation of all values in a time series. Note this is not the same as summing the values. For rates and instantaneous values, accumulation is calculated by multiplying the values by the time period they are applicable.

Tool Info
Display Name Accumulation
API Name Accumulation
Tools Explorer /Basic statistics/Accumulation
NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.BasicStatistics
Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll
API Reference DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IAccumulationTool
Input Items One or more time series
Output Items A data table

Tool Properties

The tool has no properties.

Code Sample

import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Accumulation")
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IAccumulationTool(app.Tools.CreateNew("Accumulation"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

// Get the tool
var tool = application.Tools.CreateNew("Accumulation") as DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.AccumulationTool;

// Set the tool properties and execute.
tool.InputItems.Add(ts);
tool.Execute();

// Get the output of the tool.
var outputItem = tool.OutputItems[0] as DHI.Solutions.Generic.Tools.TableContainer;
double value = (double)outputItem.TabularData.Rows[0][1];

Runtime.config

What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

The XML below shows the tool plugin information found in the Runtime.config file.

<Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.AccumulationTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll" />

Annual maximum

This tool extracts the annual maximum. The start of the year can be set to any day and month.

Tool Info
Display Name Annual maximum
API Name Annual Maximum
Tools Explorer /Extreme value extraction/Annual maximum
NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ExtremeValues
Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.dll
API Reference DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.IAnnualMaximumTool
Input Items One or more time series
Output Items A time series

Tool Properties

Display Name API Name Description
Start of water year
Day StartDay Gets or sets start day of water year
Month StartMonth Gets or sets start month of water year

Code Sample

import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ExtremeValues")
from DHI.Solutions.TimeseriesManager.Tools.ExtremeValues import *

# Get the tool.
tool = app.Tools.CreateNew("Annual Maximum")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ExtremeValues")
from DHI.Solutions.TimeseriesManager.Tools.ExtremeValues import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.IAnnualMaximumTool(app.Tools.CreateNew("Annual Maximum"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

// Get the tool
var tool = application.Tools.CreateNew("Annual Maximum") as DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.AnnualMaximumTool;

// Set the tool properties and execute.
tool.InputItems.Add(ts);
tool.StartDay = 1;
tool.StartMonth = 5;
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

Runtime.config

What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

The XML below shows the tool plugin information found in the Runtime.config file.

<Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.AnnualMaximumTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.dll" />

Annual maximum series (seasonal)

In the annual maximum series (AMS) method the maximum value in each year of the record are extracted for the extreme value analysis.

Tool Info
Display Name Annual maximum series (seasonal)
API Name Annual maximum series (seasonal)
Tools Explorer /Basic statistics/Annual maximum series (seasonal)
NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.BasicStatistics
Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll
API Reference DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.ISeasonalAnnualMaximumTool
Input Items One or more time series
Output Items A time series

Tool Properties

Display Name API Name Description
Season End
Day SeasonEndDay Gets or sets end day of season
Month SeasonEndMonth Gets or sets end month of season
Season Start
Day SeasonStartDay Gets or sets start day of season
Month SeasonStartMonth Gets or sets start month of season
Start of water year
Day StartDay Gets or sets start day of water year
Month StartMonth Gets or sets start month of water year

Code Sample

import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Annual maximum series (seasonal)")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.ISeasonalAnnualMaximumTool(app.Tools.CreateNew("Annual maximum series (seasonal)"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

// Get the tool.
var tool = application.Tools.CreateNew("Annual maximum series (seasonal)") as DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.ISeasonalAnnualMaximumTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

Runtime.config

What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

The XML below shows the tool plugin information found in the Runtime.config file.

<Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.SeasonalAnnualMaximumTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll" />

Annual n-day minimum

Tool for calulating the annual day minimum of a time series.

Tool Info
Display Name Annual n-day minimum
API Name Annual N-Day Minimum
Tools Explorer /Extreme value extraction/Annual n-day minimum
NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ExtremeValues
Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.dll
API Reference DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.IAnnualNDayMinimumTool
Input Items One or more time series
Output Items A time series

Tool Properties

Display Name API Name Description
Average Length
Number of days (n) to average AverageLength Gets or sets length of averaging
Start of water year
Day StartDay Gets or sets start day of water year
Month StartMonth Gets or sets start month of water year

Code Sample

import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ExtremeValues")
from DHI.Solutions.TimeseriesManager.Tools.ExtremeValues import *

# Get the tool.
tool = app.Tools.CreateNew("Annual N-Day Minimum")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ExtremeValues")
from DHI.Solutions.TimeseriesManager.Tools.ExtremeValues import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.IAnnualNDayMinimumTool(app.Tools.CreateNew("Annual N-Day Minimum"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

// Get the tool
var tool = application.Tools.CreateNew("Annual N-Day Minimum") as DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.AnnualNDayMinimumTool;

// Set the tool properties and execute.
tool.InputItems.Add(ts);
tool.StartDay = 1;
tool.StartMonth = 1;
tool.AverageLength = 10;
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

Runtime.config

What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

The XML below shows the tool plugin information found in the Runtime.config file.

<Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.AnnualNDayMinimumTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.dll" />

Append

The Append tool is used to append a time series or a value to an existing time series. The following methods are available:

  • Append_timeseries – One time series is appended to the other, at a user specified date(Master time series / Date settings appear when selected). If both time series contains a time step at the append date, the value from the master time series will be used.
  • Append_value – Adds a specified single value at a user specified date(value / date tool setting appears when selected).
  • Append_last_value – Adds the last value of a time series to a new time step at a user specified date(Date setting appear when selected).
Tool Info
Display Name Append
API Name Append
Tools Explorer /Time series processing/Append
NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.IAppendTool
Input Items One or more time series
Output Items A time series

Tool Properties

Display Name API Name Description
Tool options
Append option AppendOption Gets or sets the Append option.
  • Append_timeseries - Use this option to append a time series to the base time series.
  • Append_value - Use this option to append a value to the base time series.
  • Append_last_value - Use this option to append with the last value of the base time series.
    		•
    Tool settings
    Date AppendDate Gets or sets a value indicating the DateTime value the append cuts between timeseries.
    All steps in the master timeseries before and on AppendDate are copied to the output timeseries.
    All steps in the other timeseries after AppendDate are copied to the output timeseries.
    If the other timeseries has a step on AppendDate - and the master did not - it is copied to the output timeseries.
    Note that the property is only available when: AppendOption=Append_timeseries
    Date AppendDateValue Gets or sets a value indicating the time for which the specified value shall be inserted.
    Note that the property is only available when: AppendOption=Append_value,Append_last_value
    Master Timeseries MasterTimeseries Gets or sets the name of the master time series to append time steps to.
    Note that the property is only available when: AppendOption=Append_timeseries
    Value AppendValue Gets or sets the value that shall be appended at the specified AppendDateValue.
    Note that the property is only available when: AppendOption=Append_value

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("Append")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.IAppendTool(app.Tools.CreateNew("Append"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Append") as DHI.Solutions.TimeseriesManager.Tools.Processing.AppendTool;

// Set the tool properties and execute.
tool.AppendOption = DHI.Solutions.TimeseriesManager.Tools.Processing.AppendOption.Append_last_value;
tool.InputItems.Add(ts1);
tool.InputItems.Add(ts2);
tool.MasterTimeseries = "TsName1";
tool.AppendDate = new DateTime(2000, 1, 5, 0, 0, 0, 0);
tool.AppendDateValue = new DateTime(2018, 8, 30);
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.AppendTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Append values

    This tool is used for appending values on an existing time series in the database.

    Tool Info
    Display Name Append values
    API Name Append values
    Tools Explorer /Import Tools/Append values
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ImportTools
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.ImportTools.IAppendValuesTools
    Input Items A single time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    OverwriteExistingFlags OverwriteExistingFlags Gets or sets a value indicating whether over write the existing flags
    Settings
    Data column DataColumn Gets or sets the data column
    Data start row DataStartRow Gets or sets the data start row
    Decimal separator DecimalSeparator Gets or sets the decimal separator
    Delimiter Delimiter Gets or sets the delimiter of the input file
    File path FilePath Gets or sets the csv file names.
    Note that the property is only available when: ImportFromOption=SingleFile
    Flag file path FlagFilePath Gets or sets the path of flag file.
    Note that the property is only available when: ImportFromOption=SingleFile
    Mapping file path FlagMappingFilePath Gets or sets the path of mapping flag file.
    Note that the property is only available when: ImportFromOption=SingleFile
    Overwrite exist value OverwriteExistingValues Gets or sets a value indicating whether over write the existing value
    Template TemplateName Gets or sets the template of the previous chart
    Time column TimeColumn Gets or sets the time column
    Time format TimeFormat Gets or sets the time format
    Use default time format UseDefaultTimeFormat Gets or sets a value indicating whether use default time format

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *

# Get the tool.
tool = app.Tools.CreateNew("Append values")
# Add input items.
tool.InputItems.Add(<A single time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.ImportTools.IAppendValuesTools(app.Tools.CreateNew("Append values"))
# Add input items.
tool.InputItems.Add(<A single time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Append values") as DHI.Solutions.TimeseriesManager.Tools.ImportTools.AppendValuesTools;

// Set the tool properties and execute.
tool.InputItems.Add(ds_in);
tool.AutoUIExecute = false;
tool.FilePath = @"c:\temp\spreadsheet1.xlsx";
tool.IsOutOfPlatform = true;
tool.FlagMappingFilePath = @"c:\temp\MappingSpreadsheet.xlsx";
tool.OverwriteExistingFlags = true;
tool.DecimalSeparator = ".";
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.ImportTools.AppendValuesTools"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll" />

    Auto-correlation

    This tool calculates the auto-correlation value of a time series.

    Tool Info
    Display Name Auto-correlation
    API Name Auto-correlation
    Tools Explorer /Advanced statistics/Auto-correlation
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.AdvancedStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IAutoCorrelationTool
    Input Items A single time series
    Output Items An X-Y data series

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Auto-correlation")
# Add input items.
tool.InputItems.Add(<A single time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IAutoCorrelationTool(app.Tools.CreateNew("Auto-correlation"))
# Add input items.
tool.InputItems.Add(<A single time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Auto-correlation") as DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.AutoCorrelationTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds_in);
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.AutoCorrelationTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll" />

    Average

    The Average tool is used to calculate the simple mean and/or time weighted average of one or more time series.

    Tool Info
    Display Name Average
    API Name Average
    Tools Explorer /Basic statistics/Average
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.BasicStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.ITimeWeighedAverageValueTool
    Input Items One or more time series
    Output Items A data table

    Tool Properties

    Display Name API Name Description
    Input Parameters
    Time weighted average TimeBasedAverageValue Gets or sets a value indicating whether the type of average.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Average")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.ITimeWeighedAverageValueTool(app.Tools.CreateNew("Average"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Average") as DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.TimeWeighedAverageValueTool;

// Set the tool properties and execute.
tool.InputItems.Add(ts_in);
tool.TimeBasedAverageValue = true;
tool.Execute();

// Get the output of the tool.
var outputItem = tool.OutputItems[0] as DHI.Solutions.Generic.Tools.TableContainer;
var result = (double)outputItem.TabularData.Rows[0][1];

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.TimeWeighedAverageValueTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll" />

    Check time series tool

    The Check time series tool checks the values of one or more time series, according to a specified criterion, and returns back a boolean with the result of the check.

    Tool Info
    Display Name Check time series tool
    API Name Check time series tool
    Tools Explorer /QA-QC/Check time series tool
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.ICheckTimeseriesTool
    Input Items One or more time series
    Output Items A data table

    Tool Properties

    Display Name API Name Description
    Options
    Method CheckMethod Gets or sets the CheckMethod. The check method determines which
    check that will be applied to the input items.
  • Value_exists - Use this option to check that a given valueexists at least once in the time series.
  • Contains_gap_larger_than - Use this value to check if the time series containsgaps larger than a specified time span.
  • Within_range - Use this option to check if the values in the time seriesare within a specified range.
  • Max_rate_of_change - Use this option to check if the rate of change between time stepsare lower than a specified rate of change.
    		•
    Period PeriodOption Gets or sets the PeriodOption. The period option determines if the
    check shall be applied to the entire time series, or to a sub-period
    only
  • Entire_timeseries - Use this option to apply the tool to the entire time series.
  • Sub_period - Use this option to apply the tool to a sub-period.
    		•
    Settings
    Max gap MaxGap Gets or sets the MaxGap. The max gap is the maximum acceptable gap in a time series.
    If a gap that exceeds the MaxGap is found in a time series, true is returned.
    Note that the property is only available when: CheckMethod=Contains_gap_larger_than
    Max rate of change MaxRateOfChange Gets or sets the MaxRateOfChange. This is the value that defines the maximum acceptable rate of change.
    If this rate is exceeded in one or more time steps, true will be returned. Relevant if CheckMethod = Max_rate_of_change.
    Note that the property is only available when: CheckMethod=Max_rate_of_change
    Range max RangeMax Gets or sets RangeMax. Range max is the minimum value of the range that will be checked for if
    CheckMethod = WithinRange.
    Note that the property is only available when: CheckMethod=Within_range
    Range min RangeMin Gets or sets RangeMin. Range min is the minimum value of the range that will be checked for if
    CheckMethod = WithinRange.
    Note that the property is only available when: CheckMethod=Within_range
    Rate of change unit RateOfChangeUnit Gets or sets the RateOfChangeUnit. The rate of change unit defines the unit of
    the specified MaxRateOfChange.
  • Per_second - Unit is [unit of input item]/second
  • Per_minute - Unit is [unit of input item]/minute
  • Per_hour - Unit is [unit of input item]/hour
  • Per_day - Unit is [unit of input item]/day
    • .
    Note that the property is only available when: CheckMethod=Max_rate_of_change
    Value CheckValue Gets or sets the CheckValue. The check value is the value that will be
    searched for if CheckMethod = Value_exists.
    Note that the property is only available when: CheckMethod=Value_exists
    Sub-period
    End date EndDate Gets or sets the EndDate. The end date determines the end of the
    sub-period for which the check will be applied.
    Note that the property is only available when: PeriodOption=Sub_period
    Start date StartDate Gets or sets the StartDate. The start date determines the start of the
    sub-period for which the check will be applied.
    Note that the property is only available when: PeriodOption=Sub_period

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("Check time series tool")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.ICheckTimeseriesTool(app.Tools.CreateNew("Check time series tool"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Check time series tool") as DHI.Solutions.TimeseriesManager.Tools.Processing.CheckTimeseriesTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds);
tool.CheckMethod = DHI.Solutions.TimeseriesManager.Tools.Processing.CheckMethod.Within_range;
tool.PeriodOption = DHI.Solutions.TimeseriesManager.Tools.Processing.CheckTimeseriesTool_PeriodOption.Entire_timeseries;
tool.RangeMax = 100;
tool.RangeMin = 5;
tool.Execute();

// Get the output of the tool.
var outputItem = tool.OutputItems[0] as DHI.Solutions.Generic.Tools.TableContainer;
bool valueExists = (bool)outputItem.TabularData.Rows[0][1];

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.CheckTimeseriesTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Chi-squared test

    The Chi-square goodness of fit test is a statistical hypothesis test used to determine whether a variable is likely to come from a specified distribution or not. It is often used to evaluate whether sample data is representative of the full population.

    Tool Info
    Display Name Chi-squared test
    API Name Goodness-of-fit Chi-Squared
    Tools Explorer /Probability distribution/Chi-squared test
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.GoodnessOfFit.ChiSquared
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.FitChiSquaredTool.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.FitChiSquaredTool.IFitChiSquaredTool
    Input Items One or more estimation of distribution parameters
    Output Items A data table

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.FitChiSquaredTool")
from DHI.Solutions.TimeseriesManager.Tools.FitChiSquaredTool import *

# Get the tool.
tool = app.Tools.CreateNew("Goodness-of-fit Chi-Squared")
# Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.FitChiSquaredTool")
from DHI.Solutions.TimeseriesManager.Tools.FitChiSquaredTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.FitChiSquaredTool.IFitChiSquaredTool(app.Tools.CreateNew("Goodness-of-fit Chi-Squared"))
# Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Goodness-of-fit Chi-Squared") as DHI.Solutions.TimeseriesManager.Tools.FitChiSquaredTool.IFitChiSquaredTool;
// Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>);
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.FitChiSquaredTool.FitChiSquaredTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.FitChiSquaredTool.dll" />

    Convert to Ensemble

    Tool for converting two or more time series into a single ensemble time series.

    Tool Info
    Display Name Convert to Ensemble
    API Name Convert to ensemble
    Tools Explorer /Time series processing/Convert to Ensemble
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.IConvertToEnsembleTool
    Input Items Two or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Tool Settings
    Ensemble name EnsembleName Gets or sets the name of ensemble name
    to the selected series
    Overwrite option DuplicateNameOption Gets or sets the option when a time series with the same name is already existed in the group
  • CreateAndReplace - Create and replace the timeseries
  • DontCreate - Don't create the timeseries
  • CreateButRename - Create but rename the timeseries
    		•
    Target group TargetGroup Gets or sets a value indicating the selected series.
    to the selected series

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("Convert to ensemble")
# Add input items.
tool.InputItems.Add(<Two or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.IConvertToEnsembleTool(app.Tools.CreateNew("Convert to ensemble"))
# Add input items.
tool.InputItems.Add(<Two or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Convert to ensemble") as DHI.Solutions.TimeseriesManager.Tools.Processing.ConvertToEnsembleTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds1);
tool.InputItems.Add(ds2);
tool.TargetGroup = "/test";
tool.EnsembleName = "EnsembleTest";
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.ConvertToEnsembleTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Count

    The Basic Sample Size tool returns the number of time steps that contains values in a time series (number of time steps minus missing values).

    Tool Info
    Display Name Count
    API Name BasicSampleSize
    Tools Explorer /Basic statistics/Count
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.BasicStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IBasicSampleSizeTool
    Input Items One or more time series
    Output Items A data table

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("BasicSampleSize")
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IBasicSampleSizeTool(app.Tools.CreateNew("BasicSampleSize"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("BasicSampleSize") as DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.BasicSampleSizeTool;

// Set the tool properties and execute.
tool.InputItems.Add(ts_in);
tool.Execute();

// Get the output of the tool.
var outputItem = tool.OutputItems[0] as DHI.Solutions.Generic.Tools.TableContainer;
int result = (int)outputItem.TabularData.Rows[0][1];

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.BasicSampleSizeTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll" />

    Count per year (average)

    The Count per year (average) tool returns the average number of time steps per year that contains values.

    Tool Info
    Display Name Count per year (average)
    API Name BasicAvgNumEvent
    Tools Explorer /Basic statistics/Count per year (average)
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.BasicStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IBasicAvgNumEventTool
    Input Items One or more time series
    Output Items A data table

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("BasicAvgNumEvent")
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IBasicAvgNumEventTool(app.Tools.CreateNew("BasicAvgNumEvent"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("BasicAvgNumEvent") as DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.BasicAvgNumEventTool;

// Set the tool properties and execute.
tool.InputItems.Add(ts_in);
tool.Execute();

// Get the output of the tool.
var outputItem = tool.OutputItems[0] as DHI.Solutions.Generic.Tools.TableContainer;
double actual = (double)outputItem.TabularData.Rows[0][1];

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.BasicAvgNumEventTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll" />

    Coverage

    This tool calculates coverage of time series.

    Tool Info
    Display Name Coverage
    API Name Coverage
    Tools Explorer /Advanced statistics/Coverage
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.AdvancedStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.ITimeSeriesCoverageTool
    Input Items One or more time series
    Output Items No output items

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Coverage")
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.ITimeSeriesCoverageTool(app.Tools.CreateNew("Coverage"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Coverage") as DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.ITimeSeriesCoverageTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.TimeSeriesCoverageTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll" />

    Create time series

    The Create time series tool is used to create a new time series based on a template time series. Values of each time step will be set using the Value property.

    Tool Info
    Display Name Create time series
    API Name Create timeseries
    Tools Explorer /Time series processing/Create time series
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.ICreateTimeseries
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Tool settings
    End time EndTime Gets or sets the end date of the new time series
    Start time StartTime Gets or sets the the start date of the new time series
    Value Value Gets or sets the value that will be inserted at all time steps. Leaving this value empty, will set null values in time steps.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("Create timeseries")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.ICreateTimeseries(app.Tools.CreateNew("Create timeseries"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Create timeseries") as DHI.Solutions.TimeseriesManager.Tools.Processing.CreateTimeseries;

// Set the tool properties and execute.
tool.InputItems.Add(ds_in);
tool.StartTime = new DateTime(2017, 12, 20);
tool.EndTime = new DateTime(2018, 1, 26);
tool.Value = 168;
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.CreateTimeseries"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Cross-correlation

    The Cross-correlation tool measures the similarity between a time series and lagged versions of another time series as a function of the lag.

    Tool Info
    Display Name Cross-correlation
    API Name Cross-correlation
    Tools Explorer /Advanced statistics/Cross-correlation
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.AdvancedStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.ICrossCorrelationTool
    Input Items Two or more time series
    Output Items A data table

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Cross-correlation")
# Add input items.
tool.InputItems.Add(<Two or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.ICrossCorrelationTool(app.Tools.CreateNew("Cross-correlation"))
# Add input items.
tool.InputItems.Add(<Two or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Cross-correlation") as DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.CrossCorrelationTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds1_in);
tool.InputItems.Add(ds2_in);
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.Tools.TableContainer;
string name = ds_out.TabularData.Rows[0][0].ToString();
double value = (double)ds_out.TabularData.Rows[0][1];

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.CrossCorrelationTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll" />

    Cumulative distribution function

    Cumulative distribution function tool, calculating the probability that a random variable, from a particular distribution, is less than a certain value.

    Tool Info
    Display Name Cumulative distribution function
    API Name Cumulative distribution function
    Tools Explorer /Probability distribution/Cumulative distribution function
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.CumulativeDistribution
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.CDFTool.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.CDFTool.ICDFTool
    Input Items One or more estimation of distribution parameters
    Output Items An X-Y data series

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.CDFTool")
from DHI.Solutions.TimeseriesManager.Tools.CDFTool import *

# Get the tool.
tool = app.Tools.CreateNew("Cumulative distribution function")
# Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.CDFTool")
from DHI.Solutions.TimeseriesManager.Tools.CDFTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.CDFTool.ICDFTool(app.Tools.CreateNew("Cumulative distribution function"))
# Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Cumulative distribution function") as DHI.Solutions.TimeseriesManager.Tools.CDFTool.ICDFTool;
// Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>);
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.CDFTool.CDFTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.CDFTool.dll" />

    Data quantile

    This tool calculates the data quantile. The data quantile is the value that a specified fraction of all raw data are less than. For a fraction of 0.5 the data quantile is the same as the median.

    Tool Info
    Display Name Data quantile
    API Name Data quantile
    Tools Explorer /Advanced statistics/Data quantile
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.AdvancedStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IDataQuantileTool
    Input Items One or more time series
    Output Items A data table

    Tool Properties

    Display Name API Name Description
    Tool Settings
    Fraction Fraction Gets or sets the fraction for which the data quantile shall be calculated for.
    For a fraction of 0.5 the data quantile is the same as the median.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Data quantile")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IDataQuantileTool(app.Tools.CreateNew("Data quantile"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Data quantile") as DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.DataQuantileTool;

// Set the tool properties and execute.
tool.InputItems.Add(ts_in);
tool.Fraction = 0.25;
tool.Execute();

// Get the output of the tool.
var outputItem = tool.OutputItems[0] as DHI.Solutions.Generic.Tools.TableContainer;
var result = (double)outputItem.TabularData.Rows[0][1];

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.DataQuantileTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll" />

    Delta change factors

    The Delta Change Factor tool downscales one or multiple climate parameter time series (precipitation, temperature, evaporation or potential evapotranspiration) using monthly delta change factors (CFs) given in NetCDF format. The tool can either generate delta change factors from control and scenario climate data or be given the delta change factors directly. Delta change factors are relative (precipitation, potential evapotranspiration) or absolute (temperature) changes of monthly averages derived from the comparison between scenario and control period. The monthly CFs are multiplied (added) by every value in the respective month of the observation time series in order to derive the downscaled and projected timeseries. Climate data is given in NetCDF format for the control and scenario period.If the periods span across several NetCDF files, then a CSV file can be used as input that lists the files in chronological order.

    Tool Info
    Display Name Delta change factors
    API Name Delta Change Factors
    Tools Explorer /Downscaling/Delta change factors
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ClimateDeltaChangeDownscaling
    Assembly name (.dll) DHI.Solutions.TimeSeriesManager.UI.Tools.DeltaChangeDownscalingTool.dll
    API Reference DHI.Solutions.TimeseriesManager.UI.Tools.DeltaChangeDownscalingTool.IDeltaChangeDownscalingTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Delta Change Factors Generation
    Calculate Delta Change Factor CalculateDeltaChangeFactors Gets or sets a value indicating whether delta change factors shall be calculated.
    If true, ControlDataFilePath, ScenarioDataFilePath and ChangeFactorFilePath (path to file to be created) shall be provided
    If false, only ChangeFactorFilePath is required
    Calculate Delta Change for Observed Data only CalculateDeltaChangeFactorsOnlyForObservedData Gets or sets a value indicating whether delta change factors shall be calculated only for spatial grids in which the
    observed data resides
    If true, ControlDataFilePath, ScenarioDataFilePath and ChangeFactorsFilePath shall be provided
    Control Data File Path ControlDataFilePath Gets or sets the path for the control data NetCDF file
    In case control data splits across multiple files, pass the CSV file listing the multiple NetCDF files in chronological order
    Only required if CalculateDeltaChangeFactors is true
    Scenario Data File Path ScenarioDataFilePath Gets or sets the path for the scenario data NetCDF file
    In case scenario data splits across multiple files, pass the CSV file listing the multiple NetCDF files in chronological order
    Only required if CalculateDeltaChangeFactors is true
    Time Period Representative IsPeriodRepresentative Gets or sets a value indicating whether the data is representive of a time duration instead of the exact date or time. ie. if the data is daily data at 12pm (or any hour of the day), the data represents that entire day. If the data is monthly data and the date falls on the 15th day of the month (or any other day of the month), the data represents the entire month.
    Delta Change Factors Parameters
    Delta Change Factors File Path DeltaChangeFactorsFilePath Gets or sets the path for the delta change factors
    If CalculateDeltaChangeFactors is set to true, it represents the path for the file to be created
    Delta change factors file is generated if CalculateDeltaChangeFactors is true
    Keep Timestep As Observed Data KeepTimestepAsObservedData Gets or sets a value indicating whether to keep the future timesteps the same as observed data.
    If KeepTimestepAsObservedData is set to true, the future timesteps will be the same as
    the observed timesteps. Else, it will be the same as the scenario timesteps
    Minimum Rainfall Threshold (mm/month) MinimumRainfallThreshold Gets or sets a value indicating the minimum threshold for average monthly rainfall,
    below which the value is not considered in the calculation for Delta Change Factor for the month
    Output Suffix OutputSuffix Gets or sets the suffix to be added to the name of the input dataseries when naming output dataseries

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeSeriesManager.UI.Tools.DeltaChangeDownscalingTool")
from DHI.Solutions.TimeseriesManager.UI.Tools.DeltaChangeDownscalingTool import *

# Get the tool.
tool = app.Tools.CreateNew("Delta Change Factors")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeSeriesManager.UI.Tools.DeltaChangeDownscalingTool")
from DHI.Solutions.TimeseriesManager.UI.Tools.DeltaChangeDownscalingTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.UI.Tools.DeltaChangeDownscalingTool.IDeltaChangeDownscalingTool(app.Tools.CreateNew("Delta Change Factors"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Delta Change Factors") as DHI.Solutions.TimeseriesManager.UI.Tools.DeltaChangeDownscalingTool.IDeltaChangeDownscalingTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.UI.Tools.DeltaChangeDownscalingTool.DeltaChangeDownscalingTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeSeriesManager.UI.Tools.DeltaChangeDownscalingTool.dll" />

    Differences

    A Timeseries Difference tool that can calculate residual time series from a master time series.

    Tool Info
    Display Name Differences
    API Name Differences
    Tools Explorer /Time series processing/Differences
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Differences
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.TSeriesDifferenceTool.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.TSeriesDifferenceTool.ITimeseriesDifferenceTool
    Input Items Two or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Input Parameters
    Master Timeseries MasterSeries Gets or sets a value indicating the selected series. All time series will be subtracted
    to the selected series

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.TSeriesDifferenceTool")
from DHI.Solutions.TimeseriesManager.Tools.TSeriesDifferenceTool import *

# Get the tool.
tool = app.Tools.CreateNew("Differences")
# Add input items.
tool.InputItems.Add(<Two or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.TSeriesDifferenceTool")
from DHI.Solutions.TimeseriesManager.Tools.TSeriesDifferenceTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.TSeriesDifferenceTool.ITimeseriesDifferenceTool(app.Tools.CreateNew("Differences"))
# Add input items.
tool.InputItems.Add(<Two or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Differences") as DHI.Solutions.TimeseriesManager.Tools.TSeriesDifferenceTool.TimeseriesDifferenceTool;

// Set the tool properties and execute.
tool.InputItems.Add(differenceTest_Ts_Master);
tool.InputItems.Add(differenceTest_Ts_Input);
tool.MasterSeries = differenceTest_Ts_Master.Name;
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.TSeriesDifferenceTool.TimeseriesDifferenceTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.TSeriesDifferenceTool.dll" />

    Distribution

    Distribution Functions tool supporting distribution functions:

    • Cumulative (CDF) - The probability that a random variable, from a particular distribution, is less than a certain value.
    • Probability (PDF) - The probability of the random variable falling within a particular range of values.
    Tool Info
    Display Name Distribution
    API Name Distribution
    Tools Explorer /Basic statistics/Distribution
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.BasicStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IDistributionTool
    Input Items One or more time series
    Output Items An X-Y data series

    Tool Properties

    Display Name API Name Description
    Tool settings
    Distribution Type DistributionType Gets or sets the distribution Type.
  • CDF - Cumulative Distribution Function property selection.
  • PDF - Probability Distribution Function property selection.
    		•
    Interval length IntervalLength Gets or sets the interval length
    Start value StartValue Gets or sets the start value
    Y Axis Option YAxisOption Gets or sets the option that specifies which values that shall be
    assigned to the Y-Axis.
  • AbsoluteFrequency - The absolute Frequency is the number of observations in each interval
  • RelativeFrequency - The relative frequency is the number of observations in each interval, divided by the total number of observation.
  • AbsoluteFrequencyDensity - The absolute frequency density is the absolute frequency divided withthe interval width
  • RelativeFrequencyDensity - Relative frequency density is the relativt frequency dividedwith the interval width.
    • .
    Note that the property is only available when: DistributionType=PDF

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Distribution")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IDistributionTool(app.Tools.CreateNew("Distribution"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Distribution") as DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.DistributionTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds_in);
tool.DistributionType = DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.DistributionType.CDF;
tool.IntervalLength = 214;
tool.StartValue = -28;
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.DistributionTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll" />

    Double mass

    The Double mass tool is used to determine whether there is a need for corrections to the data to account for changes in data collection procedures or other local conditions. The tool is configured in a dialog that appears when executing the tool.

    Tool Info
    Display Name Double mass
    API Name Double mass
    Tools Explorer /Time series processing/Double mass
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.DoubleMass
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.UI.Tools.DoubleMassTool.dll
    API Reference DHI.Solutions.TimeseriesManager.UI.Tools.DoubleMassTool.IDoubleMassTool
    Input Items Two or more time series
    Output Items A time series

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.UI.Tools.DoubleMassTool")
from DHI.Solutions.TimeseriesManager.UI.Tools.DoubleMassTool import *

# Get the tool.
tool = app.Tools.CreateNew("Double mass")
# Add input items.
tool.InputItems.Add(<Two or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.UI.Tools.DoubleMassTool")
from DHI.Solutions.TimeseriesManager.UI.Tools.DoubleMassTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.UI.Tools.DoubleMassTool.IDoubleMassTool(app.Tools.CreateNew("Double mass"))
# Add input items.
tool.InputItems.Add(<Two or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Double mass") as DHI.Solutions.TimeseriesManager.UI.Tools.DoubleMassTool.IDoubleMassTool;
// Add input items.
tool.InputItems.Add(<Two or more time series>);
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.UI.Tools.DoubleMassTool.DoubleMassTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.UI.Tools.DoubleMassTool.dll" />

    Drought duration and volume

    Drought duration and volume tool.

    Tool Info
    Display Name Drought duration and volume
    API Name Drought Duration and Volume
    Tools Explorer /Advanced statistics/Drought duration and volume
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.AdvancedStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IDroughtTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Category_ToolSettings
    Variable Variable Gets or sets variable.
    Volume Unit VolumeUnit Gets or sets the volume unit.
    Threshold
    Threshold Threshold Gets or sets threshold level for computation

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Drought Duration and Volume")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IDroughtTool(app.Tools.CreateNew("Drought Duration and Volume"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Drought Duration and Volume") as DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.DroughtTool;

// Set the tool properties and execute.
tool.InputItems.Add(ts_in);
tool.Threshold = 300;
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.DroughtTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll" />

    Duration curve

    A duration curve is based on the calculated exceedance probability for the range of values found in the time series being analyzed. A duration curve shows the range of data values found in the time series as a function of the exceedance probability. An exceedance probability of zero means that the value is exceeded at all times and a value of one indicates that the value is not exceeded in the time span covered by the time series.

    Special case for instantaneous data, which are treated with EventsToScalarOperator. Slow, but correct, because: With interpolation for instantaneous data, where several thresholds may be crossed during a single time step, e.g., so the duration above those thresholds must also be counted (whereas a naive algorithm would only count the duration above the lowest of the two adjacent values in the single time step currently examined). Sketch:

    Tool Info
    Display Name Duration curve
    API Name Duration curve
    Tools Explorer /Advanced statistics/Duration curve
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.AdvancedStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IDurationCurveTool
    Input Items One or more time series
    Output Items An X-Y data series

    Tool Properties

    Display Name API Name Description
    Description
    X-axis Unit XAxisUnit Gets or sets the X-axis unit
  • Fraction - Fraction uint
  • Percent - Percent uint
    		•

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Duration curve")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IDurationCurveTool(app.Tools.CreateNew("Duration curve"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Duration curve") as DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.DurationCurveTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds_in);
tool.XAxisUnit = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.XAxisUnitType.Fraction;
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.DurationCurveTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll" />

    Empirical CDF

    Cumulative distribution function (empirical) Tool.

    Tool Info
    Display Name Empirical CDF
    API Name Empirical CDF
    Tools Explorer /Probability distribution/Empirical CDF
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Distribution
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Distribution.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Distribution.IEmpiricalCDFTool
    Input Items One or more time series
    Output Items An X-Y data series

    Tool Properties

    Display Name API Name Description
    Plot Position
    Plot Position PlotPosition Gets or sets plotting position (empirical probability). The following plotting positions can be used (Blom, Cunnane, Gringorten, Hazen, Weibull).

    Tool Methods

    • SetPlotPosition(EvaStatWrapper.PlotType plotPos): set plotting position by PlotType

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Distribution")
from DHI.Solutions.TimeseriesManager.Tools.Distribution import *

# Get the tool.
tool = app.Tools.CreateNew("Empirical CDF")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Distribution")
from DHI.Solutions.TimeseriesManager.Tools.Distribution import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Distribution.IEmpiricalCDFTool(app.Tools.CreateNew("Empirical CDF"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Empirical CDF") as DHI.Solutions.TimeseriesManager.Tools.Distribution.EmpiricalCDFTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds_in);
tool.PlotPosition = "Weibul";
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Distribution.EmpiricalCDFTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Distribution.dll" />

    Ensemble statistics

    The ensemble statistics tool calculates a user specified statics for each input ensemble time series. The tool will return the calculated result as an ordinary time series with one value for each time step in the input ensemble time series. The tool calculates the statistics of the remaining elements once missing values are removed.

    Tool Info
    Display Name Ensemble statistics
    API Name EnsembleStatisticsTool
    Tools Explorer /Ensemble/Ensemble statistics
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.AdvancedStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IEnsembleStatisticsTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Options
    Statistics StatOption Gets or sets the statistics option.
  • Maximum - Maximum value
  • Mean - Mean value
  • Minimum - Minimum value
  • Quantile - The Quantile
  • StandardDeviation - Standard deviation
  • Exceedance - Exceedance Probability of a constant
  • NonExceedance - Non Exceedance Probability of a constant
    		•
    Settings
    Exceedance value ExceedanceConstant Gets or sets the Exceedance Constant value option.
    Note that the property is only available when: StatOption=Exceedance
    Non-exceedance value NonExceedanceConstant Gets or sets the Non Exceedance Constant value option.
    Note that the property is only available when: StatOption=NonExceedance
    Probability Probability Gets or sets the probability for the quantile statistics option.
    Note that the property is only available when: StatOption=Quantile

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("EnsembleStatisticsTool")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IEnsembleStatisticsTool(app.Tools.CreateNew("EnsembleStatisticsTool"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("EnsembleStatisticsTool") as DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.EnsembleStatisticsTool;

// Set the tool properties and execute.
tool.StatOption = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.StatOption.Maximum;
tool.Execute();    

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.EnsembleStatisticsTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll" />

    Exceedance duration and volume

    Exceedance duration and volume.

    Tool Info
    Display Name Exceedance duration and volume
    API Name Exceedance Duration and Volume
    Tools Explorer /Advanced statistics/Exceedance duration and volume
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.AdvancedStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IExceedanceTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Threshold
    Threshold Threshold Gets or sets threshold level for computation

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Exceedance Duration and Volume")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IExceedanceTool(app.Tools.CreateNew("Exceedance Duration and Volume"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Exceedance Duration and Volume") as DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.ExceedanceTool;

// Set the tool properties and execute.
tool.InputItems.Add(ts_in);
tool.Threshold = 2000;
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.ExceedanceTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll" />

    Extract ensemble members

    A tool that can take an ensemble (multi-item) time series and produce a single item time series for each member.

    Tool Info
    Display Name Extract ensemble members
    API Name Extract ensemble members
    Tools Explorer /Ensemble/Extract ensemble members
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.IExtractEnsembleMembersTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Tool Settings
    Overwrite option DuplicateNameOption Gets or sets the option when a time series with the same name is already existed in the group
  • CreateAndReplace - Create and replace the timeseries
  • DontCreate - Don't create the timeseries
  • CreateButRename - Create but rename the timeseries
    • .
    Note that the property is only available when: SaveToDatabase=True
    Save to database SaveToDatabase Gets or sets a value indicating whether the ensemble members should be saved to the database.
    Target group TargetGroup Gets or sets a value indicating the selected series. All time series will be subtracted
    to the selected series.
    Note that the property is only available when: SaveToDatabase=True

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("Extract ensemble members")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.IExtractEnsembleMembersTool(app.Tools.CreateNew("Extract ensemble members"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Extract ensemble members") as DHI.Solutions.TimeseriesManager.Tools.Processing.ExtractEnsembleMembers;

// Set the tool properties and execute.
tool.InputItems.Add(ds_in);
tool.TargetGroup = "/";
tool.DuplicateNameOption = DHI.Solutions.TimeseriesManager.Tools.Processing.DuplicateNameOption.CreateAndReplace;
tool.SaveToDatabase = true;
tool.Execute();

// Get the output of the tool.
var ds_member1 = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;
var ds_member2 = tool.OutputItems[1] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.ExtractEnsembleMembers"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Extract time period

    Cuts all time series before start and beyond end date. This is done at the exact start and end dates, ie, if a TS does not have a time step at the start/end times, add it/them, and synchronize appropriately. The tool returns the extracted time series (clones).

    Tool Info
    Display Name Extract time period
    API Name Extract time period
    Tools Explorer /Time series processing/Extract time period
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.IExtractPeriodTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Tool Settings
    Period Begin PeriodBegin Gets or sets the start time for the cut.
    Period End PeriodEnd Gets or sets the end time for the cut.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("Extract time period")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.IExtractPeriodTool(app.Tools.CreateNew("Extract time period"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Extract time period") as DHI.Solutions.TimeseriesManager.Tools.Processing.ExtractPeriodTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds_in);
tool.PeriodBegin = new DateTime(2010, 1, 3, 12, 0, 0, 0);
tool.PeriodEnd = new DateTime(2010, 1, 8, 12, 0, 0, 0);
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.ExtractPeriodTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Fit to distribution

    Parameter estimation tool for determining the probability distribution, supporting methods:

    • Moments
    • L_Moments
    • MaximumLikelihood
    Tool Info
    Display Name Fit to distribution
    API Name Fit to distribution
    Tools Explorer /Probability distribution/Fit to distribution
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Distribution
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Distribution.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Distribution.IParameterEstimateTool
    Input Items One or more time series
    Output Items Estimation of distribution parameters

    Tool Properties

    Display Name API Name Description
    Distribution
    Distribution Distribution Gets or sets distribution used to estimate parameters
    Method
    Method Method Gets or sets method used to estimate parameters
    Parameters
    Input Type IType_LN3 Gets or sets input parameter used in MOM log-normal distribution.
    Note that the property is only available when: ShowLN3Type=1
    Input Type IType_LP3 Gets or sets input parameter used in MOM log-Pearson Type 3 distribution.
    Note that the property is only available when: ShowLP3Type=1
    Threshold Threshold Gets or sets input parameter for following distributions:

    - Log_normal2
    - Exponential1
    - Generalised_Pareto2
    - GammaPearson_Type3_2
    - Weibull2.
    Note that the property is only available when: ShowThreshold=1

    Tool Methods

    • SetMethod(EvaStatWrapper.MethodType method): set method with MethodType
    • SetDistribution(EvaStatWrapper.DistributionType dist): set distribution with DistributionType
    • SetTypeLN3(EvaStatWrapper.LN3Type ln3Type): set LN3 type with int
    • SetTypeLP3(EvaStatWrapper.LP3Type lp3Type): set LP3 type with int

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Distribution")
from DHI.Solutions.TimeseriesManager.Tools.Distribution import *

# Get the tool.
tool = app.Tools.CreateNew("Fit to distribution")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Distribution")
from DHI.Solutions.TimeseriesManager.Tools.Distribution import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Distribution.IParameterEstimateTool(app.Tools.CreateNew("Fit to distribution"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Fit to distribution") as DHI.Solutions.TimeseriesManager.Tools.Distribution.IParameterEstimateTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Distribution.ParameterEstimateTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Distribution.dll" />

    Flag outliers

    This tool adds a user specified flag to the values in a time series that falls within a specified criterion. Flags can be added to the original input time series, or a copy of the series. By default, Days=1.

    Tool Info
    Display Name Flag outliers
    API Name Flag outliers
    Tools Explorer /QA-QC/Flag outliers
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.IFlagOutlierTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Tool Criteria
    Criteria Option Option Gets or sets a value criteria for flagging
  • Outside_range - Values falls outside this range
  • Inside_range - values falls inside this range
  • Max_rate_of_change - Maximum rate of change that will be allowed
  • Min_rate_of_change - Minimum rate of change that will be allowed
    		•
    Maximum rate MaxRate Gets or sets a value of maximum allowed rate.
    Note that the property is only available when: Option=Max_rate_of_change
    Minimum rate MinRate Gets or sets a value of minimum allowed rate.
    Note that the property is only available when: Option=Min_rate_of_change
    Range max UpperLimit Gets or sets the upper limit of the data series.
    Note that the property is only available when: Option=Outside_range,Inside_range
    Range min LowerLimit Gets or sets the lower limit of the data series.
    Note that the property is only available when: Option=Outside_range,Inside_range
    Smoothing Smoothing Gets or sets a value of smoothing
  • Enabled - Enabled moving average calculations
  • Disabled - Disabled moving average calculations
    • .
    Note that the property is only available when: Option=Outside_range,Inside_range
    Unit Unit Gets or sets the unit.
  • Per_second - Change per second
  • Per_minute - Change per minute
  • Per_hour - Change per hour
  • Per_day - Change per day
    • .
    Note that the property is only available when: Option=Max_rate_of_change,Min_rate_of_change
    Tool Settings
    Add flags to copy AddFlagsToCopy Gets or sets a value indicating whether the flags shall be added to a copy of the data series.
    If true, the flags shall be added to a copy of the data series. If false,the flags shall be
    added directly to the input time series.
    Flag outliers FlagOutliers Gets or sets the flag selected.
    Replace existing flags ReplaceExisting Gets or sets a value indicating whether the flags replace the existing one
    If the value is true, the tool will always flag a value identified as outliers,
    even if the time step already has been flagged (and hence existing flags will be overwritten).
    If false, the tool will not add flags to time steps that has already been flagged.
    Window width
    Days Days Gets or sets a value of change of rate per days.
    Note that the property is only available when: Smoothing=EnabledOption=Outside_range,Inside_range
    Hours Hours Gets or sets a value of change of rate per hours.
    Note that the property is only available when: Smoothing=EnabledOption=Outside_range,Inside_range
    Minutes Minutes Gets or sets a value of change of rate per minutes.
    Note that the property is only available when: Smoothing=EnabledOption=Outside_range,Inside_range
    Seconds Seconds Gets or sets a value of change of rate per seconds.
    Note that the property is only available when: Smoothing=EnabledOption=Outside_range,Inside_range

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("Flag outliers")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.IFlagOutlierTool(app.Tools.CreateNew("Flag outliers"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Flag outliers") as DHI.Solutions.TimeseriesManager.Tools.Processing.IFlagOutlierTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.FlagOutlierTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Forecast statistics

    Forecast statistics tool

    Tool Info
    Display Name Forecast statistics
    API Name Forecast statistics
    Tools Explorer /Advanced statistics/Forecast statistics
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.AdvancedStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IForecastStatisticsTool
    Input Items A single time series group
    Output Items An X-Y data series

    Tool Properties

    Display Name API Name Description
    Settings
    Hindcast period HindCast Gets or sets the value of HindCast
    Statistics Statistics Gets or sets the value of Statistics
  • Mean - mean value
  • Max - maximum value
  • Min - minimum value
  • MeanError - mean error value
  • AbsoluteMeanError - absolute mean error value
  • RootMeanSquareError - root of mean square error
    		•
    Time series
    Forecast time series ForecastTimeseries Gets or sets the value of ForecastTimeseries
    Observation time series ObservationTimeseries Gets or sets the value of ObservationTimeseries.
    Note that the property is only available when: Statistics=MeanError,AbsoluteMeanError,RootMeanSquareError

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Forecast statistics")
# Add input items.
tool.InputItems.Add(<A single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IForecastStatisticsTool(app.Tools.CreateNew("Forecast statistics"))
# Add input items.
tool.InputItems.Add(<A single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Forecast statistics") as DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IForecastStatisticsTool;
// Add input items.
tool.InputItems.Add(<A single time series group>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.ForecastStatisticsTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll" />

    Gap filler

    Fill gaps in time series Y by: 1. finding the most closely correlated other time series X in the analysis that has data; 2. use linear regression to get Y(X) = mX + b. The coefficients m and b can be found along with the correlations (to save time, although logically, they don't have anything to do with each other in the logic of this tool) Note there is no requirement on data type or unit consistency between X and Y. In that sense, this approach is similar to co-kriging. (Strictly speaking, the m parameter includes any unit conversion.) Example for why the approach makes sense: It is ok to infer discharge from rainfall.

    Tool Info
    Display Name Gap filler
    API Name Gap filler
    Tools Explorer /Time series processing/Gap filler
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.GapFiller
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.UI.Tools.GapFillerTool.dll
    API Reference DHI.Solutions.TimeseriesManager.UI.Tools.GapFillerTool.IGapFillerTool
    Input Items Two or more time series
    Output Items A time series

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.UI.Tools.GapFillerTool")
from DHI.Solutions.TimeseriesManager.UI.Tools.GapFillerTool import *

# Get the tool.
tool = app.Tools.CreateNew("Gap filler")
# Add input items.
tool.InputItems.Add(<Two or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.UI.Tools.GapFillerTool")
from DHI.Solutions.TimeseriesManager.UI.Tools.GapFillerTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.UI.Tools.GapFillerTool.IGapFillerTool(app.Tools.CreateNew("Gap filler"))
# Add input items.
tool.InputItems.Add(<Two or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Gap filler") as DHI.Solutions.TimeseriesManager.UI.Tools.GapFillerTool.IGapFillerTool;
// Add input items.
tool.InputItems.Add(<Two or more time series>);
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.UI.Tools.GapFillerTool.PriorityRegressionGapFiller"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.UI.Tools.GapFillerTool.dll" />

    Histogram

    Tool for creating a histogram from one or more time series.

    Tool Info
    Display Name Histogram
    API Name Histogram
    Tools Explorer /Probability distribution/Histogram
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Distribution
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Distribution.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Distribution.IHistogramTool
    Input Items One or more time series
    Output Items An X-Y data series

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Distribution")
from DHI.Solutions.TimeseriesManager.Tools.Distribution import *

# Get the tool.
tool = app.Tools.CreateNew("Histogram")
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Distribution")
from DHI.Solutions.TimeseriesManager.Tools.Distribution import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Distribution.IHistogramTool(app.Tools.CreateNew("Histogram"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Histogram") as DHI.Solutions.TimeseriesManager.Tools.Distribution.HistogramTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds_in);
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Distribution.HistogramTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Distribution.dll" />

    Import from ASCII

    Import one or more time series from ASCII files. The ASCII file can contain multiple columns with time series. The name of the time series are specified in the first row of the file.

    Only data consisting of a date and a value will be read. There may be other text in the file, but it will not be read. The exception is the optional title of the value column, which must be placed next to the DateTime-column. This will be the title of the time series.

    Tool Info
    Display Name Import from ASCII
    API Name ImportFromASCII
    Tools Explorer /Import Tools/Import from ASCII
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ImportTools
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportFromASCIITool
    Input Items No input or a single time series group
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    File options
    Decimal separator DecimalSeparator Gets or sets the decimal separator.
  • RegionalSetting - the Regional Setting separator
  • Dot - the Dot separator
  • Comma - the Comma separator
    		•
    First Data Row FirstDataRow Gets or sets the first data row. The default is the second row (2).
    Note that the first row (1) in the file can contain unit and variable of the time series to import in the following format. "Discharge[m^3/s]:Instantaneous".
    In this case the first data row will be 3.
    Item Name Row ItemNameRow Gets or sets the row number containing the item names (time series names).
    Default is 0, and means that the row before the first data row is used.
    Supported from MIKE OPERATIONS 2024.2.
    Separator Separator Gets or sets the column separator in the ASCII file (Tab (\t), Comma ",", SemiColon ";" or Space " "). The default is Tab (\t).
    Value Column ValueColumn Gets or sets the value column. The default is the second column (2)
    Date and time
    Allow Duplicate Dates AllowDuplicateDates Gets or sets a value indicating wheather duplicate dates in the CSV file is allowed (if true, the value of the first occurance is used).
    Date Column DateColumn Gets or sets the date column. The default date column is the first column of the file (1).
    Date time format DateTimeFormat Gets or sets the time format of the DateColumn column. Default is "yyyy-MM-dd HH:mm:ss".
    Note that Daylight Saving Time is taken into account when having time zone in the datetime string. E.g. '2023-10-29T01:00:00+01:00' using the DateTimeFormat 'yyyy-MM-ddTHH:mm:sszzz'.
    See more on date and time formatting on Microsoft Learn Custom Date and Time Formats .
    Date time Kind DateKind Gets or sets the kind of the date time. The value could be Local or Utc.
  • Local - Local time
  • Utc - Utc time
    • .
    Note that the property is only available when: ConvertToTimeZone=True
    Enable Time Zone ConvertToTimeZone Gets or sets a value indicating whether to convert the date time to the specified time zone.
    If the value is true, the time zone value will be treated as the source time zone of the input data.
    And the date time will be converted from the source time zone to the local one or Utc, which is defined by the "Date time Kind" property.
    If the value is false, the date time in the input file will be used. No conversion will happen.
    Time Column TimeColumn Gets or sets the value of time column, in case time of time steps is in a separate column. Use the TimeFormat column to specify the Time Format.
    The default value is 0, indicating that time of the time step is not in a separate column, but in the DateTime column.
    Supported from MIKE OPERATIONS 2024.3.
    Note that the property is only available when: ImportFromOption=SingleFile,Batch
    Time Format TimeFormat Gets or sets the value of time format which is used when a time coumn exists. E.g. "HH:mm:ss".
    See more on time formatting on Microsoft Learn Custom Date and Time Formats .
    Supported from MIKE OPERATIONS 2024.3.
    Note that the property is only available when: ImportFromOption=SingleFile,Batch
    Time Zone TimeZone Gets or sets the value of timezone.
    Note that the property is only available when: ConvertToTimeZone=True
    Import Selection
    File path FilePath Gets or sets the file name to import for single file, or the file containing import information in the batch option.
    Enabled when ImportFromOption = SingleFile or Batch.
    Note that the property is only available when: ImportFromOption=SingleFile,Batch
    Folder Folder Gets or sets the Folder from which the time series / ensemble will be imported from.
    Enabled when ImportFromOption = Folder.
    Note that the property is only available when: ImportFromOption=Folder
    Import as ImportAsOption Gets or sets the import option. The import option determines if the items in the selected file(s)
    shall be imported as time series or time series ensembles.
  • TimeSeries - Option for importing all items to individual,single item dataseries
  • Ensemble - Option for importing all items to a single,multi-item time series.
    		•
    Import from ImportFromOption Gets or sets the import option. The import option determines if a single file, or all files in a specified folder
    shall be imported.
  • SingleFile - Option for importing a single file
  • Folder - Option for importing all files in a folder.
  • Batch - Option for batch importing where files to import are specified in a comma separated file (CSV) or a spreadsheet stored in the database.
    		•
    Import specification format BatchImportFormat Gets or sets the specification format of batch importing (CSV or Spreadsheet).
  • CSV - Option for batch importing from a csv file with a row per time series to import in the format and first row (header):File name,Group,Item no., Feature class (path),Feature (display),,where:- File name: is the full path of the file to import.- Group: is the full path of the time series group to import to.- Item no.: is the item number of the time series in the file to import. If not specified, the first column is used.- Feature class (path): is an optional full path of a feature class containing a feature to associate the time series to.- Feature (display): is an optional name of a feature (of the feature class) to associate the time series to.
  • Spreadsheet - Option for batch importing from a spreadsheet.The spreadsheet should contain the following columns. The first row should contain columns names as specified:- File name: specifying the full path of the file to import.- Group: specifying the full path of the time series group to import to.- Item no.: specifying the item number of the time series in the file to import. If not specified, the first column is used.- Feature class (path): is an optional full path of a feature class containing a feature to associate the time series to.- Feature (display): is an optional name of a feature (of the feature class) to associate the time series to.
    • .
    Note that the property is only available when: ImportFromOption=Batch
    Items Dfs0Items Gets or sets the items of the dfs0 file to import.
    Note that the property is only available when: ImportFromOption=SingleFile,Folder
    Spreadsheet SpreadsheetPath Gets or sets the path of the Spreadsheet that contains an optional import specification for importing more time series with varying properties.
    The spreadsheet can contain the following columns: "File name" (required), - "Item no.", "Group" (required), "Feature class (path)", "Feature (display attribute)", "Variable" (required for ASCII import), "Unit" (required for ASCII import), "ValueType" (required for ASCII import).
    Target Group Group Gets or sets the Group to which the time series / ensemble will be imported.
    Note that the property is only available when: ImportToDatabase=True
    To Database ImportToDatabase Gets or sets a value indicating whether the imported series shall be written to the database.
    Default is true, but for unit test, it shall be false.
    Time series properties
    Unit Unit Gets or sets the DHI EUM unit of the time series.
    Value type ValueType Gets or sets the type of value of the time series.
  • Instantaneous - The values of the time series are measured at a precise instant.For example, the air tempera­ture at a particular time is an instantaneous value.
  • Accumulated - The values of the time series are summed over successive intervals of time and always relative to the same starting time.For example, rainfall accumulated over a year with monthly rainfall values.
  • Step_Accumulated - The values of the time series are accumulated over a time interval, relative to the beginning of the interval.For example, a tipping bucket rain gauge measures step-accu­mulated rainfall.In this case, the rain gauge accumulates rainfall until the gauge is full, then it empties and starts accumulating again.Thus, the time series consists of the total amount of rainfall accumulated in each time period - say in mm of rainfall.
  • Mean_Step_Accumulated - The values of the time series are accumulated over the time interval as in the Step Accumu­lated, but the value is divided by the length of the accumulation period.Thus, based on the previous example, the time series consists of the rate of rainfall accumulated in each time period - say in mm of rainfall per hour (mm/hr).
  • Reverse_Mean_Step_Accumulated - Reverse Mean Step Accumulated values are the same as the Mean Step Accumulated, but the values represent the time interval from now to the start of the next time inter­val.The Reverse Mean Step Accumulated time series are primarily used for forecasting purposes.
    		•
    Variable Variable Gets or sets the DHI EUM variable for the time series.
    Processing options
    Ensemble name EnsembleName Gets or sets the name of the imported ensemble. Enabled when ImportAsOption = Ensemble.
    Note that the property is only available when: ImportAsOption=Ensemble
    GroupBy Column GroupByColumn Gets or sets the value of group by column, defining what column to group ,time steps by in case time steps from multiple time series are in separate rows.
    Default is 0 indicating that group by is disabled and all rows of the file belongs to the same time series (use value column to specify column numbers for multiple time series).
    Supported from MIKE OPERATIONS 2024.3.
    Note that the property is only available when: ImportFromOption=SingleFile,Batch
    Ignore missing values IgnoreMissingValues Gets or sets a value indicating wheather time steps with missing values should be ignored (not added to the time series).
    True is only allowed for ImportAsOption=TimeSeries.
    Supported from MIKE OPERATIONS 2024.2.
    Note that the property is only available when: ImportAsOption=TimeSeries
    Invalid Value as Missing Value InvalidValueAsMissingValue Gets or sets a value indicating wheather values not able to be parsed, should be identified as missing values.
    Supported from MIKE OPERATIONS 2024.2.
    Missing Value MissingValue Gets or sets the value used for missing values in the file.
    Naming option NamingOption Gets or sets the time series naming option.
  • UseItemNameOnly - With this option, the imported time series will begiven the dfs0 item name.
  • FileNameAndItemName - With this option the imported time series will begiven the name "File name [item name]"
  • FullPathAndItemName - With this option the imported time series will begiven the name "Full path [item name]
    • .
    Note that the property is only available when: ImportAsOption=TimeSeries
    Time series overwrite option DuplicateNameOption Gets or sets the option when a time series with the same name is already present in the group.
  • CreateAndReplace - Create and replace the timeseries
  • DontCreate - Don't create the timeseries
  • CreateButRename - Create but rename the timeseries
  • NoSave - The no save - TS will not have associations
    • .
    Note that the property is only available when: ImportToDatabase=True

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *
clr.AddReference("DHI.Solutions.Generic.Tools")
from DHI.Solutions.Generic.Tools import *
clr.AddReference("DHI.Solutions.Generic")
from DHI.Solutions.Generic import *

# Get the tool.
tool = app.Tools.CreateNew("ImportFromASCII")
# Add input items.
tool.InputItems.Add(<No input or a single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportFromASCIITool(app.Tools.CreateNew("ImportFromASCII"))
# Add input items.
tool.InputItems.Add(<No input or a single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool assuming that the tool is already loaded.
var tool = application.Tools.CreateNew("ImportFromASCII") as DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportFromASCIITool;

tool.ImportFromOption = DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportFromOption.SingleFile;
// Set column separator of the file (default=Tab).
tool.Separator = "Comma";
// Setting the file path will parse the file header using the separator.
tool.FilePath = @"c:\temp\TimeSeriesToImport.txt";
tool.Variable = "1st order rate AD model";
tool.Unit = "/h";
tool.Group = "/";
tool.ImportAsOption = DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportAsOption.TimeSeries;

// Execute the tool
tool.Execute();

// Get the output of the tool.
var importedTsList = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportFromASCIITool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll" />

    Import from DFS0

    This tool will import dfs0 files to the DSS. The following import options are available: 1. Import a single dfs0 file 2. Import all dfs0 files in a specified folder to the dss. The tool can import the items in the selected dfs0 file(s) to a (number of) single item IDataSeries, or to a single multi item IDataSeries.

    Tool Info
    Display Name Import from DFS0
    API Name ImportFromDfs0
    Tools Explorer /Import Tools/Import from DFS0
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ImportTools
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportFromDfs0Tool
    Input Items No input or a single time series group
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Date and time
    Time Zone TimeZone Gets or sets the value of timezone
    Import Selection
    File path FilePath Gets or sets the file name to import for single file, or the file containing import information in the batch option.
    Enabled when ImportFromOption = SingleFile or Batch.
    Note that the property is only available when: ImportFromOption=SingleFile,Batch
    Folder Folder Gets or sets the Folder from which the time series / ensemble will be imported from.
    Enabled when ImportFromOption = Folder.
    Note that the property is only available when: ImportFromOption=Folder
    Import as ImportAsOption Gets or sets the import option. The import option determines if the items in the selected file(s)
    shall be imported as time series or time series ensembles.
  • TimeSeries - Option for importing all items to individual,single item dataseries
  • Ensemble - Option for importing all items to a single,multi-item time series.
    		•
    Import from ImportFromOption Gets or sets the import option. The import option determines if a single file, or all files in a specified folder
    shall be imported.
  • SingleFile - Option for importing a single file
  • Folder - Option for importing all files in a folder.
  • Batch - Option for batch importing where files to import are specified in a comma separated file (CSV) or a spreadsheet stored in the database.
    		•
    Import specification format BatchImportFormat Gets or sets the specification format of batch importing (CSV or Spreadsheet).
  • CSV - Option for batch importing from a csv file with a row per time series to import in the format and first row (header):File name,Group,Item no., Feature class (path),Feature (display),,where:- File name: is the full path of the file to import.- Group: is the full path of the time series group to import to.- Item no.: is the item number of the time series in the file to import. If not specified, the first column is used.- Feature class (path): is an optional full path of a feature class containing a feature to associate the time series to.- Feature (display): is an optional name of a feature (of the feature class) to associate the time series to.
  • Spreadsheet - Option for batch importing from a spreadsheet.The spreadsheet should contain the following columns. The first row should contain columns names as specified:- File name: specifying the full path of the file to import.- Group: specifying the full path of the time series group to import to.- Item no.: specifying the item number of the time series in the file to import. If not specified, the first column is used.- Feature class (path): is an optional full path of a feature class containing a feature to associate the time series to.- Feature (display): is an optional name of a feature (of the feature class) to associate the time series to.
    • .
    Note that the property is only available when: ImportFromOption=Batch
    Items Dfs0Items Gets or sets the items of the dfs0 file to import.
    Note that the property is only available when: ImportFromOption=SingleFile,Folder
    Spreadsheet SpreadsheetPath Gets or sets the path of the Spreadsheet that contains an optional import specification for importing more time series with varying properties.
    The spreadsheet can contain the following columns: "File name" (required), - "Item no.", "Group" (required), "Feature class (path)", "Feature (display attribute)", "Variable" (required for ASCII import), "Unit" (required for ASCII import), "ValueType" (required for ASCII import).
    Target Group Group Gets or sets the Group to which the time series / ensemble will be imported.
    Note that the property is only available when: ImportToDatabase=True
    To Database ImportToDatabase Gets or sets a value indicating whether the imported series shall be written to the database.
    Default is true, but for unit test, it shall be false.
    Processing options
    Ensemble name EnsembleName Gets or sets the name of the imported ensemble. Enabled when ImportAsOption = Ensemble.
    Note that the property is only available when: ImportAsOption=Ensemble
    Naming option NamingOption Gets or sets the time series naming option.
  • UseItemNameOnly - With this option, the imported time series will begiven the dfs0 item name.
  • FileNameAndItemName - With this option the imported time series will begiven the name "File name [item name]"
  • FullPathAndItemName - With this option the imported time series will begiven the name "Full path [item name]
    • .
    Note that the property is only available when: ImportAsOption=TimeSeries
    Time series overwrite option DuplicateNameOption Gets or sets the option when a time series with the same name is already present in the group.
  • CreateAndReplace - Create and replace the timeseries
  • DontCreate - Don't create the timeseries
  • CreateButRename - Create but rename the timeseries
  • NoSave - The no save - TS will not have associations
    • .
    Note that the property is only available when: ImportToDatabase=True

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *
clr.AddReference("DHI.Solutions.Generic.Tools")
from DHI.Solutions.Generic.Tools import *

# Get the tool.
tool = app.Tools.CreateNew("ImportFromDfs0")
# Add input items.
tool.InputItems.Add(<No input or a single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportFromDfs0Tool(app.Tools.CreateNew("ImportFromDfs0"))
# Add input items.
tool.InputItems.Add(<No input or a single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("ImportFromDfs0") as DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportFromDfs0Tool;

// Set the tool properties and execute.
tool.ImportFromOption = DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportFromOption.SingleFile;
tool.FilePath = @"c:\temp\discharge_station1.dfs0";
tool.Group = "/";
tool.ImportAsOption = DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportAsOption.TimeSeries;
tool.NamingOption = DHI.Solutions.TimeseriesManager.Tools.ImportTools.NamingOption.FileNameAndItemName;
tool.ImportToDatabase = false;
tool.Execute();

// Get the output of the tool.
var importedTsList = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportFromDfs0Tool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll" />

    Import from Excel

    This tool is used for importing time series from Microsoft Excel.

    Tool Info
    Display Name Import from Excel
    API Name ImportFromExcel
    Tools Explorer /Import Tools/Import from Excel
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ImportTools
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportFromExcelTool
    Input Items No input or a single time series group
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    File options
    Data start row DataStartRow Gets or sets the Excel start row number.
    Item Name Row ItemNameRow Gets or sets the row number containing the item names (time series names).
    Default is 0, and means the time series name is taken from the Time series name property.
    Supported from MIKE OPERATIONS 2024.2.
    Sheet name SheetName Gets or sets the Excel Sheet name containing data to import.
    Value column ValueColumn Gets or sets the Excel value column: Use letters(A, B, C etc), a list of columns separated by commas (e.g. B,C,E) or a range separated by a colon (e.g. B:E).
    Multiple columns are supported from MIKE OPERATIONS 2024.2.
    Date and time
    Date column DateColumn Gets or sets the Excel date column. Use letters (A, B, C etc).
    Date format DateFormat Gets or sets the Excel date format, in case the value of the cell is not a DateTime. Default "MM/dd/yy".
    Time column TimeColumn Gets or sets the Excel Time column in case time of time steps is in a separate column. Use letters (A, B, C etc).
    TimeColumn is supported from MIKE OPERATIONS 2024.3.
    Time format TimeFormat Gets or sets the Excel time format, in case time column is specified and not in DateTime column. Default "HH:mm:ss".
    See more on time formatting on Microsoft Learn Custom Date and Time Formats .
    TimeFormat is supported from MIKE OPERATIONS 2024.3.
    Import Selection
    File path ExcelFilePath Gets or sets the Excel file name.
    Target Group TimeSeriesGroup Gets or sets the value of TS group or TS path in the MO database where the time series are placed. If a folder is specified, the time series name to use is the sensor name.
    Note that the property is only available when: ToDatabase=True
    To Database ToDatabase Gets or sets a value indicating whether the time series should be imported into the time series database (true). False means that the time series can be found as output items of the tool only.
    Time series properties
    Time series name OutputDataSeriesName Gets or sets output data series Name.
    This property is used only if the ItemNameRow=0.
    Unit Unit Gets or sets the value of unit.
    Value type ValueType Gets or sets the list of value types supported.
    Variable Variable Gets or sets the value of variable.
    Processing options
    From Date FromDate Gets or sets the value of date from where data (time steps) should be taken.
    GroupBy column GroupByColumn Gets or sets the value of group by column, defining what column to group ,time steps by in case time steps from multiple time series are in separate rows. Use letters (A, B, C etc).
    Default is empty indicating that group by is disabled and all rows of the file belongs to the same time series (use value column to specify column numbers for multiple time series).
    GroupByColumn is supported from MIKE OPERATIONS 2024.3.
    To Date ToDate Gets or sets the value of date from where data (time steps) should be taken.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *

# Get the tool.
tool = app.Tools.CreateNew("ImportFromExcel")
# Add input items.
tool.InputItems.Add(<No input or a single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportFromExcelTool(app.Tools.CreateNew("ImportFromExcel"))
# Add input items.
tool.InputItems.Add(<No input or a single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("ImportFromExcel") as DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportFromExcelTool;

// Set properties and execute the tool.
tool.ExcelFilePath = @"c:\temp\ts1.xlsx";
tool.SheetName = "Sheet1";
tool.DataStartRow = 2;
tool.DateColumn = "A";
tool.ValueColumn = "B";
tool.Variable = "Water Level";
tool.Unit = "m";
tool.ValueType = "Instantaneous";
tool.TimeSeriesGroup = "/";
tool.ToDatabase = false;
tool.Execute();

// Get the output of the tool.
var importedTsList = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportFromExcelTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll" />

    Import from GRIB

    This tool is used for extracting time series from raster’s with the GRIB format. The time series for at single point can be imported or for all points.

    Tool Info
    Display Name Import from GRIB
    API Name ImportFromGRIB
    Tools Explorer /Import Tools/Import from GRIB
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ImportTools
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportTsFromGRIBTool
    Input Items No input or a single time series group
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Date and time
    Time Zone TimeZone Gets or sets the time zone
    Import Selection
    Data provider DataProvider Gets or sets the data provider for Grib file. The data provider property is not used for the import.
  • DMI - DMI Dataset
  • ECMWF - ECMWC dataset
    		•
    Export directory ExportDirectory Gets or sets the export directory.
    Note that the property is only available when: Todatabase=False
    Extraction option ExtractionOption Gets or sets the extraction option
  • SinglePoint - Extract values from a single, user specified location.
  • AllWithinZone - Extract one single item time series for each netCdf grid that falls inside a user specified zone
  • AreaWeighting - The area weighted mean value for a user specified zone
    		•
    File parameter Variable Gets or sets the variable
    File path FilePath Gets or sets the file path
    Grid feature class overwrite option for GridFeatureClassDuplicateNameOption Gets or sets the option when a grid feature class with the same name is already present in the group
  • CreateAndReplace - Create and replace the timeseries
  • DontCreate - Don't create the timeseries
  • CreateButRename - Create but rename the timeseries
  • NoSave - The no save - TS will not have associations
    • .
    Note that the property is only available when: CalculateWeights=TrueExtractionOption=AreaWeighting
    Import as ImportAsOption Gets or sets the import as option
  • TimeSeries - Option for importing all items to individual,single item dataseries
  • Ensemble - Option for importing all items to a single,multi-item time series.
    		•
    Latitude Latitude Gets or sets the latitude of the interested point.
    Note that the property is only available when: ExtractionOption=SinglePoint
    Longitude Longitude Gets or sets the longitude of the interested point.
    Note that the property is only available when: ExtractionOption=SinglePoint
    Recalculate Weights CalculateWeights Gets or sets a value indicating whether weights shall be recalculate.
    Note that the property is only available when: ExtractionOption=AreaWeighting
    Target Group Group Gets or sets the group.
    Note that the property is only available when: Todatabase=True
    To Database Todatabase Gets or sets a value indicating whether the data should be imported to the database.
    Weights layer IntersectLayer Gets or sets intersect layer.
    Note that the property is only available when: CalculateWeights=FalseExtractionOption=AreaWeighting
    Zone feature Feature Gets or sets a feature from the feature class.
    Note that the property is only available when: ExtractionOption=AllWithinZone
    Zone layer Zone Gets or sets the feature class for the required zone.
    Note that the property is only available when: IsZonePropertyActive=True
    Time series properties
    Time series name OutputDataSeriesName Gets or sets the name of the output data series
    Time type TimeVariableType Gets or sets the type of temporal axis
    Unit Unit Gets or sets the unit
    Value type ValueType Gets or sets the type of value
    Variable TargetVariable Gets or sets the target variable
    Processing options
    Time series overwrite option DuplicateNameOption Gets or sets the option when a time series with the same name is already present in the group.
  • CreateAndReplace - Create and replace the timeseries
  • DontCreate - Don't create the timeseries
  • CreateButRename - Create but rename the timeseries
  • NoSave - The no save - TS will not have associations
    • .
    Note that the property is only available when: Todatabase=True

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *
clr.AddReference("DHI.Solutions.Generic.Tools")
from DHI.Solutions.Generic.Tools import *

# Get the tool.
tool = app.Tools.CreateNew("ImportFromGRIB")
# Add input items.
tool.InputItems.Add(<No input or a single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportTsFromGRIBTool(app.Tools.CreateNew("ImportFromGRIB"))
# Add input items.
tool.InputItems.Add(<No input or a single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("ImportFromGRIB") as DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportTsFromGRIBTool;

// Set the tool properties and execute.
tool.FilePath = @"c:\temp\nah.hs.200008.grb";
tool.Variable = "Significantheightofcombinedwindwavesandswell";
tool.DataProvider = DHI.Solutions.TimeseriesManager.Tools.ImportTools.GRIBDataProvider.DMI;
tool.ExtractionOption = DHI.Solutions.TimeseriesManager.Tools.ImportTools.ExtractionOption.SinglePoint;
tool.ImportAsOption = DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportAsOption.TimeSeries;
tool.Longitude = 300.0;
tool.OutputDataSeriesName = " GRIBTest";
tool.TimeVariableType = "Equidistant_Calendar";
tool.ValueType = "Instantaneous";
tool.TargetVariable = "1st order rate AD model";
tool.Unit = "/h";
tool.Group = "/";
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportTsFromGRIBTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll" />

    Import from NetCDF

    This tool is used for extracting time series from raster’s with the NetCDF format. The time series for a single point can be imported or for all points.

    Tool Info
    Display Name Import from NetCDF
    API Name ImportFromNetCdf
    Tools Explorer /Import Tools/Import from NetCDF
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ImportTools
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportTsFromNetCdfTool
    Input Items No input or a single time series group
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Date and time
    Time Zone TimeZone Gets or sets the time zone
    Import Selection
    Export directory ExportDirectory Gets or sets the export directory.
    Note that the property is only available when: Todatabase=False
    Extraction option ExtractionOption Gets or sets the extraction option
  • SinglePoint - Extract values from a single, user specified location.
  • AllWithinZone - Extract one single item time series for each netCdf grid that falls inside a user specified zone
  • AreaWeighting - The area weighted mean value for a user specified zone
    • .
    Note that the property is only available when: NetCdfExtractionOption=AllWithinZone
    File parameter Variable Gets or sets the variable.
    Note that the property is only available when: FilePath!=''
    File path FilePath Gets or sets the file path
    Grid feature class overwrite option for GridFeatureClassDuplicateNameOption Gets or sets the option when a grid feature class with the same name is already present in the group
  • CreateAndReplace - Create and replace the timeseries
  • DontCreate - Don't create the timeseries
  • CreateButRename - Create but rename the timeseries
  • NoSave - The no save - TS will not have associations
    • .
    Note that the property is only available when: CalculateWeights=TrueExtractionOption=AreaWeighting
    Import as ImportAsOption Gets or sets the import as option
  • TimeSeries - Option for importing all items to individual,single item dataseries
  • Ensemble - Option for importing all items to a single,multi-item time series.
    		•
    Latitude Latitude Gets or sets the latitude of the interested point.
    Note that the property is only available when: ExtractionOption=SinglePoint
    Longitude Longitude Gets or sets the longitude of the interested point.
    Note that the property is only available when: ExtractionOption=SinglePoint
    Recalculate Weights CalculateWeights Gets or sets a value indicating whether weights shall be recalculate.
    Note that the property is only available when: ExtractionOption=AreaWeighting
    Target Group Group Gets or sets the group.
    Note that the property is only available when: Todatabase=True
    To Database Todatabase Gets or sets a value indicating whether the data should be imported to the database.
    Weights layer IntersectLayer Gets or sets intersect layer.
    Note that the property is only available when: CalculateWeights=FalseExtractionOption=AreaWeighting
    Zone feature Feature Gets or sets a feature from the feature class.
    Note that the property is only available when: ExtractionOption=AllWithinZone
    Zone layer Zone Gets or sets the feature class for the required zone.
    Note that the property is only available when: IsZonePropertyActive=True
    Time series properties
    Time series name OutputDataSeriesName Gets or sets the name of the output data series
    Time type TimeVariableType Gets or sets the type of temporal axis
    Unit Unit Gets or sets the unit
    Value type ValueType Gets or sets the type of value
    Variable TargetVariable Gets or sets the target variable
    Processing options
    Time series overwrite option DuplicateNameOption Gets or sets the option when a time series with the same name is already present in the group.
  • CreateAndReplace - Create and replace the timeseries
  • DontCreate - Don't create the timeseries
  • CreateButRename - Create but rename the timeseries
  • NoSave - The no save - TS will not have associations
    • .
    Note that the property is only available when: Todatabase=True

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *
clr.AddReference("DHI.Solutions.Generic.Tools")
from DHI.Solutions.Generic.Tools import *

# Get the tool.
tool = app.Tools.CreateNew("ImportFromNetCdf")
# Add input items.
tool.InputItems.Add(<No input or a single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("ImportFromNetCdf") as DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportTsFromNetCdfTool;

// Set the tool properties and execute.
tool.FilePath = @"c:\temp\Annual_temperature_32.nc";
tool.Variable = "temperature_at_1-5m";
tool.ExtractionOption = DHI.Solutions.TimeseriesManager.Tools.ImportTools.ExtractionOption.SinglePoint;
tool.ImportAsOption = DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportAsOption.TimeSeries;
tool.Latitude = 51.280002593994141;
tool.Longitude = 63.799999237060547;
tool.OutputDataSeriesName = " NetCdfTest";
tool.TimeVariableType = "Equidistant_Calendar";
tool.ValueType = "Instantaneous";
tool.TargetVariable = "1st order rate AD model";
tool.Unit = "/h";
tool.Group = "/";
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportTsFromNetCdfTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll" />

    Import from NOAA

    This tool is used for importing time series from NOAA’s National Centers for Environmental Information (NCEI). NCEI is responsible for preserving, monitoring, assessing, and providing public access to the Nation's treasure of climate and historical weather data and information. https://www.ncdc.noaa.gov/cdo-web

    Tool Info
    Display Name Import from NOAA
    API Name ImportFromNOAA
    Tools Explorer /Import Tools/Import from NOAA
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ImportTools
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportFromNOAATool
    Input Items No input or a single time series group
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Import Selection
    Target Group TimeSeriesGroup Gets or sets the value of TS group or TS path in the MO database where the time series are placed. If a folder is specified, the time series name to use is the sensor name.
    Note that the property is only available when: ToDatabase=True
    To Database ToDatabase Gets or sets a value indicating whether the time series should be imported into the time series database (true). False means that the time series can be found as output items of the tool only.
    Time series properties
    Unit Unit Gets or sets the value of unit.
    Value type ValueType Gets or sets the list of value types supported.
    Variable Variable Gets or sets the value of variable.
    Processing options
    From Date FromDate Gets or sets the value of date from where data (time steps) should be taken.
    To Date ToDate Gets or sets the value of date from where data (time steps) should be taken.
    Settings
    Data selection DataSelection Gets or sets the result data selection (dataset id, data types, locations and stations).
    Data types DataTypes Gets or sets type of data, acts as a label.
    Dataset Id DatasetId Gets or sets all of the CDO data are in datasets. The containing dataset must be known before attempting to access its data.
    Stations Stations Gets or sets stations are where the data comes from (for most datasets) and can be considered the smallest granual of location data.
    Token Token Gets or sets User specific token. To gain access to NCDC CDO Web Services, register with your email address to get a access token.
    https://www.ncdc.noaa.gov/cdo-web/token

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *

# Get the tool.
tool = app.Tools.CreateNew("ImportFromNOAA")
# Add input items.
tool.InputItems.Add(<No input or a single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportFromNOAATool(app.Tools.CreateNew("ImportFromNOAA"))
# Add input items.
tool.InputItems.Add(<No input or a single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("ImportFromNOAA") as DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportFromNOAATool;

// Set the tool properties and execute.
tool.Token = "[token]";
tool.Variable = "Undefined";
tool.Unit = "()";
tool.ValueType = "Instantaneous";
tool.DatasetId = "GH_HLY";
tool.Stations = " COOP:010063";
tool.DataTypes = "HPCP";
tool.TimeSeriesGroup = "/";
tool.ToDatabase = false;
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportFromNOAATool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll" />

    Import from Res1d

    This tool will import res1d files to the DSS.

    Tool Info
    Display Name Import from Res1d
    API Name ImportFromRes1d
    Tools Explorer /Import Tools/Import from Res1d
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ImportTools
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportFromRes1dTool
    Input Items No input or a single time series group
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Date and time
    Time Zone TimeZone Gets or sets the value of timezone
    Import Selection
    File path FilePath Gets or sets the file name to import for single file, or the file containing import information in the batch option.
    Enabled when ImportFromOption = SingleFile or Batch.
    Note that the property is only available when: ImportFromOptionRes1d=SingleFile
    Folder Folder Gets or sets the Folder from which the time series / ensemble will be imported from.
    Enabled when ImportFromOption = Folder.
    Note that the property is only available when: ImportFromOptionRes1d=Folder
    Import as ImportAsOption Gets or sets the import option. The import option determines if the items in the selected file(s)
    shall be imported as time series or time series ensembles.
  • TimeSeries - Option for importing all items to individual,single item dataseries
  • Ensemble - Option for importing all items to a single,multi-item time series.
    		•
    Import from ImportFromOption Gets or sets the import option. The import option determines if a single file, or all files in a specified folder
    shall be imported.
  • SingleFile - Option for importing a single file
  • Folder - Option for importing all files in a folder.
  • Batch - Option for batch importing where files to import are specified in a comma separated file (CSV) or a spreadsheet stored in the database.
    		•
    Import from ImportFromOptionRes1d Gets or sets the Res1D import option.
  • SingleFile - Option for importing a single res1d file
  • Folder - Option for importing all res1d files in a folder.
    		•
    Import specification format BatchImportFormat Gets or sets the specification format of batch importing (CSV or Spreadsheet).
  • CSV - Option for batch importing from a csv file with a row per time series to import in the format and first row (header):File name,Group,Item no., Feature class (path),Feature (display),,where:- File name: is the full path of the file to import.- Group: is the full path of the time series group to import to.- Item no.: is the item number of the time series in the file to import. If not specified, the first column is used.- Feature class (path): is an optional full path of a feature class containing a feature to associate the time series to.- Feature (display): is an optional name of a feature (of the feature class) to associate the time series to.
  • Spreadsheet - Option for batch importing from a spreadsheet.The spreadsheet should contain the following columns. The first row should contain columns names as specified:- File name: specifying the full path of the file to import.- Group: specifying the full path of the time series group to import to.- Item no.: specifying the item number of the time series in the file to import. If not specified, the first column is used.- Feature class (path): is an optional full path of a feature class containing a feature to associate the time series to.- Feature (display): is an optional name of a feature (of the feature class) to associate the time series to.
    • .
    Note that the property is only available when: ImportFromOption=Batch
    Items Dfs0Items Gets or sets the items of the dfs0 file to import.
    Note that the property is only available when: ImportFromOption=SingleFile,Folder
    Items Items Gets or sets the items of the resid file to import.
    Spreadsheet SpreadsheetPath Gets or sets the path of the Spreadsheet that contains an optional import specification for importing more time series with varying properties.
    The spreadsheet can contain the following columns: "File name" (required), - "Item no.", "Group" (required), "Feature class (path)", "Feature (display attribute)", "Variable" (required for ASCII import), "Unit" (required for ASCII import), "ValueType" (required for ASCII import).
    Target Group Group Gets or sets the Group to which the time series / ensemble will be imported.
    Note that the property is only available when: ImportToDatabase=True
    To Database ImportToDatabase Gets or sets a value indicating whether the imported series shall be written to the database.
    Default is true, but for unit test, it shall be false.
    Processing options
    Ensemble name EnsembleName Gets or sets the name of the imported ensemble. Enabled when ImportAsOption = Ensemble.
    Note that the property is only available when: ImportAsOption=Ensemble
    Naming option NamingOption Gets or sets the time series naming option.
  • UseItemNameOnly - With this option, the imported time series will begiven the dfs0 item name.
  • FileNameAndItemName - With this option the imported time series will begiven the name "File name [item name]"
  • FullPathAndItemName - With this option the imported time series will begiven the name "Full path [item name]
    • .
    Note that the property is only available when: ImportAsOption=TimeSeries
    Time series overwrite option DuplicateNameOption Gets or sets the option when a time series with the same name is already present in the group.
  • CreateAndReplace - Create and replace the timeseries
  • DontCreate - Don't create the timeseries
  • CreateButRename - Create but rename the timeseries
  • NoSave - The no save - TS will not have associations
    • .
    Note that the property is only available when: ImportToDatabase=True

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *
clr.AddReference("DHI.Solutions.Generic.Tools")
from DHI.Solutions.Generic.Tools import *

# Get the tool.
tool = app.Tools.CreateNew("ImportFromRes1d")
# Add input items.
tool.InputItems.Add(<No input or a single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportFromRes1dTool(app.Tools.CreateNew("ImportFromRes1d"))
# Add input items.
tool.InputItems.Add(<No input or a single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("ImportFromRes1d") as DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportFromRes1dTool;
// Add input items.
tool.InputItems.Add(<No input or a single time series group>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportFromRes1dTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll" />

    Import from Sensemetrics

    This tool is used for importing time series from Sensemetrics.

    Tool Info
    Display Name Import from Sensemetrics
    API Name ImportFromSensemetricsTool
    Tools Explorer /Import Tools/Import from Sensemetrics
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ImportTools
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportFromSensemetricsTool
    Input Items No input items required
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Import Selection
    API Key APIKey Gets or sets the value of API Key for getting access to connections, devices and sensors.
    Devices Devices Gets or sets the value of Devices.
    Host Host Gets or sets the value of Host.
    Metrics Metrics Gets or sets the metrics to import.
    Node/Connection Connection Gets or sets the value of a connection contains devices. It is possible to query a connection to get available devices.
    Retrieval parameters RetrievalParamsXml Gets or sets the retrieval parameters XML.
    Sensors Sensors Gets or sets the sensors to import.
    Target Group TimeSeriesGroup Gets or sets the value of TS group or TS path in the MO database where the time series are placed. If a folder is specified, the time series name to use is the sensor name.
    Note that the property is only available when: ToDatabase=True
    To Database ToDatabase Gets or sets a value indicating whether the time series should be imported into the time series database (true). False means that the time series can be found as output items of the tool only.
    Time series properties
    Unit Unit Gets or sets the value of unit.
    Value Type ValueType Gets or sets the list of value types supported.
    Variable Variable Gets or sets the value of variable.
    Processing options
    From Date FromDate Gets or sets the value of date from where data (time steps) should be taken.
    To Date ToDate Gets or sets the value of date from where data (time steps) should be taken.

    Tool Methods

    • GetNodeIds(): Gets the node ids/connections available using the API Key
    • GetDeviceIds(System.String nodeId): Gets the device ids of a node
    • GetSensorIds(): Gets a list of all sensor ids
    • GetSensorIds(System.String nodeId ,System.String deviceId): Gets a list of sensor ids for the specified device
    • GetSensors(): Gets a list of sensors.
    • GetMetrics(System.String sensorId): Gets a list of metrics of the specified sensor
    • GetMetrics(System.String nodeId ,System.String deviceId ,System.String sensorId): Gets a list of metrics of the specified node, device and sensor

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *

# Get the tool.
tool = app.Tools.CreateNew("ImportFromSensemetricsTool")
# Add input items.
tool.InputItems.Add(<No input items required>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportFromSensemetricsTool(app.Tools.CreateNew("ImportFromSensemetricsTool"))
# Add input items.
tool.InputItems.Add(<No input items required>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("ImportFromSensemetricsTool") as DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportFromSensemetricsTool;

// Set the tool properties and execute.
tool.APIKey = "[API Key]";
tool.Connection = "/n1/n2";
tool.Devices = "/d1/d2";
tool.Sensors = "/sensor";
tool.Metrics = "metrics";
tool.Variable = "Rainfall";
tool.Unit = "m";
tool.ValueType = "Instantaneous";
tool.ToDatabase = false;
tool.TimeSeriesGroup = "/";
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportFromSensemetricsTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll" />

    Import from USGS

    The import from USGS tool is used to import time series data provided by the United States Geological Survey (USGS). Specifically, the tool downloads data from the USGS Daily Values Site Web Service (https://waterservices.usgs.gov/rest/DV-Service.html) and stores them in the selected time series group. The tool is designed to allow repeated execution in order to append more recent data to time series that already exist in the selected time series group.

    Tool Info
    Display Name Import from USGS
    API Name ImportFromUSGS
    Tools Explorer /Import Tools/Import from USGS
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ImportTools
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportFromUSGSTool
    Input Items No input or a single time series group
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Import Selection
    Ensure Euidistant Time Step EnsureEquidistant Gets or sets a value indicating whether it should be ensured that the time series imported are equidistant.
    Parameter Code ParameterCode Gets or sets the parameter code of time serie to download for the station
    Site Number SiteNo Gets or sets the site number of the station to download data from
    Statistics Type StatisticsType Gets or sets the type of time serie statistics to download for the station
    Time Series Group TimeSeriesGroup Gets or sets the name of directory where time series will be stored
    To Database ImportToDatabase Gets or sets a value indicating whether the imported series shall be written to the database.
    Default is true, but for unit test, it shall be false.
    Options
    End Date EndDate Gets or sets the End Date of downloaded data
    Start Date StartDate Gets or sets the Start Date of downloaded data

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *

# Get the tool.
tool = app.Tools.CreateNew("ImportFromUSGS")
# Add input items.
tool.InputItems.Add(<No input or a single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ImportTools")
from DHI.Solutions.TimeseriesManager.Tools.ImportTools import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.ImportTools.IImportFromUSGSTool(app.Tools.CreateNew("ImportFromUSGS"))
# Add input items.
tool.InputItems.Add(<No input or a single time series group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("ImportFromUSGS") as DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportFromUSGSTool;

// Set the tool properties and execute.
tool.StartDate = DateTime.MinValue;
tool.EndDate = DateTime.MinValue;
tool.SiteNo = "11456000,11458000";
tool.TimeSeriesGroup = "/";
tool.ImportToDatabase = false;
tool.ParameterCode = "00060";
tool.StatisticsType = "00003";
tool.EnsureEquidistant = true;
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.ImportTools.ImportFromUSGSTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.ImportTools.dll" />

    Kolmogorov-Smirnov test

    The Kolmogorov-Smirnov Goodness of Fit Test (K-S test) compares distribution data with a known distribution to determine if the data have the same distribution.

    Tool Info
    Display Name Kolmogorov-Smirnov test
    API Name Goodness-of-fit Kolmogorov-Smirnov
    Tools Explorer /Probability distribution/Kolmogorov-Smirnov test
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.GoodnessOfFit.KolmogorovSmirnov
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.FitKSTool.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.FitKSTool.IFitKSTool
    Input Items One or more estimation of distribution parameters
    Output Items A data table

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.FitKSTool")
from DHI.Solutions.TimeseriesManager.Tools.FitKSTool import *

# Get the tool.
tool = app.Tools.CreateNew("Goodness-of-fit Kolmogorov-Smirnov")
# Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.FitKSTool")
from DHI.Solutions.TimeseriesManager.Tools.FitKSTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.FitKSTool.IFitKSTool(app.Tools.CreateNew("Goodness-of-fit Kolmogorov-Smirnov"))
# Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Goodness-of-fit Kolmogorov-Smirnov") as DHI.Solutions.TimeseriesManager.Tools.FitKSTool.IFitKSTool;
// Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>);
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.FitKSTool.FitKSTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.FitKSTool.dll" />

    L-Moments

    L-moments are statistics used to summarize the shape of a probability distribution. They are analogous to ordinary moments in that they can be used to calculate quantities analogous to standard deviation, skewness and kurtosis, termed the L-scale, L-skewness and L-kurtosis respectively (the L-mean is identical to the conventional mean). L-moments differ from conventional moments in that they are calculated using linear combinations of the ordered data; the "l" in "linear" is what leads to the name being "L-moments". Just as for conventional moments, a theoretical distribution has a set of population L-moments.

    Output contains a table containing five columns with one row for each input item:

    • Name of input time series
    • L1
    • L2
    • L_Skewness
    • L_Kurtosis
    Tool Info
    Display Name L-Moments
    API Name BasicLMoments
    Tools Explorer /Advanced statistics/L-Moments
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.AdvancedStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IBasicLMomentsTool
    Input Items One or more time series
    Output Items A data table

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("BasicLMoments")
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IBasicLMomentsTool(app.Tools.CreateNew("BasicLMoments"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("BasicLMoments") as DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.BasicLMomentsTool;

// Set the tool properties and execute.
tool.InputItems.Add(ts_in);
tool.Execute();

// Get the output of the tool.
var outputItem = tool.OutputItems[0] as DHI.Solutions.Generic.Tools.TableContainer;
var result = outputItem.TabularData.Rows[0];

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.BasicLMomentsTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll" />

    Log-likelihood test

    Tool for calculating the log-likelihood value of a regression model. It is a way to measure the goodness of fit for a model. The higher the value of the log-likelihood, the better a model fits a dataset.

    Tool Info
    Display Name Log-likelihood test
    API Name Goodness-of-fit Log-Likelihood
    Tools Explorer /Probability distribution/Log-likelihood test
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.GoodnessOfFit.LogLikelihood
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.FitLogLikelihoodTool.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.FitLogLikelihoodTool.IFitLogLikelihoodTool
    Input Items One or more estimation of distribution parameters
    Output Items A data table

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.FitLogLikelihoodTool")
from DHI.Solutions.TimeseriesManager.Tools.FitLogLikelihoodTool import *

# Get the tool.
tool = app.Tools.CreateNew("Goodness-of-fit Log-Likelihood")
# Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.FitLogLikelihoodTool")
from DHI.Solutions.TimeseriesManager.Tools.FitLogLikelihoodTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.FitLogLikelihoodTool.IFitLogLikelihoodTool(app.Tools.CreateNew("Goodness-of-fit Log-Likelihood"))
# Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Goodness-of-fit Log-Likelihood") as DHI.Solutions.TimeseriesManager.Tools.FitLogLikelihoodTool.IFitLogLikelihoodTool;
// Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>);
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.FitLogLikelihoodTool.FitLogLikelihoodTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.FitLogLikelihoodTool.dll" />

    Mann-Kendall test

    The Mann-Kendall test is used for testing monotonic trend of a time series.

    Tool Info
    Display Name Mann-Kendall test
    API Name MannKendall
    Tools Explorer /Advanced statistics/Mann-Kendall test
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.AdvancedStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IMannKendallTool
    Input Items One or more time series
    Output Items A data table

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("MannKendall")
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IMannKendallTool(app.Tools.CreateNew("MannKendall"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("MannKendall") as DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IMannKendallTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.MannKendallTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll" />

    Mann-Whitney test

    The Mann-Whitney test is used for testing shift in the mean between two sub-samples defined from a time series.

    Tool Info
    Display Name Mann-Whitney test
    API Name Mann-Whitney test
    Tools Explorer /Advanced statistics/Mann-Whitney test
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.AdvancedStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IMannWhitneyTool
    Input Items One or more time series
    Output Items A data table

    Tool Properties

    Display Name API Name Description
    Split date
    Split date SplitDate Gets or sets the date that splits data in 2 samples

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Mann-Whitney test")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IMannWhitneyTool(app.Tools.CreateNew("Mann-Whitney test"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Mann-Whitney test") as DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IMannWhitneyTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.MannWhitneyTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll" />

    Maximum

    The Maximum Value Tool get the maximum value of the input time series, and returns it as a scalar value. The tool will return one value per input item.

    Tool Info
    Display Name Maximum
    API Name Maximum value
    Tools Explorer /Basic statistics/Maximum
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.BasicStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IMaximumValueTool
    Input Items One or more time series
    Output Items A data table

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Maximum value")
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IMaximumValueTool(app.Tools.CreateNew("Maximum value"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Maximum value") as DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.MaximumValueTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds_in);
tool.Execute();

// Get the output of the tool.
var outputItem = tool.OutputItems[0] as DHI.Solutions.Generic.Tools.TableContainer;
var result = (double)outputItem.TabularData.Rows[0][1];

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.MaximumValueTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll" />

    MIKE Cloud Upload Tool

    Tool for uploading time series to the DHI Cloud Platform Time Series storage.

    Tool Info
    Display Name MIKE Cloud Upload Tool
    API Name MIKECloudTsUploadTool
    Tools Explorer /MIKE Cloud/MIKE Cloud Upload Tool
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.MikeCloudUpload
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.MikeCloudUploadTool.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.MikeCloudUploadTool.IMikeCloudUploadTool
    Input Items One or more time series or one or more time series groups
    Output Items No output items

    Tool Properties

    Display Name API Name Description
    Options
    Destination Root Path DestinationRootPath Gets or sets the path in the MIKE Cloud Platform project to upload time series and time series groups to.
    Group Structure UploadStructure Gets or sets the export directory structure
  • DatasetPerGroup - Create a dataset for every time series group. The dataset name will get the time series group name.
  • DatasetPerTimeSeries - Create a dataset for every time series. The dataset will get the same name as the time series.
  • SingleDataset - Add all time series to a single dataset, specified by the Destination Path.
    		•
    MIKE Cloud Provider MikeCloudProvider Gets or sets the MIKE Cloud provider to be used for uploading time series.
    Overwrite Option OverwriteOption Gets or sets the value of overwrite option
  • Replace - Replace the existing time series
  • Update - Update the existing time series
    • .
    Note that the property is only available when: Overwrite=True
    Overwrite Overwrite Gets or sets a value indicating whether existing time series should be overwritten. If False, existing time series will be skipped.
    Register Root Path RegisterRootPath Gets or sets the root folder where registered time series should be placed (support UploadStructure).
    Note that the property is only available when: RegisterTimeSeries=True
    Register Time Series RegisterTimeSeries Gets or sets a value indicating whether time series uploaded should be registered to a new folder in the time series manager

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.MikeCloudUploadTool")
from DHI.Solutions.TimeseriesManager.Tools.MikeCloudUploadTool import *

# Get the tool.
tool = app.Tools.CreateNew("MIKECloudTsUploadTool")
# Add input items.
tool.InputItems.Add(<One or more time series or one or more time series groups>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.MikeCloudUploadTool")
from DHI.Solutions.TimeseriesManager.Tools.MikeCloudUploadTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.MikeCloudUploadTool.IMikeCloudUploadTool(app.Tools.CreateNew("MIKECloudTsUploadTool"))
# Add input items.
tool.InputItems.Add(<One or more time series or one or more time series groups>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("MIKECloudTsUploadTool") as DHI.Solutions.TimeseriesManager.Tools.MikeCloudUploadTool.MikeCloudUploadTool;

// Set the tool properties and execute.
tool.MikeCloudProvider = timeSeriesDataProvider as DHI.Solutions.TimeseriesManager.TSMIKECloudProvider.TimeSeriesMIKECloudProvider;
tool.InputItems.Add(ts);
tool.DestinationRootPath = "/MyProject/MyTimeSeriesRep";
tool.Overwrite = false;
tool.RegisterTimeSeries = true;
tool.RegisterRootPath = "/TsGroup/RegisteredTs";
tool.UploadStructure = DHI.Solutions.TimeseriesManager.Tools.MikeCloudUploadTool.UploadStructureOptions.DatasetPerTimeSeries;
tool.Execute();

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.MikeCloudUploadTool.MikeCloudUploadTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.MikeCloudUploadTool.dll" />

    Group Structure - SingleDataset

    MIKE Workbench MIKE Cloud
    • DatasetPerGroup
    MIKE Workbench MIKE Cloud
    • DatasetPerTimeSeries
    MIKE Workbench MIKE Cloud

    Minimum

    The Minimum Value Tool get the minimum value of the input time series, and returns it as a scalar value. The tool will return one value per input item.

    Tool Info
    Display Name Minimum
    API Name Minimum value
    Tools Explorer /Basic statistics/Minimum
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.BasicStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IMinimumValueTool
    Input Items One or more time series
    Output Items A data table

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Minimum value")
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IMinimumValueTool(app.Tools.CreateNew("Minimum value"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Maximum value") as DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.MaximumValueTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds_in);
tool.Execute();

// Get the output of the tool.
var outputItem = tool.OutputItems[0] as DHI.Solutions.Generic.Tools.TableContainer;
var result = (double)outputItem.TabularData.Rows[0][1];

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.MinimumValueTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll" />

    Mode

    The Model value tool calculates the mode of the specified input series. The Mode is the value that occurs the most frequently in a sample. The mode is not necessarily unique, since the same maximum frequency may be attained at different values. The most ambiguous case occurs in uniform distributions, wherein all values are equally likely, and for samples drawn from continuous distributions where all values tend to occur only once. Since the latter is a very common, the Mode tool has been extended such that the user can specify a tolerance within which two values can be considered equal. In the case where the tolerance is set to low when mode is calculated for samples drawn from continuous distribution, the number of mode values will approach the number of values in the sample. When this happens, the concept becomes useless. To indicate when this happens, the user may set a limit to the number of values the tool can return. If this value is exceeded, the tool returns a single double.NaN.

    Tool Info
    Display Name Mode
    API Name Mode
    Tools Explorer /Advanced statistics/Mode
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.AdvancedStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IModeValueTool
    Input Items One or more time series
    Output Items A data table

    Tool Properties

    Display Name API Name Description
    Input Parameters
    Max. no. of mode values MaxNoOfModeValuesReturned Gets or sets the Maximum number of mode values the tool
    may return. If this number is exceeded, the tool will
    return a single double.NaN.
    Tolerance Tolerance Gets or sets the Tolerance. For samples drawn from discrete distributions, the tolerance
    should be set to zero. For samples drawn from continuous distributions the tolerance
    should be a positive number.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Mode")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IModeValueTool(app.Tools.CreateNew("Mode"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Mode") as DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.ModeValueTool;

// Set the tool properties and execute.
tool.InputItems.Add(ts_in);
tool.Tolerance = 0.1;
tool.MaxNoOfModeValuesReturned = 5;
tool.Execute();

// Get the output of the tool.
var outputItem = tool.OutputItems[0] as DHI.Solutions.Generic.Tools.TableContainer;
var result = (double)outputItem.TabularData.Rows[0][1];

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.ModeValueTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll" />

    Monthly Statistics

    This tool calculates statistics for each specified month. This can be a single month or a range of months. For a timeseries containing several years, a calculation is made for each month in each year. In addition to the chosen statistic, it is possible to get monthly and yearly mean, maximum, and minimum. Note that these values are also based on the chosen time series.

    Tool Info
    Display Name Monthly Statistics
    API Name Monthly Statistics
    Tools Explorer /Basic statistics/Monthly Statistics
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.BasicStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IMonthlyStatisticsTool
    Input Items One or more time series
    Output Items A data table

    Tool Properties

    Display Name API Name Description
    Monthly statistics
    Tool to apply Tool Gets or sets the tool to use to calculate statistics. Only tools having scalars as output are supported
    Monthly summary
    Average MonthlyAverage Gets or sets a value indicating whether calculate monthly average
    Maximum MonthlyMaximum Gets or sets a value indicating whether calculate monthly maximum
    Minimum MonthlyMinimum Gets or sets a value indicating whether calculate monthly minimum
    Period
    First Month FirstMonth Gets or sets the first month to calculate statistics.
  • January - January period
  • February - February period
  • March - March period
  • April - April period
  • May - May period
  • June - June period
  • July - July period
  • August - August period
  • September - September period
  • October - October period
  • November - November period
  • December - December period
    		•
    Last Month LastMonth Gets or sets the last month to calculate statistics.
  • January - January period
  • February - February period
  • March - March period
  • April - April period
  • May - May period
  • June - June period
  • July - July period
  • August - August period
  • September - September period
  • October - October period
  • November - November period
  • December - December period
    		•
    Statistics
    Statistics data StatisticsData Gets or sets the calculate statistics data
    Yearly summary
    Average YearlyAverage Gets or sets a value indicating whether calculate yearly average statistics
    Maximum YearlyMaximum Gets or sets a value indicating whether calculate yearly maximum
    Minimum YearlyMinimum Gets or sets a value indicating whether calculate yearly minimum

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Monthly Statistics")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IMonthlyStatisticsTool(app.Tools.CreateNew("Monthly Statistics"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Monthly Statistics") as DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IMonthlyStatisticsTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.MonthlyStatisticsTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll" />

    Moving average

    The Moving average tool calculates the moving average for a number of input time series. If the tool is configured to interpolate across gaps in the input time series, the user can specify a maximum duration / missing value count across interpolation shall take place. If interpolation across gaps is not allowed, or if the gaps in the input series exceeds the criteria defined by the user, gaps will be transferred to the output series.

    Tool Info
    Display Name Moving average
    API Name Moving Average
    Tools Explorer /Time series processing/Moving average
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.IMovingAverageTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Gap Settings
    Interpolate across gaps InterpolateAcrossGaps Gets or sets a value indicating whether the algorithm shall interpolate
    across gaps in the input series or not. If set to true, the algorithm will
    interpolate across gaps that are less than a specified duration/number.
    If set to false, gaps in the input series will result in gaps in the output series.
    Max. allowed gap duration MaxAllowedGapDuration Gets or sets a value indicating the no of missing values the algorithm shall interpolate
    across. (it has an effect when property InterpolateAcrossGaps is false).
    Note that the property is only available when: InterpolateAcrossGaps=True
    Max. missing values per gap MaxNumberOfMissingValuesPerGap Gets or sets a value indicating the maximum duration a gap the algorithm shall interpolate
    across. (it has an effect when property InterpolateAcrossGaps is false).
    Note that the property is only available when: InterpolateAcrossGaps=True
    Window Position
    Averaging window position WindowPosition Gets or sets a value indicating the window position.
  • Centered - Indicates window position centered.
  • Backward - Indicates window position backward.
  • Forward - Indicates window position forward
    		•
    Window width
    Days TimeStepDay Gets or sets the Day part of the averaging window
    Hours TimeStepHour Gets or sets the Hour part of the averaging window
    Minutes TimeStepMinute Gets or sets the Minute part of the averaging window
    Seconds TimeStepSecond Gets or sets the Second part of the averaging window

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("Moving Average")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.IMovingAverageTool(app.Tools.CreateNew("Moving Average"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Moving Average") as DHI.Solutions.TimeseriesManager.Tools.Processing.IMovingAverageTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.MovingAverageTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Nearest neighbour resampling

    The weather generation tool creates daily time series ensembles of weather variables based on historical time series. It analyses historical time series from one or more locations of different variable types, shuffles the historical record and produces an ensemble of time series with consistent spatiotemporal statistics.

    An example of how the weather generator tool simulates weather by shuffling historical time series data. For each day of the year (DOY) to simulate (eg. day 50) a multi-day search window is centred on the preceding day (eg. day 49) for each year in the historical dataset. For example, for a search window of 7 days, the closest weather matches around DOY 49 is searched (between DOY 46 and 52 in all years in the historical record). Once the ‘k’ closest weather matches are selected from all the time windows, one is chosen according to a discrete probability distribution that gives a higher probability to the closest neighbor.

    Please also refer to the "How to use the Weather generator" section of the MIKE OPERATIONS online help.

    Tool Info
    Display Name Nearest neighbour resampling
    API Name Nearest neighbour resampling
    Tools Explorer /Weather generators/Nearest neighbour resampling
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.NearestNeighbourResampling
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.NearestNeighbourResampling.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.NearestNeighbourResampling.INearestNeighbourResampling
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    New weather ensemble.
    Number of days within search window. DayWindow Gets or sets parameter _dayWindow. Where _dayWindow is the number of days
    within the search window. Default is 61 (same as the paper).
    Number of ensemble members to generate. NumberOfEnsembles Gets or sets the Day part of the resampling time span
    Number of nearest neighbours in feature vector (k) K Gets or sets parameter K. Where K is the number of nearest
    neighbors from which to select.
    Number of years to generate NumberOfYears Gets or sets the Day part of the resampling time span
    Start year for generation StartDateYear Gets or sets the Month part of the resampling time span

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.NearestNeighbourResampling")
from DHI.Solutions.TimeseriesManager.Tools.NearestNeighbourResampling import *

# Get the tool.
tool = app.Tools.CreateNew("Nearest neighbour resampling")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.NearestNeighbourResampling")
from DHI.Solutions.TimeseriesManager.Tools.NearestNeighbourResampling import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.NearestNeighbourResampling.INearestNeighbourResampling(app.Tools.CreateNew("Nearest neighbour resampling"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Nearest neighbour resampling") as DHI.Solutions.TimeseriesManager.Tools.NearestNeighbourResampling.INearestNeighbourResampling;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.NearestNeighbourResampling.NearestNeighbourResampling"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.NearestNeighbourResampling.dll" />

    Ordinary moments

    The Ordinary moments tool calculates the ordinary moments of one or more time series. The ordinary moments are:

    - Mean
- Variance
- Skewness
- Kurtosis
    Tool Info
    Display Name Ordinary moments
    API Name BasicOrdinaryMoments
    Tools Explorer /Basic statistics/Ordinary moments
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.BasicStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IBasicOrdinaryMomentsTool
    Input Items One or more time series
    Output Items A data table

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("BasicOrdinaryMoments")
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IBasicOrdinaryMomentsTool(app.Tools.CreateNew("BasicOrdinaryMoments"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("BasicOrdinaryMoments") as DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.BasicOrdinaryMomentsTool;

// Set the tool properties and execute.
tool.InputItems.Add(ts_in);
tool.Execute();

// Get the output of the tool.
var outputItem = tool.OutputItems[0] as DHI.Solutions.Generic.Tools.TableContainer;
var result = outputItem.TabularData.Rows[0];

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.BasicOrdinaryMomentsTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll" />

    Partial duration series

    This tool is used to extract extreme events from a time series.

    Tool Info
    Display Name Partial duration series
    API Name Partial Duration Series
    Tools Explorer /Extreme value extraction/Partial duration series
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ExtremeValues
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.IPartialDurationSeriesTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Independence Criteria
    Inter Event Level InterEventLevel Gets or sets inter event level.
    Note that the property is only available when: UseInterEventTime=TrueUseInterEventLevel=True
    Inter Event Time [hours] InterEventTime Gets or sets inter event time (in hours).
    Note that the property is only available when: UseInterEventTime=True
    Use Inter Event Level UseInterEventLevel Gets or sets a value indicating whether use inter event level.
    Note that the property is only available when: UseInterEventTime=True
    Use Inter Event Time UseInterEventTime Gets or sets a value indicating whether use inter event time
    PDS Parameters
    Avg. Annual No of Exceed. AvgExceed Gets or sets average annual number of exceedances.
    Note that the property is only available when: PDSType=AvgAnnualNoExceed
    PDS Type PDSType Gets or sets type of PDS analysis
  • ThresholdLevel - Threshold Level
  • AvgAnnualNoExceed - Average annual number of exceedances
    		•
    Record Length [years] RecordLength Gets or sets record Length
    Threshold Level Threshold Gets or sets threshold level.
    Note that the property is only available when: PDSType=ThresholdLevel

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ExtremeValues")
from DHI.Solutions.TimeseriesManager.Tools.ExtremeValues import *

# Get the tool.
tool = app.Tools.CreateNew("Partial Duration Series")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ExtremeValues")
from DHI.Solutions.TimeseriesManager.Tools.ExtremeValues import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.IPartialDurationSeriesTool(app.Tools.CreateNew("Partial Duration Series"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Partial Duration Series") as DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.IPartialDurationSeriesTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.PartialDurationSeriesTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.dll" />

    Partial duration series (seasonal)

    This tool is used to extract extreme events from a time series on a seasonal basis.

    Tool Info
    Display Name Partial duration series (seasonal)
    API Name Partial duration series (seasonal)
    Tools Explorer /Extreme value extraction/Partial duration series (seasonal)
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ExtremeValues
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.ISeasonalPartialDurationSeriesTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Independence Criteria
    Inter Event Level InterEventLevel Gets or sets inter event level.
    Note that the property is only available when: UseInterEventTime=TrueUseInterEventLevel=True
    Inter Event Time [hours] InterEventTime Gets or sets inter event time (in hours).
    Note that the property is only available when: UseInterEventTime=True
    Use Inter Event Level UseInterEventLevel Gets or sets a value indicating whether use inter event level.
    Note that the property is only available when: UseInterEventTime=True
    Use Inter Event Time UseInterEventTime Gets or sets a value indicating whether use inter event time
    PDS Parameters
    Avg. Annual No of Exceed. AvgExceed Gets or sets average annual number of exceedances.
    Note that the property is only available when: PDSType=AvgAnnualNoExceed
    PDS Type PDSType Gets or sets type of PDS analysis
  • ThresholdLevel - Threshold Level
  • AvgAnnualNoExceed - Average annual number of exceedances
    		•
    Record Length [years] RecordLength Gets or sets Record Length
    Threshold Level Threshold Gets or sets threshold level.
    Note that the property is only available when: PDSType=ThresholdLevel
    Season End
    Day SeasonEndDay Gets or sets end day of season
    Month SeasonEndMonth Gets or sets end month of season
    Season Start
    Day SeasonStartDay Gets or sets start day of season
    Month SeasonStartMonth Gets or sets start month of season

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ExtremeValues")
from DHI.Solutions.TimeseriesManager.Tools.ExtremeValues import *

# Get the tool.
tool = app.Tools.CreateNew("Partial duration series (seasonal)")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ExtremeValues")
from DHI.Solutions.TimeseriesManager.Tools.ExtremeValues import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.ISeasonalPartialDurationSeriesTool(app.Tools.CreateNew("Partial duration series (seasonal)"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Partial duration series (seasonal)") as DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.ISeasonalPartialDurationSeriesTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.SeasonalPartialDurationSeriesTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.ExtremeValues.dll" />

    Period Statistics

    This tool calculates statistics for a specified period (daily, monthly etc.).

    Tool Info
    Display Name Period Statistics
    API Name Period Statistics
    Tools Explorer /Basic statistics/Period Statistics
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.PeriodStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.PeriodStatisticsTool.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.PeriodStatisticsTool.IPeriodStatisticsTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Tool Settings
    Output Value Type ItemValueType Gets or sets the target Item Value Type.
  • Instantaneous - The values of the time series are measured at a precise instant.For example, the air tempera­ture at a particular time is an instantaneous value.
  • Accumulated - The values of the time series are summed over successive intervals of time and always relative to the same starting time.For example, rainfall accumulated over a year with monthly rainfall values.
  • Step_Accumulated - The values of the time series are accumulated over a time interval, relative to the beginning of the interval.For example, a tipping bucket rain gauge measures step-accu­mulated rainfall.In this case, the rain gauge accumulates rainfall until the gauge is full, then it empties and starts accumulating again.Thus, the time series consists of the total amount of rainfall accumulated in each time period - say in mm of rainfall.
  • Mean_Step_Accumulated - The values of the time series are accumulated over the time interval as in the Step Accumu­lated, but the value is divided by the length of the accumulation period.Thus, based on the previous example, the time series consists of the rate of rainfall accumulated in each time period - say in mm of rainfall per hour (mm/hr).
  • Reverse_Mean_Step_Accumulated - Reverse Mean Step Accumulated values are the same as the Mean Step Accumulated, but the values represent the time interval from now to the start of the next time inter­val.The Reverse Mean Step Accumulated time series are primarily used for forecasting purposes.
    		•
    Period Length PeriodLength Gets or sets the period length to calculate statistics
    Period Period Gets or sets the period to calculate statistics
  • Daily - Daily period
  • Weekly - Weekly period
  • Monthly - Monthly period
  • Yearly - Yearly period
  • Seconds - Seconds period
  • Minutes - Minutes period
  • Hourly - Hourly period
    		•
    Tool to apply Tool Gets or sets the tool to use to calculate statistics. Only tools having scalars as output are supported

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.PeriodStatisticsTool")
from DHI.Solutions.TimeseriesManager.Tools.PeriodStatisticsTool import *
clr.AddReference("DHI.Solutions.Generic")
from DHI.Solutions.Generic import *

# Get the tool.
tool = app.Tools.CreateNew("Period Statistics")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.PeriodStatisticsTool")
from DHI.Solutions.TimeseriesManager.Tools.PeriodStatisticsTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.PeriodStatisticsTool.IPeriodStatisticsTool(app.Tools.CreateNew("Period Statistics"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Period Statistics") as DHI.Solutions.TimeseriesManager.Tools.PeriodStatisticsTool.IPeriodStatisticsTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.PeriodStatisticsTool.PeriodStatisticsTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.PeriodStatisticsTool.dll" />

    Polynomial regression

    This tool performs polynomial regression between two time series.

    Tool Info
    Display Name Polynomial regression
    API Name Regression statistics
    Tools Explorer /Time series processing/Polynomial regression
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.PolynomialRegression
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.EOAnalysis.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.EOAnalysis.IPolynomialRegression
    Input Items Two time series
    Output Items An X-Y data series

    Tool Properties

    Display Name API Name Description
    2. Settings
    Degree Degree Gets the degree of the regression polynomial (1 - 5). Notice that when Degree is set to one, linear regression will
    be used.
    Independent variable IndependentVariable Gets or sets the independent variable (time series). The independent variable shall be one of the two input
    time series.
    Mode ToolMode Gets or sets the tool mode. The tool mode can be either Analyze or Predict. In Analyze mode, the tool will
    calculate the regression line, and in Predict mode, the tool will use the
    specified parameters to predict the empty values in the dependent series.
  • Analyze - Analyze mode.
  • Predict - Predict mode.
    		•
    3. Parameters
    a0 a0 Gets or sets the Intercept in the regression line. In Analyze mode, this value will be calculated.
    In Predict mode, this value will be used to predict the empty values in the dependent series.
    a1 a1 Gets or sets the first-order parameter in the regression line. In Analyze mode, this value will be calculated.
    In Predict mode, this value will be used to predict the empty values in the dependent series.
    a2 a2 Gets or sets the second-order parameter in the regression line. In Analyze mode, this value will be calculated.
    In Predict mode, this value will be used to predict the empty values in the dependent series.
    a3 a3 Gets or sets the third-order parameter in the regression line. In Analyze mode, this value will be calculated.
    In Predict mode, this value will be used to predict the empty values in the dependent series.
    a4 a4 Gets or sets the fourth-order parameter in the regression line. In Analyze mode, this value will be calculated.
    In Predict mode, this value will be used to predict the empty values in the dependent series.
    a5 a5 Gets or sets the fifth-order parameter in the regression line. In Analyze mode, this value will be calculated.
    In Predict mode, this value will be used to predict the empty values in the dependent series.
    4. Statistics
    Akaike information criterion AkaikeCriterion Gets the Akaike criterion of the model. The Akaike information criterion is a measure of the relative
    goodness of fit of a statistical model. It can be said to describe the tradeoff between bias and variance
    in model construction, or loosely speaking between accuracy and complexity of the model.
    Note that the property is only available when: ToolMode=Analyze
    Bayesian information criterion BayesianCriterion Gets the Bayesian criterion for the model. The Bayesian criterion is similar to the Akaike criterion, but
    generally has a higher penalty term for introduction of additional parameters in a model.
    Note that the property is only available when: ToolMode=Analyze
    R2 R2 Gets the R2 of the regression line. The R2 value indicates the ratio of variation that is explained by the model
    to the total variation in the model. Its value is always between 0 and 1, where 0 indicates the model explains
    nothing, and 1 means the model explains the data perfectly.
    Note that the property is only available when: ToolMode=Analyze
    Standard error StandardError Gets the Standard error of the model. The standard error is the root-mean-square of the residuals.
    Note that the property is only available when: ToolMode=Analyze
    Sum of squares SumOfSquares Gets the Sum of squares of the residuals of the model.
    Note that the property is only available when: ToolMode=Analyze

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.EOAnalysis")
from DHI.Solutions.TimeseriesManager.Tools.EOAnalysis import *

# Get the tool.
tool = app.Tools.CreateNew("Regression statistics")
# Add input items.
tool.InputItems.Add(<Two time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.EOAnalysis")
from DHI.Solutions.TimeseriesManager.Tools.EOAnalysis import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.EOAnalysis.IPolynomialRegression(app.Tools.CreateNew("Regression statistics"))
# Add input items.
tool.InputItems.Add(<Two time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Regression statistics") as DHI.Solutions.TimeseriesManager.Tools.EOAnalysis.IPolynomialRegression;
// Add input items.
tool.InputItems.Add(<Two time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.EOAnalysis.PolynomialRegression"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.EOAnalysis.dll" />

    Probability density function

    Estimation of distribution parameters tool.

    Tool Info
    Display Name Probability density function
    API Name Estimation of distribution parameters
    Tools Explorer /Probability distribution/Probability density function
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ProbabilityDistribution
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.PDFTool.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.PDFTool.IPDFTool
    Input Items One or more estimation of distribution parameters
    Output Items A data table

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.PDFTool")
from DHI.Solutions.TimeseriesManager.Tools.PDFTool import *

# Get the tool.
tool = app.Tools.CreateNew("Estimation of distribution parameters")
# Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.PDFTool")
from DHI.Solutions.TimeseriesManager.Tools.PDFTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.PDFTool.IPDFTool(app.Tools.CreateNew("Estimation of distribution parameters"))
# Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Estimation of distribution parameters") as DHI.Solutions.TimeseriesManager.Tools.PDFTool.IPDFTool;
// Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>);
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.PDFTool.PDFTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.PDFTool.dll" />

    Probability plot correlation coefficient

    Tool for calculationg the correlation coefficient of a set of distribution parameters. The coefficient provides a measure of how good a linear prediction of the value of one of the two random variables can be formed based on an observed value of the other.

    Tool Info
    Display Name Probability plot correlation coefficient
    API Name Goodness-of-fit Probability plot correlation coefficient
    Tools Explorer /Probability distribution/Probability plot correlation coefficient
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.GoodnessOfFit.ProbabilityPlot
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.FitPPCCTool.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.FitPPCCTool.IFitPPCCTool
    Input Items One or more estimation of distribution parameters
    Output Items A data table

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.FitPPCCTool")
from DHI.Solutions.TimeseriesManager.Tools.FitPPCCTool import *

# Get the tool.
tool = app.Tools.CreateNew("Goodness-of-fit Probability plot correlation coefficient")
# Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.FitPPCCTool")
from DHI.Solutions.TimeseriesManager.Tools.FitPPCCTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.FitPPCCTool.IFitPPCCTool(app.Tools.CreateNew("Goodness-of-fit Probability plot correlation coefficient"))
# Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Goodness-of-fit Probability plot correlation coefficient") as DHI.Solutions.TimeseriesManager.Tools.FitPPCCTool.IFitPPCCTool;
// Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>);
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.FitPPCCTool.FitPPCCTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.FitPPCCTool.dll" />

    Quality flag filter

    The quality flag filter tool can be used to process the flagged values of the input time series.

    Tool Info
    Display Name Quality flag filter
    API Name Quality flag filter
    Tools Explorer /QA-QC/Quality flag filter
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.IQualityFlagFilterTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Input Parameters
    Filter Mode FlagOption Gets or sets a value flag option. It can be "Skip" or "Substitute"
  • Delete_flagged_time_steps - Skip the selected flag value
  • Remove_flagged_values - Substitute delete value for the selected flag value
  • Insert_constant - Insert value for the selected flag value
    		•
    Flag selection QualityFlag Gets or sets a value Quality Flag. Comma separated string contains integers
    Process Copy ProcessCopy Gets or sets a value indicating whether process the input items' copy.
    Value ValueToInsert Gets or sets the value to insert.
    Note that the property is only available when: FlagOption=Insert_constant

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("Quality flag filter")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.IQualityFlagFilterTool(app.Tools.CreateNew("Quality flag filter"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Quality flag filter") as DHI.Solutions.TimeseriesManager.Tools.Processing.IQualityFlagFilterTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.FilteringTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Quantile estimates

    Quantile Estimation Tool.

    Tool Info
    Display Name Quantile estimates
    API Name Quantile estimates
    Tools Explorer /Probability distribution/Quantile estimates
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.QuantileEstimates
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.QuantileEstimateTool.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.QuantileEstimateTool.IQuantileEstimateTool
    Input Items One or more estimation of distribution parameters
    Output Items A data table

    Tool Properties

    Display Name API Name Description
    Return Period
    Return Period ReturnPeriod Gets or sets definition of return periods

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.QuantileEstimateTool")
from DHI.Solutions.TimeseriesManager.Tools.QuantileEstimateTool import *

# Get the tool.
tool = app.Tools.CreateNew("Quantile estimates")
# Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.QuantileEstimateTool")
from DHI.Solutions.TimeseriesManager.Tools.QuantileEstimateTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.QuantileEstimateTool.IQuantileEstimateTool(app.Tools.CreateNew("Quantile estimates"))
# Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Quantile estimates") as DHI.Solutions.TimeseriesManager.Tools.QuantileEstimateTool.IQuantileEstimateTool;
// Add input items.
tool.InputItems.Add(<One or more estimation of distribution parameters>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.QuantileEstimateTool.QuantileEstimateTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.QuantileEstimateTool.dll" />

    Quantile Perturbation

    The Quantile Perturbation tool downscales one or multiple climate parameter time series (precipitation, temperature, evaporation or potential evapotranspiration) using change factor quantile mapping (see Sunyer et. al. (2015) for a more detailed description). The change factor quantile mapping approach derives monthly, empirical cumulative distribution functions(CDF) for control and scenario climate data. Observations are projected, bias corrected and downscaled by mapping the probability of the observed value, determined from the CDF of the control period, to the scenario probability and corresponding value. This approach is also referred to as empirical quantile mapping.The graph under the “Quantile Quantile” tool illustrates the principle of quantile mapping. While the central part of the CDF is typically well described empirically, the extreme tail of the distribution is not.If the data in the observed record and the control data allow, i. e.there are at least 20 data points above the 95th percentile, then the tail of the distribution is parameterized using a Gamma/Pearson Type 3 distribution. This parametrization is also used to extrapolate projected values falling outside the range of the control data. Climate data is given in NetCDF format for the control and scenario period.If the periods span across several NetCDF files, then a CSV file can be used as input that lists the files in chronological order.

    Tool Info
    Display Name Quantile Perturbation
    API Name Quantile Perturbation
    Tools Explorer /Downscaling/Quantile Perturbation
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ClimateQuantilePerturbation
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.UI.Tools.QuantilePerturbationDownscalingTool.dll
    API Reference DHI.Solutions.TimeseriesManager.UI.Tools.QuantilePerturbationDownscalingTool.IQuantilePerturbationDownscalingTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Quantile Perturbation Parameters
    Control Data File Path ControlDataFilePath Gets or sets the path for the control data NetCDF file
    Keep Timestep As Observed Data KeepTimestepAsObservedData Gets or sets a value indicating whether to keep the future timesteps the same as observed data.
    If KeepTimestepAsObservedData is set to true, the future timesteps will be the same as
    the observed timesteps. Else, it will be the same as the scenario timesteps
    Minimum Rainfall Threshold (mm/month) MinimumRainfallThreshold Gets or sets a value indicating the minimum threshold for average monthly rainfall in mm/mth,
    below which the value is not considered in the calculation for quantile perturbation for the month
    Output Suffix OutputSuffix Gets or sets the suffix to be added to the name of the input dataseries when naming output dataseries
    Scenario Data File Path ScenarioDataFilePath Gets or sets the path for the scenario data NetCDF file

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.UI.Tools.QuantilePerturbationDownscalingTool")
from DHI.Solutions.TimeseriesManager.UI.Tools.QuantilePerturbationDownscalingTool import *

# Get the tool.
tool = app.Tools.CreateNew("Quantile Perturbation")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.UI.Tools.QuantilePerturbationDownscalingTool")
from DHI.Solutions.TimeseriesManager.UI.Tools.QuantilePerturbationDownscalingTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.UI.Tools.QuantilePerturbationDownscalingTool.IQuantilePerturbationDownscalingTool(app.Tools.CreateNew("Quantile Perturbation"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Quantile Perturbation") as DHI.Solutions.TimeseriesManager.UI.Tools.QuantilePerturbationDownscalingTool.IQuantilePerturbationDownscalingTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.UI.Tools.QuantilePerturbationDownscalingTool.QuantilePerturbationDownscalingTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.UI.Tools.QuantilePerturbationDownscalingTool.dll" />

    Quantile Quantile

    The Quantile Quantile tool downscales one or multiple climate parameter time series (precipitation, temperature, evaporation or potential evapotranspiration) using bias correction quantile mapping (see Sunyer et. al. (2015) for a more detailed description). The bias correction quantile mapping approach derives monthly, empirical cumulative distribution functions(CDF) for observations and control climate data. Scenario climate data are bias corrected and downscaled by mapping the probability of the scenario value, determined from the CDF of the control period, to the observed probability and corresponding value. This approach is also referred to as empirical quantile mapping.The graph below illustrates the principle of quantile mapping.

    Tool Info
    Display Name Quantile Quantile
    API Name Quantile Quantile
    Tools Explorer /Downscaling/Quantile Quantile
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ClimateQuantileQuantile
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.UI.Tools.QuantileQuantileDownscalingTool.dll
    API Reference DHI.Solutions.TimeseriesManager.UI.Tools.QuantileQuantileDownscalingTool.IQuantileQuantileDownscalingTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Quantile Quantile Parameters
    Control Data File Path ControlDataFilePath Gets or sets the path for the control data NetCDF file
    Minimum Rainfall Threshold (mm/month) MinimumRainfallThreshold Gets or sets a value indicating the minimum threshold for average monthly rainfall in mm/mth,
    below which the value is not considered in the calculation for quantile quantile for the month
    Output Suffix OutputSuffix Gets or sets the suffix to be added to the name of the input dataseries when naming output dataseries
    Scenario Data File Path ScenarioDataFilePath Gets or sets the path for the scenario data NetCDF file

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.UI.Tools.QuantileQuantileDownscalingTool")
from DHI.Solutions.TimeseriesManager.UI.Tools.QuantileQuantileDownscalingTool import *

# Get the tool.
tool = app.Tools.CreateNew("Quantile Quantile")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.UI.Tools.QuantileQuantileDownscalingTool")
from DHI.Solutions.TimeseriesManager.UI.Tools.QuantileQuantileDownscalingTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.UI.Tools.QuantileQuantileDownscalingTool.IQuantileQuantileDownscalingTool(app.Tools.CreateNew("Quantile Quantile"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Quantile Quantile") as DHI.Solutions.TimeseriesManager.UI.Tools.QuantileQuantileDownscalingTool.IQuantileQuantileDownscalingTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.UI.Tools.QuantileQuantileDownscalingTool.QuantileQuantileDownscalingTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.UI.Tools.QuantileQuantileDownscalingTool.dll" />

    Rate of change

    The Rate of change tool calculates the slope (rate of change) of a input time series.

    Tool Info
    Display Name Rate of change
    API Name Rate of change
    Tools Explorer /Time series processing/Rate of change
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.IRateChangeTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Tool Settings
    Suffix Suffix Gets or sets a value of the name suffix for output time series.
    Unit Unit Gets or sets a value of time unit. Change (Per_second, Per_minute, Per_hour, Per_day)
  • Per_second - Change per second
  • Per_minute - Change per minute
  • Per_hour - Change per hour
  • Per_day - Change per day
    		•

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("Rate of change")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.IRateChangeTool(app.Tools.CreateNew("Rate of change"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Rate of change") as DHI.Solutions.TimeseriesManager.Tools.Processing.RateChangeTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds_in);
tool.Unit = DHI.Solutions.TimeseriesManager.Tools.Processing.Units.Per_hour;
tool.Suffix = "hour";
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.RateChangeTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Replace value tool

    The Replace values tool can be used to replace any given value (“Replace value”) or range of values in a time series by a new value (“Replace with”) (e.g. the user can specify that all values = 5 shall be replaced with the value 2.5).

    Tool Info
    Display Name Replace value tool
    API Name Replace value tool
    Tools Explorer /Time series processing/Replace value tool
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.IReplaceValuesTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Options
    Method ReplaceValueMethod Gets or sets the ReplaceValueMethod. ReplaceValueMethod determines what shall replace the
    specified ReplaceValue.
  • With_constant - Use this option to replace by a constant
  • Last_value_before - Use this option to replace by the last different value before.
  • First_value_after - Use this option to replace by the first different value after.
  • Interpolation - Use this option to replace by linear interpolation between last differentvalue before and first different value after.
  • Replace_range_with_constant - Use this option to replace all values in a specified range by a constantvalues.
  • Limit_rate_of_change - Use this option to limit the rate of change between time steps. If the specified maxrate of change is exceeded, the value corresponding to the max allowed change willbe inserted.
  • Remove_from_max_gap - Use this option remove all time steps after a gap in time series larger than max.
    		•
    Period PeriodOption Gets or sets the period option of the tool. The period option determines if the tool shall be applied on the entire time series, or on a sub-period.
  • Entire_timeseries - Apply the tool to the entire time series.
  • Sub_period - Apply the tool to a sub-period only.
    		•
    Process option ProcessOption Gets or sets the process option. The process option determines if the tool shall process the input series or a copy of the input series.
  • Process_copy - Process a copy of the input item.
  • Process_input_timeseries - Process a copy of the input item.
    		•
    Replace option ReplaceOption Gets or sets the ReplaceOption. The Replace option determines of all or only the first occurrence of the ReplaceValue
    shall be replaced.
  • Replace_all_hits - If this option is used, all ReplaceValues willbe processed.
  • First_hit_only - If this option is used, only the first ReplaceValuewill be processed.
    • .
    Note that the property is only available when: ReplaceValueMethod=With_constant,Last_value_before,First_value_after,Interpolation,Replace_range_with_constant,Limit_rate_of_change
    Sub-period
    End date EndDate Gets or sets the end date to where the values should be replaced.
    Note that the property is only available when: PeriodOption=Sub_period
    Start date StartDate Gets or sets the start date from where the values should be replaced.
    Note that the property is only available when: PeriodOption=Sub_period
    Values
    Max gap unit MaxGapUnit Gets or sets the MaxGapUnit. The max gap unit defines the unit of the specified max gap.
  • Seconds - Unit is seconds
  • Minutes - Unit is minutes
  • Hours - Unit is hours
  • Days - Unit is days
    • .
    Note that the property is only available when: ReplaceValueMethod=Remove_from_max_gap
    Max gap MaxGap Gets or sets the MaxGap. The max gap defines the maximum gap allowed in a time series.
    Note that the property is only available when: ReplaceValueMethod=Remove_from_max_gap
    Max rate of change MaxRateOfChange Gets or sets the MaxRateOfChange. If ReplaceValueMethod = Limit_rate_of_change, the time series will be
    corrected such that the specified MaxRateOfChange is never exceeded.
    Note that the property is only available when: ReplaceValueMethod=Limit_rate_of_change
    Range maximum RangeMax Gets or sets RangeMax. If ReplaceValueMethod = Replace_range_with_constant, RangeMax defines the
    max value of the range.
    Note that the property is only available when: ReplaceValueMethod=Replace_range_with_constant
    Range minimum RangeMin Gets or sets RangeMin. If ReplaceValueMethod = Replace_range_with_constant, RangeMax defines the
    minimum value of the range.
    Note that the property is only available when: ReplaceValueMethod=Replace_range_with_constant
    Range option RangeOption Gets or sets the replace option. The range option determines if the values inside, or outside the specified range shall be replaced. Only relevant when ReplaceValueMethod = Replace_range_with_constant
  • Replace_outside_range - Replace values outside the specified range.
  • Replace_inside_range - Replace values inside the specified range.
    • .
    Note that the property is only available when: ReplaceValueMethod=Replace_range_with_constant
    Rate of change option RateOfChangeOption Gets or sets how values outside the allowed rate of change should be set.
  • With_max_allowed_change - Replace values outside the allowed rate of change with the max allowed change.
  • With_constant - Replace values outside the allowed rate of change with a constant.
    • .
    Note that the property is only available when: ReplaceValueMethod=Limit_rate_of_change
    Rate of change unit RateOfChangeUnit Gets or sets the RateOfChangeUnit. The rate of change unit defines the unit of the specified max rate of change.
  • Per_second - Unit is [unit of input item]/second
  • Per_minute - Unit is [unit of input item]/minute
  • Per_hour - Unit is [unit of input item]/hour
  • Per_day - Unit is [unit of input item]/day
    • .
    Note that the property is only available when: ReplaceValueMethod=Limit_rate_of_change
    Replace value ReplaceValue Gets or sets the ReplaceValue. The ReplaceValue is the value that will be replaced according to the
    selected ReplaceValueOption.
    Note that the property is only available when: ReplaceValueMethod=With_constant,Last_value_before,First_value_after,Interpolation
    Replace with ReplaceByValue Gets or sets the ReplaceByValue. If ReplaceValueToolOption is With_constant, the ReplaceByValue will be inserted instead of the
    ReplaceValue.
    Note that the property is only available when: ReplaceValueMethod=With_constant,Replace_range_with_constant
    Replace with ReplaceByValueForExceededRate Gets or sets value to be replace with for ReplaceOption Limit_rate_of_change and With_constant.
    Note that the property is only available when: ReplaceValueMethod=Limit_rate_of_changeRateOfChangeOption=With_constant

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("Replace value tool")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.IReplaceValuesTool(app.Tools.CreateNew("Replace value tool"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Replace value tool") as DHI.Solutions.TimeseriesManager.Tools.Processing.ReplaceValuesTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds_in);
tool.ReplaceValueMethod = DHI.Solutions.TimeseriesManager.Tools.Processing.ReplaceValueMethod.With_constant;
tool.ReplaceOption = DHI.Solutions.TimeseriesManager.Tools.Processing.ReplaceOption.Replace_all_hits;
tool.ReplaceValue = 1;
tool.ReplaceByValue = 100;
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.ReplaceValuesTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Resample

    The resample tool is used for changing the time step of a time series into a user specified time step. It is possible to resample into larger and smaller time steps. The tool will not update the the input time series directly, but will create clones of the input time series, to by found in the tools output items after resampling. Set the time step for year, month, day, hour, minute, second. Note that the tool is by default using a 1 day interval (TimeStepDay=1).

    Tool Info
    Display Name Resample
    API Name Resample
    Tools Explorer /Time series processing/Resample
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.IResampleTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Gap Settings
    Interpolate across gaps InterpolateAcrossGaps Gets or sets a value indicating whether the algorithm shall interpolate
    across gaps in the input series or not. If set to true, the algorithm will
    interpolate across gaps that are less than a specified duration/number.
    If set to false, gaps in the input series will result in gaps in the output series.
    Max. allowed gap duration MaxAllowedGapDuration Gets or sets a value indicating the number of missing values the algorithm shall interpolate across.
    It has an effect when property InterpolateAcrossGaps is false.
    Note that the property is only available when: InterpolateAcrossGaps=True
    Max. missing values per gap MaxNumberOfMissingValuesPerGap Gets or sets a value indicating the maximum duration a gap the algorithm shall interpolate
    across. (it has an effect when property InterpolateAcrossGaps is false).
    Note that the property is only available when: InterpolateAcrossGaps=True
    New time step
    Days TimeStepDay Gets or sets the Day part of the resampling time span. The default value is 1 day.
    Hours TimeStepHour Gets or sets the Hour part of the resampling time span.
    Minutes TimeStepMinute Gets or sets the Minute part of the resampling time span.
    Months TimeStepMonth Gets or sets the Month part of the resampling time span
    Seconds TimeStepSecond Gets or sets the second part of the resampling time span.
    Years TimeStepYear Gets or sets the Day part of the resampling time span
    Start time
    Start Date Offset Type StartDateOffset Gets or sets the offset used for the resampling
  • None - Not using the start date offset
  • Day - Daily offset
  • SpecificDateTime - Specific DateTime
    		•
    Start Time Offset StartTimeOffset Gets or sets the start time used in conjunction with the start Start Date Offset.
    Note that the property is only available when: StartDateOffset=Day
    Start Time StartTime Gets or sets the start date time used in conjunction with the Start Date Offset = SpecificDateTime.
    Note that the property is only available when: StartDateOffset=SpecificDateTime

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("Resample")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.IResampleTool(app.Tools.CreateNew("Resample"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool assuming that the tool is already loaded.
var tool = application.Tools.CreateNew("Resample") as DHI.Solutions.TimeseriesManager.Tools.Processing.ResampleTool;

// Add a time series to the input items (the tool support 1 or more input time series).
tool.InputItems.Add(ts);

// Default of TimeStepDay=1
tool.TimeStepDay = 0;
tool.TimeStepMinute = 30;

// Execute the tool
tool.Execute();

// Get the output of the tool.
var resampledTs = tool.OutputItems[0];

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.ResampleTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Residual mass

    The Residual mass is calculated by first converting the input series to value type Step_Accumulated, and then:

    Res_n = Xn - Avg + Xn-1

    where Res_n is the residual mass, and X are the step accumulated values. The Item Type of the output will be Accumulated. The Residual mass tool uses the Convert value tool.

    Tool Info
    Display Name Residual mass
    API Name Residual mass
    Tools Explorer /Advanced statistics/Residual mass
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.AdvancedStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IResidualMassTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Residual mass")
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IResidualMassTool(app.Tools.CreateNew("Residual mass"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Residual mass") as DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IResidualMassTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.ResidualMassTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll" />

    Run test

    RunTestTool - General non-parametric test for testing independence and homogeneity of a time series.

    Tool Info
    Display Name Run test
    API Name RunTest
    Tools Explorer /Advanced statistics/Run test
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.AdvancedStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IRunTestTool
    Input Items One or more time series
    Output Items A data table

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("RunTest")
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IRunTestTool(app.Tools.CreateNew("RunTest"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("RunTest") as DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IRunTestTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.RunTestTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll" />

    Select Timeseries

    Tool for selecting time series in one or more time series groups.

    Tool Info
    Display Name Select Timeseries
    API Name SelectTsTool
    Tools Explorer /Time series processing/Select Timeseries
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.ISelectTsTool
    Input Items One or more time series groups
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Input Parameters
    Timeseries name TimeseriesName Gets or sets the value of the timeseries name pattern, e.g. MyTs, Ts* (any time series starting with Ts), Ts? (matching single character).
    Value Type ValueType Gets or sets the Item Value Type (All, Instantaneous, Accumulated, Step_Accumulated, Mean_Step_Accumulated or Reverse_Mean_Step_Accumulated).

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("SelectTsTool")
# Add input items.
tool.InputItems.Add(<One or more time series groups>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.ISelectTsTool(app.Tools.CreateNew("SelectTsTool"))
# Add input items.
tool.InputItems.Add(<One or more time series groups>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("SelectTsTool") as DHI.Solutions.TimeseriesManager.Tools.Processing.SelectTsTool;

// Set the tool properties and execute.
tool.InputItems.Add(tsGroup);
tool.ValueType = "All";
tool.TimeseriesName = "t*";
tool.Execute();

// Output items contains a list of time series satisfying the name pattern.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.SelectTsTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Standard deviation

    Standard Deviation tool calculates the standard deviation of a time series, or XY Series. The tool handles multiple input items, and returns a single value for each input item. If provided with an empty time series, double.NaN is returned.

    Tool Info
    Display Name Standard deviation
    API Name Standard deviation
    Tools Explorer /Basic statistics/Standard deviation
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.BasicStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IStandardDeviationTool
    Input Items One or more time series
    Output Items A data table

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Standard deviation")
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.IStandardDeviationTool(app.Tools.CreateNew("Standard deviation"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Standard deviation") as DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.StdDevTool;

// Set the tool properties and execute.
tool.InputItems.Add(ts_in);
tool.Execute();

// Get the output of the tool.
var outputItem = tool.OutputItems[0] as DHI.Solutions.Generic.Tools.TableContainer;
var result = (double)outputItem.TabularData.Rows[0][1];

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.StdDevTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll" />

    Sum

    This tool calculates the sum of all the values in a timeseries.

    Tool Info
    Display Name Sum
    API Name Sum
    Tools Explorer /Basic statistics/Sum
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.BasicStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.ISumTool
    Input Items One or more time series
    Output Items A data table

    Tool Properties

    The tool has no properties.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Sum")
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.BasicStatistics")
from DHI.Solutions.TimeseriesManager.Tools.BasicStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.ISumTool(app.Tools.CreateNew("Sum"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Sum") as DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.SumTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds_in);
tool.Execute();

// Get the output of the tool.
var outputItem = tool.OutputItems[0] as DHI.Solutions.Generic.Tools.TableContainer;
var result = (double)outputItem.TabularData.Rows[0][1];

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.SumTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.BasicStatistics.dll" />

    Synchronize

    The Synchronize tool is used to resample a set of time series into a common time axis. The new common time axis is defined by combining the axes of all input time series. One synchronized time series will be produced for each time series.

    Tool Info
    Display Name Synchronize
    API Name Synchronize
    Tools Explorer /Time series processing/Synchronize
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.ISynchronizeTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Gap Settings
    Interpolate across gaps InterpolateAcrossGaps Gets or sets a value indicating whether the algorithm shall interpolate
    across gaps in the input series or not. If set to true, the algorithm will
    interpolate across gaps that are less than a specified duration/number.
    If set to false, gaps in the input series will result in gaps in the output series.
    Max. allowed gap duration MaxAllowedGapDuration Gets or sets a value indicating the no of missing values the algorithm shall interpolate
    across. (it has an effect when property InterpolateAcrossGaps is false).
    Note that the property is only available when: InterpolateAcrossGaps=True
    Max. missing values per gap MaxNumberOfMissingValuesPerGap Gets or sets a value indicating the maximum duration a gap the algorithm shall interpolate
    across. (it has an effect when property InterpolateAcrossGaps is false).
    Note that the property is only available when: InterpolateAcrossGaps=True
    Synchronization Settings
    Allow Time Step Merging AllowTimeStepMerging Gets or sets a value indicating whether Time step merging is allowed or not.
    Concurrency tolerance ConcurrencyTolerance Gets or sets a value indicating the minimum concurrency time step. The adjacent time
    steps which are separated by less than this value they will be merged into a single
    time step, it has an effect when property AllowTimeStepMerging is true.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("Synchronize")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.ISynchronizeTool(app.Tools.CreateNew("Synchronize"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Synchronize") as DHI.Solutions.TimeseriesManager.Tools.Processing.SynchronizeTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds1_in);
tool.InputItems.Add(ds2_in);
tool.InterpolateAcrossGaps = true;
tool.MaxAllowedGapDuration = TimeSpan.FromMinutes(10);
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.SynchronizeTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Time shift

    Tool to shift X or Y values

    Tool Info
    Display Name Time shift
    API Name Time Shift
    Tools Explorer /Time series processing/Time shift
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.IShiftAndLagTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Replace Original Values
    Replace Values ReplaceValues Gets or sets a value indicating whether the original dataseries has to be replaced or a new cloned dataseries has to be sent as output.
    Shift and Lag
    Shift X LagXDateTime Gets or sets a value which shifts all values of X by a specified value.
    This property with type timespan is used when the XValue type is date time.
    Note that the property is only available when: AreAllCalendar=True
    Shift X LagXDouble Gets or sets a value which shifts all values of X by a specified value.
    This property with type double is used when the XValue type is scalar.
    Note that the property is only available when: AreAllCalendar=False
    Shift Y ShiftY Gets or sets a value which shifts all values of Y by a specified value.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("Time Shift")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.IShiftAndLagTool(app.Tools.CreateNew("Time Shift"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Time Shift") as DHI.Solutions.TimeseriesManager.Tools.Processing.ShiftAndLagTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds_in);
tool.ShiftY = 10;
tool.LagXDateTime = new TimeSpan(0, 2, 0);
tool.ReplaceValues = false;
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.ShiftAndLagTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Times series Query Tool

    Time series query tool for querying time series.

    Tool Info
    Display Name Times series Query Tool
    API Name Time series query
    Tools Explorer /Data tools/Times series Query Tool
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Query
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.QueryTool.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.QueryTool.IQueryTool
    Input Items No input items required
    Output Items List of results

    Tool Properties

    Display Name API Name Description
    Covers period
    End Time EndDate Gets or sets the date that time series should end after.
    Start Time StartDate Gets or sets the date that time series should start before.
    Query parameters
    Has Association(s) HasAssiactions Gets or sets a value indicating wether the time series query should be limited to time series with or without feature associations.
    Empty (null) will not limit the query.
    Is associated to selection MapSelection Gets or sets a value indicating if the query should be limited to time series wioth associations to the active maps selection of features.
    Max time series returned MaxEntries Gets or sets a the maximum number of entries returned when quering entites.
    Metadata Metadata Gets or sets metadata of time series to query for in the time series query.
    Note that the property is only available when: HasMetadataModule=True
    Name TimeSeriesName Gets or sets the name of time series to query for. Wildcards (* and ?) are supported.
    Type ElementType Gets or sets the variable type of time series to query for.
    Within Group WithinGroup Gets or sets time series groups to limit the search of time series. Wildcards are supported.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.QueryTool")
from DHI.Solutions.TimeseriesManager.Tools.QueryTool import *

# Get the tool.
tool = app.Tools.CreateNew("Time series query")
# Add input items.
tool.InputItems.Add(<No input items required>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.QueryTool")
from DHI.Solutions.TimeseriesManager.Tools.QueryTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.QueryTool.IQueryTool(app.Tools.CreateNew("Time series query"))
# Add input items.
tool.InputItems.Add(<No input items required>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Time series query") as DHI.Solutions.TimeseriesManager.Tools.QueryTool.IQueryTool;
// Add input items.
tool.InputItems.Add(<No input items required>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.QueryTool.QueryTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.QueryTool.dll" />

    Timeseries Calculator

    Tool for performing timeseries math on one or more input timeseries.

    Tool Info
    Display Name Timeseries Calculator
    API Name Timeseries Calculator
    Tools Explorer /Time series processing/Timeseries Calculator
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.ITimeseriesCalculatorTool
    Input Items One or more time series or one or more time series groups
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Tool Settings
    Formula Formula Gets or sets the formula to be used for calculating timeseries The formula syntax is based on SpreadsheetGear (which itself is based on Microsoft Excel). Instead of cell references,
    however, formulas are to be entered using timeseries names in brackets. (e.g. "[mytimeseries]" or "min([ts1], [ts2])"). The link between the timeseries names and
    the timeseries are to be mapped in the Mapping property.
    Keep Spreadsheet ToSpreadsheet A value indicating whether to save the calculation spreadsheet
    Name Mapping NameMapping Gets or sets the mapping of names used in the formula to the input timeseries.
    Time Series Query TimeSeriesQuery Gets or sets the time series query to use for all time series in the formula.
    If no query is specified, all time steps of the time series are used.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("Timeseries Calculator")
# Add input items.
tool.InputItems.Add(<One or more time series or one or more time series groups>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.ITimeseriesCalculatorTool(app.Tools.CreateNew("Timeseries Calculator"))
# Add input items.
tool.InputItems.Add(<One or more time series or one or more time series groups>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Timeseries Calculator") as DHI.Solutions.TimeseriesManager.Tools.Processing.ITimeseriesCalculatorTool;
// Add input items.
tool.InputItems.Add(<One or more time series or one or more time series groups>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.TimeseriesCalculatorTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Timeseries Query

    The time series query tool retrieves a set of data series based on a query specified by the user.

    Tool Info
    Display Name Timeseries Query
    API Name Timeseries Query
    Tools Explorer /Query Tools/Timeseries Query
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.TimeseriesQuery
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.TimeseriesQueryTool.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.TimeseriesQueryTool.ITimeseriesQueryTool
    Input Items No input items required
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Input Settings
    Query Query Query which will be run to fetch the results.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.TimeseriesQueryTool")
from DHI.Solutions.TimeseriesManager.Tools.TimeseriesQueryTool import *

# Get the tool.
tool = app.Tools.CreateNew("Timeseries Query")
# Add input items.
tool.InputItems.Add(<No input items required>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.TimeseriesQueryTool")
from DHI.Solutions.TimeseriesManager.Tools.TimeseriesQueryTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.TimeseriesQueryTool.ITimeseriesQueryTool(app.Tools.CreateNew("Timeseries Query"))
# Add input items.
tool.InputItems.Add(<No input items required>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Timeseries Query") as DHI.Solutions.TimeseriesManager.Tools.TimeseriesQueryTool.ITimeseriesQueryTool;
// Add input items.
tool.InputItems.Add(<No input items required>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.TimeseriesQueryTool.TimeseriesQueryTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.TimeseriesQueryTool.dll" />

    To chart

    Tool for presenting time series on a chart data view.

    Tool Info
    Display Name To chart
    API Name To chart
    Tools Explorer /Output Tools/To chart
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ToChart
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.UI.Tools.ToChart.dll
    API Reference DHI.Solutions.TimeseriesManager.UI.Tools.ToChart.IToChartTool
    Input Items One or more time series or one or more time series
    Output Items A chart data view

    Tool Properties

    Display Name API Name Description
    Tool settings
    Apply template TemplateName Gets or sets the Template name. The chart will be applied with the template appreance.
    Chart area option ChartAreaOptions Gets or sets the DisplayOption for the chart area
    New Chart Area
    New or First Compliant Chart Area
  • NewChartArea - To indicate all series contained by the tool will be attempted added to a single, new ChartArea. If the Tool contains items with non-eqvivalent units, a secondary Y-Axis is created. If the tool tries to add items that has more than two non-eqvivalent units, a second ChartArea is created, if there are more than four non-eqvivalent units, a third ChartArea is created etc.
  • FirstCompliantOrNew - To indicate that When a Data Series is added to the chart, it will be added to the first ChartArea that has an eqvivalent unit on the Primary Y-Axis. If none of the Chart Areas has eqvivalent axes, a new ChartArea will be added. This procedure is followed for each series that is added by the tool
    		•
    Chart option ChartDisplayOptions Gets or sets the DisplayOption for the chart
    New Chart
    New or active chart
  • NewChart - Whether dataseries is to be added to a new chart
  • ActiveOrNewChart - If a chart is opened, add onto that else create a new one
  • SpecifiedChart - Whether the chart has to be added to an existing one
    		•
    Output chart name ChartOutputName Gets or sets the name of chart if Specified Chart option is selected for ChartDisplayOptions.
    Note that the property is only available when: ChartDisplayOptions=SpecifiedChart

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.UI.Tools.ToChart")
from DHI.Solutions.TimeseriesManager.UI.Tools.ToChart import *

# Get the tool.
tool = app.Tools.CreateNew("To chart")
# Add input items.
tool.InputItems.Add(<One or more time series or one or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.UI.Tools.ToChart")
from DHI.Solutions.TimeseriesManager.UI.Tools.ToChart import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.UI.Tools.ToChart.IToChartTool(app.Tools.CreateNew("To chart"))
# Add input items.
tool.InputItems.Add(<One or more time series or one or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("To chart") as DHI.Solutions.TimeseriesManager.UI.Tools.ToChart.IToChartTool;
// Add input items.
tool.InputItems.Add(<One or more time series or one or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.UI.Tools.ToChart.ToChart"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.UI.Tools.ToChart.dll" />

    To database

    This tool takes one or more timeseries and saves it directly to the database.

    Tool Info
    Display Name To database
    API Name To database
    Tools Explorer /Output Tools/To database
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ToDatabase
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.ToDatabaseTool.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.ToDatabaseTool.IToDatabaseTool
    Input Items One or more time series
    Output Items No output items

    Tool Properties

    Display Name API Name Description
    Tool settings
    Name suffix NamePostFix Gets or sets the postfix string to be added to the timeseries name.e.g. TimeseriesA Postfix
    Overwrite option DuplicateNameOption Gets or sets the option to be chosen when a timeseres with the same name is already present in the group
  • CreateAndReplace - Create and replace the timeseries
  • ReplaceValues - Replace the value of the timeseries
  • DontCreate - Don't create the timeseries
  • CreateButRename - Create but rename the timeseries
  • NoSave - The no save - TS will not hava associations
    		•
    Save to group Group Gets or sets the group in which to save the timeseries
    Save with new name TimeseriesName Gets or sets the name to be added to the timeseries, e.g. MyTs, MyTs (1), MyTs(2) etc

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ToDatabaseTool")
from DHI.Solutions.TimeseriesManager.Tools.ToDatabaseTool import *

# Get the tool.
tool = app.Tools.CreateNew("To database")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ToDatabaseTool")
from DHI.Solutions.TimeseriesManager.Tools.ToDatabaseTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.ToDatabaseTool.IToDatabaseTool(app.Tools.CreateNew("To database"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("To database") as DHI.Solutions.TimeseriesManager.Tools.ToDatabaseTool.IToDatabaseTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.ToDatabaseTool.ToDatabaseTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.ToDatabaseTool.dll" />

    To feature class

    This tool takes one or more timeseries and saves it directly to the database.

    Tool Info
    Display Name To feature class
    API Name To feature class
    Tools Explorer /Output Tools/To feature class
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ToFeatureClass
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.ToFeatureClass.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.ToFeatureClass.IToFeatureClassTool
    Input Items One or more time series
    Output Items A feature class

    Tool Properties

    Display Name API Name Description
    Tool Settings
    Column Name ColumnName Gets or sets the name of the column to be added to feature class(es) to contain scalar values
    Feature class FeatureClass Gets or sets the value of selected feature class
    Output option OutputOption Gets or sets the output option for the tool
  • AddStatsToOriginal - Add the statistics to the original time series
  • AddStatsToCopy - Add the statistics to the copied time series
    		•
    Tool to apply Tool Gets or sets the tool to use to calculate scalars. Only tools having scalars as output are supported

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ToFeatureClass")
from DHI.Solutions.TimeseriesManager.Tools.ToFeatureClass import *

# Get the tool.
tool = app.Tools.CreateNew("To feature class")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.ToFeatureClass")
from DHI.Solutions.TimeseriesManager.Tools.ToFeatureClass import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.ToFeatureClass.IToFeatureClassTool(app.Tools.CreateNew("To feature class"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("To feature class") as DHI.Solutions.TimeseriesManager.Tools.ToFeatureClass.IToFeatureClassTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.ToFeatureClass.ToFeatureClassTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.ToFeatureClass.dll" />

    To file

    The “To file” tool is used to export one or more time series, ensemble and/or group to files on the disk.

    Tool Info
    Display Name To file
    API Name To file
    Tools Explorer /Output Tools/To file
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.TimeseriesExport
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.TimeseriesExportTool.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.TimeseriesExportTool.ITimeseriesExportTool
    Input Items One or more time series or one or more time series groups
    Output Items No output items

    Tool Properties

    Display Name API Name Description
    Export Settings
    Directory structure option DirectoryStructure Gets or sets the export directory structure
  • ReplicateSubgroups - only the sub-groups to the group on which the tool is executed are replicated as folders on the disk.
  • ReplicateFullPath - a directory structure corresponding to the full group path, starting at the database root shall be replicated as folders on the disk. The root shall be in the Export directory
  • NoSubfolders - all selected time series shall be added to the Export directory, regardless of what groups they come from.
    		•
    Export directory ExportDirectory Gets or sets the export directory
    Export format ExportFormat Gets or sets the export format
  • Ascii - Create the Ascii file
  • Excel - Create the Excel file
  • dfs0 - Create the dfs0 file
    		•
    Flags
    Export Flags ExportFlags Gets or sets a value indicating whether the flags should be export or not
    Format Settings
    Date time format DateTimeFormat Gets or sets the time format of the DateColumn column. Default is "yyyy-MM-dd HH:mm:ss".
    Note that Daylight Saving Time is taken into account when having time zone in the datetime string. E.g. '2023-10-29T01:00:00+01:00' using the DateTimeFormat 'yyyy-MM-ddTHH:mm:sszzz'.
    See more on date and time formatting on Microsoft Learn - Custom Date and Time Formats .
    Note that the property is only available when: ExportFormat=Ascii
    Delimiter character Delimiter Gets or sets the delimiter format.
  • Tab - the Tab separator
  • Semicolon - the Semicolon separator
  • Comma - the Comma separator
  • UserDefined - the User Defined separator
    • .
    Note that the property is only available when: ExportFormat=Ascii
    User defined delimiter DefinedDelimiterFormat Gets or sets the user defined separator format.
    Note that the property is only available when: ExportFormat=AsciiDelimiter=UserDefined
    Metadata
    Export Metadata ExportMetadata Gets or sets a value indicating whether the metadata of the entity should be exported.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.TimeseriesExportTool")
from DHI.Solutions.TimeseriesManager.Tools.TimeseriesExportTool import *

# Get the tool.
tool = app.Tools.CreateNew("To file")
# Add input items.
tool.InputItems.Add(<One or more time series or one or more time series groups>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.TimeseriesExportTool")
from DHI.Solutions.TimeseriesManager.Tools.TimeseriesExportTool import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.TimeseriesExportTool.ITimeseriesExportTool(app.Tools.CreateNew("To file"))
# Add input items.
tool.InputItems.Add(<One or more time series or one or more time series groups>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("To file") as DHI.Solutions.TimeseriesManager.Tools.TimeseriesExportTool.TimeseriesExportTool;

// Set the tool properties and execute.
tool.InputItems.Add(ds_in);
tool.ExportFormat = DHI.Solutions.TimeseriesManager.Tools.TimeseriesExportTool.ExportFormatOptions.dfs0;
tool.ExportDirectory = @"c:\Temp";
tool.Execute();

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.TimeseriesExportTool.TimeseriesExportTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.TimeseriesExportTool.dll" />

    To table

    The ToXYTable tool opens the input XY series to an XY Table.

    Tool Info
    Display Name To table
    API Name To XY table
    Tools Explorer /Output Tools/To table
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ToTimeseriesTable
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.UI.Tools.ToTimeseriesTable.dll
    API Reference DHI.Solutions.TimeseriesManager.UI.Tools.ToTimeseriesTable.ToXYTable
    Input Items No input items required
    Output Items A data table view

    Tool Properties

    Display Name API Name Description
    Tool settings
    Output table name. TableOutputName This is the name of the table that will be created by the tool.
    Note that the property is only available when: TableDisplayOptions=SpecifiedTableAllowMerge=True
    Table option TableDisplayOptions This setting determines whether the input values shall be added to an existing or new table.
  • AlwaysNewTable - Whether data is to be added to a new table
  • NewOrActiveTable - If a table is opened, add onto that else create a new one
  • SpecifiedTable - Whether the table has to be added to an existing one
    • .
    Note that the property is only available when: AllowMerge=True

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.UI.Tools.ToTimeseriesTable")
from DHI.Solutions.TimeseriesManager.UI.Tools.ToTimeseriesTable import *
clr.AddReference("DHI.Solutions.Generic.UI.Tools.ToTable")
from DHI.Solutions.Generic.UI.Tools.ToTable import *

# Get the tool.
tool = app.Tools.CreateNew("To XY table")
# Add input items.
tool.InputItems.Add(<No input items required>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("To XY table") as DHI.Solutions.TimeseriesManager.UI.Tools.ToTimeseriesTable.ToXYTable;
// Add input items.
tool.InputItems.Add(<No input items required>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.UI.Tools.ToTimeseriesTable.ToXYTable"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.UI.Tools.ToTimeseriesTable.dll" />

    To timeseries table

    The To time series table tool opens the input series in a time series table.

    Tool Info
    Display Name To timeseries table
    API Name To timeseries table
    Tools Explorer /Output Tools/To timeseries table
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.ToTimeseriesTable
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.UI.Tools.ToTimeseriesTable.dll
    API Reference DHI.Solutions.TimeseriesManager.UI.Tools.ToTimeseriesTable.ToTimeseriesTable
    Input Items One or more time series
    Output Items A time series table

    Tool Properties

    Display Name API Name Description
    Tool settings.
    Table option TableDisplayOptions This setting determines whether the input values shall be added to an existing or new table.
  • AlwaysNewTable - Whether data is to be added to a new table
  • NewOrActiveTable - If a table is opened, add onto that else create a new one
  • SpecifiedTable - Whether the table has to be added to an existing one
    • .
    Note that the property is only available when: AllowMerge=True
    Tool settings
    Output table name. TableOutputName This is the name of the table that will be created by the tool.
    Note that the property is only available when: TableDisplayOptions=SpecifiedTableAllowMerge=True

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.UI.Tools.ToTimeseriesTable")
from DHI.Solutions.TimeseriesManager.UI.Tools.ToTimeseriesTable import *
clr.AddReference("DHI.Solutions.Generic.UI.Tools.ToTable")
from DHI.Solutions.Generic.UI.Tools.ToTable import *

# Get the tool.
tool = app.Tools.CreateNew("To timeseries table")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("To timeseries table") as DHI.Solutions.TimeseriesManager.UI.Tools.ToTimeseriesTable.ToTimeseriesTable;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.UI.Tools.ToTimeseriesTable.ToTimeseriesTable"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.UI.Tools.ToTimeseriesTable.dll" />

    Unit conversion

    The Unit conversion tool converts a time series into a new variable/unit. The operation is performed on a clone of the input item, and hence no changes are made to the input items. If multiple input items are selected, they will all be converted to the same variable/unit. When the target variable has been set, the target unit has to be set to one of the valid units for the selected variable.

    Tool Info
    Display Name Unit conversion
    API Name Unit conversion
    Tools Explorer /Time series processing/Unit conversion
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.IUnitConversionTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Tool Settings
    Target Unit TargetUnit Gets or sets the unit that the input items shall be converted to. The
    unit shall be a valid unit for the selected target variable.
    Variable type VariableType Gets or sets the common variable type for the input items.

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = app.Tools.CreateNew("Unit conversion")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.IUnitConversionTool(app.Tools.CreateNew("Unit conversion"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Unit conversion") as DHI.Solutions.TimeseriesManager.Tools.Processing.UnitConversionTool;

// Set the tool properties and execute.
tool.InputItems.Add(ts_in);
tool.TargetUnit = "/d";
tool.VariableType = "Rainfall";
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.UnitConversionTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Value type conversion

    The Convert To Value tool allows the user to convert the value type of a Time Series between the five possible value types: Instantaneous, Mean Step Accumulated, Reverse Mean Step Accumulated and Step Accumulated. When a series is converted from either I, MSA, RMSA to either A or SA, the tool attempts to integrate the unit as well (e.g. m3/s -> m3). When going from A, SA to I, MSA or RMSA the tool will attempt to differentiate the unit as well (m3 -> m3/s). If this conversion is not successful, the unit will be set to undefined. ///

    Tool Info
    Display Name Value type conversion
    API Name Value type conversion
    Tools Explorer /Time series processing/Value type conversion
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.Processing
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.Processing.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.Processing.IConvertToValueTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Input Parameters
    Value Type ItemValueType Gets or sets the target Item Value Type.
  • Instantaneous - The values of the time series are measured at a precise instant.For example, the air tempera­ture at a particular time is an instantaneous value.
  • Accumulated - The values of the time series are summed over successive intervals of time and always relative to the same starting time.For example, rainfall accumulated over a year with monthly rainfall values.
  • Step_Accumulated - The values of the time series are accumulated over a time interval, relative to the beginning of the interval.For example, a tipping bucket rain gauge measures step-accu­mulated rainfall.In this case, the rain gauge accumulates rainfall until the gauge is full, then it empties and starts accumulating again.Thus, the time series consists of the total amount of rainfall accumulated in each time period - say in mm of rainfall.
  • Mean_Step_Accumulated - The values of the time series are accumulated over the time interval as in the Step Accumu­lated, but the value is divided by the length of the accumulation period.Thus, based on the previous example, the time series consists of the rate of rainfall accumulated in each time period - say in mm of rainfall per hour (mm/hr).
  • Reverse_Mean_Step_Accumulated - Reverse Mean Step Accumulated values are the same as the Mean Step Accumulated, but the values represent the time interval from now to the start of the next time inter­val.The Reverse Mean Step Accumulated time series are primarily used for forecasting purposes.
    		•

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *
clr.AddReference("DHI.Solutions.Generic")
from DHI.Solutions.Generic import *

# Get the tool.
tool = app.Tools.CreateNew("Value type conversion")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.Processing")
from DHI.Solutions.TimeseriesManager.Tools.Processing import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.Processing.IConvertToValueTool(app.Tools.CreateNew("Value type conversion"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool
var tool = application.Tools.CreateNew("Value type conversion") as DHI.Solutions.TimeseriesManager.Tools.Processing.ConvertToValueTool;

// Set the tool properties and execute.
tool.InputItems.Add(ts_in);
tool.ItemValueType = DHI.Solutions.Generic.DataSeriesValueType.Instantaneous;
tool.Execute();

// Get the output of the tool.
var ds_out = tool.OutputItems[0] as DHI.Solutions.Generic.IDataSeries;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.Processing.ConvertToValueTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.Processing.dll" />

    Within-year statistics

    The Within-year statistics tool calculates the specified statics for a relative time period (Analysis time step). The output is a time series that covers a single year with the statistics calculated on the specified time step. The tool can be used to calculate e.g. the average flow for Jan, feb, ... Dec based on a time series that spans several years. The input series must cover at least one full year.

    Tool Info
    Display Name Within-year statistics
    API Name Within Year Statistic
    Tools Explorer /Advanced statistics/Within-year statistics
    NuGet Package DHI.MikeOperations.TimeseriesManager.Tools.AdvancedStatistics
    Assembly name (.dll) DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll
    API Reference DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IWithinYearStatsTool
    Input Items One or more time series
    Output Items A time series

    Tool Properties

    Display Name API Name Description
    Analysis time step
    Output time step unit PeriodUnit Gets or sets period unit
  • Day - Day of month
  • Month - Month of year
    		•
    Time step length PeriodLenght Gets or sets period length
    Output settings
    First day in output TS StartDate Gets or sets start date
    Output time series suffix Surffix Gets or sets the value of suffix
    Output statistics
    Within-year statistic StatisticalMethod Gets or sets statistical method
  • Min - Minimum value of all data values inside a given evaluation time step
  • Max - maximum value of all data values inside a given evaluation time step
  • Average - The average of all values inside a given evaluation time step
  • StandardDeviation - standard deviation of all data values inside a given evaluation time step
  • Count - The number of valid (not deleted) data values in a evaluation time step
  • Medium - Medium (50% fractile)
  • Quantiles - two confidence fractiles
    		•
    Quantile settings
    Lower Boundary for Quantile LowerBoundary Gets or sets the value of lower boundary.
    Note that the property is only available when: UseBoundary=Lower,BothStatisticalMethod=Quantiles
    Quantile % Quantile Gets or sets the value of quantile.
    Note that the property is only available when: StatisticalMethod=Quantiles
    Upper Boundary for Quantile UpperBoundary Gets or sets the value of upper boundary.
    Note that the property is only available when: UseBoundary=Both,UpperStatisticalMethod=Quantiles
    Use quantile boundary UseBoundary Gets or sets the value of use boundary
  • No - No boundary style
  • Lower - Lower boundary style
  • Upper - Upper boundary style
  • Both - Both boundary style
    • .
    Note that the property is only available when: StatisticalMethod=Quantiles

    Code Sample

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = app.Tools.CreateNew("Within Year Statistic")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    import clr
clr.AddReference("DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics")
from DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics import *

# Get the tool.
tool = DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IWithinYearStatsTool(app.Tools.CreateNew("Within Year Statistic"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

    // Get the tool.
var tool = application.Tools.CreateNew("Within Year Statistic") as DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.IWithinYearStatsTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

    Runtime.config

    What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

    The XML below shows the tool plugin information found in the Runtime.config file.

    <Plugin
  Name="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.WithinYearStatsTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.TimeseriesManager.Tools.AdvancedStatistics.dll" />