Add subprocessor channel filtering by sample rate to LfpDisplayEditor

Author: kmichaelfox

Source/Plugins/LfpDisplayNodeAlpha/LfpDisplayCanvas.cpp

@@ -222,7 +222,9 @@ void LfpDisplayCanvas::update()
 			}
 		}
 		else
+        {
 			sampleRate.add(30000);
+        }
 
        // std::cout << "Sample rate for ch " << i << " = " << sampleRate[i] << std::endl; 
         displayBufferIndex.add(0);
@@ -264,6 +266,8 @@ void LfpDisplayCanvas::update()
         }
 
     }
+    
+    lfpDisplay->rebuildDrawableChannelsList();
 
 }
 
@@ -564,10 +568,15 @@ bool LfpDisplayCanvas::getDrawMethodState()
 
 int LfpDisplayCanvas::getChannelSampleRate(int channel)
 {
-    // TODO: (kelly) should this do a range check?
     return sampleRate[channel];
 }
 
+void LfpDisplayCanvas::setDrawableSampleRate(float samplerate)
+{
+    std::cout << "setting the drawable sample rate in the canvas" << std::endl;
+    lfpDisplay->setDisplayedSampleRate(samplerate);
+}
+
 void LfpDisplayCanvas::redraw()
 {
     fullredraw=true;
@@ -1947,9 +1956,6 @@ void LfpDisplay::setNumChannels(int numChannels)
         //lfpInfo->setColour(channelColours[i % channelColours.size()]);
         lfpInfo->setRange(range[options->getChannelType(i)]);
         lfpInfo->setChannelHeight(canvas->getChannelHeight());
-        
-        // TODO: (kelly) this won't work... samplerate gets set AFTER this method is called
-        lfpInfo->setChannelSampleRate(canvas->getChannelSampleRate(i));
 
         addAndMakeVisible(lfpInfo);
 
@@ -1992,35 +1998,7 @@ int LfpDisplay::getTotalHeight()
 
 void LfpDisplay::resized()
 {
-    
-    //canvas->channelOverlapFactor
-
     int totalHeight = 0;
-
-//    for (int i = 0; i < channels.size(); i++)
-//    {
-//
-//        LfpChannelDisplay* disp = channels[i];
-//        
-//        if (disp->getHidden()) continue;
-//
-//        disp->setBounds(canvas->leftmargin,
-//                        totalHeight-(disp->getChannelOverlap()*canvas->channelOverlapFactor)/2,
-//                        getWidth(),
-//                        disp->getChannelHeight()+(disp->getChannelOverlap()*canvas->channelOverlapFactor));
-//
-//        disp-> resized();
-//        
-//        LfpChannelDisplayInfo* info = channelInfo[i];
-//
-//        info->setBounds(0,
-//                        totalHeight-disp->getChannelHeight()/4,
-//                        canvas->leftmargin + 50,
-//                        disp->getChannelHeight());
-//
-//        totalHeight += disp->getChannelHeight();
-//
-//    }
 
     for (int i = 0; i < drawableChannels.size(); i++)
     {
@@ -2189,6 +2167,7 @@ int LfpDisplay::getRange(DataChannel::DataChannelTypes type)
 
 void LfpDisplay::setChannelHeight(int r, bool resetSingle)
 {
+    std::cout << "setting channel height in LfpDisplay" << std::endl;
     if (!getSingleChannelState()) cachedDisplayChannelHeight = r;
 
     for (int i = 0; i < numChans; i++)
@@ -2258,6 +2237,18 @@ void LfpDisplay::cacheNewChannelHeight(int r)
     cachedDisplayChannelHeight = r;
 }
 
+float LfpDisplay::getDisplayedSampleRate()
+{
+    return drawableSampleRate;
+}
+
+// Must manually call rebuildDrawableChannelsList after this is set, typically will happen
+// already as a result of some other procedure
+void LfpDisplay::setDisplayedSampleRate(float samplerate)
+{
+    std::cout << "Setting the displayed samplerate for LfpDisplayCanvas to " << samplerate << std::endl;
+    drawableSampleRate = samplerate;
+}
 
 bool LfpDisplay::getChannelsReversed()
 {
@@ -2266,8 +2257,6 @@ bool LfpDisplay::getChannelsReversed()
 
 void LfpDisplay::setChannelsReversed(bool state)
 {
-    // TODO: (kelly) clean up this method
-    
     if (state == channelsReversed) return; // bail early, in case bookkeeping error
 
     channelsReversed = state;
@@ -2288,7 +2277,6 @@ void LfpDisplay::setChannelsReversed(bool state)
 
         // swap front and back, moving towards middle
         drawableChannels.swap(i, j);
-//        channelInfo.swap(i, j);
 
         // also swap coords
         {
@@ -2448,45 +2436,21 @@ void LfpDisplay::mouseWheelMove(const MouseEvent&  e, const MouseWheelDetails&
 
 void LfpDisplay::toggleSingleChannel(int chan)
 {
-    //std::cout << "Toggle channel " << chan << std::endl;
-
-    
-    //if (chan != singleChan)
     if (!getSingleChannelState())
     {
-//        std::cout << "Single channel on" << std::endl;
-//        singleChan = chan;
-//
-//        int newHeight = viewport->getHeight();
-//		channelInfo[chan]->setEnabledState(true);
-//        channelInfo[chan]->setSingleChannelState(true);
-//        setChannelHeight(newHeight, false);
-//        setSize(getWidth(), numChans*getChannelHeight());
-//
-//        viewport->setScrollBarsShown(false,false);
-//        viewport->setViewPosition(Point<int>(0,chan*newHeight));
-//
-//        for (int i = 0; i < channels.size(); i++)
-//        {
-//            if (i != chan)
-//                channels[i]->setEnabledState(false);
-//        }
 
         std::cout << "Single channel on (" << chan << ")" << std::endl;
         singleChan = chan;
 
         int newHeight = viewport->getHeight();
         LfpChannelTrack lfpChannelTrack{drawableChannels[chan].channel, drawableChannels[chan].channelInfo};
-//        drawableChannels[chan].channelInfo->setEnabledState(true);
-//        drawableChannels[chan].channelInfo->setSingleChannelState(true);
         lfpChannelTrack.channelInfo->setEnabledState(true);
         lfpChannelTrack.channelInfo->setSingleChannelState(true);
         setChannelHeight(newHeight, false);
         setSize(getWidth(), numChans*getChannelHeight());
 
         viewport->setScrollBarsShown(false, false);
         viewport->setViewPosition(Point<int>(0, chan*newHeight));
-//        viewport->setViewPosition(Point<int>(0, 0));
 
         // disable unused channels
         for (int i = 0; i < drawableChannels.size(); i++)
@@ -2512,7 +2476,7 @@ void LfpDisplay::toggleSingleChannel(int chan)
         {
             channelInfo[n]->setSingleChannelState(false);
         }
-        //drawableChannels[0].channelInfo->setSingleChannelState(false);
+        
         setChannelHeight(cachedDisplayChannelHeight);
 
         reactivateChannels();
@@ -2536,10 +2500,17 @@ void LfpDisplay::rebuildDrawableChannelsList()
     Array<LfpChannelTrack> channelsToDraw;
     drawableChannels = Array<LfpDisplay::LfpChannelTrack>();
 
-    
     // iterate over all channels and select drawable ones
     for (size_t i = 0; i < channels.size(); i++)
     {
+        // if channel[i] is not the right samplerate, hide it and continue
+        if (canvas->getChannelSampleRate(i) != getDisplayedSampleRate())
+        {
+            channels[i]->setHidden(true);
+            channelInfo[i]->setHidden(true);
+            continue;
+        }
+        
         if (displaySkipAmt == 0) // no skips, add all channels
         {
             channels[i]->setHidden(false);
@@ -2595,7 +2566,12 @@ void LfpDisplay::rebuildDrawableChannelsList()
         }
     }
 
-    canvas->resizeToChannels();
+    // this guards against an exception where the editor sets the drawable samplerate
+    // before the lfpDisplay is fully initialized
+    if (getHeight() > 0 && getWidth() > 0)
+    {
+        canvas->resizeToChannels();
+    }
 }
 
 LfpBitmapPlotter * const LfpDisplay::getPlotterPtr() const

Source/Plugins/LfpDisplayNodeAlpha/LfpDisplayCanvas.h

@@ -96,13 +96,17 @@ class LfpDisplayCanvas : public Visualizer,
     float histogramParameterA;
     float histogramParameterB;
 
+    /** Returns the number of both continuous and event channels tracked by the canvas */
     int getNumChannels();
     /** Returns the number of channels NOT hidden for display */
     int getNumChannelsVisible();
     bool getInputInvertedState();
     bool getDrawMethodState();
 
     int getChannelSampleRate(int channel);
+    
+    /** Delegates a samplerate for drawing to the LfpDisplay referenced by this canvas */
+    void setDrawableSampleRate(float samplerate);
 
     const float getXCoord(int chan, int samp);
     const float getYCoord(int chan, int samp);
@@ -137,7 +141,7 @@ class LfpDisplayCanvas : public Visualizer,
     bool  drawSaturationWarning; // optionally raise hell if the actual data is saturating
 
     int nChans;
-    int nChansVisible; // the number of channels NOT hidden for display
+    //int nChansVisible; // the number of channels NOT hidden for display
 
     float timebase;
 
@@ -450,6 +454,19 @@ class LfpDisplay : public Component
     void setChannelHeight(int r, bool resetSingle = true);
     int getChannelHeight();
 
+    /** Returns the sample rate that is currently filtering the drawable channels */
+    float getDisplayedSampleRate();
+    
+    /** Sets the samplerate that displayed channels must be set to. No channels with
+        differing samplerates will be drawn to screen.
+     
+        This function does not automatically repopulate the drawableChannels list, so
+        rebuildDrawableChannelsList must be called before the screen is updated.
+     
+        @see LfpDisplayCanvas::setDrawableSampleRate, LfpDisplayNode::updateSettings
+     */
+    void setDisplayedSampleRate(float samplerate);
+    
     /** Caches a new channel height without updating the channels */
     void cacheNewChannelHeight(int r);
 
@@ -556,6 +573,7 @@ class LfpDisplay : public Component
     int numChans;
     int displaySkipAmt;
     int cachedDisplayChannelHeight;     // holds a channel height if reset during single channel focus
+    float drawableSampleRate;
 
     int totalHeight;
 

Source/Plugins/LfpDisplayNodeAlpha/LfpDisplayEditor.cpp

@@ -30,24 +30,53 @@ LfpDisplayEditor::LfpDisplayEditor(GenericProcessor* parentNode, bool useDefault
     : VisualizerEditor(parentNode, useDefaultParameterEditors)
 
 {
-
+    lfpProcessor = (LfpDisplayNode*) parentNode;
     tabText = "LFP";
 
     desiredWidth = 180;
-
+    
+    subprocessorSelectionLabel = new Label("Display subprocessor sample rate", "Display Subproc. Sample Rate");
+    subprocessorSelectionLabel->setBounds(10, 25, 140, 20);
+    addAndMakeVisible(subprocessorSelectionLabel);
+    
+    subprocessorSelection = new ComboBox("Subprocessor sample rate");
+    subprocessorSelection->setBounds(subprocessorSelectionLabel->getX()+5, subprocessorSelectionLabel->getBottom(), 60, 22);
+    subprocessorSelection->addListener(this);
+    addAndMakeVisible(subprocessorSelection);
 }
 
 LfpDisplayEditor::~LfpDisplayEditor()
 {
 }
 
-
 Visualizer* LfpDisplayEditor::createNewCanvas()
 {
+    canvas = new LfpDisplayCanvas(lfpProcessor);
+    updateSubprocessorSelectorOptions();
+    return canvas;
+}
 
-    LfpDisplayNode* processor = (LfpDisplayNode*) getProcessor();
-    return new LfpDisplayCanvas(processor);
-
+void LfpDisplayEditor::buttonClicked(Button *button)
+{
+    // duplicate default VisualizerEditor behavior, except...
+    if (canvas == nullptr)
+    {
+        canvas = createNewCanvas();
+        
+        // initialize the subprocessor sample rate filtering before canvas updates
+        // (else) initialization errors. lots of time-critical cross dependencies here,
+        // should be cleaned up
+        updateSubprocessorSelectorOptions();
+        ((LfpDisplayCanvas*)canvas.get())->setDrawableSampleRate(*(inputSampleRates.begin() + (subprocessorSelection->getSelectedId() - 1)));
+        
+        canvas->update();
+        
+        if (isPlaying)
+            canvas->beginAnimation();
+    }
+    
+    // resume default behavior
+    VisualizerEditor::buttonClicked(button);
 }
 
 // not really being used (yet)...
@@ -57,3 +86,54 @@ void LfpDisplayEditor::buttonEvent(Button* button)
 
 }
 
+void LfpDisplayEditor::comboBoxChanged(juce::ComboBox *cb)
+{
+    if (cb == subprocessorSelection)
+    {
+        setCanvasDrawableSampleRate(cb->getSelectedId() - 1);
+    }
+}
+
+void LfpDisplayEditor::updateSubprocessorSelectorOptions()
+{
+    // clear out the old data
+    inputSampleRates.clear();
+    subprocessorSelection->clear(dontSendNotification);
+    
+    // get a list of all the sample rates
+    for (int i = 0, len = lfpProcessor->getNumInputs(); i < len; ++i)
+    {
+        float samplerate = lfpProcessor->getDataChannel(i)->getSampleRate();
+        bool success = inputSampleRates.add(samplerate);
+        
+//        if (success) std::cout << "\t\tadding sample rate " << samplerate << " ... size = " << inputSampleRates.size() << std::endl;
+    }
+    
+    // if the source changes, default to first samplerate given
+    int sampleRateToSet = -1;
+    if (inputSampleRates.size() > 0)
+    {
+        sampleRateToSet = 0;
+    }
+    
+    // add the samplerate options to the combobox
+    for (int i = 0; i < inputSampleRates.size(); ++i)
+    {
+        subprocessorSelection->addItem(String(*(inputSampleRates.begin()+i)), i+1);
+    }
+    
+    if (sampleRateToSet >= 0)
+    {
+        setCanvasDrawableSampleRate(sampleRateToSet);
+    }
+}
+
+void LfpDisplayEditor::setCanvasDrawableSampleRate(int index)
+{
+    if (canvas)
+    {
+        std::cout << "selected index = " << index << std::endl;
+        ((LfpDisplayCanvas*)canvas.get())->setDrawableSampleRate(*(inputSampleRates.begin() + (index)));
+    }
+}
+