Concrete strategy for a PNG image recording. More...

#include <VisionX/libraries/imrec/record/strats/PNGRecordingStrategy.h>

Inheritance diagram for PNGRecordingStrategy:

Public Member Functions
	PNGRecordingStrategy ()

	PNGRecordingStrategy (const std::filesystem::path &filePath, const std::string &file_name, unsigned int png_compression=9)

void	recordFrame (const cv::Mat &frame, std::chrono::microseconds timestamp) override
	Adds the given frame to the recording. More...

void	startRecording () override
	Starts the recording manually if constructed empty. More...

	~PNGRecordingStrategy () override

Public Member Functions inherited from AbstractSequencedRecordingStrategy
	AbstractSequencedRecordingStrategy ()
	Default constructor to manually start the recording. More...

	AbstractSequencedRecordingStrategy (const std::filesystem::path &filePath, const std::filesystem::path &ext)

std::filesystem::path	getDotExtension () const override
	Gets the extension plus preceeded dot of the configured file (e.g. More...

std::filesystem::path	getMetadataPath () const override

	~AbstractSequencedRecordingStrategy () override
	Destruct the recording strategy. More...

Public Member Functions inherited from AbstractRecordingStrategy
	AbstractRecordingStrategy ()
	Default constructor to start the recording manually. More...

	AbstractRecordingStrategy (const std::filesystem::path &filePath)
	Constructor for any recording strategy, immediately starting the recording. More...

virtual std::filesystem::path	getFilePath () const
	Gets the raw file path for the recording as configured. More...

virtual std::filesystem::path	getPath () const
	Gets the path to the recording without filename. More...

virtual std::filesystem::path	getStem () const
	Gets the stem of the configured file (filename without extension) More...

virtual bool	isRecording () const
	Indicates whether this instance is already initialised for recording. More...

virtual void	recordFrame (const CByteImage &frame, std::chrono::microseconds timestamp)
	Adds the given frame to the recording. More...

virtual void	stopRecording ()
	Stops the recording. More...

virtual void	writeMetadataDatetime (const std::string &var_name, std::chrono::microseconds timestamp)

virtual std::tuple< unsigned int, std::string >	writeMetadataFrame (const CByteImage &frame, std::chrono::microseconds timestamp)

virtual std::tuple< unsigned int, std::string >	writeMetadataFrame (const cv::Mat &frame, std::chrono::microseconds timestamp)

virtual void	writeMetadataLine (const std::string &var_name, std::string_view var_type, std::string_view var_value)

virtual	~AbstractRecordingStrategy ()
	Destructor. More...

Static Public Member Functions
static void	recordSnapshot (const CByteImage &image, const std::filesystem::path &path)

static void	recordSnapshot (const cv::Mat &image, const std::filesystem::path &path)

Protected Attributes
unsigned int	m_png_compression

Protected Attributes inherited from AbstractRecordingStrategy
std::filesystem::path	m_file_path
	Path to where the recording file should be written to. More...

Additional Inherited Members
Protected Member Functions inherited from AbstractSequencedRecordingStrategy
std::filesystem::path	deriveFramePath (const unsigned int sequence_number, const std::string &frame_name)
	Returns the next sequenced full path and increments the sequence number. More...

Detailed Description

Concrete strategy for a PNG image recording.

Definition at line 41 of file PNGRecordingStrategy.h.

Constructor & Destructor Documentation

◆ PNGRecordingStrategy() [1/2]

PNGRecordingStrategy ( )

Definition at line 39 of file PNGRecordingStrategy.cpp.

◆ PNGRecordingStrategy() [2/2]

PNGRecordingStrategy	(	const std::filesystem::path &	filePath,
		const std::string &	file_name,
		unsigned int	png_compression = `9`
	)

Definition at line 45 of file PNGRecordingStrategy.cpp.

◆ ~PNGRecordingStrategy()

~PNGRecordingStrategy ( )

override

Definition at line 54 of file PNGRecordingStrategy.cpp.

Member Function Documentation

◆ recordFrame()

void recordFrame	(	const cv::Mat &	frame,
		std::chrono::microseconds	timestamp
	)

overridevirtual

Adds the given frame to the recording.

Parameters

frame Frame to be added

Reimplemented from AbstractRecordingStrategy.

Definition at line 99 of file PNGRecordingStrategy.cpp.

◆ recordSnapshot() [1/2]

void recordSnapshot	(	const CByteImage &	image,
		const std::filesystem::path &	path
	)

static

Definition at line 81 of file PNGRecordingStrategy.cpp.

Here is the call graph for this function:

◆ recordSnapshot() [2/2]

void recordSnapshot	(	const cv::Mat &	image,
		const std::filesystem::path &	path
	)

static

Definition at line 61 of file PNGRecordingStrategy.cpp.

◆ startRecording()

void startRecording ( )

overridevirtual

Starts the recording manually if constructed empty.

Parameters

filePath	Path to where the recording file should be written to
fps	Amount of frames being recorded per second

Reimplemented from AbstractSequencedRecordingStrategy.

Definition at line 91 of file PNGRecordingStrategy.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ m_png_compression

unsigned int m_png_compression

protected

Definition at line 47 of file PNGRecordingStrategy.h.

The documentation for this class was generated from the following files:

VisionX/libraries/imrec/record/strats/PNGRecordingStrategy.h
VisionX/libraries/imrec/record/strats/PNGRecordingStrategy.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members