helper::ScannerBase Class Reference

#include <ScannerHelpers.h>

Public Member Functions
bool	addExpression (const char *expr)
bool	addExtraCut (const char *cut)
	Add one extra cut that can be evaluated separately (as if it was an expression) More...
void	clearCut ()
	Clear the default cut. More...
void	clearExpressions ()
	Clear all the expressions. More...
void	clearExtraCuts ()
	Clear all extra cuts ;. More...
double	eval (const void *obj, size_t iexpr=0) const
void	fill1D (const void *obj, TH1 *hist) const
void	fill2D (const void *obj, TH2 *hist2d) const
void	fillGraph (const void *obj, TGraph *graph) const
void	fillProf (const void *obj, TProfile *prof) const
size_t	numberOfExpressions () const
	Number of valid expressions. More...
size_t	numberOfExtraCuts () const
	Number of extra cuts. More...
void	print (const void *obj) const
	ScannerBase ()
	Empty constructor, necessary for Root, DO NOT USE. More...
	ScannerBase (const edm::TypeWithDict &objType)
	Constructor taking as argument the type of the individual object passed to the scanner. More...
bool	setCut (const char *cut)
	Set the default cut that is applied to the events. More...
void	setIgnoreExceptions (bool ignoreThem)
bool	test (const void *obj, size_t icut=0) const

Private Attributes
std::vector< reco::parser::SelectorPtr >	cuts_
	The first one is the default cut, the others are the extra ones. More...
std::vector< reco::parser::ExpressionPtr >	exprs_
bool	ignoreExceptions_
	See setIgnoreExceptions to find out what this means. More...
edm::TypeWithDict	objType_

Detailed Description

Class helper::ScannerBase: tool to print or histogram proprieties of an object using the dictionary, The class is generic, but each instance is restricted to the type of the objects to inspect, fixed at construction time.

Definition at line 44 of file ScannerHelpers.h.

Constructor & Destructor Documentation

ScannerBase() [1/2]

helper::ScannerBase::ScannerBase ( )

inline

Empty constructor, necessary for Root, DO NOT USE.

Definition at line 47 of file ScannerHelpers.h.

{}

ScannerBase() [2/2]

helper::ScannerBase::ScannerBase ( const edm::TypeWithDict &  objType )

inline

Constructor taking as argument the type of the individual object passed to the scanner.

Definition at line 49 of file ScannerHelpers.h.

: objType_(objType), cuts_(1), ignoreExceptions_(false) {}

Member Function Documentation

addExpression()

bool helper::ScannerBase::addExpression

(

const char *

expr

)

Add an expression to be evaluated on the objects Returns false if the parsing failed

Definition at line 67 of file ScannerHelpers.cc.

References EcnaPython_AdcPeg12_S1_10_R170298_1_0_150_Dee0::cerr, jetsAK8_cff::expr, helper::Parser::makeExpression(), and convertSQLiteXML::ok.

Referenced by fwlite::Scanner< Collection >::draw(), fwlite::Scanner< Collection >::draw2D(), fwlite::Scanner< Collection >::drawGraph(), fwlite::Scanner< Collection >::drawProf(), fwlite::Scanner< Collection >::fillDataSet(), and fwlite::Scanner< Collection >::scan().

                                                      {
  bool ok = true;
  exprs_.push_back(helper::Parser::makeExpression(expr, objType_));
  if (exprs_.back().get() == nullptr) {
    std::cerr << "Failed to parse expression " << expr << std::endl;
    exprs_.pop_back();
    ok = false;
  }
  return ok;
}

addExtraCut()

bool helper::ScannerBase::addExtraCut

(

const char *

cut

)

Add one extra cut that can be evaluated separately (as if it was an expression)

Definition at line 92 of file ScannerHelpers.cc.

References EcnaPython_AdcPeg12_S1_10_R170298_1_0_150_Dee0::cerr, PA_MinBiasSkim_cff::cut, helper::Parser::makeSelector(), and convertSQLiteXML::ok.

Referenced by fwlite::Scanner< Collection >::fillDataSet().

                                                   {
  bool ok = true;
  cuts_.push_back(helper::Parser::makeSelector(cut, objType_));
  if (!cuts_.back().get()) {
    std::cerr << "Failed to add cut \"" << cut << "\"" << std::endl;
    ok = false;
    cuts_.pop_back();
  }
  return ok;
}

clearCut()

