PixelCPEGeneric.h

Go to the documentation of this file.

#ifndef RecoLocalTracker_SiPixelRecHits_PixelCPEGeneric_H
#define RecoLocalTracker_SiPixelRecHits_PixelCPEGeneric_H

// \class PixelCPEGeneric  -- a generalized CPE reco for the idealized detector
//
// The basic idea of this class is to use generic formulae in order
// to achieve clean and minimal code.  It should work for
// - both normal and big pixels
// - both barrel and forward
// - both "FromDetPosition" and "FromTrackAngles" (i.e. by the track fit)
//
// This is possible since, in its nature, the original "ORCA" algorithm by
// Danek and Susana is the same in both X and Y directions, provided that
// one correctly computes angles alpha_ and beta_ up front.  Thus, all
// geometrical and special corrections are dropped, since the presumption
// is that alpha_ and beta_ are determined as best as possible.  That means
// that they either come from the track, or, if they come from the
// position of the DetUnit, they include all geometrical information
// possible for this DetUnit:
// - for both the barrel and the forward, we use the cluster position
//   instead of the center of the module/plaquette
// - for the forward, the tilt of the blades is included too
//
// In addtion, anything which is special for the computation of the lorentz
// angle is done in setTheDet() method.  So the algorithm per se does not
// need to worry about it.  This includes extra E*B term (a.k.a. "alpha2Order")
// and extra tilt in the forward.
//
// Thus, the formula for the computation of the hit position is very
// simple, and is described in Morris's note (IN ???) on the generalizaton
// of the pixel algorithm.

#include "RecoLocalTracker/SiPixelRecHits/interface/PixelCPEBase.h"
#include "CalibTracker/SiPixelESProducers/interface/SiPixelCPEGenericDBErrorParametrization.h"


// The template header files
//#include "RecoLocalTracker/SiPixelRecHits/interface/SiPixelTemplateReco.h"
#include "CondFormats/SiPixelTransient/interface/SiPixelTemplate.h"
#include "CondFormats/SiPixelTransient/interface/SiPixelGenError.h"


#include <utility>
#include <vector>

#if 0

#endif

class MagneticField;
class PixelCPEGeneric final : public PixelCPEBase
{
public:
   struct ClusterParamGeneric : ClusterParam
   {
      ClusterParamGeneric(const SiPixelCluster & cl) : ClusterParam(cl){}
      // The truncation value pix_maximum is an angle-dependent cutoff on the
      // individual pixel signals. It should be applied to all pixels in the
      // cluster [signal_i = fminf(signal_i, pixmax)] before the column and row
      // sums are made. Morris
      int pixmx;
      
      // These are errors predicted by PIXELAV
      float sigmay; // CPE Generic y-error for multi-pixel cluster
      float sigmax; // CPE Generic x-error for multi-pixel cluster
      float sy1   ; // CPE Generic y-error for single single-pixel
      float sy2   ; // CPE Generic y-error for single double-pixel cluster
      float sx1   ; // CPE Generic x-error for single single-pixel cluster
      float sx2   ; // CPE Generic x-error for single double-pixel cluster
      
      // These are irradiation bias corrections
      float deltay; // CPE Generic y-bias for multi-pixel cluster
      float deltax; // CPE Generic x-bias for multi-pixel cluster
      float dy1   ; // CPE Generic y-bias for single single-pixel cluster
      float dy2   ; // CPE Generic y-bias for single double-pixel cluster
      float dx1   ; // CPE Generic x-bias for single single-pixel cluster
      float dx2   ; // CPE Generic x-bias for single double-pixel cluster
   };
   
   PixelCPEGeneric(edm::ParameterSet const& conf, const MagneticField *,
                   const TrackerGeometry&, const TrackerTopology&, const SiPixelLorentzAngle *,
                   const SiPixelGenErrorDBObject *, const SiPixelLorentzAngle *);
   
   ~PixelCPEGeneric() override {;}
   
   
   
private:
   ClusterParam * createClusterParam(const SiPixelCluster & cl) const override;
   
   LocalPoint localPosition (DetParam const & theDetParam, ClusterParam & theClusterParam) const override;
   LocalError localError   (DetParam const & theDetParam, ClusterParam & theClusterParam) const override;
   
   //--------------------------------------------------------------------
   //  Methods.
   //------------------------------------------------------------------
   float
   generic_position_formula( int size,                
                            int Q_f,              
                            int Q_l,              
                            float upper_edge_first_pix, 
                            float lower_edge_last_pix,  
                            float lorentz_shift,   
                            float theThickness,   //detector thickness
                            float cot_angle,            
                            float pitch,            
                            bool first_is_big,       
                            bool last_is_big,        
                            float eff_charge_cut_low, 
                            float eff_charge_cut_high,
                            float size_cut           
   ) const;
   
   void
   collect_edge_charges(ClusterParam & theClusterParam,  
                        int & Q_f_X,              
                        int & Q_l_X,              
                        int & Q_f_Y,              
                        int & Q_l_Y               
   ) const;
   
   
   //--- Errors squared in x and y.  &&& Need to be revisited.
   float err2X(bool&, int&) const;
   float err2Y(bool&, int&) const;
   
   //--- Cuts made externally settable
   float the_eff_charge_cut_lowX;
   float the_eff_charge_cut_lowY;
   float the_eff_charge_cut_highX;
   float the_eff_charge_cut_highY;
   float the_size_cutX;
   float the_size_cutY;
   
   bool inflate_errors;
   bool inflate_all_errors_no_trk_angle;
   
   bool UseErrorsFromTemplates_;
   bool DoCosmics_;
   //bool LoadTemplatesFromDB_;
   bool TruncatePixelCharge_;
   bool IrradiationBiasCorrection_;
   bool isUpgrade_;
   
   float EdgeClusterErrorX_;
   float EdgeClusterErrorY_;
   
   std::vector<float> xerr_barrel_l1_,yerr_barrel_l1_,xerr_barrel_ln_;
   std::vector<float> yerr_barrel_ln_,xerr_endcap_,yerr_endcap_;
   float xerr_barrel_l1_def_, yerr_barrel_l1_def_,xerr_barrel_ln_def_;
   float yerr_barrel_ln_def_, xerr_endcap_def_, yerr_endcap_def_;
   
   //--- DB Error Parametrization object, new light templates 
   std::vector< SiPixelGenErrorStore > thePixelGenError_;
   //SiPixelCPEGenericDBErrorParametrization * genErrorsFromDB_;
   
};

#endif