RFIFilter.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2004 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// dspsr/Signal/General/dsp/RFIFilter.h
 
#ifndef __RFIFilter_h
#define __RFIFilter_h
 
#include "dsp/Response.h"
#include "Reference.h"
#include "MJD.h"
 
namespace dsp {
 
  class Source;
  class TimeSeries;
  class Bandpass;
 
  /* This class may become a base class for all RFI mitigaton
     strategies that can be applied in the frequency domain.  For now,
     it produces a narrow-band birdie zapping mask. */
  class RFIFilter: public Response {
 
  public:
 
    RFIFilter ();
 
    ~RFIFilter ();
 
    void match (const Observation*, unsigned nchan);
 
    void match (const Response* response);
 
    void set_nchan (unsigned nchan);
 
    void set_update_interval (double seconds);
 
    void set_duty_cycle (float cycle);
 
    void set_source (Source*);
 
    void set_buffer (TimeSeries* buffer);
 
    void set_data (Response* data);
 
    void set_bandpass (Bandpass* bandpass);
 
    void calculate (Response* bp);
 
  protected:
 
    template<typename SourceType>
    void match (SourceType* source, const Observation*, unsigned nchan);
    
    Reference::To<Source> source;
 
    Reference::To<TimeSeries> buffer;
 
    Reference::To<Bandpass> bandpass;
 
    Reference::To<Response> data;
 
    uint64_t maximum_block_size;
 
    unsigned nchan_bandpass;
 
    double interval;
 
    float duty_cycle;
 
    unsigned median_window;
 
  private:
 
    MJD end_time;
 
    MJD start_time;
 
    bool calculated;
 
  };
  
}
 
#endif