OpenWalnut
1.4.0
|
00001 //--------------------------------------------------------------------------- 00002 // 00003 // Project: OpenWalnut ( http://www.openwalnut.org ) 00004 // 00005 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS 00006 // For more information see http://www.openwalnut.org/copying 00007 // 00008 // This file is part of OpenWalnut. 00009 // 00010 // OpenWalnut is free software: you can redistribute it and/or modify 00011 // it under the terms of the GNU Lesser General Public License as published by 00012 // the Free Software Foundation, either version 3 of the License, or 00013 // (at your option) any later version. 00014 // 00015 // OpenWalnut is distributed in the hope that it will be useful, 00016 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00018 // GNU Lesser General Public License for more details. 00019 // 00020 // You should have received a copy of the GNU Lesser General Public License 00021 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>. 00022 // 00023 //--------------------------------------------------------------------------- 00024 00025 #ifndef WEEGCHANNELINFO_H 00026 #define WEEGCHANNELINFO_H 00027 00028 #include <cstddef> 00029 00030 #include <string> 00031 00032 #include <boost/shared_ptr.hpp> 00033 00034 #include "../common/math/linearAlgebra/WPosition.h" 00035 #include "WEEGPositionsLibrary.h" 00036 #include "exceptions/WDHException.h" 00037 #include "io/WPagerEEG.h" 00038 00039 00040 00041 /** 00042 * Class which contains information about one channel of an EEG recording, read 00043 * from a WPagerEEG. 00044 * \ingroup dataHandler 00045 */ 00046 class WEEGChannelInfo // NOLINT 00047 { 00048 public: 00049 /** 00050 * Constructor 00051 * 00052 * \param channelID number of this channel 00053 * \param pager pager class which contains the data, read from a 00054 * file on demand 00055 * \param positionsLibrary class which contains the positions of the 00056 * electrodes 00057 */ 00058 WEEGChannelInfo( std::size_t channelID, 00059 boost::shared_ptr< WPagerEEG > pager, 00060 boost::shared_ptr< WEEGPositionsLibrary > positionsLibrary ); 00061 00062 /** 00063 * Get the unit used by the recording of the channel. 00064 * 00065 * \return unit as string 00066 */ 00067 std::string getUnit() const; 00068 00069 /** 00070 * Get the label of the channel. 00071 * 00072 * \return label as string 00073 */ 00074 std::string getLabel() const; 00075 00076 /** 00077 * Get the position of the electrode. 00078 * 00079 * \return position 00080 */ 00081 WPosition getPosition() const throw( WDHException ); 00082 00083 protected: 00084 private: 00085 std::string m_unit; //!< unit used by the recording of the channel 00086 std::string m_label; //!< label of the channel 00087 bool m_hasPosition; //!< whether there is a valid position for this electrode 00088 WPosition m_position; //!< position of the electrode 00089 }; 00090 00091 #endif // WEEGCHANNELINFO_H