Class UnitParameters

Parameters data class of the UnitModel.

Inheritance

object

ModelParametersBaseClass

UnitParameters

Inherited Members

ModelParametersBaseClass.Fitting

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: TimeSeriesAnalysis.Dynamic

Assembly: TimeSeriesAnalysis.dll

Syntax

public class UnitParameters : ModelParametersBaseClass

Constructors

UnitParameters()

Default constructor.

Declaration

public UnitParameters()

Fields

FittingSpecs

User-specified inputs to model fitting process such as minima,maxima and working point

Declaration

public FittingSpecs FittingSpecs

Field Value

Type	Description
FittingSpecs

Y_max

the maximum allowed output value(if set to NaN, no maximum is applied)

Declaration

public double Y_max

Field Value

Type	Description
double

Y_min

The minimum allowed output value(if set to NaN, no minimum is applied)

Declaration

public double Y_min

Field Value

Type	Description
double

Properties

Bias

The constant bias that is added so that models and dataset match on average, this value will depend on U0 and other parameters.

Declaration

public double Bias { get; set; }

Property Value

Type	Description
double

BiasUnc

The 95% uncertainty of the bias

Declaration

public double? BiasUnc { get; set; }

Property Value

Type	Description
double?

CurvatureUnc

The unceratainties of the curvature term of the process gains

Declaration

public double[] CurvatureUnc { get; set; }

Property Value

Type	Description
double[]

Curvatures

The nonlinear curvature of the process gain, this paramter is multiplied + Curvatures*((u-u0)/Unorm)^2. If value is nullc> then no curvatures are added to the model

Declaration

public double[] Curvatures { get; set; }

Property Value

Type	Description
double[]

DampingRatio

Damping (second-order) values between ~0.3-0.99 will cause step response with a single visibl overshoot. ) Set to zero to disable damping. As values less than 0.3 approach zero, the step response will become more and more oscillatory.

Declaration

public double DampingRatio { get; set; }

Property Value

Type	Description
double

LinearGainUnc

An array of 95% uncertatinty in the linear gains (u-u0))

Declaration

public double[] LinearGainUnc { get; set; }

Property Value

Type	Description
double[]

LinearGains

An array of gains that determine how much in the steady state each input change affects the output(multiplied with (u-u0))

Declaration

public double[] LinearGains { get; set; }

Property Value

Type	Description
double[]

TimeConstantUnc_s

The uncertinty of the time constant estimate

Declaration

public double? TimeConstantUnc_s { get; set; }

Property Value

Type	Description
double?

TimeConstant_s

A time constant in seconds, the time a 1. order linear system requires to do 63% of a step response. Set to zero to turn off time constant in model.

Declaration

public double TimeConstant_s { get; set; }

Property Value

Type	Description
double

TimeDelay_s

The time delay in seconds.This number needs to be a multiple of the sampling rate. Set to zero to turn off time delay in model.

Declaration

public double TimeDelay_s { get; set; }

Property Value

Type	Description
double

U0

The working point of the model, the value of each U around which the model is localized. If value is nullc> then no U0 is used in the model.

Declaration

public double[] U0 { get; set; }

Property Value

Type	Description
double[]

UNorm

A "normal range" of U that is used in the nonlinear curvature term ((u-u0)/Unorm)^2. If value is nullc> then no UNorm is used in the model.

Declaration

public double[] UNorm { get; set; }

Property Value

Type	Description
double[]

Methods

AddWarning(UnitdentWarnings)

Adds an identification warning to the object.

Declaration

public void AddWarning(UnitdentWarnings warning)

Parameters

Type	Name	Description
UnitdentWarnings	warning

CreateCopy()

Creates a deep-copy of the object.

Declaration

public UnitParameters CreateCopy()

Returns

Type	Description
UnitParameters

GetNumInputs()

Get the number of inputs U to the model.

Declaration

public int GetNumInputs()

Returns

Type	Description
int

GetProcessGainUncertainties()

Get all the process gain uncertainties.

Declaration

public double[] GetProcessGainUncertainties()

Returns

Type	Description
double[]

GetProcessGains()

Get all process gains (including both linear and any nonlinear terms).

Declaration

public double[] GetProcessGains()

Returns

Type	Description
double[]	may return null if no process gains given.

GetTotalCombinedProcessGain(int)

Return the "total combined" process gain for a given index at u=u0, a combination of linear gain and curvature gain.

Note that for nonlinear processes, the process gain is given by a combination of the linear and curvature terms of the model : dy/du(u=u0)

Declaration

public double GetTotalCombinedProcessGain(int inputIdx)

Parameters

Type	Name	Description
int	inputIdx

Returns

Type	Description
double

GetTotalCombinedProcessGainUncertainty(int)

Return the process gain uncertatinty for a given input index at u=u0.

Note that for nonlinear processes, the process gain is given by a combination of the linear and curvature terms of the model : dy/du(u=u0)

Declaration

public double GetTotalCombinedProcessGainUncertainty(int inputIdx)

Parameters

Type	Name	Description
int	inputIdx

Returns

Type	Description
double

GetWarningList()

Get the list of all warnings given during identification of the model.

Declaration

public List<UnitdentWarnings> GetWarningList()

Returns

Type	Description
List<UnitdentWarnings>