Pixel.hpp

Go to the documentation of this file.

 
 
#pragma once
 
#include <iostream>
#include <string>
 
#include "NumCpp/Core/Internal/StaticAsserts.hpp"
#include "NumCpp/Core/Types.hpp"
#include "NumCpp/Utils/essentiallyEqual.hpp"
#include "NumCpp/Utils/num2str.hpp"
 
namespace nc::imageProcessing
{
    //================================================================================
    // Class Description:
    template<typename dtype>
    class Pixel
    {
    private:
        STATIC_ASSERT_ARITHMETIC(dtype);
 
    public:
        //==================================Attributes================================
        mutable int32 clusterId{ -1 };
        uint32        row{ 0 };
        uint32        col{ 0 };
        dtype         intensity{ 0 };
 
        //=============================================================================
        // Description:
        constexpr Pixel() = default;
 
        //=============================================================================
        // Description:
        constexpr Pixel(uint32 inRow, uint32 inCol, dtype inIntensity) noexcept :
            row(inRow),
            col(inCol),
            intensity(inIntensity)
        {
        }
 
        //=============================================================================
        // Description:
        constexpr bool operator==(const Pixel<dtype>& rhs) const noexcept
        {
            return utils::essentiallyEqual(row, rhs.row) && utils::essentiallyEqual(col, rhs.col) &&
                   utils::essentiallyEqual(intensity, rhs.intensity);
        }
 
        //=============================================================================
        // Description:
        constexpr bool operator!=(const Pixel<dtype>& rhs) const noexcept
        {
            return !(*this == rhs);
        }
 
        //=============================================================================
        // Description:
        bool operator<(const Pixel<dtype>& rhs) const noexcept
        {
            if (row < rhs.row)
            {
                return true;
            }
            if (row == rhs.row)
            {
                return static_cast<bool>(col < rhs.col);
            }
 
            return false;
        }
 
        //=============================================================================
        // Description:
        [[nodiscard]] std::string str() const
        {
            std::string out = "row = " + utils::num2str(row) + " col = " + utils::num2str(col);
            out += " intensity = " + utils::num2str(intensity) + '\n';
            return out;
        }
 
        //============================================================================
        void print() const
        {
            std::cout << *this;
        }
 
        //=============================================================================
        // Description:
        friend std::ostream& operator<<(std::ostream& inStream, const Pixel<dtype>& inPixel)
        {
            inStream << inPixel.str();
            return inStream;
        }
    };
} // namespace nc::imageProcessing