ProfileExtractionParameters.h

#pragma once
#include "Parameter.h"
 
namespace mmind {
namespace eye {
namespace profile_extraction {
 
class MinGrayscaleValue
{
public:
    static constexpr const char* name = "MinGrayscaleValue";
 
    static constexpr const char* description =
        "Set the minimum grayscale value of the valid pixels in the raw image. Pixels with "
        "grayscale values smaller than this value will not participate in profile "
        "extraction.\n\nNote: \n* The minimum value of \"Min Grayscale Value\" is affected by "
        "\"Digital Gain\". \n* \"Min Grayscale Value\" affects the minimum value of \"Min Spot "
        "Intensity\" and \"Max Spot Intensity\".";
 
    static constexpr Parameter::Type type = Parameter::Type::_Int;
};
 
class MinSpotIntensity
{
public:
    static constexpr const char* name = "MinSpotIntensity";
 
    static constexpr const char* description =
        "Set the minimum intensity for the spots. Spots with intensity values smaller than this "
        "value will be excluded. The intensity of a spot is the average grayscale value of all the "
        "valid pixels in the pixel column of the laser line.\nThe spots of laser lines produced by "
        "stray light or interreflection usually have low intensities. Setting an appropriate "
        "minimum intensity can remove these spots.\n\nNote: The minimum value of \"Min Spot "
        "Intensity\" is affected by \"Min Grayscale Value\".";
 
    static constexpr Parameter::Type type = Parameter::Type::_Int;
};
 
class MaxSpotIntensity
{
public:
    static constexpr const char* name = "MaxSpotIntensity";
 
    static constexpr const char* description =
        "Set the maximum intensity for the spots. Spots with intensity values greater than this "
        "value will be excluded. The intensity of a spot is the average grayscale value of all the "
        "valid pixels in the pixel column of the laser line.\nSetting an appropriate maximum "
        "intensity can remove abnormally bright spots produced by specular reflection.\n\nNote: "
        "The minimum value of \"Max Spot Intensity\" is affected by \"Min Grayscale Value\".";
 
    static constexpr Parameter::Type type = Parameter::Type::_Int;
};
 
class MinLaserLineWidth
{
public:
    static constexpr const char* name = "MinLaserLineWidth";
 
    static constexpr const char* description =
        "Set the minimum width for the laser lines. If the width of a pixel column in a laser line "
        "is smaller than this value, the spot of this pixel column in this laser line is "
        "excluded.\nLaser line width is a property of each pixel column in a laser line. It is "
        "equal to the number of valid pixels in such a pixel column.\nSetting appropriate minimum "
        "and maximum widths can exclude the laser lines produced by stray light or "
        "interreflection, which are usually too wide or too narrow.";
 
    static constexpr Parameter::Type type = Parameter::Type::_Int;
};
 
class MaxLaserLineWidth
{
public:
    static constexpr const char* name = "MaxLaserLineWidth";
 
    static constexpr const char* description =
        "Set the maximum width for the laser lines. If the width of a pixel column in a laser line "
        "is greater than this value, the spot of this pixel column in this laser line is "
        "excluded.\nLaser line width is a property of each pixel column in a laser line. It is "
        "equal to the number of valid pixels in such a pixel column.\nSetting appropriate minimum "
        "and maximum widths can exclude the laser lines produced by stray light or "
        "interreflection, which are usually too wide or too narrow.";
 
    static constexpr Parameter::Type type = Parameter::Type::_Int;
};
 
class SpotSelection
{
public:
    static constexpr const char* name = "SpotSelection";
 
    static constexpr const char* description =
        "If a pixel column contains multiple spots, the final spot is selected according to the "
        "value of this parameter.\nStrongest: selects the spot with the highest "
        "intensity as the final spot.\nNearest: selects the spot with the smallest Z value as the "
        "final spot.\nFarthest: selects the spot with the greatest Z value as the final spot.\n"
        "Invalid: regards the pixel column as invalid and discards the spots. The profile "
        "therefore has a gap. Usually used for complex situations where selection is difficult to "
        "make.";
 
    static constexpr Parameter::Type type = Parameter::Type::_Enum;
 
    enum struct Value {
        Strongest,
        Nearest,
        Farthest,
        Invalid,
    };
};
 
} // namespace profile_extraction
} // namespace eye
} // namespace mmind