OpenWalnut  1.4.0
WEEG2Segment.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 WEEG2SEGMENT_H
00026 #define WEEG2SEGMENT_H
00027 
00028 #include <cstddef>
00029 
00030 #include <boost/shared_ptr.hpp>
00031 
00032 #include "io/WPagerEEG.h"
00033 #include "WEEGValueMatrix.h"
00034 
00035 
00036 
00037 /**
00038  * Class which contains one segment of an EEG recording, read from a WPagerEEG.
00039  * \ingroup dataHandler
00040  */
00041 class WEEG2Segment // NOLINT
00042 {
00043 public:
00044     /**
00045      * Constructor
00046      *
00047      * \param segmentID number of this segment
00048      * \param pager pager class which contains the data, read from a file on
00049      *              demand
00050      */
00051     WEEG2Segment( std::size_t segmentID, boost::shared_ptr< WPagerEEG > pager );
00052 
00053     /**
00054      * Get the number of samples this segment consists of.
00055      *
00056      * \return number of samples
00057      */
00058     std::size_t getNumberOfSamples() const;
00059 
00060     /**
00061      * Get the values of all channels for a given sample range.
00062      *
00063      * \param start start sample of the sample range
00064      * \param length length of the sample range
00065      * \return matrix of values
00066      */
00067     boost::shared_ptr< WEEGValueMatrix > getValues( std::size_t start, std::size_t length ) const;
00068 
00069 protected:
00070 private:
00071     std::size_t m_segmentID; //!< number of this segment
00072     boost::shared_ptr< WPagerEEG > m_pager; //!< pager class which contains the data, read from a file on demand
00073     std::size_t m_nbSamples; //!< number of samples this segment consists of
00074 };
00075 
00076 #endif  // WEEG2SEGMENT_H