Класс для создания объектов-гистограмм, на которые можно выводить различную информацию Подробнее...

#include <histogram.h>

Граф наследования:Histogram:

Открытые члены
	Histogram (int width, int height, int x_limit, int id, std::vector< double > &x_values, std::vector< float > &y_values)
	Конструктор этого класса Подробнее...

	~Histogram ()
	Деструктор этого класса Подробнее...

void	DetectEvent (int event, int x, int y, int flags)
	callback функция для определения события (используется для хэндлинга клика мышью) Подробнее...

void	ShowHistogram ()
	Выводит гистограмму в окно гистограммы Подробнее...

void	SetXValues (std::vector< double > x_values)
	Устанавливает X-ы Подробнее...

void	SetYValues (std::vector< float > y_values)
	Устанавливает Y-ы Подробнее...

void	SetHistogramFlag (bool flag)
	Устанавливает статус флага отрисовки гистограммы Подробнее...

void	SetHistogramWindowProperty (int prop_id, int prop_value)
	Обновляет статус окна гистограммы (например, для вывода на передний план) Подробнее...

Открытые статические члены
static void	OnMouse (int event, int x, int y, int flags, void *userdata)
	callback функция для определения события (используется для хэндлинга клика мышью) Подробнее...

Защищенные данные
bool	is_histogram_plotted_
	Флаг для отрисовки гистограммы Подробнее...

Закрытые члены
void	InitHistogramBackground ()
	Подгатавливаем Histogram::histogram_background_ для дальнейшего использования Подробнее...

Mat	CalcHistogram ()
	Вычисляет значения для гистограммы Подробнее...

bool	IsInteracted (int x, int interval)
	Проверяет, соответствует ли точка координате мыши Подробнее...

void	PlotMouseValue (Mat &frame, int value_idx)
	Выводит значение частоты рядом с курсором Подробнее...

std::string	to_string_with_precision (const float value, const int n=6)
	Для ограничения кол-ва знаков Подробнее...

Закрытые данные
std::string	winname_
	Название окна Подробнее...

float	histogram_offset_
	Оффсет рамки гистограммы Подробнее...

int	histogram_frame_width_
	Ширина окна гистограммы (включая оффсет) Подробнее...

int	histogram_frame_height_
	Высота окна гистограммы (включая оффсет) Подробнее...

Mat	histogram_
	cv::Mat изображение гистограммы Подробнее...

Mat	histogram_background_
	cv::Mat фон для гистограммы Подробнее...

std::vector< double > *	x_values_
	Значения гистограммы по оси X. Подробнее...

std::vector< float > *	y_values_
	Значения гистограммы по оси Y. Подробнее...

float	axis_signature_offset_
	Отступ для подписей оси Подробнее...

float	signature_interval_
	Интервал для делений оси и количество этих делений Подробнее...

int	signature_amount_
	Количество подписей на оси Подробнее...

int	x_limit_
	Максимальное (предельное) значение по оси X. Подробнее...

Point2i	last_mouse_coordinates_
	Координаты мыши (курсора) Подробнее...

float	dead_zone_coeff_
	Процент диапазона, который будет нижней мертвой зоной: 1.0 - 100%. Подробнее...

Подробное описание

Класс для создания объектов-гистограмм, на которые можно выводить различную информацию

См. определение в файле histogram.h строка 16

Конструктор(ы)

◆ Histogram()

Histogram::Histogram	(	int	width,
		int	height,
		int	x_limit,
		int	id,
		std::vector< double > &	x_values,
		std::vector< float > &	y_values
	)

Конструктор этого класса

Аргументы

width	ширина окна гистограммы (включая оффсет)
height	высота окна гистограммы (включая оффсет)
x_limit	максимальное (предельное) значение по оси X
id	ID точки
x_values	адрес контейнера со значениями для оси X
y_values	адрес контейнера со значеними для оси Y