void helper::ScannerBase::clearCut

(

)

Clear the default cut.

Definition at line 88 of file ScannerHelpers.cc.

{ cuts_[0].reset(); }

clearExpressions()

void helper::ScannerBase::clearExpressions ( )

inline

Clear all the expressions.

Definition at line 55 of file ScannerHelpers.h.

References exprs_.

{ exprs_.clear(); }

clearExtraCuts()

void helper::ScannerBase::clearExtraCuts

(

)

Clear all extra cuts ;.

Definition at line 90 of file ScannerHelpers.cc.

{ cuts_.resize(1); }

eval()

double helper::ScannerBase::eval	(	const void *	obj,
		size_t	iexpr = 0
	)		const

Evaluate one of the expressions set in this scanner Obj must point to an object of the type used to construct this ScannerBase

Definition at line 118 of file ScannerHelpers.cc.

References EcnaPython_AdcPeg12_S1_10_R170298_1_0_150_Dee0::cerr, cppFunctionSkipper::exception, getGTfromDQMFile::obj, and relativeConstraints::value.

Referenced by fwlite::Scanner< Collection >::draw2D(), and fwlite::Scanner< Collection >::fillDataSet().

                                                                  {
  try {
    edm::ObjectWithDict obj(objType_, const_cast<void *>(ptr));
    if (exprs_.size() > iexpr)
      return exprs_[iexpr]->value(obj);
  } catch (std::exception &ex) {
    if (!ignoreExceptions_)
      std::cerr << "Caught exception " << ex.what() << std::endl;
  }
  return 0;
}

fill1D()

void helper::ScannerBase::fill1D	(	const void *	obj,
		TH1 *	hist
	)		const

Fill the histogram with the first expression evaluated on the object, if it passes the default cut Obj must point to an object of the type used to construct this ScannerBase

Definition at line 179 of file ScannerHelpers.cc.

References EcnaPython_AdcPeg12_S1_10_R170298_1_0_150_Dee0::cerr, cppFunctionSkipper::exception, gpuVertexFinder::hist, and getGTfromDQMFile::obj.

Referenced by fwlite::Scanner< Collection >::draw().

                                                               {
  edm::ObjectWithDict obj(objType_, const_cast<void *>(ptr));
  if ((cuts_[0].get() == nullptr) || (*cuts_[0])(obj)) {
    try {
      if (!exprs_.empty())
        hist->Fill(exprs_[0]->value(obj));
    } catch (std::exception &ex) {
      if (!ignoreExceptions_)
        std::cerr << "Caught exception " << ex.what() << std::endl;
    }
  }
}

fill2D()

void helper::ScannerBase::fill2D	(	const void *	obj,
		TH2 *	hist2d
	)		const

Fill the histogram with (x,y) equal to the first and second expressions evaluated on the object, if it passes the default cut Obj must point to an object of the type used to construct this ScannerBase

Definition at line 192 of file ScannerHelpers.cc.

References EcnaPython_AdcPeg12_S1_10_R170298_1_0_150_Dee0::cerr, cppFunctionSkipper::exception, gpuVertexFinder::hist, and getGTfromDQMFile::obj.

Referenced by fwlite::Scanner< Collection >::draw2D().

                                                               {
  edm::ObjectWithDict obj(objType_, const_cast<void *>(ptr));
  if ((cuts_[0].get() == nullptr) || (*cuts_[0])(obj)) {
    try {
      if (exprs_.size() >= 2)
        hist->Fill(exprs_[0]->value(obj), exprs_[1]->value(obj));
    } catch (std::exception &ex) {
      if (!ignoreExceptions_)
        std::cerr << "Caught exception " << ex.what() << std::endl;
    }
  }
}

fillGraph()

void helper::ScannerBase::fillGraph	(	const void *	obj,
		TGraph *	graph
	)		const

Fill the graph with (x,y) equal to the first and second expressions evaluated on the object, if it passes the default cut Obj must point to an object of the type used to construct this ScannerBase

Definition at line 205 of file ScannerHelpers.cc.

References EcnaPython_AdcPeg12_S1_10_R170298_1_0_150_Dee0::cerr, cppFunctionSkipper::exception, and getGTfromDQMFile::obj.

