analyzer.h

/* 
 * Copyright (C) 2006-2013  Music Technology Group - Universitat Pompeu Fabra
 *
 * This file is part of Gaia
 * 
 * Gaia is free software: you can redistribute it and/or modify it under 
 * the terms of the GNU Affero General Public License as published by the Free 
 * Software Foundation (FSF), either version 3 of the License, or (at your 
 * option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT 
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more 
 * details.
 * 
 * You should have received a copy of the Affero GNU General Public License
 * version 3 along with this program.  If not, see http://www.gnu.org/licenses/
 */

#ifndef GAIA_ANALYZER_H
#define GAIA_ANALYZER_H

#include "dataset.h"
#include "factory.h"
#include "transformation.h"

namespace gaia2 {

class Analyzer {

 public:

  QString name;

  Analyzer(const ParameterMap& params);
  virtual ~Analyzer() {};

  virtual Transformation analyze(const DataSet* dataset) const;
  virtual Transformation analyze(const DataSet* dataset, const Region& region) const;

  void checkDataSet(const DataSet* dataset) const;

  void checkMinPoints(const DataSet* dataset, int n) const;

  const Region& checkFixedLength(const Region& region, const PointLayout& layout) const;

  QStringList validParams;

 protected:
  ParameterMap _params;
  QStringList _descriptorNames, _exclude;

};


typedef ParamCheckingFactory<QString, Analyzer, ParameterMap> AnalyzerFactory;

void registerAnalyzers();


} // namespace gaia2

#endif // GAIA_ANALYZER_H