OpenWalnut  1.3.1
WEEGChannelInfo.h
1 //---------------------------------------------------------------------------
2 //
3 // Project: OpenWalnut ( http://www.openwalnut.org )
4 //
5 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
6 // For more information see http://www.openwalnut.org/copying
7 //
8 // This file is part of OpenWalnut.
9 //
10 // OpenWalnut is free software: you can redistribute it and/or modify
11 // it under the terms of the GNU Lesser General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // OpenWalnut is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU Lesser General Public License for more details.
19 //
20 // You should have received a copy of the GNU Lesser General Public License
21 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
22 //
23 //---------------------------------------------------------------------------
24 
25 #ifndef WEEGCHANNELINFO_H
26 #define WEEGCHANNELINFO_H
27 
28 #include <cstddef>
29 
30 #include <string>
31 
32 #include <boost/shared_ptr.hpp>
33 
34 #include "../common/math/linearAlgebra/WLinearAlgebra.h"
35 #include "WEEGPositionsLibrary.h"
36 #include "exceptions/WDHException.h"
37 #include "io/WPagerEEG.h"
38 
39 
40 
41 /**
42  * Class which contains information about one channel of an EEG recording, read
43  * from a WPagerEEG.
44  * \ingroup dataHandler
45  */
46 class WEEGChannelInfo // NOLINT
47 {
48 public:
49  /**
50  * Constructor
51  *
52  * \param channelID number of this channel
53  * \param pager pager class which contains the data, read from a
54  * file on demand
55  * \param positionsLibrary class which contains the positions of the
56  * electrodes
57  */
58  WEEGChannelInfo( std::size_t channelID,
59  boost::shared_ptr< WPagerEEG > pager,
60  boost::shared_ptr< WEEGPositionsLibrary > positionsLibrary );
61 
62  /**
63  * Get the unit used by the recording of the channel.
64  *
65  * \return unit as string
66  */
67  std::string getUnit() const;
68 
69  /**
70  * Get the label of the channel.
71  *
72  * \return label as string
73  */
74  std::string getLabel() const;
75 
76  /**
77  * Get the position of the electrode.
78  *
79  * \return position
80  */
81  WPosition getPosition() const throw( WDHException );
82 
83 protected:
84 private:
85  std::string m_unit; //!< unit used by the recording of the channel
86  std::string m_label; //!< label of the channel
87  bool m_hasPosition; //!< whether there is a valid position for this electrode
88  WPosition m_position; //!< position of the electrode
89 };
90 
91 #endif // WEEGCHANNELINFO_H