Referenced by fwlite::Scanner< Collection >::drawGraph().

                                                                      {
  edm::ObjectWithDict obj(objType_, const_cast<void *>(ptr));
  if ((cuts_[0].get() == nullptr) || (*cuts_[0])(obj)) {
    try {
      if (exprs_.size() >= 2)
        graph->SetPoint(graph->GetN(), exprs_[0]->value(obj), exprs_[1]->value(obj));
    } catch (std::exception &ex) {
      if (!ignoreExceptions_)
        std::cerr << "Caught exception " << ex.what() << std::endl;
    }
  }
}

fillProf()

void helper::ScannerBase::fillProf	(	const void *	obj,
		TProfile *	prof
	)		const

Fill the profile histogram with (x,y) equal to the first and second expressions evaluated on the object, if it passes the default cut Obj must point to an object of the type used to construct this ScannerBase

Definition at line 218 of file ScannerHelpers.cc.

References EcnaPython_AdcPeg12_S1_10_R170298_1_0_150_Dee0::cerr, cppFunctionSkipper::exception, gpuVertexFinder::hist, and getGTfromDQMFile::obj.

Referenced by fwlite::Scanner< Collection >::drawProf().

                                                                      {
  edm::ObjectWithDict obj(objType_, const_cast<void *>(ptr));
  if ((cuts_[0].get() == nullptr) || (*cuts_[0])(obj)) {
    try {
      if (exprs_.size() >= 2)
        hist->Fill(exprs_[0]->value(obj), exprs_[1]->value(obj));
    } catch (std::exception &ex) {
      if (!ignoreExceptions_)
        std::cerr << "Caught exception " << ex.what() << std::endl;
    }
  }
}

numberOfExpressions()

size_t helper::ScannerBase::numberOfExpressions ( ) const

inline

Number of valid expressions.

Definition at line 57 of file ScannerHelpers.h.

References exprs_.

{ return exprs_.size(); }

numberOfExtraCuts()

size_t helper::ScannerBase::numberOfExtraCuts ( ) const

inline

Number of extra cuts.

Definition at line 68 of file ScannerHelpers.h.

References cuts_.

{ return cuts_.size() - 1; }

print()

void helper::ScannerBase::print

(

const void *

obj

)

const

Print out in a single row all the expressions for this object Obj must point to an object of the type used to construct this ScannerBase

Definition at line 130 of file ScannerHelpers.cc.

References EcnaPython_AdcPeg12_S1_10_R170298_1_0_150_Dee0::cerr, gather_cfg::cout, cppFunctionSkipper::exception, getGTfromDQMFile::obj, runTheMatrix::ret, mps_setup::stdout, and heppy_batch::val.

Referenced by fwlite::Scanner< Collection >::scan().

                                                   {
  edm::ObjectWithDict obj(objType_, const_cast<void *>(ptr));
  if ((cuts_[0].get() == nullptr) || (*cuts_[0])(obj)) {
    for (std::vector<reco::parser::ExpressionPtr>::const_iterator it = exprs_.begin(), ed = exprs_.end(); it != ed;
         ++it) {
      if (ptr == nullptr || it->get() == nullptr) {
        printf(" : %8s", "#ERR");
      } else {
        try {
          double val = (*it)->value(obj);
          // I found no easy ways to enforce a fixed width from printf that works also with leading zeroes or large exponents (e.g. 1e15 or 1e101)
          // So we have to go the ugly way
          char buff[255];
          int len = sprintf(buff, " : % 8.6g", val);  // this is usually ok, and should be 3+8 chars long
          if (len == 3 + 8) {
            std::cout << buff;
          } else {
            if (strchr(buff, 'e')) {
              printf((len == 3 + 13 ? " :  % .0e" : " : % .1e"), val);
            } else {
              printf("%11.11s", buff);
            }
          }
        } catch (std::exception &ex) {
          printf(" : %8s", "EXCEPT");
          if (!ignoreExceptions_)
            std::cerr << "Caught exception " << ex.what() << std::endl;
        }
      }
    }
    for (std::vector<reco::parser::SelectorPtr>::const_iterator it = cuts_.begin() + 1, ed = cuts_.end(); it != ed;
         ++it) {
      if (ptr == nullptr || it->get() == nullptr) {
        printf(" : %8s", "#ERR");
      } else {
        try {
          int ret = (*it)->operator()(obj);
          printf(" : %8d", ret);
        } catch (std::exception &ex) {
          printf(" : %8s", "EXCEPT");
          if (!ignoreExceptions_)
            std::cerr << "Caught exception " << ex.what() << std::endl;
        }
      }
    }
    fflush(stdout);
  }
}

