genfit::StepLimits Class Reference

Helper to store different limits on the stepsize for the RKTRackRep. More...

#include <StepLimits.h>

Public Member Functions
	StepLimits ()
StepLimits &	operator= (const StepLimits &other)
double	getLimit (StepLimitType type) const
	Get limit of type. If that limit has not yet been set, return max double value.
double	getLimitSigned (StepLimitType type) const
std::pair< StepLimitType, double >	getLowestLimit (double margin=1.E-3) const
	Get the lowest limit.
double	getLowestLimitVal (double margin=1.E-3) const
	Get the unsigned numerical value of the lowest limit.
double	getLowestLimitSignedVal (double margin=1.E-3) const
	Get the numerical value of the lowest limit, signed with stepSign_.
char	getStepSign () const
void	reduceLimit (StepLimitType type, double value)
	absolute of value will be taken! If limit is already lower, it will stay.
void	setLimit (StepLimitType type, double value)
	absolute of value will be taken! If limit is already lower, it will be set to value anyway.
void	setStepSign (char signedVal)
	sets stepSign_ to sign of signedVal
void	setStepSign (double signedVal)
	sets stepSign_ to sign of signedVal
void	removeLimit (StepLimitType type)
void	reset ()
void	Print ()

Private Attributes
std::vector< double >	limits_
signed char	stepSign_

Static Private Attributes
static const double	maxLimit_ = 99.E99

Detailed Description

Helper to store different limits on the stepsize for the RKTRackRep.

Definition at line 54 of file StepLimits.h.

Constructor & Destructor Documentation

StepLimits()

genfit::StepLimits::StepLimits ( )

inline

Definition at line 57 of file StepLimits.h.

  : limits_(ENUM_NR_ITEMS, maxLimit_), stepSign_(1) {;}

Member Function Documentation

getLimit()

double genfit::StepLimits::getLimit ( StepLimitType  type ) const

inline

Get limit of type. If that limit has not yet been set, return max double value.

Definition at line 63 of file StepLimits.h.

{return limits_[type];}

getLimitSigned()

double genfit::StepLimits::getLimitSigned ( StepLimitType  type ) const

inline

Definition at line 64 of file StepLimits.h.

                                                  {
    return stepSign_*getLimit(type);
  }

getLowestLimit()

std::pair< StepLimitType, double > genfit::StepLimits::getLowestLimit

(

double

margin = 1.E-3

)

const

Get the lowest limit.

If hard limits are there, medium limits can be exceeded by up to margin (default margin is 0.1, i.e. medium limits can be exceeded by up to 10%). If no limit has been set yet, return std::pair<stp_noLimit, std::numeric_limits<double>::max>.

Definition at line 44 of file StepLimits.cc.

                                                                             {
 
  double lowest(maxLimit_);
  unsigned int iLowest(0);
 
  for (unsigned int i=1; i<ENUM_NR_ITEMS; ++i) {
 
    // lowest hard limit may exceed lowest soft limit by up to #margin
    if (i == int(stp_sMaxArg))
      lowest *= (1+margin);
 
    if (limits_[i] < lowest) {
      lowest = limits_[i];
      iLowest = i;
    }
  }
 
  return std::pair<StepLimitType, double>(static_cast<StepLimitType>(iLowest), lowest);
}

getLowestLimitSignedVal()

double genfit::StepLimits::getLowestLimitSignedVal ( double  margin = 1.E-3 ) const

inline

Get the numerical value of the lowest limit, signed with stepSign_.

Definition at line 80 of file StepLimits.h.

                                                              {
    return getLowestLimitVal(margin) * stepSign_;
  }

getLowestLimitVal()

double genfit::StepLimits::getLowestLimitVal

(

double

margin = 1.E-3

)

const

Get the unsigned numerical value of the lowest limit.

Definition at line 65 of file StepLimits.cc.

                                                        {
 
  double lowest(maxLimit_);
 
  for (unsigned int i=1; i<ENUM_NR_ITEMS; ++i) {
 
    // lowest hard limit may exceed lowest soft limit by up to #margin
    if (i == int(stp_sMaxArg))
      lowest *= (1+margin);
 
    if (limits_[i] < lowest) {
      lowest = limits_[i];
    }
  }
 
  return lowest;
}

