PhiFilterRange.h

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
 
// PhiFilterRange.h 
// Header file for class PhiFilterRange
// Author: S.Binet<binet@cern.ch>
#ifndef ANALYSISUTILS_PHIFILTERRANGE_H 
#define ANALYSISUTILS_PHIFILTERRANGE_H 
 
// STL includes
 
// AnalysisUtils includes
#include "AnalysisUtils/FilterRange.h"
#include <optional>
 
class PhiFilterRange : public FilterRange
{ 
 
  // Public methods: 
 public: 
 
  PhiFilterRange();
 
  PhiFilterRange( const PhiFilterRange& range );
 
  PhiFilterRange( const double min, const double max );
 
  virtual ~PhiFilterRange(); 
 
  PhiFilterRange &operator=(const PhiFilterRange &obj); 
 
  // Const methods: 
 
  double lower() const;
 
  double upper() const;
 
  double getMin() const;
 
  double getMax() const;
 
  /*
   *return Return true if the point is in range : min <= point <= max
   */
  bool isInRange( const double point ) const;
 
  bool isActive() const;
 
  double atlasPhi( const double phi ) const;
  
  // Non-const methods: 
  void setRange( const double lower, const double upper );
  void setMin( const double minValue );
  void setMax( const double maxValue );
 
  void include( const double xMin, const double xMax);
  
  void includeAll();
  
  // Protected method: 
 protected: 
 
  void addRange(double xMin, double xMax);
 
  //void cleanRanges(double xMin, double xMax);
 
  // Protected data: 
 protected: 
  
}; 
 
// Operators
bool operator==( const PhiFilterRange& r1, const PhiFilterRange& r2 );
bool operator!=( const PhiFilterRange& r1, const PhiFilterRange& r2 );
bool operator <( const PhiFilterRange& r1, const PhiFilterRange& r2 );
bool operator >( const PhiFilterRange& r1, const PhiFilterRange& r2 );
bool operator<=( const PhiFilterRange& r1, const PhiFilterRange& r2 );
bool operator>=( const PhiFilterRange& r1, const PhiFilterRange& r2 );
 
 
inline PhiFilterRange::PhiFilterRange() :
  FilterRange()
{}
 
inline PhiFilterRange::PhiFilterRange( const double min, const double max ) :
  FilterRange( min, max )
{
  if ( min == -M_PI && max == +M_PI ) {
    //std::cout << ">>> You are giving a NO-OP interval : ]"
    //      << min << "; "
    //      << max << "["
    //      << std::endl
    //      << ">>> De-activating this range for optimization purpose."
    //      << std::endl;
    m_range = std::nullopt;
    if ( isActive() ) {
      std::string err = "ERROR : PhiFilterRange is ACTIVE (Should NOT BE !!)";
      throw err;
    }
  } else {
    // Do nothing : everything is allright
  }
}
 
inline PhiFilterRange::~PhiFilterRange() {}
 
inline double PhiFilterRange::lower() const 
{
  if ( m_range ) {
    return m_range->lower();
  }
 
  return -M_PI;
}
 
inline double PhiFilterRange::upper() const 
{
  if ( m_range ) {
    return m_range->upper();
  }
 
  return +M_PI;
}
 
inline double PhiFilterRange::getMin() const 
{
  return lower();
}
 
inline double PhiFilterRange::getMax() const 
{
  return upper();
}
 
inline bool PhiFilterRange::isActive() const
{
  if ( m_range ) return true;
  return false;
}
 
inline void PhiFilterRange::setRange( const double lower, const double upper )
{
  return addRange( lower, upper );
}
 
inline void PhiFilterRange::setMin( const double minValue )
{
  return setRange( minValue, getMax() );
}
 
inline void PhiFilterRange::setMax( const double maxValue )
{
  return setRange( getMin(), maxValue );
}
 
#endif //> ANALYSISUTILS_PhiFILTERRANGE_H