InterQuartileRange.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2021 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
#ifndef __Pulsar_InterQuartileRange_h
#define __Pulsar_InterQuartileRange_h
 
#include "Pulsar/TimeFrequencyMask.h"
 
namespace Pulsar
{

  class InterQuartileRange : public TimeFrequencyMask
  {
    
  public:
    
    InterQuartileRange() = default;
    

    unsigned update_mask (std::vector<float> &mask, 
                          std::vector<float> &stat,
                          std::vector<float> &model,
                          unsigned nsubint, unsigned nchan, unsigned npol);
    
    void set_cutoff_threshold (float t)
    { threshold = cutoff_threshold_max = cutoff_threshold_min = t; }
    
    void set_cutoff_threshold_max (float t) { cutoff_threshold_max = t; }
    
    float get_cutoff_threshold_max () const { return cutoff_threshold_max; }

    void set_cutoff_threshold_min (float t) { cutoff_threshold_min = t; }

    float get_cutoff_threshold_min () const { return cutoff_threshold_min; }

    void set_minimum_slope_median_duty_cycle (float t)
    { minimum_slope_median_duty_cycle = t; }
    
    float get_minimum_slope_median_duty_cycle () const
    { return minimum_slope_median_duty_cycle; }
 
    const std::string& get_way () const { return way; }
    void set_way (const std::string& t) { way = t; }
 
    // Text interface to the InterQuartileRange class
    class Interface : public TextInterface::To<InterQuartileRange> {
    public:
      Interface (InterQuartileRange* = 0);
      std::string get_interface_name () const { return "iqr"; }
    };
    
    TextInterface::Parser* get_interface ();
    
    // Return new instance
    InterQuartileRange* clone () const { return new InterQuartileRange(); }
    
  protected:
    
    float cutoff_threshold_max = 1.5;
    float cutoff_threshold_min = 1.5;

    float minimum_slope_median_duty_cycle = 0.0;
 
    // dimension along which to compare
    std::string way = "all";
  };
 
}
 
#endif