#include <frame.h>

Public Member Functions
	frame (cv::Mat matIn)

void	copyFrom (frame *copyFrom)

void	setParameter (std::string, std::string)

std::string	encodeMetadata ()

std::string	getParam (std::string)

	frame (frame const &)=default

int	getParamSize ()

Public Attributes
cv::Mat	image

bool	doMeta = false

Detailed Description

Frame structure used for images passing through processing blocks. Supports inserting metadata into frames on processing steps applied and threshold values, which can be later read.

Member Function Documentation

◆ copyFrom()

void frame::copyFrom ( frame * copyFrom )

inline

Custom copy constructor. Provide a pointer to an existing frame and copy from there into a constructed second frame.

◆ encodeMetadata()

std::string frame::encodeMetadata ( )

If metadata capture is enabled, encodes metadata into frame structure.

Returns: standard string containing image processing settings encoded such that it can be later be parsed to recover image settings.

◆ getParam()

std::string frame::getParam ( std::string param )

Getter for metadata parameter value.

Parameters

param metadata parameter for which to return value

Returns: std string containing requests metadata value

◆ getParamSize()

int frame::getParamSize ( )

Returns: size of metadata parameters map

◆ setParameter()

void frame::setParameter	(	std::string	param,
		std::string	val
	)

Sets metadata parameter value. First checks that parameter is a valid image setting. If so, sets corresponding parameter to given value in frame structure metadata. If metadata is disabled, will do nothing and return.