ocsHistogram2D.hh

Go to the documentation of this file.

// $Id: ocsHistogram2D.hh,v 1.3 2008/08/08 02:20:44 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_HISTOGRAM_2D_HH_
#define  _OCS_HISTOGRAM_2D_HH_

#include "ocsOptSignal.hh"
#include "ocsPhotodetector.hh"

class Histogram2D
{

public:


  Histogram2D(string InFileName,float x_min2,float x_max2,
                                float y_min2, float y_max2);


  void InitializeParameters(void);


  Histogram2D(string InFileName);

  // Note: The following method should really belong to a derived 
  // EyeDiagram class of the Histogram2D class.


  Histogram2D(string InFileName,OptSignal *oOptSignal);


  Histogram2D(Histogram2D & OrigHist);


  Histogram2D & operator=(Histogram2D & RHSHist);


  ~Histogram2D();

  void Clear();


  void SetMaxX(double x_max2); 
 

  void SetMaxY(double y_max2); 
 
  void SetMinMaxXY(double x_min2, double x_max2,
                   double y_min2, double y_max2);
  
 float GetMaxX(void) {return x_max;};
   
 float GetMaxY(void) {return y_max;};

 float GetMinX(void) {return x_min;};
 float GetMinY(void) {return y_min;};

 float GetDeltaX(void) {return delta_x;};
 float GetDeltaY(void) {return delta_y;};
 int GetNumBinsX(void) {return NumBinsX;};
 int GetNumBinsY(void) {return NumBinsX;};


  float GetSamplesMaxX(void) {return SamplesMaxX;};


  float GetSamplesMaxY(void) {return SamplesMaxY;}; 


  void SetBin(int x_index, int y_index, double value);
  
  double GetBin(int x_index, int y_index);
  double GetBinSquare(int x_index, int y_index);  
  int GetIndex(int x_index, int y_index)
     { return   y_index + NumBinsY*x_index;};   


  double Get_pdfConfidence(int x_index, int y_index);


  void ObtainConfidence(void);
  
  int GetQtSamplesBin(int x_index, int y_index);

  void IncrementBin(int x_index, int y_index, double LikelihoodRatio);


  int GetQtSamples(void) {return NumSamplesTotal;}; 


  void AddSample(double x, double y);


  void AddSample(double x, double y, double LikelihoodRatio);  


  
  void WriteFile_pdf2D(string OutFileName);

  double GetMeanX(void);

  double GetMeanY(void);



  void UpdateEyeDiagram(OptSignal *oOptSignal,Photodetector *oPhotodetector);


  void WriteEyeDiagramHistogram(string OutFileName);


  void MultipleSelectMaxRelNumHitsImport(string InFileName,
                                         int Convert2dB_Scale);                                  
  void GetLevelCurvesMultipleSelectMaxRelNumHitsImport(string InFileName,
                                               int Convert2dB_Scale,
                                               int CosnvertParam2dB_Scale);


  void MultipleHeuristicBalanceImport(string InFileName,
                                       int Convert2dB_Scale);

  void MergeMultipleConditionalHeuristicBalance(string InFileName,
                                                double z_min, double z_max,
                                                int Convert2dB_Scale);

  void MergeMultipleConditionalHeuristicBalance(string InFileName,
                                                double z_min, double z_max,
                                                double w_min, double w_max,
                                                int Convert2dB_Scale);


   void GetLevelCurvesMultipleHeuristicBalanceImport(string InFileName,
                                                  int Convert2dB_Scale,
                                                  int ConvertParam2dB_Scale);
                                                  
   void GetLevelCurvesMultipleHeuristicBalanceImportVarianceWeighted(
                                                  string InFileName,
                                                  int Convert2dB_Scale,
                                                  int ConvertParam2dB_Scale);



   void ComputePDFfromHistogram(void);


   void NormalizePDF(void);


   void SetPDF(int x_index, int y_index, double value);


   double GetPDF(int x_index, int y_index);

   void ComputeXMarginalPDF(void);
   void ComputeYMarginalPDF(void);

   double ComputeIntegralPDF(void);
   double ComputeMeanX_PDF(void);
   double ComputeMeanY_PDF(void);


   double GetMaxPDF(void);
 

   double SetPDFToZeroBelowThreshold(double Threshold);


   void GaussianPDF(double mean_x, double mean_y, double std);


   void WritePDF(string OutFileName);

   double BilinearInterpolationPDF(double x, double y);


   void RotatePDF(double CenterX, double CenterY, double Angle, 
                  double *OutData);

public:


  double * PDF;

private:

  // Parameters describing physical domain of pdf


  float x_min;



  float x_max;


  float y_min;


  float y_max;
 
  float x_window_size,y_window_size;


  int NumBinsX;



  int  NumBinsY;

  float delta_x, delta_y;
  

  double * Bin;
  int *qtSamplesBin;
  
  double * BinSquare;
  double * pdfConfidence;
  bool PreviouslyComputed_pdfConfidenceFlag;

  // Data to manipulate PDFs

  double * XData;
  double * YData;
  double * XMarginal;
  double * YMarginal;


  // Parameters relating to statistics of pdf

  int NumSamplesTotal;
  int NumSamplesInRange;
  int NumSamplesWithOutOfRangeX;
  int NumSamplesWithOutOfRangeY;

  // Used to determine size of physical grid for later runs


  float SamplesMinX; 


  float SamplesMaxX;


  float SamplesMinY; 


  float SamplesMaxY;

  
  string HistInFileName; 

  double MeanX;
  double MeanY;

};

#endif /*  _OCS_HISTOGRAM_2D_HH_ */