Dyad

Appearance

ScalarInterpolation.md

ScalarInterpolation ​

Performs interpolation on input values using a specified dataset and interpolation method.

Takes an input value and produces an output by interpolating within a dataset according to the specified interpolation type. The component creates an interpolator object from the dataset and interpolation parameters, then applies this interpolator to map input values to output values through lookup and interpolation.

This component extends from BlockComponents.SISO

Usage ​

ScalarInterpolation(interpolator=dataset_interpolation(interpolation_type, filepath, independent_var, [dependent_var]))

Parameters: ​

NameDescriptionUnitsDefault value
filepathDataset containing the data points to be interpolated–
independent_var–
dependent_var–
interpolation_type–

Connectors ​

  • u - This connector represents a real signal as an input to a component (RealInput)

  • y - This connector represents a real signal as an output from a component (RealOutput)

Behavior ​

@example
using BlockComponents #hide
using ModelingToolkit #hide
@named sys = ScalarInterpolation() #hide
full_equations(sys) #hide

Source ​

# Performs interpolation on input values using a specified dataset and interpolation method.
#
# Takes an input value and produces an output by interpolating within a dataset according to the
# specified interpolation type. The component creates an interpolator object from the dataset and
# interpolation parameters, then applies this interpolator to map input values to output values
# through lookup and interpolation.
component ScalarInterpolation
  extends BlockComponents.SISO
  # Dataset containing the data points to be interpolated
  structural filepath::String
  structural independent_var::String
  structural dependent_var::String
  structural interpolation_type::String
  final parameter interpolator::Real2RealInterpolator = dataset_interpolation(interpolation_type, filepath, independent_var, [dependent_var])
relations
  y = interpolator(u)
end
Flattened Source
# Performs interpolation on input values using a specified dataset and interpolation method.
#
# Takes an input value and produces an output by interpolating within a dataset according to the
# specified interpolation type. The component creates an interpolator object from the dataset and
# interpolation parameters, then applies this interpolator to map input values to output values
# through lookup and interpolation.
component ScalarInterpolation
  # Input signal port
  u = RealInput() [{
    "Dyad": {
      "placement": {"icon": {"iconName": "input", "x1": -50, "y1": 450, "x2": 50, "y2": 550}}
    }
  }]
  # Output signal port
  y = RealOutput() [{
    "Dyad": {
      "placement": {"icon": {"iconName": "output", "x1": 950, "y1": 450, "x2": 1050, "y2": 550}}
    }
  }]
  # Dataset containing the data points to be interpolated
  structural filepath::String
  structural independent_var::String
  structural dependent_var::String
  structural interpolation_type::String
  final parameter interpolator::Real2RealInterpolator = dataset_interpolation(interpolation_type, filepath, independent_var, [dependent_var])
relations
  y = interpolator(u)
metadata {}
end


Test Cases ​

No test cases defined.