ClusterSummary.h

Go to the documentation of this file.

// -*- C++ -*-
//
// Package:    ClusterSummary
// Class:      ClusterSummary
// 
//
// Original Author:  Michael Segala
//         Created:  Wed Feb 23 17:36:23 CST 2011
// $Id: ClusterSummary.h,v 1.6 2012/10/04 13:25:29 venturia Exp $
//
//

#ifndef CLUSTERSUMMARY
#define CLUSTERSUMMARY

// system include files
#include <memory>
#include <string>
#include <map>
#include <vector>
#include<iostream>
#include <string.h>
#include <sstream>
#include "FWCore/Utilities/interface/Exception.h"

// user include files

#include "FWCore/Framework/interface/Frameworkfwd.h"
#include "DataFormats/SiStripCluster/interface/SiStripCluster.h"
#include "DataFormats/SiStripDigi/interface/SiStripDigi.h"
#include "DataFormats/SiPixelCluster/interface/SiPixelCluster.h"
#include "DataFormats/Common/interface/DetSetVectorNew.h"


#include "RecoLocalTracker/SiStripClusterizer/interface/SiStripClusterInfo.h"
#include "DataFormats/SiStripDigi/interface/SiStripProcessedRawDigi.h"
#include "DataFormats/Common/interface/DetSetVector.h"

#include "DataFormats/SiStripDetId/interface/StripSubdetector.h"
#include "DataFormats/DetId/interface/DetId.h" 
#include "DataFormats/SiStripDetId/interface/TIBDetId.h"
#include "DataFormats/SiStripDetId/interface/TOBDetId.h"
#include "DataFormats/SiStripDetId/interface/TIDDetId.h"
#include "DataFormats/SiStripDetId/interface/TECDetId.h"
#include "DataFormats/SiPixelDetId/interface/PXBDetId.h"
#include "DataFormats/SiPixelDetId/interface/PXFDetId.h"
#include "DataFormats/SiPixelDetId/interface/PixelSubdetector.h"
#include "DataFormats/SiPixelDetId/interface/PixelBarrelName.h"
#include "Geometry/TrackerGeometryBuilder/interface/PixelGeomDetUnit.h"
#include "Geometry/TrackerGeometryBuilder/interface/PixelGeomDetType.h"

/*****************************************************************************************

How to use ClusterSummary class:

ClusterSummary provides summary inforation for a number of cluster dependent variables.
All the variables are stored within variables_
The modules selected are stored within modules_
The number of variables for each module is stored within iterator_

[If putting ClusterSummary into producer]

1) In beginJob() of Producer, set the method   

  Cluster.SetUserContent(v_userContent);
  Cluster.SetUserIterator();

  where v_userContent is a vector of strings of the varibales you are getting info on
   

2) In produce() of Prodcuer, fill the output vectors

   // Tell ClusterSummary which Tracker Partitions you want summary information from
   Cluster.SetUserModules( mod ) 


   //Fill generic vector to hold any variables. You can fill the vector based on the name of the variables or the location of the variable within userContent
   cCluster.SetGenericVariable( "sHits", mod_pair2, 1 );
   cCluster.SetGenericVariable( "sSize", mod_pair2, Summaryinfo.clusterSize() );
   cCluster.SetGenericVariable( "sCharge", mod_pair2, Summaryinfo.charge() );


   // Once the loop over all detIds have finsihed fill the Output vectors
   Cluster.SetUserVariables( mod );


  // Dont forget to clear all the vectors and arrays at end of each event




[If putting reading back ClusterSummary from anlayzer]

   You can access all the summary vectors in the following way

   Handle< ClusterSummary  > class_;
   iEvent.getByLabel( _class, class_);
      
   genericVariables_ = class_ -> GetGenericVariable();   

   //You can access the variables by genericVariables_[i][j] where 'i' is the order in which the variable was stored, see enum VariablePlacement
   cout << genericVariables_[0][1] << endl;
   cout << genericVariables_[1][1]/genericVariables_[0][1] << endl;
   cout << genericVariables_[2][2]/genericVariables_[0][2] << endl;

   --or--
   
   //You can access the variables by the variable and partition name.
   cout << class_ -> GetGenericVariable("cHits", ClusterSummary::TIB) << endl;
   cout << class_ -> GetGenericVariable("cSize", ClusterSummary::TIB)/class_ -> GetGenericVariable("cHits", ClusterSummary::TIB) << endl;
   cout << class_ -> GetGenericVariable("cCharge", ClusterSummary::TOB)/class_ -> GetGenericVariable("cHits", ClusterSummary::TOB) << endl;




********************************************************************************************/


