using System; using System.Collections.Generic; using System.Threading; using MathNet.Numerics.LinearAlgebra; using Microsoft.Extensions.DependencyInjection; using MOSAIC.Components.Basics; namespace MOSAIC.Models.SignalProcessing; /// Multiplies every element of an incoming vector by a scalar gain. /// /// Accepts one Vector<double> input and publishes a new vector of the same length. /// Params[0] is the gain (default 1.0). Negative and zero gains are allowed. /// Other payload types are ignored. /// /// /// /// { /// "Amplify": { /// "Type": "gainblock", /// "Inputs": ["Signal"], /// "Params": [2.5] /// } /// } /// /// Signal must name an upstream vector-producing block. Params[0] is the gain. /// public sealed class GainBlock : BaseBlock { #region Settings private double _gain; /// The multiplier currently used by the processing code. public double Gain => Volatile.Read(ref _gain); /// Applies a finite gain. Zero and negative values are allowed. public void SetGain(double gain) { if (!double.IsFinite(gain)) throw new ArgumentOutOfRangeException(nameof(gain), "Gain must be finite."); Volatile.Write(ref _gain, gain); } #endregion #region Construction public GainBlock(string name, double desiredRate = 0, double gain = 1.0) : base(name, desiredRate) { SetGain(gain); } #endregion #region Processing protected override void OnReceive(object sender, object value) { if (value is not Vector input) { ReportError("Gain requires a numeric vector."); return; } ClearError(); // Read once so every channel uses the same gain. double gain = Gain; var output = input.Multiply(gain); Publish(output); } #endregion #region JSON configuration public static GainBlock ConfigureInput(IServiceProvider sp, JsonModel m) { double gain = m.Params is { Count: > 0 } ? JsonModel.GetDouble(m.Params[0], 1.0) : 1.0; return ActivatorUtilities.CreateInstance( sp, m.Name ?? "Gain", m.DesiredRate ?? 0d, gain); } protected override string JsonTypeName => "gainblock"; protected override IReadOnlyList? GetJsonParams() => new object[] { Gain }; #endregion }