quantumgaussianblur.h

Go to the documentation of this file.

/**
 * @file quantumgaussianblur.h
 * @brief Declares the quantumgaussianblur visualization component used by QPE.
 * @ingroup qpe_graphics
 *
 * Source: @c graphics/renderer/quantumgaussianblur.h. This file is part of Quantum Phenomena Explorer (QPE),
 * maintained by Officina Turini. See LICENSE_IT.txt / LICENSE.txt for the
 * QPE freeware source-available terms and THIRD_PARTY_NOTICES.txt for
 * third-party components.
 */
 
#pragma once
 
namespace qpe {
 
// Display-only Gaussian blur kernel helper mirrored by the GPU shader.
// The shader uses a bilinear-sampling optimized 5-fetch separable kernel.
/**
 * @brief Implements the Quantum Gaussian Blur component.
 *
 * The class provides one focused service within the QPE architecture and is documented here independently of the experiment-level Help.
 */
class QuantumGaussianBlur
{
public:
    /**
     * @brief Performs center weight.
     */
    static float centerWeight();
    /**
     * @brief Performs inner pair weight.
     */
    static float innerPairWeight();
    /**
     * @brief Performs outer pair weight.
     */
    static float outerPairWeight();
    /**
     * @brief Performs inner offset.
     */
    static float innerOffset();
    /**
     * @brief Performs outer offset.
     */
    static float outerOffset();
 
    /**
     * @brief Returns normalized spread.
     * @param spread The spread value used by the operation.
     */
    static float normalizedSpread(float spread);
    /**
     * @brief Performs total weight.
     */
    static float totalWeight();
};
 
} // namespace qpe