ocsOptFilter.hh

Go to the documentation of this file.

// $Id: ocsOptFilter.hh,v 1.2 2005/07/06 16:28:18 zweck Exp $

//###################################################################
//
//           Optical Communication Systems Simulator
//
//       Copyright (2000):
//       Optical Fiber Communications Laboratory (OFCL)
//       Computer Science & Electrical Engineering Department (CSEE)
//       University of Maryland Baltimore County (UMBC)
//
//###################################################################

#ifndef _OCS_OPT_FILTER_HH_
#define _OCS_OPT_FILTER_HH_

#include "ocsOptSignal.hh"


enum typeOptFilter { NOFILTER = 0, SUPERGAUSS = 1, 
                     SANTEC = 2, BOTH_SANTEC = 3 ,
                     BANDPASS = 4,FABRY_PEROT = 5, 
                     CIENA_DEMUX = 6 };


// ##### Input parameter to initialize Optical Filters
struct OptFilterParam
{
   typeOptFilter TypeOptFilter;
   int OrderOptFilter;
   double FreqFWHM_OptFilter;
   double CenterFreqOptFilter;
};

// ##### Class OptFilter
class OptFilter
{
   public:

    //#### Methods by Ivan Lima:

      OptFilter();
      void InitOptFilter(cfftw *fft2, fftMatrices sfftM2
                          ,OptFilterParam soOptFilter);

      //######################################
      //## Copy constructor 
      OptFilter(OptFilter *oOrigOptFilter, OptSignal *oOptSignal2);
      
      void FilterOptSignal(); 


      void FilterOptSignal_OLD();
      void SwitchOptSignalData(OptSignal *oOptSignal2);

     typeOptFilter GetTypeOptFilter(void)
           {return TypeOptFilter;};
     int GetOrderOptFilter(void)
           {return OrderOptFilter;};
     double GetRelativeCenterFreqOptFilter()
           {return RelativeCenterFreqOptFilter;};
     double GetFreqFWHM_OptFilter(void)
           { return FreqFWHM_OptFilter;};
     void SetFreqFWHM_OptFilter(double FreqFWHM_OptFilter2);          

     //###### Methods by John Zweck:

     // Use this constructor:

     OptFilter(string InFileName, OptSignal *oOptSignal2);

     // Two Constructors for tunable optical filter designed to be used in 
     // conjunction with OptDemuxer (Added by JZ):

     OptFilter(string InFileName,typeSimulation TypeSimulation2); 

  
     OptFilter(int TypeOptFilter2,int OrderOptFilter2,
               double FreqFWHM_OptFilter2,typeSimulation TypeSimulation2);
  
 
     double GetPowerEquivalentSpectralWidth(void);
     void WriteFilterImpulseResponse(string FileNameImpulseResponseTime,
                                     string FileNameImpulseResponseFreq);
               
     void SetRelativeCenterFreq(double RelativeCenterFreqOptFilter2); 
                                                         
 
     void SetOpticalData(cfftw * fft2, fftMatrices sfftM2); 

     void GaussianTunableOpticalFilter(cplx * TimeSignal, cplx * FreqSignal);

     void SuperGaussianTunableOpticalFilter(cplx * TimeSignal, 
                                            cplx * FreqSignal);


     void OpticalBandpassFilter(cplx * TimeSignal, cplx * FreqSignal);
          
     void FabryPerotFilter(cplx * TimeSignal, cplx * FreqSignal);

     void SantecTunableOpticalFilter(cplx * TimeSignal, cplx * FreqSignal);
   

     void DemuxLoopTunableOpticalFilter(cplx * TimeSignal, cplx * FreqSignal);

     void TunableFilterOptSignal();

     void WriteFreqPowerGaussianFilter(string OutFileName);


     void WriteFreqPowerSuperGaussianFilter(string OutFileName);
     
     void WriteFreqPowerBandpassFilter(string OutFileName);

     void WriteFreqPowerFabryPerotFilter(string OutFileName);

     void WriteFreqPowerSantecFilter(string OutFileName);
     double SantecPoly(double x);


     void WriteFreqPowerDemuxLoopFilter(string OutFileName);


     double DemuxLoopPoly(double x);
     
     bool GetDoAdditionalFiltering(void) {return DoAdditionalFilteringFlag;};


   private:
      OptSignal *oOptSignal;
      cfftw *fft;
      fftMatrices sfftM;
      int ObjectInitialized;                          
      typeOptFilter TypeOptFilter;
      int OrderOptFilter;
      typeSimulation TypeSimulation;
      double FreqFWHM_OptFilter;
      double RelativeCenterFreqOptFilter;

     // For Ciena work:   
    bool DoAdditionalFilteringFlag; 
   
  int DebugLevel;

};

#endif /* _OCS_OPT_FILTER_HH_ */