AliEmcalTriggerSelectionCuts.h

Go to the documentation of this file.

/************************************************************************************
 * Copyright (C) 2017, Copyright Holders of the ALICE Collaboration                 *
 * All rights reserved.                                                             *
 *                                                                                  *
 * Redistribution and use in source and binary forms, with or without               *
 * modification, are permitted provided that the following conditions are met:      *
 *     * Redistributions of source code must retain the above copyright             *
 *       notice, this list of conditions and the following disclaimer.              *
 *     * Redistributions in binary form must reproduce the above copyright          *
 *       notice, this list of conditions and the following disclaimer in the        *
 *       documentation and/or other materials provided with the distribution.       *
 *     * Neither the name of the <organization> nor the                             *
 *       names of its contributors may be used to endorse or promote products       *
 *       derived from this software without specific prior written permission.      *
 *                                                                                  *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND  *
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED    *
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE           *
 * DISCLAIMED. IN NO EVENT SHALL ALICE COLLABORATION BE LIABLE FOR ANY              *
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES       *
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;     *
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND      *
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT       *
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS    *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                     *
 ************************************************************************************/
#ifndef ALIEMCALTRIGGERSELECTIONCUTS_H
#define ALIEMCALTRIGGERSELECTIONCUTS_H

#include <iosfwd>
#include <TObject.h>

class AliEMCALTriggerPatchInfo;

// operator<< has to be forward declared carefully to stay in the global namespace so that it works with CINT.
// For generally how to keep the operator in the global namespace, See: https://stackoverflow.com/a/38801633
namespace PWG { namespace EMCAL { class AliEmcalTriggerSelectionCuts; } }
std::ostream & operator<< (std::ostream &in, const PWG::EMCAL::AliEmcalTriggerSelectionCuts &cuts);

namespace PWG {
namespace EMCAL {

class AliEmcalTriggerSelectionCuts: public TObject {
public:
  enum SelectionMethod_t {
    kADC = 0,
    kEnergyRough = 1,
    kEnergyOffline = 2,
    kEnergyOfflineSmeared = 3
  };
  enum PatchType_t {
    kAnyPatch = 0,
    kL1JetPatch = 1,
    kL1GammaPatch = 2,
    kL0Patch = 3,
    kL1JetLowPatch = 4,
    kL1JetHighPatch = 5,
    kL1GammaLowPatch = 6,
    kL1GammaHighPatch = 7
  };
  enum AcceptanceType_t {
    kEMCALAcceptance = 0,
    kDCALAcceptance = 1,
    kEMCALDCALAcceptance = 2
  };

  AliEmcalTriggerSelectionCuts();
  virtual ~AliEmcalTriggerSelectionCuts() {}

  PatchType_t GetPatchType() const { return fPatchType; }
  SelectionMethod_t GetSelectionMethod() const { return fSelectionMethod; }
  Double_t GetThreshold() const { return fThreshold; }
  Bool_t IsRequestingSimpleOfflinePatches() const { return fUseSimpleOffline; }

  void SetPatchType(PatchType_t patchType) { fPatchType = patchType; }
  void SetAcceptanceType(AcceptanceType_t acceptance) { fAcceptanceType = acceptance; }
  void SetSelectionMethod(SelectionMethod_t selectionMethod) { fSelectionMethod = selectionMethod; }
  void SetThreshold(Double_t threshold) { fThreshold = threshold; }
  void SetUseSimpleOfflinePatches(Bool_t doUse = kTRUE) { fUseSimpleOffline = doUse; }
  void SetUseRecalcPatches(Bool_t doUse = kTRUE) { fUseRecalc = doUse; }

  Bool_t IsSelected(const AliEMCALTriggerPatchInfo * const patch) const;

  Int_t CompareTriggerPatches(const AliEMCALTriggerPatchInfo *first, const AliEMCALTriggerPatchInfo *second) const;

  friend std::ostream& ::operator<<(std::ostream &stream, const AliEmcalTriggerSelectionCuts &cuts);

protected:

  Double_t GetCutPrimitive(const AliEMCALTriggerPatchInfo * const patch) const;

  Bool_t SelectPatchType(const AliEMCALTriggerPatchInfo * const patch) const;

  Bool_t SelectAcceptance(const AliEMCALTriggerPatchInfo * const patch) const;

  SelectionMethod_t     fSelectionMethod;           
  PatchType_t           fPatchType;                 
  AcceptanceType_t      fAcceptanceType;            
  Double_t              fThreshold;                 
  Bool_t                fUseSimpleOffline;          
  Bool_t                fUseRecalc;                 

private:

  void PrintStream(std::ostream &stream) const;

  ClassDef(AliEmcalTriggerSelectionCuts, 1);         // Cuts for the EMCAL Trigger selection
};

}
}

#endif /* ALIEMCALTRIGGERSELECTIONCUTS_H */