TimeFrequencyMask.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2018 by Paul Demorest
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
#ifndef __Pulsar_TimeFrequencyMask_h
#define __Pulsar_TimeFrequencyMask_h
 
#include "Pulsar/Algorithm.h"
#include "Pulsar/Archive.h"
 
namespace Pulsar {


  class TimeFrequencyMask : public Algorithm
  {
 
    public:

      static TimeFrequencyMask* factory (const std::string& name);

      static const std::vector<TimeFrequencyMask*>& children ();
 
      TimeFrequencyMask();


      virtual unsigned update_mask (std::vector<float> &mask, 
                                    std::vector<float> &stat,
                                    std::vector<float> &model,
                                    unsigned nsubint,
                                    unsigned nchan,
                                    unsigned npol) = 0;
 
      virtual void set_threshold (float t) { threshold = t; }
      virtual float get_threshold () const { return threshold; }

      virtual TextInterface::Parser* get_interface () { return 0; }

      virtual TimeFrequencyMask* clone () const = 0;
 
    protected:
 
      float threshold;
 
    private:
      static void build ();
  };
 
  std::ostream& operator<< (std::ostream&, TimeFrequencyMask*);
 
  std::istream& operator>> (std::istream&, TimeFrequencyMask*&);
 
}
 
#endif