HG_REPOSITORIES/LPP/SciQLOP_Repos/SciQLop Files · core/include/Data/SpectrogramSeries.h

Updates model after an event has been created through the colored zone

Alexandre Leroux - - Load All Authors

File last commit:

r987:2928e8449245


                r1231:073d4af7c849

Download file

             SpectrogramSeries.h
        
                    40 lines
            
             | 1.5 KiB
            
                | text/x-c
            
             |
                CLexer
            
             / core / include / Data / SpectrogramSeries.h
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      #ifndef SCIQLOP_SPECTROGRAMSERIES_H

      #define SCIQLOP_SPECTROGRAMSERIES_H

      #include "CoreGlobal.h"

      #include <Data/DataSeries.h>

      /**

       * @brief The SpectrogramSeries class is the implementation for a data series representing a

       * spectrogram.

       *

       * It defines values on a x-axis and a y-axis.

       */

      class SCIQLOP_CORE_EXPORT SpectrogramSeries : public DataSeries<2> {

      public:

          /// Ctor

          explicit SpectrogramSeries(std::vector<double> xAxisData, std::vector<double> yAxisData,

                                     std::vector<double> valuesData, const Unit &xAxisUnit,

                                     const Unit &yAxisUnit, const Unit &valuesUnit,

                                     double xResolution = std::numeric_limits<double>::quiet_NaN());

          /// Ctor directly with the y-axis

          explicit SpectrogramSeries(std::shared_ptr<ArrayData<1> > xAxisData, const Unit &xAxisUnit,

                                     std::shared_ptr<ArrayData<2> > valuesData, const Unit &valuesUnit,

                                     OptionalAxis yAxis,

                                     double xResolution = std::numeric_limits<double>::quiet_NaN());

          /// @sa DataSeries::clone()

          std::unique_ptr<IDataSeries> clone() const override;

          /// @sa DataSeries::subDataSeries()

          std::shared_ptr<IDataSeries> subDataSeries(const SqpRange &range) override;

          inline double xResolution() const noexcept { return m_XResolution; }

      private:

          double m_XResolution; ///< Resolution used on x-axis to build the spectrogram

      };

      #endif // SCIQLOP_SPECTROGRAMSERIES_H

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				#ifndef SCIQLOP_SPECTROGRAMSERIES_H
				#define SCIQLOP_SPECTROGRAMSERIES_H

				#include "CoreGlobal.h"

				#include <Data/DataSeries.h>

				/**
				* @brief The SpectrogramSeries class is the implementation for a data series representing a
				* spectrogram.
				*
				* It defines values on a x-axis and a y-axis.
				*/
				class SCIQLOP_CORE_EXPORT SpectrogramSeries : public DataSeries<2> {
				public:
				/// Ctor
				explicit SpectrogramSeries(std::vector<double> xAxisData, std::vector<double> yAxisData,
				std::vector<double> valuesData, const Unit &xAxisUnit,
				const Unit &yAxisUnit, const Unit &valuesUnit,
				double xResolution = std::numeric_limits<double>::quiet_NaN());

				/// Ctor directly with the y-axis
				explicit SpectrogramSeries(std::shared_ptr<ArrayData<1> > xAxisData, const Unit &xAxisUnit,
				std::shared_ptr<ArrayData<2> > valuesData, const Unit &valuesUnit,
				OptionalAxis yAxis,
				double xResolution = std::numeric_limits<double>::quiet_NaN());

				/// @sa DataSeries::clone()
				std::unique_ptr<IDataSeries> clone() const override;

				/// @sa DataSeries::subDataSeries()
				std::shared_ptr<IDataSeries> subDataSeries(const SqpRange &range) override;

				inline double xResolution() const noexcept { return m_XResolution; }

				private:
				double m_XResolution; ///< Resolution used on x-axis to build the spectrogram
				};

				#endif // SCIQLOP_SPECTROGRAMSERIES_H