OpenWalnut  1.4.0
WEEGPositionsLibrary.h
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 WEEGPOSITIONSLIBRARY_H
00026 #define WEEGPOSITIONSLIBRARY_H
00027 
00028 #include <map>
00029 #include <string>
00030 
00031 #include "../common/exceptions/WOutOfBounds.h"
00032 #include "../common/math/linearAlgebra/WPosition.h"
00033 
00034 
00035 
00036 /**
00037  * Class which contains the positions of EEG electrodes by label.
00038  * \ingroup dataHandler
00039  */
00040 class WEEGPositionsLibrary // NOLINT
00041 {
00042 public:
00043     /**
00044      * Constructor
00045      *
00046      * \param positions mapping from labels to positions
00047      */
00048     explicit WEEGPositionsLibrary( const std::map< std::string, WPosition >& positions );
00049 
00050     /**
00051      * Get the position of an electrode with the given label
00052      *
00053      * \param label label of the electrode
00054      * \return position of the electrode
00055      */
00056     WPosition getPosition( std::string label ) const throw( WOutOfBounds );
00057 
00058 protected:
00059 private:
00060     std::map< std::string, WPosition > m_positions; //!< mapping from labels to positions
00061 };
00062 
00063 #endif  // WEEGPOSITIONSLIBRARY_H