AliAnalysisTaskEmcalTriggerSelection.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 ALIANALYSISTASKEMCALTRIGGERSELECTION_H
#define ALIANALYSISTASKEMCALTRIGGERSELECTION_H

#include <iosfwd>
#include <exception>
#include <string>
#include <vector>
#include <TList.h>
#include <TNamed.h>
#include <TString.h>
#include "AliAnalysisTaskEmcal.h"
#include "AliEmcalTriggerSelectionCuts.h"

// 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 AliAnalysisTaskEmcalTriggerSelection; } }
std::ostream & operator<< (std::ostream &in, const PWG::EMCAL::AliAnalysisTaskEmcalTriggerSelection &task);

namespace PWG{
namespace EMCAL {

class AliEmcalTriggerDecision;
class AliEmcalTriggerDecisionContainer;
class AliEmcalTriggerSelection;

class AliAnalysisTaskEmcalTriggerSelection: public AliAnalysisTaskEmcal {
public:

  class ConfigValueException : public std::exception {
  public:
    ConfigValueException(const char *key, const char *value);

    virtual ~ConfigValueException() throw() {}

    const char *what() const throw() { return fMessage.data(); }

    const std::string &getKey() const { return fKey; }
    const std::string &getValue() const { return fValue; }

  private:
    std::string           fKey;       
    std::string           fValue;     
    std::string           fMessage;   
  };
  AliAnalysisTaskEmcalTriggerSelection();

  AliAnalysisTaskEmcalTriggerSelection(const char *name);

  virtual ~AliAnalysisTaskEmcalTriggerSelection() {}

  void AddTriggerSelection(AliEmcalTriggerSelection * const selection);

  const TList &GetListOfTriggerSelections() const { return fTriggerSelections; }

  void SetGlobalDecisionContainerName(const char *name) { fGlobalDecisionContainerName = name; }

  const TString  &GetGlobalDecisionContainerName() const { return fGlobalDecisionContainerName; }

  void ConfigureFromYAML(const char *yamlconfig);

  void AutoConfigure(const char *period);

  void ConfigurePP2012();

  void ConfigureMCPP2012();

  void ConfigurePP2016();

  void ConfigureMCPP2016();

  friend std::ostream& ::operator<<(std::ostream &stream, const AliAnalysisTaskEmcalTriggerSelection &task);
  
protected:

  class AliEmcalTriggerSelectionQA : public TNamed {
  public:

    AliEmcalTriggerSelectionQA();

    AliEmcalTriggerSelectionQA(const AliEmcalTriggerSelection * const sel);

    AliEmcalTriggerSelectionQA(const AliEmcalTriggerSelectionQA &ref);

    AliEmcalTriggerSelectionQA &operator=(const AliEmcalTriggerSelectionQA &ref);

    virtual ~AliEmcalTriggerSelectionQA() {}

    void Fill(const AliEmcalTriggerDecision * const decision);

    void GetHistos(TList *targetlist) const;

  private:
     TH1 *fMaxPatchADC;                 
     TH1 *fMaxPatchEnergy;              
     TH1 *fMaxPatchEnergySmeared;       
  };

  virtual void UserCreateOutputObjects();

  virtual void UserExecOnce();

  virtual Bool_t Run();

  virtual Bool_t FillHistograms();

  AliEmcalTriggerDecisionContainer *GetGlobalTriggerDecisionContainer() const { return fTriggerDecisionContainer; }

  void MakeQA(const AliEmcalTriggerDecisionContainer *cont);

  void InitQA(const AliEmcalTriggerSelection *const sel);

  Bool_t Is2012PP(const char *dataset) const;
  Bool_t Is2012MCPP(const char *dataset) const;
  Bool_t Is2016PP(const char *dataset) const;
  Bool_t Is2016MCPP(const char *dataset) const;
  Bool_t IsSupportedMCSample(const char *period, std::vector<TString> &supportedProductions) const;
 
  AliEmcalTriggerSelectionCuts::AcceptanceType_t  DecodeAcceptanceString(const std::string &acceptancestring);
  AliEmcalTriggerSelectionCuts::PatchType_t       DecodePatchTypeString(const std::string &patchtypestring);
  AliEmcalTriggerSelectionCuts::SelectionMethod_t DecodeEnergyDefinition(const std::string &energydefstring);

  AliEmcalTriggerDecisionContainer          *fTriggerDecisionContainer;        
  TString                                    fGlobalDecisionContainerName;     
  TList                                      fTriggerSelections;               
  TList                                      fSelectionQA;                     

private:

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

  ClassDef(AliAnalysisTaskEmcalTriggerSelection, 1);    // Task running different EMCAL trigger selections
};


}
}

#endif /* ALIANALYSISTASKEMCALTRIGGERSELECTION_H */