NoiseCovariance.hh

Go to the documentation of this file.

// $Id: NoiseCovariance.hh,v 1.4 2007/10/24 14:29:19 zweck Exp $

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

#ifndef _NOISE_COVARIANCE_
#define _NOISE_COVARIANCE_


#include "ocsOptSignal.hh"
#include "ocsOptFiberLocalError.hh"
#include "ocsOptAmplifier.hh"
#include "ocsLumpedLoss.hh"
#include "MatrixTools.hh"


enum typeNoiseMethod { AWGN = 0, MC_WITHOUT_K=1,
                       MC_WITH_K=2, ODE=3};


enum typeJitterSeparation { NONE = 0, PHASE_ONLY = 1, PHASE_AND_TIMING = 2};



class NoiseCovariance
{

  public:

  // ######### Public Methods ##################


  NoiseCovariance(string InFileName, string Job2,OptSignal * Signal2);


  NoiseCovariance & operator=(NoiseCovariance & RHS_NoiseCovariance);


  void ResetVolatileParameters(void);
   

  ~NoiseCovariance(void);


   void Propagate(OptFiberLocalError * Fiber2);


   void Amplify(OptAmplifier * Amplifier2);


   void Attenuate(LumpedLoss * oLumpedLoss);


  void TurnOffJitterSeparation(void);


  void TurnOnJitterSeparation(void);

  string WriteTypeNoiseMethod(void);

  string WriteTypeJitterSeparation(void);

  void WriteFileNoiseFreeSignalAndCovarianceMatrix(
                         string OutFileNamesSuffix);


  void ReadFileNoiseFreeSignalAndCovarianceMatrix(
                          string InFileNamesPrefix);
  

  void WriteFileAWGNNoiseFreeSignalAndNoiseSpectralDensity(
                                   string OutFileNameSuffix);

  void WriteFileTimeField(string OutFileName,fftMatrices Field);
  void WriteFileFreqField(string OutFileName,fftMatrices Field);


  void GetReducedNoiseFreeSignal(fftMatrices & ReceiverReducedNoiseFreeSignal);


  void ComputeCovarianceMatrixAWGN(void);


  void SetCovarianceMatrixAWGN(double OSNRdB, double B_OSA);


  void InitializeCovarianceMatrix(double TotalNoiseSpectralDensity);


   void PropagateAnalyticCWSignalNoLossNoDispersion(
        OptFiberLocalError * Fiber2,OptAmplifier * Amplifier2);


  void GetCovarianceMatrix(double ** ReceiverCovarianceMatrix,
                           bool ReadInSignalAndCovMatrixFlag,
                           double SetOSNRdB, double B_OSA);

  int GetCovMatrixDim(void) {return CovMatrixDim;};
  int GetCovMatrixFirstIndex(void) {return CovMatrixFirstIndex;};
  int GetCovMatrixLastIndex(void) {return CovMatrixLastIndex;};
  
  string GetJobName(void) {return Job;};

  double GetPropagatedLength(void) {return PropagatedLength;};

  private: 

  // ########### Private Methods ################


  void AllocateMemory(void);



  void Propagator(void);


  void ComputeColumnPropagator(int PerturbedFreqIndex,double Delta, 
                          bool RealNotImag,double TotalEnergy);



  void Perturb(int PerturbedFreqIndex,double Delta, bool RealNotImag);



  void Perturb(int PerturbedFreqIndex,double Delta, 
               bool RealNotImag, int ChannelIndex);


  void UpdateCovMatrixODE(void);  


  void ApplyArtificialDispersionCompensation(fftMatrices SignalData, 
                                             bool DisentangleFlag);



  void ComputeArtificialDispersionCompensationOperator(void);

  void AmplifyCovarianceMatrix(double LinearGain);

  void LumpedLossCovarianceMatrix(double LossLinear);

  void ComputeReducedSignal(fftMatrices Signal2,fftMatrices ReducedSignal2);


  void ApplyArtificialCentralChannelDemux(fftMatrices& PerturbationEnd);


  void RestoreChannels(fftMatrices& PerturbationEnd);

  // ########### Public Data ####################

public:
  OptSignal * Signal;

  // ########### Private Data ###################

private:

  typeNoiseMethod TypeNoiseMethod;
  typeJitterSeparation TypeJitterSeparation;
  typeJitterSeparation TypeJitterSeparationInput;
  bool AlsoRemoveZerosJitter;

  string Job;
  OptFiberLocalError * Fiber;
  OptAmplifier * Amplifier;

  double PropagatedLength;
  double PropagatedLengthSaved;
  int ZStepNum;
  int ZStepNumSaved;


  double AccumulatedFirstOrderDispersion;


  double AccumulatedSndOrderDispersion;


  double DeltaFrac;


  fftMatrices DataToPropagate;

  typeSimulation TypeSimulation;


  int SignalVecDim;


  cfftw * fft;



  int CovMatrixDim; 


  int CovMatrixFirstIndex;


  int CovMatrixLastIndex;



  cfftw * Reduced_fft;


  double **CovarianceMatrix;


  double **PropagatorMatrix;


  double **TempProductMatrix;


  double * CovarianceStorageVec;


  double * PropagatorStorageVec;


  double * TempProductStorageVec;



  fftMatrices NoiseFreeSignalStart;


  fftMatrices NoiseFreeSignalEnd;


  fftMatrices jcNoiseFreeSignalEnd;


  fftMatrices jcOmegaNoiseFreeSignalEnd;


  fftMatrices PerturbationEnd;


  fftMatrices ReducedPerturbationEnd;

  cplx * ArtificialDispersionCompensationOperator;

  fftMatrices ReducedNoiseFreeSignal;


  fftMatrices ReducedNoiseFreeSignalStorage;
 
 
  // added by Walter for WDM systems
  
  // used for the version of perturb() that allows to compute covariance
  // matrixes for each channel  
  int ChannelOfCovarianceMatrix;
  
  // data for WDM
  int NumberOfChannels;
    
  // save PerturbationEnd of WDM signal to be able to reconstruct WDM signal
  // after the jitter separation
  fftMatrices PerturbationEnd_saved;
   
};

#endif // _NOISE_COVARIANCE_