См. определение в файле histogram.cpp строка 3

                                                                                                                        :
    histogram_frame_width_{ width },
    histogram_frame_height_{ height },
    x_limit_{ x_limit },
    is_histogram_plotted_{ false },
    signature_amount_{ 8 },
    dead_zone_coeff_{ 0.0f },
    x_values_{ &x_values },
    y_values_{ &y_values }
{
    // Инициализация гистограммы пустым кадром черного цвета
    histogram_offset_ = static_cast<float>(histogram_frame_width_) * 0.05;
    axis_signature_offset_ = static_cast<float>(histogram_frame_width_) * 0.03;
    histogram_ = Mat(Size(histogram_frame_width_, histogram_frame_height_), CV_32F, Scalar(0, 0, 0));
    // Инициализируем название окна
    winname_ = "histogram " + std::to_string(id);
    // Посчитаем интервал между подписями оси
    signature_interval_ = (histogram_.cols - histogram_offset_ * 2.0) / static_cast<float>(signature_amount_ - 1);
}

◆ ~Histogram()

Histogram::~Histogram ( )

Деструктор этого класса

Окно гистограммы разрушается внутри деструктора

См. определение в файле histogram.cpp строка 23

{
    if (is_histogram_plotted_)
        destroyWindow(winname_);
}

Методы

◆ CalcHistogram()

Mat Histogram::CalcHistogram ( )

private

Вычисляет значения для гистограммы

См. определение в файле histogram.cpp строка 116

{
    InitHistogramBackground();
    float interval = ((histogram_.cols) - histogram_offset_ * 2.0) / y_values_->size();
    
    Mat frame = histogram_background_.clone();
 
    // Инициализируем максимальные и минимальные значения магнитуд
    float max_value = 0.0;
 
    for (int i = 0; i < y_values_->size(); i++)
    {
        if (y_values_->at(i) > max_value)
            max_value = y_values_->at(i);
    }
 
 
    // Отрисовка столбцов
    for (int i = 0; i < y_values_->size(); i++)
    {
        float x_0 = histogram_offset_ + i * interval + interval;
        float y_0 = histogram_frame_height_ - histogram_offset_ - axis_signature_offset_;
        float x_1 = x_0;
        float y_1 = y_0 - y_values_->at(i) / max_value * (histogram_frame_height_ - 2 * histogram_offset_ - axis_signature_offset_);
 
        // Если мышь указывает на текущее значение, отрисовываем это значение рядом с курсором
        if (IsInteracted(static_cast<int>(x_0), interval))
        {
            PlotMouseValue(frame, i);
        }
        line(frame, Point2f(x_0, y_0), Point2f(x_1, y_1), Scalar(255, 255, 255), 1, LINE_AA);
    }
 
    return frame;
}

◆ DetectEvent()

void Histogram::DetectEvent	(	int	event,
		int	x,
		int	y,
		int	flags
	)

callback функция для определения события (используется для хэндлинга клика мышью)

См. определение в файле histogram.cpp строка 35

{
    switch (event) {
        // ЛКМ была прожата вниз
    case EVENT_LBUTTONDOWN:
    {
        is_histogram_plotted_ = false;
        destroyWindow(winname_);
        break;
    }
    case EVENT_MOUSEMOVE:
    {
        last_mouse_coordinates_.x = x;
        last_mouse_coordinates_.y = y;
        break;
    }
    }
}

◆ InitHistogramBackground()

void Histogram::InitHistogramBackground ( )

private

Подгатавливаем Histogram::histogram_background_ для дальнейшего использования

См. определение в файле histogram.cpp строка 85