class ClusterSummary {

 public:
  
  ClusterSummary():genericVariablesTmp_(6, std::vector<double>(100,0) ){}

  // Enum for each partition within Tracer
  enum CMSTracker { TRACKER = 0,
            TIB = 1,
            TIB_1 = 11, TIB_2 = 12, TIB_3 = 13, TIB_4 = 14, //TIB layer 1-4
            TOB = 2,
            TOB_1 = 21, TOB_2 = 22, TOB_3 = 23, TOB_4 = 24, TOB_5 = 25, TOB_6 = 26,  //TOB layer 1-6
            TID = 3,
            TIDM = 31, TIDP = 32,  //TID minus and plus
            TIDM_1 = 311, TIDM_2 = 312, TIDM_3 = 313, //TID minus layer 1-3
            TIDP_1 = 321, TIDP_2 = 322, TIDP_3 = 323, //TID plus layer 1-3
            TIDMR_1 = 3110, TIDMR_2 = 3120, TIDMR_3 = 3130, //TID minus ring 1-3
            TIDPR_1 = 3210, TIDPR_2 = 3220, TIDPR_3 = 3230, //TID plus ring 1-3
            TEC = 4,
            TECM = 41, TECP = 42,  //TEC minus and plus
            TECM_1 = 411, TECM_2 = 412, TECM_3 = 413, TECM_4 = 414, TECM_5 = 415, TECM_6 = 416, TECM_7 = 417, TECM_8 = 418, TECM_9 = 419, //TEC minus layer 1-9
            TECP_1 = 421, TECP_2 = 422, TECP_3 = 423, TECP_4 = 424, TECP_5 = 425, TECP_6 = 426, TECP_7 = 427, TECP_8 = 428, TECP_9 = 429, //TEC plus layer 1-9 
            TECMR_1 = 4110, TECMR_2 = 4120, TECMR_3 = 4130, TECMR_4 = 4140, TECMR_5 = 4150, TECMR_6 = 4160, TECMR_7 = 4170, //TEC minus ring 1-9
            TECPR_1 = 4210, TECPR_2 = 4220, TECPR_3 = 4230, TECPR_4 = 4240, TECPR_5 = 4250, TECPR_6 = 4260, TECPR_7 = 4270, //TEC plus ring 1-9
            //PIXELS
            PIXEL = 5,
            FPIX = 6, // Pixel endcaps
            FPIX_1 = 61,FPIX_2 = 62,FPIX_3 = 63, // Endcaps disks 1-3
            FPIXM = 611, FPIXP = 612,  // Pixel endcaps minus and plus side
            FPIXM_1 = 6110, FPIXM_2 = 6120, FPIXM_3 = 6130, // Endcap minus disk 1-3  
            FPIXP_1 = 6210, FPIXP_2 = 6220, FPIXP_3 = 6230, // Endcap plus disk 1-3  
            BPIX = 7, //Pixel barrel
            BPIX_1 = 71, BPIX_2 = 72, BPIX_3 = 73 //Pixel barrel layer 1-3
        
  };

  // Enum which describes the ordering of the summary variables inside vector variables_
  enum VariablePlacement{ NMODULES = 0,
              CLUSTERSIZE = 1,
              CLUSTERCHARGE = 2,
              NMODULESPIXELS = 3,
              CLUSTERSIZEPIXELS = 4,
              CLUSTERCHARGEPIXELS = 5};
 

  //===================+++++++++++++========================
  //
  //                 Main methods to fill 
  //                      Variables
  //
  //===================+++++++++++++========================

  
  //Get value of any variable given location of the variable within userContent and the module number based on enum CMSTracker
  double GetGenericVariable( int variableLocation, int module ) const { 
    return GetModuleLocation(module) < 0  ? 0. : genericVariables_[variableLocation][GetModuleLocation(module)]; }

  //Get value of any variable given variable name and the module number based on enum CMSTracker
  double GetGenericVariable( std::string variableName, int module ) const { 

    int position = GetVariableLocation(variableName);
    int mposition = GetModuleLocation(module);

    return mposition < 0 ? 0. : genericVariables_[position][mposition];    
  }

