Display units alongside channel type in LFP Viewer

Author: anjaldoshi

Plugins/LfpViewer/DisplayBuffer.cpp

@@ -68,7 +68,8 @@ void DisplayBuffer::addChannel (
     String description,
     String structure,
     float inputRangeMin,
-    float inputRangeMax)
+    float inputRangeMax,
+    String units)
 {
     ChannelMetadata metadata = ChannelMetadata();
     metadata.name = name;
@@ -81,6 +82,7 @@ void DisplayBuffer::addChannel (
     metadata.description = description;
     metadata.inputRangeMin = inputRangeMin;
     metadata.inputRangeMax = inputRangeMax;
+    metadata.units = units;
 
     channelMetadata.add (metadata);
     channelMap[channelNum] = numChannels;

Plugins/LfpViewer/DisplayBuffer.h

@@ -65,7 +65,8 @@ class TESTABLE DisplayBuffer : public AudioBuffer<float>
                      String description = "",
                      String structure = "None",
                      float inputRangeMin = -5000.0f,
-                     float inputRangeMax = +5000.0f);
+                     float inputRangeMax = +5000.0f,
+                     String units = "");
 
     /** Initializes the event channel at the start of each buffer */
     void initializeEventChannel (int nSamples);
@@ -95,6 +96,7 @@ class TESTABLE DisplayBuffer : public AudioBuffer<float>
         String description = "";
         float inputRangeMin = -5000.0f;
         float inputRangeMax = +5000.0f;
+        String units = "";
     };
 
     Array<ChannelMetadata> channelMetadata;

Plugins/LfpViewer/LfpChannelDisplay.cpp

@@ -79,6 +79,16 @@ void LfpChannelDisplay::setType (ContinuousChannel::Type type_)
     typeStr = options->getTypeName (type);
 }
 
+void LfpChannelDisplay::setUnits (const String& newUnits)
+{
+    units = newUnits;
+}
+
+const String& LfpChannelDisplay::getUnits() const
+{
+    return units;
+}
+
 void LfpChannelDisplay::setEnabledState (bool state)
 {
     /*if (state)

Plugins/LfpViewer/LfpChannelDisplay.h

@@ -113,6 +113,12 @@ class LfpChannelDisplay : public Component
     /** Return the assigned channel name */
     String getName();
 
+    /** Set the units string used for display */
+    void setUnits (const String& newUnits);
+
+    /** Return the units string for this channel */
+    const String& getUnits() const;
+
     /** Returns the assigned channel number for this display, relative
         to the subset of channels being drawn to the canvas */
     int getDrawableChannelNumber();
@@ -193,6 +199,8 @@ class LfpChannelDisplay : public Component
     float depth;
     bool isRecorded;
 
+    String units;
+
     FontOptions channelFont;
 
     Colour lineColour;

Plugins/LfpViewer/LfpChannelDisplayInfo.cpp

@@ -239,8 +239,31 @@ void LfpChannelDisplayInfo::paint (Graphics& g)
 
     if (getChannelTypeStringVisibility())
     {
+        constexpr int textHeight = 14;
+        constexpr int textStartX = 5;
+        const int textY = center + 10;
+
         g.setFont (FontOptions (13.0f));
-        g.drawText (typeStr, 5, center + 10, 50, 14, Justification::centred, false);
+        g.setColour (lineColour);
+        const auto currentFont = g.getCurrentFont();
+
+        const int typeWidth = currentFont.getStringWidth (typeStr);
+        const int typeBoundsWidth = typeWidth + 2;
+        g.drawText (typeStr, textStartX, textY, typeBoundsWidth, textHeight, Justification::centredLeft, false);
+
+        const String& unitsText = getUnits();
+        if (unitsText.isNotEmpty())
+        {
+            const int unitsX = textStartX + typeWidth + 5;
+            const int unitsWidth = getWidth() - unitsX - 4;
+
+            if (unitsWidth > 0)
+            {
+                g.setColour (Colours::grey.withAlpha (0.8f));
+                g.setFont (FontOptions (12.0f));
+                g.drawFittedText (unitsText, unitsX, textY, unitsWidth, textHeight, Justification::centredLeft, 1, 0.8f);
+            }
+        }
     }
 
     if (isSingleChannel)

Plugins/LfpViewer/LfpDisplayNode.cpp

@@ -95,7 +95,8 @@ void LfpDisplayNode::updateSettings()
                                                 channel->getDescription(),
                                                 "None", // structure
                                                 channel->inputRange.min, // inputRangeMin
-                                                channel->inputRange.max); // inputRangeMax
+                                                channel->inputRange.max, // inputRangeMax
+                                                channel->getUnits()); // units
     }
 
     Array<DisplayBuffer*> toDelete;