ConstellationWaveform.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopehal                                                                                                          *
*                                                                                                                      *
* 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 ConstellationWaveform_h
#define ConstellationWaveform_h
 
#include "DensityFunctionWaveform.h"
#include "EyeWaveform.h"
 
class ConstellationWaveform : public DensityFunctionWaveform
{
public:
 
    ConstellationWaveform(size_t width, size_t height);
    virtual ~ConstellationWaveform();
 
    //not copyable or assignable
    ConstellationWaveform(const ConstellationWaveform&) =delete;
    ConstellationWaveform& operator=(const ConstellationWaveform&) =delete;
 
    int64_t* GetAccumData()
    { return m_accumdata.GetCpuPointer(); }
 
    AcceleratorBuffer<int64_t>& GetAccumBuffer()
    { return m_accumdata; }
 
    void Normalize();
 
    void Normalize(
        vk::raii::CommandBuffer& cmdBuf,
        std::shared_ptr<ComputePipeline> normalizeReducePipe,
        std::shared_ptr<ComputePipeline> normalizeScalePipe,
        AcceleratorBuffer<int64_t>& nmaxBuf
        );
 
    size_t GetTotalSymbols()
    { return m_totalSymbols; }
 
    void IntegrateSymbols(size_t symbols)
    { m_totalSymbols += symbols; }
 
    float m_saturationLevel;
 
    virtual void FreeGpuMemory() override
    { m_accumdata.FreeGpuBuffer(); }
 
    virtual bool HasGpuBuffer() override
    { return m_accumdata.HasGpuBuffer(); }
 
    virtual void PrepareForCpuAccessNonblocking(vk::raii::CommandBuffer& cmdBuf) override
    {
        m_outdata.PrepareForCpuAccessNonblocking(cmdBuf);
        m_accumdata.PrepareForCpuAccessNonblocking(cmdBuf);
    }
 
    virtual void PrepareForCpuAccess() override
    {
        m_outdata.PrepareForCpuAccess();
        m_accumdata.PrepareForCpuAccess();
    }
 
    virtual void PrepareForGpuAccess() override
    {
        m_outdata.PrepareForGpuAccess();
        m_accumdata.PrepareForGpuAccess();
    }
 
    virtual void MarkSamplesModifiedFromCpu() override
    {
        m_outdata.MarkModifiedFromCpu();
        m_accumdata.MarkModifiedFromCpu();
    }
 
    virtual void MarkSamplesModifiedFromGpu() override
    {
        m_outdata.MarkModifiedFromGpu();
        m_accumdata.MarkModifiedFromGpu();
    }
 
    virtual void MarkModifiedFromCpu() override
    {
        m_outdata.MarkModifiedFromCpu();
        m_accumdata.MarkModifiedFromCpu();
    }
 
    virtual void MarkModifiedFromGpu() override
    {
        m_outdata.MarkModifiedFromGpu();
        m_accumdata.MarkModifiedFromGpu();
    }
 
protected:
 
    AcceleratorBuffer<int64_t> m_accumdata;
 
    size_t m_totalSymbols;
};
 
#endif