  //Get specific varibale for all modules using the variable name
  std::vector<double> GetGenericVariable( std::string variableName ) const {     
    return genericVariables_[GetVariableLocation(variableName)];
  }

  //Get specific varibale for all modules using the location of the variable within userContent
  std::vector<double> GetGenericVariable( int variableLocation ) const {     
    return genericVariables_[variableLocation];
  }

  //Get the vector genericVariables_
  std::vector< std::vector<double> > GetGenericVariable() const { return genericVariables_; }  

  //Set the vector genericVariables_ based on the location of the variable within userContent and the module number based on enum CMSTracker
  void SetGenericVariable( int variableLocation, int module, double value ) { 
    if(GetModuleLocation(module) >=0) genericVariablesTmp_[variableLocation][GetModuleLocation(module)] += value; } 

  //Set the vector genericVariables_ given the variable name and the module number based on enum CMSTracker
  void SetGenericVariable( std::string variableName, int module, double value ) { 
    
    /*
      genericVariablesTmp[ variable ][ module ]
      
      This will fill the values in the order as they are filled in the produced.
      
      1) Find where the variableName lives in userContent
      2) Find where module lives in modules_

    */

    int position = GetVariableLocation(variableName);
    int mposition = GetModuleLocation(module);

    if(mposition >=0) genericVariablesTmp_[position][mposition] += value;    
  } 

  //Prepair the final vector to be put into the producer. Remove any remaining 0's and copy the Tmp to the vector over to genericVariables_. Must be done at the end of each event.
  void PrepairGenericVariable() { 
    
    genericVariables_ = genericVariablesTmp_;
    
    for (unsigned int i = 0; i < userContent.size(); ++i){
      genericVariables_[i].erase(std::remove(genericVariables_[i].begin(), genericVariables_[i].end(), 0), genericVariables_[i].end());
    }
  } 

  //Clear genericVariablesTmp_. Must be done at the end of each event.
  void ClearGenericVariable() { 
    
    //genericVariablesTmp_.clear();

    for (unsigned int i = 0; i < genericVariablesTmp_.size(); ++i){
      for (unsigned int j = 0; j < genericVariablesTmp_[i].size(); ++j){
    genericVariablesTmp_[i][j] = 0;
      }
    }    
  } 



  // Setter and Getter for the User Content. You can also return the size and what is stored in the UserContent 
  void SetUserContent(std::vector<std::string> Content)  const { userContent = Content;}
  std::vector<std::string> GetUserContent()  { return userContent;}
  int GetUserContentSize()  { return userContent.size(); }
  void  GetUserContentInfo() const  { 
    std::cout << "Saving info for " ;
    for (unsigned int i = 0; i < userContent.size(); ++i){ std::cout << userContent.at(i) << " " ;}
    std::cout << std::endl;
  }
  int GetVariableLocation ( std::string var ) const;


  //Set and Get modules_
  void SetUserModules( int value ) { modules_.push_back( value ); }
  std::vector<int> GetUserModules( ) const { return modules_;  }
  void ClearUserModules( ) { modules_.clear(); }
  // Return the location of desired module within modules_. 
  int GetModuleLocation ( int mod ) const;


  //Set and Get iterator_
  void SetUserIterator() { iterator_.push_back( GetUserContentSize()  );}
  std::vector<int> GetUserIterator() const { return iterator_; }
  void ClearUserIterator() { iterator_.clear(); }
    
  // Return a vector of the modules that summary infomation was requested for. This should come from the provenance information. 
  std::vector<std::string> DecodeProvInfo(std::string ProvInfo) const;

  // Class which determines if a detId is part of a desired partition
  class ModuleSelection{
  public:
    ModuleSelection(std::string gs);
    virtual ~ModuleSelection();
    virtual std::pair<int,int> IsStripSelected (int DetId);
    virtual std::pair<int,int> IsPixelSelected (int DetId);
  private:
    std::string geosearch; // string of selected modules    
  };




 private:
  

  // String which stores the name of the variables the user is getting the summary info for
  mutable std::vector<std::string>        userContent;

  std::vector<int>    iterator_;   // <number of varibale for Module1, number of varibale for Module2 ...>
  std::vector<int>    modules_;    // <Module1, Module2 ...>

  std::vector< std::vector<double> > genericVariables_; 
  mutable std::vector< std::vector<double> > genericVariablesTmp_; 

};


#endif