Merge branch 'development' into test-pr

Author: medengineer

.github/workflows/tests.yml

@@ -96,7 +96,7 @@ jobs:
       - name: Install test-suite
         shell: powershell
         run: |
-          git clone --branch juce8 https://github.com/open-ephys/open-ephys-python-tools.git C:\open-ephys-python-tools
+          git clone --branch main https://github.com/open-ephys/open-ephys-python-tools.git C:\open-ephys-python-tools
           cd C:\open-ephys-python-tools
           pip install -e .
           pip install psutil

Plugins/LfpViewer/DisplayBuffer.cpp

@@ -66,7 +66,10 @@ void DisplayBuffer::addChannel (
     int group,
     float ypos,
     String description,
-    String structure)
+    String structure,
+    float inputRangeMin,
+    float inputRangeMax,
+    String units)
 {
     ChannelMetadata metadata = ChannelMetadata();
     metadata.name = name;
@@ -77,6 +80,9 @@ void DisplayBuffer::addChannel (
     metadata.type = type;
     metadata.isRecorded = isRecorded;
     metadata.description = description;
+    metadata.inputRangeMin = inputRangeMin;
+    metadata.inputRangeMax = inputRangeMax;
+    metadata.units = units;
 
     channelMetadata.add (metadata);
     channelMap[channelNum] = numChannels;

Plugins/LfpViewer/DisplayBuffer.h

@@ -63,7 +63,10 @@ class TESTABLE DisplayBuffer : public AudioBuffer<float>
                      int group = 0,
                      float ypos = 0,
                      String description = "",
-                     String structure = "None");
+                     String structure = "None",
+                     float inputRangeMin = -5000.0f,
+                     float inputRangeMax = +5000.0f,
+                     String units = "");
 
     /** Initializes the event channel at the start of each buffer */
     void initializeEventChannel (int nSamples);
@@ -91,6 +94,9 @@ class TESTABLE DisplayBuffer : public AudioBuffer<float>
         ContinuousChannel::Type type;
         bool isRecorded = false;
         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/LfpDisplay.cpp

@@ -162,8 +162,32 @@ ChannelColourScheme* LfpDisplay::getColourSchemePtr()
 
 void LfpDisplay::updateRange (int i)
 {
-    channels[i]->setRange (range[channels[i]->getType()]);
-    channelInfo[i]->setRange (range[channels[i]->getType()]);
+    // Check if this is an AUX channel with auto-scaling enabled
+    if (channels[i]->getType() == ContinuousChannel::Type::AUX && options->isAuxAutoScaleEnabled())
+    {
+        // Apply individual auto-scaling based on this channel's InputRange
+        float rangeMin = canvasSplit->displayBuffer->channelMetadata[i].inputRangeMin;
+        float rangeMax = canvasSplit->displayBuffer->channelMetadata[i].inputRangeMax;
+        float autoRange = rangeMax - rangeMin;
+
+        if (autoRange > 0.0f)
+        {
+            channels[i]->setRange (autoRange);
+            channelInfo[i]->setRange (autoRange);
+        }
+        else
+        {
+            // Fall back to the default range for this type
+            channels[i]->setRange (range[channels[i]->getType()]);
+            channelInfo[i]->setRange (range[channels[i]->getType()]);
+        }
+    }
+    else
+    {
+        // Use the standard range for the channel type
+        channels[i]->setRange (range[channels[i]->getType()]);
+        channelInfo[i]->setRange (range[channels[i]->getType()]);
+    }
 }
 
 void LfpDisplay::setNumChannels (int newChannelCount)
@@ -602,7 +626,10 @@ void LfpDisplay::setRange (float r, ContinuousChannel::Type type)
         for (int i = 0; i < numChans; i++)
         {
             if (channels[i]->getType() == type)
+            {
                 channels[i]->setRange (range[type]);
+                channelInfo[i]->setRange (range[type]);
+            }
         }
 
         if (displayIsPaused)
@@ -615,6 +642,46 @@ void LfpDisplay::setRange (float r, ContinuousChannel::Type type)
     }
 }
 
