Processes txt files which hold filter coefficients. More...

#include <filterio.h>

Public Types
typedef QSharedPointer< FilterIO >	SPtr

typedef QSharedPointer< const FilterIO >	ConstSPtr

Public Member Functions
	FilterIO ()

Static Public Member Functions
static bool	readFilter (QString path, FilterKernel &filter)

static bool	writeFilter (const QString &path, const FilterKernel &filter)

Detailed Description

Processes txt files which hold filter coefficients.

Definition at line 76 of file filterio.h.

Member Typedef Documentation

◆ ConstSPtr

typedef QSharedPointer<const FilterIO> RTPROCESSINGLIB::FilterIO::ConstSPtr

Const shared pointer type for FilterIO.

Definition at line 80 of file filterio.h.

◆ SPtr

typedef QSharedPointer<FilterIO> RTPROCESSINGLIB::FilterIO::SPtr

Shared pointer type for FilterIO.

Definition at line 79 of file filterio.h.

Constructor & Destructor Documentation

◆ FilterIO()

FilterIO::FilterIO ( )

Constructs a FilterIO object.

Definition at line 62 of file filterio.cpp.

Member Function Documentation

◆ readFilter()

bool FilterIO::readFilter	(	QString	path,
		FilterKernel &	filter
	)

static

Reads a given txt file and scans it for filter coefficients. Pls see sample file for file syntax.

Parameters

[in]	path	holds the file path of the txt file which is to be read.
[in,out]	filter	holds the filter which the read parameters are to be saved to.

Returns: true if reading was successful, false otherwise.

Definition at line 68 of file filterio.cpp.

◆ writeFilter()

bool FilterIO::writeFilter	(	const QString &	path,
		const FilterKernel &	filter
	)

static

Writes a given filter to txt file .

Parameters

[in]	path	holds the file path of the txt file which is to be written to.
[in]	filter	holds the filter which is to be written to file.

Returns: true if reading was successful, false otherwise.

Definition at line 153 of file filterio.cpp.

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

src/libraries/rtprocessing/helpers/filterio.h
src/libraries/rtprocessing/helpers/filterio.cpp

Public Types

Public Member Functions

Static Public Member Functions