v2.0.0
Loading...
Searching...
No Matches
UTILSLIB::FilterIO Class Reference

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.

Processes txt files which hold filter coefficients.

Definition at line 66 of file filterio.h.

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for FilterIO.

Definition at line 70 of file filterio.h.

◆ SPtr

typedef QSharedPointer<FilterIO> UTILSLIB::FilterIO::SPtr

Shared pointer type for FilterIO.

Definition at line 69 of file filterio.h.

Constructor & Destructor Documentation

◆ FilterIO()

FilterIO::FilterIO ( )

Constructs a FilterIO object.

Definition at line 39 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]pathholds the file path of the txt file which is to be read.
[in,out]filterholds the filter which the read parameters are to be saved to.
Returns
true if reading was successful, false otherwise.

Definition at line 45 of file filterio.cpp.

◆ writeFilter()

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

Writes a given filter to txt file .

Parameters
[in]pathholds the file path of the txt file which is to be written to.
[in]filterholds the filter which is to be written to file.
Returns
true if reading was successful, false otherwise.

Definition at line 132 of file filterio.cpp.


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