{
    Mat frame = Mat(Size(histogram_frame_width_, histogram_frame_height_), CV_32F, Scalar(0, 0, 0));
 
    // Отрисовываем рамку гистограммы
    rectangle(frame, Rect(
        Point2f(histogram_offset_ * 0.5, histogram_offset_ * 0.5), // top-left
        Point2f(histogram_frame_width_ - histogram_offset_ * 0.5, histogram_frame_height_ - histogram_offset_ * 0.5 - axis_signature_offset_)), // bottom-right
        Scalar(255, 255, 255),
        1
    );
 
    // Отрисовываем подписи
    for (int i = 0; i < signature_amount_; i++)
    {
        float signature_start = static_cast<float>(x_values_->front());
        float signature_interval = static_cast<float>(x_limit_ - signature_start) / static_cast<float>(signature_amount_ - 1);
        float value = signature_start + signature_interval * i;
        putText(
            frame,
            to_string_with_precision(value, 1),
            Point2f(histogram_offset_ / 2.0 + i * signature_interval_, histogram_frame_height_ - axis_signature_offset_ / 2.0),
            FONT_HERSHEY_PLAIN,
            1,
            Scalar(255, 255, 255)
        );
    }
 
    frame.copyTo(histogram_background_);
}

◆ IsInteracted()

bool Histogram::IsInteracted	(	int	x,
		int	interval
	)

private

Проверяет, соответствует ли точка координате мыши

См. определение в файле histogram.cpp строка 152

{
    if (interval > 1)
    {
        Rect interaction_box = Rect(Point2f(x - interval * 0.9, -1), Point2f(x + interval * 0.9, 1));
        return ((interaction_box.contains(Point2i(last_mouse_coordinates_.x, 0))) ? true : false);
    }
    return ((last_mouse_coordinates_.x == x) ? true : false);
}

◆ OnMouse()

void Histogram::OnMouse	(	int	event,
		int	x,
		int	y,
		int	flags,
		void *	userdata
	)

static

callback функция для определения события (используется для хэндлинга клика мышью)

См. определение в файле histogram.cpp строка 29

{
    Histogram* d = static_cast<Histogram*>(userdata);
    d->DetectEvent(event, x, y, flags);
}

◆ PlotMouseValue()

void Histogram::PlotMouseValue	(	Mat &	frame,
		int	value_idx
	)

private

Выводит значение частоты рядом с курсором

См. определение в файле histogram.cpp строка 162

{
    putText(
        frame,
        to_string_with_precision(x_values_->at(value_idx), 1),
        Point2f(last_mouse_coordinates_.x + histogram_offset_ * 0.5, last_mouse_coordinates_.y + histogram_offset_ * 0.2),
        FONT_HERSHEY_PLAIN,
        1,
        Scalar(255, 255, 255)
    );
}

◆ SetHistogramFlag()

void Histogram::SetHistogramFlag ( bool flag )

Устанавливает статус флага отрисовки гистограммы

См. определение в файле histogram.cpp строка 74

{
    // Устанавливаем флаг
    is_histogram_plotted_ = flag;
}

◆ SetHistogramWindowProperty()

void Histogram::SetHistogramWindowProperty	(	int	prop_id,
		int	prop_value
	)

Обновляет статус окна гистограммы (например, для вывода на передний план)

На данный момент функция не используется :/

См. определение в файле histogram.cpp строка 80

{
    setWindowProperty(winname_, prop_id, prop_value);
}

◆ SetXValues()

void Histogram::SetXValues ( std::vector< double > x_values )

Устанавливает X-ы

См. определение в файле histogram.cpp строка 64

{
    //x_values_ = x_values;
}

◆ SetYValues()

void Histogram::SetYValues ( std::vector< float > y_values )

Устанавливает Y-ы

См. определение в файле histogram.cpp строка 69

{
    //y_values_ = y_values;
}

◆ ShowHistogram()

void Histogram::ShowHistogram ( )

Выводит гистограмму в окно гистограммы

См. определение в файле histogram.cpp строка 54

{
    if (is_histogram_plotted_)
    {
        histogram_ = CalcHistogram();
        imshow(winname_, histogram_);
        setMouseCallback(winname_, OnMouse, (void*)this);
    }
}

◆ to_string_with_precision()