setCut()

bool helper::ScannerBase::setCut

(

const char *

cut

)

Set the default cut that is applied to the events.

Definition at line 78 of file ScannerHelpers.cc.

References EcnaPython_AdcPeg12_S1_10_R170298_1_0_150_Dee0::cerr, PA_MinBiasSkim_cff::cut, helper::Parser::makeSelector(), and convertSQLiteXML::ok.

Referenced by fwlite::Scanner< Collection >::count(), fwlite::Scanner< Collection >::draw(), fwlite::Scanner< Collection >::draw2D(), fwlite::Scanner< Collection >::drawGraph(), fwlite::Scanner< Collection >::drawProf(), fwlite::Scanner< Collection >::fillDataSet(), fwlite::ObjectCountSelector< Collection >::ObjectCountSelector(), fwlite::Scanner< Collection >::scan(), and fwlite::ObjectCountSelector< Collection >::setCut().

                                              {
  bool ok = true;
  cuts_[0] = helper::Parser::makeSelector(cut, objType_);
  if (strlen(cut) && !cuts_[0].get()) {
    std::cerr << "Failed to set cut \"" << cut << "\"" << std::endl;
    ok = false;
  }
  return ok;
}

setIgnoreExceptions()

void helper::ScannerBase::setIgnoreExceptions ( bool  ignoreThem )

inline

If set to true, exceptions are silently ignored: test will return 'false', and 'eval' will return 0. If left to the default value, false, for each exception a printout is done.

Definition at line 100 of file ScannerHelpers.h.

References ignoreExceptions_.

Referenced by fwlite::Scanner< Collection >::count(), fwlite::Scanner< Collection >::draw(), fwlite::Scanner< Collection >::draw2D(), fwlite::Scanner< Collection >::drawGraph(), fwlite::Scanner< Collection >::drawProf(), fwlite::Scanner< Collection >::fillDataSet(), fwlite::ObjectCountSelector< Collection >::ObjectCountSelector(), fwlite::Scanner< Collection >::scan(), and fwlite::ObjectCountSelector< Collection >::setIgnoreExceptions().

{ ignoreExceptions_ = ignoreThem; }

test()

bool helper::ScannerBase::test	(	const void *	obj,
		size_t	icut = 0
	)		const

Check if the object passes the default cut (icut=0) or any extra cut (icut = 1 .. numberOfExtraCuts) Obj must point to an object of the type used to construct this ScannerBase

Definition at line 103 of file ScannerHelpers.cc.

References EcnaPython_AdcPeg12_S1_10_R170298_1_0_150_Dee0::cerr, cppFunctionSkipper::exception, and getGTfromDQMFile::obj.

Referenced by fwlite::ObjectCountSelector< Collection >::accept(), fwlite::Scanner< Collection >::count(), fwlite::Scanner< Collection >::draw2D(), fwlite::Scanner< Collection >::fillDataSet(), edmIntegrityCheck.IntegrityCheck::report(), fwlite::Scanner< Collection >::scan(), and edmIntegrityCheck.IntegrityCheck::structured().

                                                               {
  if (icut >= cuts_.size())
    return false;
  if (cuts_[icut].get() == nullptr)
    return true;
  try {
    edm::ObjectWithDict obj(objType_, const_cast<void *>(ptr));
    return (*cuts_[icut])(obj);
  } catch (std::exception &ex) {
    if (!ignoreExceptions_)
      std::cerr << "Caught exception " << ex.what() << std::endl;
    return false;
  }
}

Member Data Documentation

cuts_

std::vector<reco::parser::SelectorPtr> helper::ScannerBase::cuts_

private

The first one is the default cut, the others are the extra ones.

Definition at line 107 of file ScannerHelpers.h.

Referenced by numberOfExtraCuts().

exprs_

std::vector<reco::parser::ExpressionPtr> helper::ScannerBase::exprs_

private

Definition at line 104 of file ScannerHelpers.h.

Referenced by clearExpressions(), and numberOfExpressions().

ignoreExceptions_

bool helper::ScannerBase::ignoreExceptions_

private

See setIgnoreExceptions to find out what this means.

Definition at line 110 of file ScannerHelpers.h.

Referenced by setIgnoreExceptions().

objType_

edm::TypeWithDict helper::ScannerBase::objType_

private

Definition at line 103 of file ScannerHelpers.h.