GaussianReceiver.hh

Go to the documentation of this file.

// $Id:

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

// Written by John Zweck, Jan 2006


#ifndef _OCS_GAUSSIAN_RECEIVER_HH_
#define _OCS_GAUSSIAN_RECEIVER_HH_

#include "ocsOptSignal.hh"
#include "ocsOptFilter.hh"
#include "ocsOptDemuxer.hh"
#include "ocsPhotodetector.hh"
#include "ocsElecFilter.hh"
#include "ocsElecSignalStat.hh"
#include "ocsOptDataWriter.hh"
#include "ChiSquareReceiver.hh"
#include "ocsOptFiber.hh"

/*

From ChiSquareReceiver.hh:

Enumeration type that specifies sort of statistics of electrical pdf
to be generated by the class

    Possible values:

    - PDFS = 1, i.e., pdfs in each bit at clock recovery 
                      together with average pdfs of marks and spaces
    - EYE = 2, i.e., a contour eye diagram 
          
enum typeOutput { PDFS = 1, EYE = 2};

*/


enum typeGaussianNoise { UNPOLARIZED = 1, 
                         PARTIALLY_POLARIZED = 2, 
                         PARTIALLY_POLARIZED_WITH_DGD = 3};


enum typePMDonSignal { NO_PMD = 1, FIRST_ORDER_PMD = 2 };



enum typeClockRecoveryGaussianReceiver { AUTOMATIC = 1, MANUALLY_SET = 2 };


class GaussianReceiver
{

public:

  GaussianReceiver(OptSignal * WDMSignal2,
                   RanNumGen *RNG2,
                   int DemuxChannArrayIndex2,
                   string InDir, 
                   string Job2);

  ~GaussianReceiver();

  string WriteTypeOutput(void);
  string WriteTypeGaussianNoise(void);
  string WriteTypePMDonSignal(void);
  string WriteTypeClockRecovery(void);

  void ReceiveSignal(string FileID);


    void SetFirstOrderPMDParameters(
                double * StokesParametersPlusPlus,
                cplx * StokesParametersPlusMinus, cplx c_plus2, cplx c_minus2);


  void ComputeFirstOrderPMDParameters(OptFiber * PMF);


void ReceiveSignalDGD_NoisePartiallyPolarized(
     double DGD2, 
     double ClockRecoveryTime2, 
     double *UnitStokesPlusPlus2, 
     double *UnitAverageStokesSignal,
     double DOP_Signal,
     double TotalNoiseSpectralDensity,
     double DOP_Noise, 
     double * UnitStokesVectorPolarizedPartNoise,
     string OutFileID);

private:

  // METHODS:

void RecoverClockAndSetTimeSlices(void);
void SetTimeSlices(void);
void ReceiveSignalUnpolarizedNoise(string FileID);
void ReceiveSignalNoPMD_NoisePartiallyPolarized(string FileID);


void ReceiveSignalDGD_NoisePartiallyPolarized(string FileID);
void ComputeMinimumBERAndDecisionThreshold(string FileID);
void WriteFilePairVectors(double * x, double *y, int dim, string OutFileName);
void WriteFilePDFTimeSlices(string OutFileName);
void ComputeAveragePDFs(string FileID);

  // DATA:

  typeOutput TypeOutput;  
  // enumtype  typeOutput is defined in ChiSquareReceiver.hh
  typeGaussianNoise TypeGaussianNoise;
  typePMDonSignal  TypePMDonSignal;
  typeClockRecoveryGaussianReceiver TypeClockRecovery;

  int DebugLevel;

  double ClockRecoveryTime;

  OptSignal * WDMSignal;
  OptSignal * SingleChannelSignal;
  OptSignal * WDMSignalTmp;

  OptFilter * TunableOptFilter;
  OptDemuxer *oOptDemuxer;

  Photodetector * oPhotodetector;
  ElecFilter * oElecFilter;

  ElecSignalStat * oElecSignalStat;

  int DemuxChannArrayIndex;
  string Job;

  int ObjectInitialized;

  int NumTimeSlices;
  int NumSlicesPerBit;
  double TimeBetweenSlices;
 
  int NumBitsToPlot;

  double * TimeSlices;
  int * TimeSliceIndices;

  double * VarianceCurrent;
  double * MeanCurrent;
  double MeanNoise;

  double  MinCurrent,MaxCurrent,DeltaCurrent;
  int NumPointsCurrent;
  double * CurrentVector;

  double * BER;
  double * AveragePDFZeros;
  double * AveragePDFOnes;
  double ** PDFTimeSlices;
  double * PDFTimeSlicesStorageVec;
  int * BitString;


  // Parameters for signal with FirstOrderPMD

  bool FirstOrderPMDParametersSet;
  double DGD;
  double * StokesPlusPlus;
  cplx * StokesPlusMinus;
  cplx c_plus;
  cplx c_minus;

};

#endif