std::string Histogram::to_string_with_precision	(	const float	value,
		const int	n = `6`
	)

private

Для ограничения кол-ва знаков

См. определение в файле histogram.cpp строка 174

{
    std::ostringstream out;
    out.precision(n);
    out << std::fixed << value;
    return out.str();
}

Данные класса

◆ axis_signature_offset_

float Histogram::axis_signature_offset_

private

Отступ для подписей оси

См. определение в файле histogram.h строка 131

◆ dead_zone_coeff_

float Histogram::dead_zone_coeff_

private

Процент диапазона, который будет нижней мертвой зоной: 1.0 - 100%.

См. определение в файле histogram.h строка 151

◆ histogram_

Mat Histogram::histogram_

private

cv::Mat изображение гистограммы

См. определение в файле histogram.h строка 115

◆ histogram_background_

Mat Histogram::histogram_background_

private

cv::Mat фон для гистограммы

См. определение в файле histogram.h строка 119

◆ histogram_frame_height_

int Histogram::histogram_frame_height_

private

Высота окна гистограммы (включая оффсет)

См. определение в файле histogram.h строка 111

◆ histogram_frame_width_

int Histogram::histogram_frame_width_

private

Ширина окна гистограммы (включая оффсет)

См. определение в файле histogram.h строка 107

◆ histogram_offset_

float Histogram::histogram_offset_

private

Оффсет рамки гистограммы

См. определение в файле histogram.h строка 103

◆ is_histogram_plotted_

bool Histogram::is_histogram_plotted_

protected

Флаг для отрисовки гистограммы

См. определение в файле histogram.h строка 93

◆ last_mouse_coordinates_

Point2i Histogram::last_mouse_coordinates_

private

Координаты мыши (курсора)

См. определение в файле histogram.h строка 147

◆ signature_amount_

int Histogram::signature_amount_

private

Количество подписей на оси

См. определение в файле histogram.h строка 139

◆ signature_interval_

float Histogram::signature_interval_

private

Интервал для делений оси и количество этих делений

См. определение в файле histogram.h строка 135

◆ winname_

std::string Histogram::winname_

private

Название окна

См. определение в файле histogram.h строка 99

◆ x_limit_

int Histogram::x_limit_

private

Максимальное (предельное) значение по оси X.

См. определение в файле histogram.h строка 143

◆ x_values_

std::vector<double>* Histogram::x_values_

private

Значения гистограммы по оси X.

См. определение в файле histogram.h строка 123

◆ y_values_

std::vector<float>* Histogram::y_values_

private

Значения гистограммы по оси Y.

См. определение в файле histogram.h строка 127

Объявления и описания членов классов находятся в файлах:

C:/Users/seeyo/source/repos/Visual-Vibration-Tracking-V2/include/VVT-V2/histogram.h
C:/Users/seeyo/source/repos/Visual-Vibration-Tracking-V2/source/histogram.cpp

Открытые члены

Открытые статические члены

Защищенные данные

Закрытые члены

Закрытые данные

Подробное описание

Конструктор(ы)

◆ Histogram()

◆ ~Histogram()

Методы

◆ CalcHistogram()

◆ DetectEvent()

◆ InitHistogramBackground()

◆ IsInteracted()

◆ OnMouse()

◆ PlotMouseValue()

◆ SetHistogramFlag()

◆ SetHistogramWindowProperty()

◆ SetXValues()

◆ SetYValues()

◆ ShowHistogram()

◆ to_string_with_precision()

Данные класса

◆ axis_signature_offset_

◆ dead_zone_coeff_

◆ histogram_

◆ histogram_background_

◆ histogram_frame_height_

◆ histogram_frame_width_

◆ histogram_offset_

◆ is_histogram_plotted_

◆ last_mouse_coordinates_

◆ signature_amount_

◆ signature_interval_

◆ winname_

◆ x_limit_

◆ x_values_

◆ y_values_