[10] | 1 | // %flair:license{
|
---|
[15] | 2 | // This file is part of the Flair framework distributed under the
|
---|
| 3 | // CECILL-C License, Version 1.0.
|
---|
[10] | 4 | // %flair:license}
|
---|
[7] | 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 |
|
---|
[15] | 18 | namespace flair {
|
---|
| 19 | namespace core {
|
---|
| 20 | class cvmatrix;
|
---|
[7] | 21 | }
|
---|
[15] | 22 | namespace gui {
|
---|
| 23 | class LayoutPosition;
|
---|
| 24 | }
|
---|
| 25 | }
|
---|
[7] | 26 |
|
---|
| 27 | class ButterworthLowPass_impl;
|
---|
| 28 |
|
---|
[15] | 29 | namespace flair {
|
---|
| 30 | namespace filter {
|
---|
| 31 | /*! \class ButterworthLowPass
|
---|
| 32 | *
|
---|
| 33 | * \brief Class defining a Butterworth low pass filter
|
---|
| 34 | */
|
---|
| 35 | class ButterworthLowPass : public core::IODevice {
|
---|
| 36 | public:
|
---|
| 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 | */
|
---|
| 51 | ButterworthLowPass(const IODevice *parent,
|
---|
| 52 | const gui::LayoutPosition *position, std::string name,
|
---|
| 53 | int order);
|
---|
[7] | 54 |
|
---|
[15] | 55 | /*!
|
---|
| 56 | * \brief Constructor
|
---|
| 57 | *
|
---|
| 58 | * Construct a ButterworthLowPass at position. \n
|
---|
| 59 | * The ButterworthLowPass will automatically be child of position->getLayout()
|
---|
| 60 | *Layout. After calling this function,
|
---|
| 61 | * position will be deleted as it is no longer usefull. \n
|
---|
| 62 | * The filter is updated manually with UpdateFrom method. \n
|
---|
| 63 | *
|
---|
| 64 | * \param position position to display settings
|
---|
| 65 | * \param name name
|
---|
| 66 | * \param order order of the filter
|
---|
| 67 | */
|
---|
| 68 | ButterworthLowPass(const gui::LayoutPosition *position, std::string name,
|
---|
| 69 | int order);
|
---|
[7] | 70 |
|
---|
[15] | 71 | /*!
|
---|
| 72 | * \brief Destructor
|
---|
| 73 | *
|
---|
| 74 | */
|
---|
| 75 | ~ButterworthLowPass();
|
---|
[7] | 76 |
|
---|
[15] | 77 | /*!
|
---|
| 78 | * \brief Output value
|
---|
| 79 | *
|
---|
| 80 | * \return filtered output
|
---|
| 81 | */
|
---|
| 82 | float Output(void) const;
|
---|
[7] | 83 |
|
---|
[15] | 84 | /*!
|
---|
| 85 | * \brief Output matrix
|
---|
| 86 | *
|
---|
| 87 | * \return filtered output
|
---|
| 88 | */
|
---|
| 89 | core::cvmatrix *Matrix(void) const;
|
---|
[7] | 90 |
|
---|
[15] | 91 | /*!
|
---|
| 92 | * \brief Update using provided datas
|
---|
| 93 | *
|
---|
| 94 | * Reimplemented from IODevice.
|
---|
| 95 | *
|
---|
| 96 | * \param data data from the parent to process
|
---|
| 97 | */
|
---|
| 98 | void UpdateFrom(const core::io_data *data);
|
---|
[7] | 99 |
|
---|
[15] | 100 | private:
|
---|
| 101 | class ButterworthLowPass_impl *pimpl_;
|
---|
| 102 | };
|
---|
[7] | 103 | } // end namespace filter
|
---|
| 104 | } // end namespace flair
|
---|
| 105 | #endif // BUTTERWORTHLOWPASS_H
|
---|