MIRA
SchmittTriggerHysteresis.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 by
3  * MetraLabs GmbH (MLAB), GERMANY
4  * and
5  * Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
6  * All rights reserved.
7  *
8  * Contact: info@mira-project.org
9  *
10  * Commercial Usage:
11  * Licensees holding valid commercial licenses may use this file in
12  * accordance with the commercial license agreement provided with the
13  * software or, alternatively, in accordance with the terms contained in
14  * a written agreement between you and MLAB or NICR.
15  *
16  * GNU General Public License Usage:
17  * Alternatively, this file may be used under the terms of the GNU
18  * General Public License version 3.0 as published by the Free Software
19  * Foundation and appearing in the file LICENSE.GPL3 included in the
20  * packaging of this file. Please review the following information to
21  * ensure the GNU General Public License version 3.0 requirements will be
22  * met: http://www.gnu.org/copyleft/gpl.html.
23  * Alternatively you may (at your option) use any later version of the GNU
24  * General Public License if such license has been publicly approved by
25  * MLAB and NICR (or its successors, if any).
26  *
27  * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
28  * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
29  * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
30  * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
33  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
34  * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
35  * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
36  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
37  */
38 
47 #ifndef _MIRA_SCHMITTTRIGGERHYSTERESIS_H_
48 #define _MIRA_SCHMITTTRIGGERHYSTERESIS_H_
49 
50 namespace mira
51 {
52 
54 
64 template <typename T>
66 {
67 public:
71  enum State
72  {
74  LOW,
76  };
77 
79  mState(UNKNOWN)
80  {}
81 
83  mState(state)
84  {}
85 
86  SchmittTriggerHysteresis(const T& lower, const T& upper) :
87  mState(UNKNOWN),
88  mLowerThreshold(lower<=upper?lower:upper),
89  mUpperThreshold(upper>=lower?upper:lower)
90  {}
91 
92  SchmittTriggerHysteresis(State state, const T& lower, const T& upper) :
93  mState(state),
94  mLowerThreshold(lower<=upper?lower:upper),
95  mUpperThreshold(upper>=lower?upper:lower)
96  {}
97 
98  template <typename Reflector>
99  void reflect(Reflector& r)
100  {
101  r.property("Lower", mLowerThreshold, "Lower threshold");
102  r.property("Upper", mUpperThreshold, "Upper threshold");
103  r.member("State", mState, "The state", UNKNOWN);
104  }
105 
110  bool update(const T& value)
111  {
112  State oldState = mState;
113  if (value < mLowerThreshold)
114  mState = LOW;
115  if (value > mUpperThreshold)
116  mState = HIGH;
117  if (mState != oldState)
118  return true;
119  return false;
120  }
121 
125  State getState() const
126  {
127  return mState;
128  }
129 
130 private:
131  State mState;
132  T mLowerThreshold;
133  T mUpperThreshold;
134 };
135 
137 
138 }
139 
140 #endif
Definition: SchmittTriggerHysteresis.h:74
Class realizing a Schmitt trigger.
Definition: SchmittTriggerHysteresis.h:65
SchmittTriggerHysteresis(State state, const T &lower, const T &upper)
Definition: SchmittTriggerHysteresis.h:92
specialize cv::DataType for our ImgPixel and inherit from cv::DataType<Vec>
Definition: IOService.h:67
void reflect(Reflector &r)
Definition: SchmittTriggerHysteresis.h:99
SchmittTriggerHysteresis(State state)
Definition: SchmittTriggerHysteresis.h:82
SchmittTriggerHysteresis()
Definition: SchmittTriggerHysteresis.h:78
Definition: SchmittTriggerHysteresis.h:73
SchmittTriggerHysteresis(const T &lower, const T &upper)
Definition: SchmittTriggerHysteresis.h:86
State getState() const
Returns the state of the trigger.
Definition: SchmittTriggerHysteresis.h:125
Definition: SchmittTriggerHysteresis.h:75
State
State of the trigger.
Definition: SchmittTriggerHysteresis.h:71
bool update(const T &value)
Feed the next value into the trigger.
Definition: SchmittTriggerHysteresis.h:110