getStepSign()

char genfit::StepLimits::getStepSign ( ) const

inline

Definition at line 84 of file StepLimits.h.

{return stepSign_;} // +- 1

operator=()

StepLimits & genfit::StepLimits::operator=

(

const StepLimits &

other

)

Definition at line 33 of file StepLimits.cc.

                                                         {
  for (unsigned int i=1; i<ENUM_NR_ITEMS; ++i) {
    limits_[i] = other.limits_[i];
  }
 
  stepSign_ = other.stepSign_;
 
  return *this;
}

Print()

void genfit::StepLimits::Print

(

)

Definition at line 116 of file StepLimits.cc.

                       {
  for (unsigned int i=0; i<ENUM_NR_ITEMS; ++i) {
    if (limits_[i] >= maxLimit_)
      continue;
 
    std::cout << "   | " << limits_[i] << " cm due to ";
    switch (static_cast<StepLimitType>(i)) {
    case stp_noLimit:
      break;
    case stp_fieldCurv:
      std::cout << "stp_fieldCurv (medium limit): stepsize limited by curvature and magnetic field inhomogenities";
      break;
    case stp_momLoss:
      std::cout << "stp_momLoss (medium limit): stepsize limited by stepper because maximum momLoss is reached";
      break;
    case stp_sMax:
      std::cout << "stp_sMax (medium limit): stepsize limited by SMax defined in #estimateStep()";
      break;
    case stp_sMaxArg:
      std::cout << "stp_sMaxArg (hard limit): stepsize limited by argument maxStepArg passed to #estimateStep()";
      break;
    case stp_boundary:
      std::cout << "stp_boundary (hard limit): stepsize limited by stepper because material boundary is encountered";
      break;
    case stp_plane:
      std::cout << "stp_plane (hard limit):  stepsize limited because destination plane is reached";
      break;
    case ENUM_NR_ITEMS:
      break;
    }
    std::cout << "\n";
  }
  std::cout << "\n";
}

reduceLimit()

void genfit::StepLimits::reduceLimit	(	StepLimitType	type,
		double	value
	)

absolute of value will be taken! If limit is already lower, it will stay.

Definition at line 84 of file StepLimits.cc.

                                                             {
  assert (type != stp_noLimit);
  value = fabs(value);
 
  if (limits_[type] > value)
    limits_[type] = value;
}

removeLimit()

void genfit::StepLimits::removeLimit ( StepLimitType  type )

inline

Definition at line 95 of file StepLimits.h.

{limits_[type] = maxLimit_;}

reset()

void genfit::StepLimits::reset

(

)

Definition at line 108 of file StepLimits.cc.

                       {
  for (unsigned int i=1; i<ENUM_NR_ITEMS; ++i) {
    limits_[i] = maxLimit_;
  }
  stepSign_ = 1;
}

setLimit()

void genfit::StepLimits::setLimit ( StepLimitType  type, double  value  )

inline

absolute of value will be taken! If limit is already lower, it will be set to value anyway.

Definition at line 89 of file StepLimits.h.

{limits_[type] = fabs(value);}

setStepSign() [1/2]

void genfit::StepLimits::setStepSign

(

char

signedVal

)

sets stepSign_ to sign of signedVal

Definition at line 93 of file StepLimits.cc.

                                           {
  if (signedVal < 0)
    stepSign_ = -1;
  else
    stepSign_ = 1;
}

setStepSign() [2/2]

void genfit::StepLimits::setStepSign

(

double

signedVal

)

sets stepSign_ to sign of signedVal

Definition at line 100 of file StepLimits.cc.

                                             {
  if (signedVal < 0.)
    stepSign_ = -1;
  else
    stepSign_ = 1;
}

Member Data Documentation

limits_

std::vector<double> genfit::StepLimits::limits_

private

Definition at line 101 of file StepLimits.h.

maxLimit_

const double genfit::StepLimits::maxLimit_ = 99.E99

staticprivate

Definition at line 103 of file StepLimits.h.

stepSign_

signed char genfit::StepLimits::stepSign_

private

Definition at line 102 of file StepLimits.h.

---

The documentation for this class was generated from the following files:

• genfit/trackReps/include/StepLimits.h
• genfit/trackReps/src/StepLimits.cc