Class WeightedLeastDifferenceSelector

All Implemented Interfaces:
FWSimFieldContainer
Direct Known Subclasses:
LeastDifferenceSelector

public class WeightedLeastDifferenceSelector extends FWSimulationSelector
Selects the simulation with the best error/deviation for multiple target variables. The general error is the weighted sum of the errors.

Configuration

User has to specify

  • the frequency at which values should be compared
  • the calculation method cMode (Bias,MRE,MAE,RMAE,MSE,RMSE,index,rc etc.)
  • the number of target variables cNumberOfVariables (up to 20)
  • for each target variable a pair of SimVariables cObserved{i}/cSimulated{i}
  • for each target variable the weight for the error cWeight{i}
  • {i} ranges from 1 to cNumberOfVariables

Outputs

  • the selected simulation id as a one size CHARARRAY selectedsimulations
  • the best error value achieved as DOUBLE BestErrorValue
  • all simulations weighted sum of errors ErrorValues as DOUBLEARRAY
  • for each target variable all simulations error ErrorValuesVariable{i} as DOUBLEARRAY

Description

For a simulation the calculated values of different variables \(i = 1, ... cNumberOfVariables\) are compared to reference (measured) values (e.g. Yield, LAI, Biomass). The selector can handle maximum 20 different variables. Each variable exists pairwise in the simulation as observed\simulated. Observed variables normally come from a resource (datafile), where simulated ones are calculated. (Notice: The selector works also, if both variables come from resources or if both are simulated.)

For each of these variables \(n\) samples are produced by the simulation (\(n\) is determined by the simulated time span and the selectors frequence information).

Let \(\mathcal{E}: \mathbb{R}^n \times \mathbb{R}^n\ \rightarrow \mathbb{R}\) be the selected calculation method - e.g. the bias \(E(o,s)=\sum_{j=1}^n o_j - s_j\)

The weighted difference is then

\[ E = \frac{1}{\omega}\sum_{i=1}^{cNumberOfVariables} cWeight_i \mathcal{E}(cObserved_i,cSimulated_i) \] where \(\omega\) is the sum of weights: \[ \omega = \sum_{i=1}^{cNumberOfVariables} cWeight_i \]

If \(k= 1, ... l\) simulations are performed within a project, then the selector calculates all weighted errors \(E_k\) and selects the simulation with the best error. (The best error depends on the calculation method for RMSE it's the one closest to 0, for agreement index closest to 1 etc.)

The output NumberOfValues counts the number of simulations used for comparison. Normally it's equal to \(l\), but it can be lower because simulations that produce no usable result (i.e. \(E_k\) could not be calculated) are skipped.

Example

|  <selector id="Selector" class="net.simplace.sim.control.selectors.WeightedLeastDifferenceSelector"
|      frequence="COMPLEX" rule="${observations.HasData}" >
|    <input id="cMode" datatype="CHAR">RRMSE</input>
|    <input id="cNumberOfVariables" datatype="INT">1</input>
|
|    <input id="cObserved1" datatype="DOUBLE" mode="LAST" source="observations.yield"/>
|    <input id="cSimulated1" datatype="DOUBLE" mode="LAST" source="GecrosCrop.WSO"/>
|    <input id="cWeight1" datatype="DOUBLE">0.8</input>
|
|    <input id="cObserved2" datatype="DOUBLE" mode="LAST" source="observations.greenLAI_destructive"/>
|    <input id="cSimulated2" datatype="DOUBLE" mode="LAST" source="GecrosCrop.LAI"/>
|    <input id="cWeight2" datatype="DOUBLE">0.2</input>
|  </selector>

Error methods

  • Bias - mean error
  • SignedBias - mean error, selects the smallest signed bias
  • MRE - mean relative error
  • MAE - mean absolute error
  • RMAE - relative mean absolute error
  • MSE - mean squared error
  • RMSE - root mean squared error
  • RRMSE - relative root mean squared error
  • SMAPE - symmetric mean absolute percentage error
  • EF - model efficiency
  • r - Correlation Coefficient
  • rc - Concordance Correlation Coefficient
  • index - Agreement Index
  • NONE - Void Error Calculator
Author:
Gunther Krauss
See Also:
  • Field Details

    • maxnumber

      protected int maxnumber
      maximum number of variable pairs (20, or 1 if set before createVariables())
    • number

      protected int number
      number of variable pairs used
    • weightsum

      protected double weightsum
      sum of the weights
    • cNumberOfVariables

      protected FWSimVariable<Integer> cNumberOfVariables
      input: number of variable pairs
    • iObserved

      protected ArrayList<FWSimVariable<String>> iObserved
      inputs: observed variables
    • iSimulated

      protected ArrayList<FWSimVariable<String>> iSimulated
      inputs: simulated variables
    • cWeight

      protected ArrayList<FWSimVariable<Double>> cWeight
      inputs: weights of the variable pairs
    • cMode

      protected FWSimVariable<String> cMode
      input: error calculation method
    • NumberOfValues

      protected FWSimVariable<Integer> NumberOfValues
      output: number of compared simulations
    • ErrorValue

      protected FWSimVariable<Double> ErrorValue
      output: error of the selected simulation
    • ErrorValues

      protected FWSimVariable<Double[]> ErrorValues
      output: errors of all simulations
    • IndividualErrorValues

      protected ArrayList<FWSimVariable<Double[]>> IndividualErrorValues
      outputs: errors of all simulations per variable pair
    • ErrorMethod

      protected FWSimVariable<String> ErrorMethod
      output: name of the error calculation method
    • errorCalculator

      protected ErrorCalculationMethod[] errorCalculator
      error calculator per variable pair
  • Constructor Details

    • WeightedLeastDifferenceSelector

      public WeightedLeastDifferenceSelector(org.jdom2.Element aSimulationSelectorElement, FWSimSession aSession)
      Parameters:
      aSimulationSelectorElement - the selector element
      aSession - the session
  • Method Details

    • createVariables

      public HashMap<String, FWSimVariable<?>> createVariables()
      Creates the inputs (cNumberOfVariables, cMode, and cObserved{i}, cSimulated{i}, cWeight{i} per pair) and the outputs.
      Returns:
      the variables, keyed by name
      See Also:
    • init

      public void init()
      Takes over the inputs: the number of pairs (at most the maximum), the variables and weights (a non-positive sum of weights is replaced by 1) and the error method.
      Specified by:
      init in class FWSimulationControlContainer
    • select

      protected void select(ResultSet aResultSet)
      Reads the data of the iteration row by row (ordered by simulation), accumulates the error of each variable pair per simulation, calculates the weighted error of each simulation and selects the best simulation (per project in INDIVIDUAL mode, over all projects in GLOBAL mode). The outputs are set and the selected simulation id is appended to the selected simulations.
      Specified by:
      select in class FWSimulationSelector
      Parameters:
      aResultSet - the data of the iteration (must not be null)