Class Displayer

Base class used to display images queried from each camera. More...

#include <display.h>

Inherits the following classes: QObject

Inherited by the following classes: DisplayerFunctional

Public Attributes

Type	Name
QString	m_cameraType Stores the type or model of the camera currently used.

Public Slots

Type	Name
slot void	Display (XI_IMG & image) Qt slot in charge of displaying images.

Public Signals

Type	Name
signal void	ImageReadyToUpdateRGB (QImage) Qt signal emitted when an RGB image is ready to be displayed in the UI.
signal void	ImageReadyToUpdateRaw (QImage) Qt signal emitted when a raw image is ready to be displayed in the UI.
signal void	SaturationPercentageReady (double undersaturation, double oversaturation) Qt signal emitted when the saturation values are ready to be displayed in the UI.

Public Functions

Type	Name
	Displayer (QObject * parent=nullptr)
virtual void	SetCameraProperties (QString cameraModel) = 0 Configures the camera properties based on the provided camera model.
void	StartDisplayer () Allows to start or continue displaying images.
void	StopDisplayer () Blocks the display of images.
virtual void	UpdateBGRChannels (const std::vector< int > & bgrChannels) Updates the BGR channel values for the displayer.
virtual void	UpdateLut (int minValue, int maxValue, const QColor & darkColor, const QColor & saturatedColor) Updates the lookup table (LUT) with the specified minimum and maximum values.
	~Displayer () override

Protected Attributes

Type	Name
QColor	m_darkColor The color used to highlight underexposed regions of the image.
boost::condition_variable	m_displayCondition Condition variable used to wait until a new image is available to be processed.
QColor	m_saturatedColor
bool	m_stop = `false` Indicate that process should stop displaying images.

Detailed Description

This class implements several Qt signals that are triggered when new images are ready to be displayed. For example, RGB, raw, and saturation percentages for each image.

Whether images are to be displayed or not are also controlled through the variable Displayer::m_stop.

Public Attributes Documentation

variable m_cameraType

Stores the type or model of the camera currently used.

QString Displayer::m_cameraType;

Public Slots Documentation

slot Display

Qt slot in charge of displaying images.

virtual void Displayer::Display;

Parameters:

image

Public Signals Documentation

signal ImageReadyToUpdateRGB

Qt signal emitted when an RGB image is ready to be displayed in the UI.

void Displayer::ImageReadyToUpdateRGB;

signal ImageReadyToUpdateRaw

Qt signal emitted when a raw image is ready to be displayed in the UI.

void Displayer::ImageReadyToUpdateRaw;

signal SaturationPercentageReady

Qt signal emitted when the saturation values are ready to be displayed in the UI.

void Displayer::SaturationPercentageReady;

Public Functions Documentation

function Displayer

explicit Displayer::Displayer (
    QObject * parent=nullptr
)

function SetCameraProperties

Configures the camera properties based on the provided camera model.

virtual void Displayer::SetCameraProperties (
    QString cameraModel
) = 0

This pure virtual method must be implemented by derived classes to initialize or modify display-related behaviors or settings according to the specified camera model.

Parameters:

cameraModel A string representing the model of the camera, used

function StartDisplayer

Allows to start or continue displaying images.

void Displayer::StartDisplayer ()

function StopDisplayer

Blocks the display of images.

void Displayer::StopDisplayer ()

function UpdateBGRChannels

Updates the BGR channel values for the displayer.

virtual void Displayer::UpdateBGRChannels (
    const std::vector< int > & bgrChannels
)

This method is used to set the values of the Blue, Green, and Red channels for processing or rendering purposes. The values provided in the input parameter define the specific intensities or configurations for each channel.

Parameters:

bgrChannels A vector containing the values for the Blue, Green, and Red channels, typically in the order [Blue, Green, Red].

function UpdateLut

Updates the lookup table (LUT) with the specified minimum and maximum values.

virtual void Displayer::UpdateLut (
    int minValue,
    int maxValue,
    const QColor & darkColor,
    const QColor & saturatedColor
)

This method adjusts the LUT range to enhance or modify the image display settings based on the given values. It allows flexibility in defining the lower and upper bounds of the LUT.

Parameters:

minValue The minimum value for the LUT.
maxValue The maximum value for the LUT.
darkColor The color used to highlight underexposed regions in an image.
saturatedColor The color used to highlight overexposed regions in an image.

function ~Displayer

Displayer::~Displayer () override

Protected Attributes Documentation

variable m_darkColor

The color used to highlight underexposed regions of the image.

QColor Displayer::m_darkColor;

variable m_displayCondition

Condition variable used to wait until a new image is available to be processed.

boost::condition_variable Displayer::m_displayCondition;

variable m_saturatedColor

QColor Displayer::m_saturatedColor;

The color used to highlight overexposed regions of the image.

variable m_stop

Indicate that process should stop displaying images.

bool Displayer::m_stop;

The documentation for this class was generated from the following file src/display.h