+void LfpDisplay::setAutoRangeForAuxChannels()
+{
+    if (canvasSplit->displayBuffer == nullptr || channels.size() == 0)
+        return;
+
+    // Apply individual ranges to each AUX channel based on their InputRange
+    for (int i = 0; i < numChans; i++)
+    {
+        if (channels[i]->getType() == ContinuousChannel::Type::AUX)
+        {
+            // Get the InputRange from the channel metadata
+            if (i < canvasSplit->displayBuffer->channelMetadata.size())
+            {
+                float rangeMin = canvasSplit->displayBuffer->channelMetadata[i].inputRangeMin;
+                float rangeMax = canvasSplit->displayBuffer->channelMetadata[i].inputRangeMax;
+                float autoRange = rangeMax - rangeMin;
+
+                if (autoRange > 0.0f)
+                {
+                    channels[i]->setRange (autoRange);
+                    channelInfo[i]->setRange (autoRange);
+                }
+                else
+                {
+                    // Fall back to the default range for this type
+                    channels[i]->setRange (range[ContinuousChannel::Type::AUX]);
+                    channelInfo[i]->setRange (range[ContinuousChannel::Type::AUX]);
+                }
+            }
+        }
+    }
+
+    if (displayIsPaused)
+    {
+        timeOffsetChanged = true;
+        canRefresh = true;
+        refresh();
+    }
+}
+
 int LfpDisplay::getRange()
 {
     return getRange (options->getSelectedType());
@@ -834,20 +901,25 @@ void LfpDisplay::mouseWheelMove (const MouseEvent& e, const MouseWheelDetails& w
     {
         if (e.mods.isAltDown()) // ALT + scroll wheel -> change channel range (was SHIFT but that clamps wheel.deltaY to 0 on OSX for some reason..)
         {
+            auto chanType = options->getSelectedType();
+
+            if (chanType == ContinuousChannel::AUX && options->isAuxAutoScaleEnabled())
+                return;
+
             int h = getRange();
 
-            int step = options->getRangeStep (options->getSelectedType());
+            int step = options->getRangeStep (chanType);
 
             // std::cout << wheel.deltaY << std::endl;
 
             if (wheel.deltaY > 0)
             {
-                setRange (h + step, options->getSelectedType());
+                setRange (h + step, chanType);
             }
             else
             {
                 if (h > step + 1)
-                    setRange (h - step, options->getSelectedType());
+                    setRange (h - step, chanType);
             }
 
             options->setRangeSelection (h); // update combobox
@@ -1174,6 +1246,7 @@ void LfpDisplay::mouseDown (const MouseEvent& event)
     int dist = 0;
     int mindist = 10000;
     int closest = 5;
+    float chanRange = getRange();
 
     for (int n = 0; n < drawableChannels.size(); n++) // select closest instead of relying on eventComponent
     {
@@ -1188,6 +1261,7 @@ void LfpDisplay::mouseDown (const MouseEvent& event)
         {
             mindist = dist - 1;
             closest = n;
+            chanRange = drawableChannels[n].channel->getRange();
         }
     }
 
@@ -1213,7 +1287,7 @@ void LfpDisplay::mouseDown (const MouseEvent& event)
         {
             drawableChannels[0].channelInfo->updateXY (
                 float (x) / getWidth() * canvasSplit->timebase,
-                (-(float (y) - viewport->getViewPositionY()) / viewport->getViewHeight() * float (getRange())) + float (getRange() / 2));
+                (-(float (y) - viewport->getViewPositionY()) / viewport->getViewHeight() * float (chanRange)) + float (chanRange / 2));
         }
     }
 

Plugins/LfpViewer/LfpDisplay.h

@@ -92,6 +92,9 @@ class LfpDisplay : public Component,
     /** Sets the display range for a particular channel type*/
     void setRange (float range, ContinuousChannel::Type type);
 
+    /** Applies auto-scaling to AUX channels based on their individual InputRange values */
+    void setAutoRangeForAuxChannels();
+
     /** Returns the display range for the current channel type*/
     int getRange();
 

Plugins/LfpViewer/LfpDisplayCanvas.cpp

@@ -30,6 +30,8 @@
 #include "ShowHideOptionsButton.h"
 
 #include <math.h>
+#include <algorithm>
+#include <cmath>
 
 #define MS_FROM_START Time::highResolutionTicksToSeconds (Time::getHighResolutionTicks() - start) * 1000
 
@@ -750,6 +752,27 @@ String LfpDisplaySplitter::getStreamKey()
     return stream->getKey();
 }
 
+void LfpDisplaySplitter::refreshLeftMargin()
+{
+    int newMargin = minimumLeftMargin;
+
+    if (displayBuffer != nullptr)
+    {
+        const auto labelFont = Font (FontOptions (14.0f));
+        constexpr int padding = 20;
+
+        for (int i = 0; i < displayBuffer->channelMetadata.size(); ++i)
+        {
+            const auto& metadata = displayBuffer->channelMetadata.getReference (i);
+            const float textWidth = labelFont.getStringWidthFloat (metadata.name);
+            const int requiredWidth = static_cast<int> (std::ceil (textWidth)) + padding;
+            newMargin = std::max (newMargin, requiredWidth);
+        }
+    }
+
+    leftmargin = newMargin;
+}
+
 void LfpDisplaySplitter::resized()
 {
     const int timescaleHeight = 30;
@@ -928,6 +951,7 @@ void LfpDisplaySplitter::updateSettings()
         sampleRate = 44100.0f;
 
         options->setEnabled (true);
+        leftmargin = minimumLeftMargin;
     }
     else
     {
@@ -942,6 +966,8 @@ void LfpDisplaySplitter::updateSettings()
 
         options->setEnabled (true);
         channelOverlapFactor = options->selectedOverlapValue.getFloatValue();
+
+        refreshLeftMargin();
     }
 
     if (eventDisplayBuffer == nullptr) // not yet initialized
@@ -968,12 +994,14 @@ void LfpDisplaySplitter::updateSettings()
         lfpDisplay->channels[i]->setDepth (displayBuffer->channelMetadata[i].ypos);
         lfpDisplay->channels[i]->setRecorded (displayBuffer->channelMetadata[i].isRecorded);
         lfpDisplay->channels[i]->updateType (displayBuffer->channelMetadata[i].type);
+        lfpDisplay->channels[i]->setUnits (displayBuffer->channelMetadata[i].units);
 
         lfpDisplay->channelInfo[i]->setName (displayBuffer->channelMetadata[i].name);
         lfpDisplay->channelInfo[i]->setGroup (displayBuffer->channelMetadata[i].group);
         lfpDisplay->channelInfo[i]->setDepth (displayBuffer->channelMetadata[i].ypos);
         lfpDisplay->channelInfo[i]->setRecorded (displayBuffer->channelMetadata[i].isRecorded);
         lfpDisplay->channelInfo[i]->updateType (displayBuffer->channelMetadata[i].type);
+        lfpDisplay->channelInfo[i]->setUnits (displayBuffer->channelMetadata[i].units);
 
         lfpDisplay->updateRange (i);
 

Plugins/LfpViewer/LfpDisplayCanvas.h

@@ -308,8 +308,11 @@ class LfpDisplaySplitter : public Component,
      */
     bool fullredraw;
 
-    /** Left margin for lfp plots (so the ch number text doesnt overlap) */
-    static const int leftmargin = 60; //
+    /** Minimum left margin for LFP plots (so the channel label has space) */
+    static constexpr int minimumLeftMargin = 60;
+
+    /** Left margin for LFP plots, adjusted to fit the widest channel label */
+    int leftmargin = minimumLeftMargin;
 
     Array<bool> isChannelEnabled;
 
@@ -359,6 +362,8 @@ class LfpDisplaySplitter : public Component,
     String getStreamKey();
 
 private:
+    void refreshLeftMargin();
+
     bool isSelected;
     bool isUpdating;