EyeMask.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopehal                                                                                                    *
*                                                                                                                      *
* Copyright (c) 2012-2024 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 EyeMask_h
#define EyeMask_h
 
#include "../canvas_ity/src/canvas_ity.hpp"
 
class EyeDecoder2;
class EyeWaveform;
 
class EyeMaskPoint
{
public:
 
    EyeMaskPoint()
        : m_time(0)
        , m_voltage(0)
    {}
 
    EyeMaskPoint(float t, float v)
    : m_time(t)
    , m_voltage(v)
    {}
 
    float m_time;
 
    float m_voltage;
};
 
class EyeMaskPolygon
{
public:
 
    std::vector<EyeMaskPoint> m_points;
};
 
class EyeMask
{
 
public:
    EyeMask();
    virtual ~EyeMask();
 
    bool Load(std::string path);
    bool Load(const YAML::Node& node);
 
    std::string GetFileName() const
    { return m_fname; }
 
    std::string GetMaskName() const
    { return m_maskname; }
 
    float GetAllowedHitRate() const
    { return m_hitrate; }
 
    void RenderForAnalysis(
        EyeWaveform* waveform,
        float xscale,
        float xoff,
        float yscale,
        float yoff,
        float height) const;
 
    float CalculateHitRate(
        EyeWaveform* cap,
        size_t width,
        size_t height,
        float fullscalerange,
        float xscale,
        float xoff);
 
    bool empty() const
    { return m_polygons.empty(); }
 
    bool IsTimebaseRelative()
    { return m_timebaseIsRelative; }
 
    const std::vector<EyeMaskPolygon>& GetPolygons() const
    { return m_polygons; }
 
    size_t GetWidth()
    { return m_width; }
 
    size_t GetHeight()
    { return m_height; }
 
    //Helpers for unit testing
public:
 
    void GetPixels(std::vector<uint8_t>& pixels)
    {
        pixels.resize(m_width * m_height * 4);
        m_canvas->get_image_data(pixels.data(), m_width, m_height, m_width*4, 0,0);
    }
 
protected:
 
    std::string m_fname;
 
    std::vector<EyeMaskPolygon> m_polygons;
 
    float m_hitrate;
 
    bool m_timebaseIsRelative;
 
    std::string m_maskname;
 
    std::unique_ptr< canvas_ity::canvas > m_canvas;
 
    size_t m_width;
 
    size_t m_height;
};
 
#endif