source: flair-dev/trunk/include/FlairFilter/ButterworthLowPass.h@ 50

Last change on this file since 50 was 50, checked in by Sanahuja Guillaume, 5 years ago

doc

File size: 2.6 KB
RevLine 
[9]1// %flair:license{
[13]2// This file is part of the Flair framework distributed under the
3// CECILL-C License, Version 1.0.
[9]4// %flair:license}
[6]5/*!
6 * \file ButterworthLowPass.h
7 * \brief Class defining a Butterworth low pass filter
8 * \author Guillaume Sanahuja, Copyright Heudiasyc UMR UTC/CNRS 7253
9 * \date 2013/12/10
10 * \version 4.0
11 */
12
13#ifndef BUTTERWORTHLOWPASS_H
14#define BUTTERWORTHLOWPASS_H
15
16#include <IODevice.h>
17
[13]18namespace flair {
19namespace core {
20class cvmatrix;
[6]21}
[13]22namespace gui {
23class LayoutPosition;
24}
25}
[6]26
27class ButterworthLowPass_impl;
28
[13]29namespace flair {
30namespace filter {
31/*! \class ButterworthLowPass
32*
33* \brief Class defining a Butterworth low pass filter
34*/
35class ButterworthLowPass : public core::IODevice {
36public:
37 /*!
38 * \brief Constructor
39 *
40 * Construct a ButterworthLowPass at position. \n
41 * After calling this function, position will be deleted as it is no longer
42 *usefull. \n
43 * The filter is automatically updated when parent's
44 * IODevice::ProcessUpdate is called.
45 *
46 * \param parent parent
47 * \param position position to display settings
48 * \param name name
49 * \param order order of the filter
[50]50 * \param nbRow number of rows of input/output
51 * \param nbCol number of cols of input/output
[13]52 */
53 ButterworthLowPass(const IODevice *parent,
54 const gui::LayoutPosition *position, std::string name,
[50]55 uint32_t order,uint32_t nbRow=1,uint32_t nbCol=1);
[6]56
[13]57 /*!
58 * \brief Constructor
59 *
60 * Construct a ButterworthLowPass at position. \n
61 * The ButterworthLowPass will automatically be child of position->getLayout()
62 *Layout. After calling this function,
63 * position will be deleted as it is no longer usefull. \n
64 * The filter is updated manually with UpdateFrom method. \n
65 *
66 * \param position position to display settings
67 * \param name name
68 * \param order order of the filter
[50]69 * \param nbRow number of rows of input/output
70 * \param nbCol number of cols of input/output
[13]71 */
72 ButterworthLowPass(const gui::LayoutPosition *position, std::string name,
[50]73 uint32_t order,uint32_t nbRow,uint32_t nbCol);
[6]74
[13]75 /*!
76 * \brief Destructor
77 *
78 */
79 ~ButterworthLowPass();
[6]80
[13]81 /*!
82 * \brief Output value
83 *
84 * \return filtered output
85 */
86 float Output(void) const;
[6]87
[13]88 /*!
89 * \brief Output matrix
90 *
91 * \return filtered output
92 */
93 core::cvmatrix *Matrix(void) const;
[6]94
[13]95 /*!
96 * \brief Update using provided datas
97 *
98 * Reimplemented from IODevice.
99 *
100 * \param data data from the parent to process
101 */
102 void UpdateFrom(const core::io_data *data);
[6]103
[13]104private:
105 class ButterworthLowPass_impl *pimpl_;
106};
[6]107} // end namespace filter
108} // end namespace flair
109#endif // BUTTERWORTHLOWPASS_H
Note: See TracBrowser for help on using the repository browser.