GyotoSpectrometer.h

Go to the documentation of this file.

/*
    Copyright 2011-2016, 2024 Thibaut Paumard

    This file is part of Gyoto.

    Gyoto is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Gyoto 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 GNU General Public License
    along with Gyoto.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __GyotoSpectrometer_H_ 
#define __GyotoSpectrometer_H_ 

#include <GyotoDefs.h>
#include <GyotoSmartPointer.h>
#include <GyotoObject.h>
#include <GyotoRegister.h>
#include <GyotoHooks.h>
#include <string>

namespace Gyoto{
  namespace Register { class Entry; }
  class FactoryMessenger;
  namespace Spectrometer {
    class Generic;

    typedef char const * kind_t;

    typedef SmartPointer<Gyoto::Spectrometer::Generic>
      Subcontractor_t(Gyoto::FactoryMessenger*, std::vector<std::string> const &);

    Gyoto::Spectrometer::Subcontractor_t* getSubcontractor(std::string name,
                                                           std::vector<std::string> &plugins,
                                                           int errmode = 0);

    template<typename T> SmartPointer<Spectrometer::Generic> Subcontractor
      (FactoryMessenger* fmp, std::vector<std::string> const &plugins) {
      SmartPointer<T> spectro = new T();
      spectro -> plugins(plugins);
#ifdef GYOTO_USE_XERCES
      if (fmp) spectro -> setParameters(fmp);
#endif
      return spectro;
    }

    extern Gyoto::Register::Entry * Register_;

    void initRegister(); 

    void Register(std::string name, Gyoto::Spectrometer::Subcontractor_t* scp);

  }
}

class Gyoto::Spectrometer::Generic
: public Gyoto::SmartPointee,
  public Gyoto::Object,
  public Gyoto::Hook::Teller
{
  friend class Gyoto::SmartPointer<Gyoto::Spectrometer::Generic>;
 protected:
  kind_t kindid_;
 public:
  size_t nsamples_; 
  size_t nboundaries_; 

  double* boundaries_;

  size_t* chanind_;

  double* midpoints_;

  double* widths_;

 public:
  GYOTO_OBJECT;

  Generic();

  Generic(kind_t kindid);

  Generic(const Generic& ) ;

  virtual Generic * clone() const =0;

  virtual ~Generic();

  virtual kind_t kindid() const ;

  virtual void  kindid(kind_t) ;

  virtual size_t nSamples() const ; 
  virtual size_t getNBoundaries() const ; 
  virtual double const * getMidpoints() const  ; 

  virtual void getMidpoints( double data[], std::string unit);
  virtual void getChannelBoundaries( double data[], std::string unit);
  virtual double const * getChannelBoundaries() const ; 
  virtual size_t const * getChannelIndices() const ; 
  virtual double const * getWidths() const ; 

  virtual void getWidths( double data[], std::string unit);

};


#endif