HistogramFilter.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopeprotocols                                                                                                    *
*                                                                                                                      *
* Copyright (c) 2012-2026 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the       *
*      following disclaimer in the documentation and/or other materials provided with the distribution.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   *
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES        *
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR       *
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE       *
* POSSIBILITY OF SUCH DAMAGE.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/
 
#ifndef HistogramFilter_h
#define HistogramFilter_h
 
class HistogramFilter : public Filter
{
public:
    HistogramFilter(const std::string& color);
 
    virtual void Refresh(vk::raii::CommandBuffer& cmdBuf, std::shared_ptr<QueueHandle> queue) override;
 
    static std::string GetProtocolName();
    virtual void SetDefaultName() override;
 
    virtual float GetVoltageRange(size_t stream) override;
    virtual void SetVoltageRange(float range, size_t stream) override;
 
    virtual float GetOffset(size_t stream) override;
    virtual void SetOffset(float offset, size_t stream) override;
 
    virtual void ClearSweeps() override;
 
    PROTOCOL_DECODER_INITPROC(HistogramFilter)
 
protected:
    FilterParameter& m_autorange;
    FilterParameter& m_pmin;
    FilterParameter& m_pmax;
    FilterParameter& m_binSize;
 
    float m_midpoint;
    float m_range;
 
    float m_min;
    float m_max;
 
    std::vector<size_t> m_histogram;
 
    //Minmax calculation for bounds
    ComputePipeline m_minmaxPipeline;
    AcceleratorBuffer<float> m_minbuf;
    AcceleratorBuffer<float> m_maxbuf;
 
    //Histogram calculation
    std::shared_ptr<ComputePipeline> m_histogramPipeline;
    AcceleratorBuffer<uint64_t> m_histogramBuf;
};
 
#endif