EnergyCorrectionPlugins.h

Go to the documentation of this file.

/*
 *
 * EnergyCorrectionPlugin.h header template automatically generated by a class generator
 * Creation date : mar. nov. 17 2015
 * Updated november 2023 by Tanguy Pasquier
 *
 * This file is part of APRILContent libraries.
 * 
 * APRILContent is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * based upon these libraries are permitted. Any copy of these libraries
 * must include this copyright notice.
 * 
 * APRILContent is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with APRILContent.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * @author Remi Ete
 * @copyright CNRS , IPNL
 */


#ifndef APRIL_CONTENT_ENERGYCORRECTIONPLUGIN_H
#define APRIL_CONTENT_ENERGYCORRECTIONPLUGIN_H

#include "Plugins/EnergyCorrectionsPlugin.h"

namespace april_content
{

  class AnalogicEnergyFunction : public pandora::EnergyCorrectionPlugin
  {
  public:
    AnalogicEnergyFunction();

    pandora::StatusCode MakeEnergyCorrections(const pandora::Cluster *const pCluster, float &correctedEnergy) const;

    pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle);

  private:
    unsigned int                   m_ecalEnergyType;
    unsigned int                   m_hcalEnergyType;
    unsigned int                   m_muonEnergyType;
    unsigned int                   m_otherEnergyType;
  };

  //------------------------------------------------------------------------------------------------------------------------------------------
  //------------------------------------------------------------------------------------------------------------------------------------------

  class SdhcalQuadraticEnergyFunction : public pandora::EnergyCorrectionPlugin
  {
  public:
    SdhcalQuadraticEnergyFunction();

    pandora::StatusCode MakeEnergyCorrections(const pandora::Cluster *const pCluster, float &correctedEnergy) const;

    pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle);

  private:

    pandora::FloatVector                m_sdhcalThresholds;             
    pandora::FloatVector                m_energyConstantParameters;    
  };

  //------------------------------------------------------------------------------------------------------------------------------------------
  //------------------------------------------------------------------------------------------------------------------------------------------

  class BarrelGapEnergyFunction : public pandora::EnergyCorrectionPlugin
  {
  public:
    BarrelGapEnergyFunction();

    pandora::StatusCode MakeEnergyCorrections(const pandora::Cluster *const pCluster, float &correctedEnergy) const;

    pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle);

  private:
    enum Approach
    {
      INNER_GAP_APPROACH = -1,
      FAR_FROM_GAP = 0,
      OUTER_GAP_APPROACH = 1
    };

    bool IsNearbyGap(const pandora::CaloHit *const pCaloHit) const;

    Approach GetApproach(const pandora::CaloHit *const pCaloHit) const;

  private:
    pandora::FloatVector                m_ecalZGapPositions;
    pandora::FloatVector                m_hcalZGapPositions;

    float                               m_ecalDistanceToGap;
    float                               m_hcalDistanceToGap;

    float                               m_ecalGapAlpha;
    float                               m_ecalGapBeta;
    float                               m_hcalGapAlpha;
    float                               m_hcalGapBeta;
  };

  //------------------------------------------------------------------------------------------------------------------------------------------
  //------------------------------------------------------------------------------------------------------------------------------------------

  class ThetaNHitFunction : public pandora::EnergyCorrectionPlugin
  {
  public:
    ThetaNHitFunction();

    pandora::StatusCode MakeEnergyCorrections(const pandora::Cluster *const pCluster, float &correctedEnergy) const;

    pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle);

  private:
    float GetCosTheta(const pandora::Cluster *const pCluster) const;

    float GetCorrectedHitNumber(int nHit, float cosTheta) const;


  private:
    float                       m_lowEnergyCut;

    pandora::FloatVector                m_sdhcalThresholds;             
    // pandora::FloatVector                m_energyConstantParameter;    ///< The energy constant parameters
  };

  //------------------------------------------------------------------------------------------------------------------------------------------
  //------------------------------------------------------------------------------------------------------------------------------------------

  class PhiNHitFunction : public pandora::EnergyCorrectionPlugin
  {
  public:
    PhiNHitFunction();

    pandora::StatusCode MakeEnergyCorrections(const pandora::Cluster *const pCluster, float &correctedEnergy) const;

    pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle);

  private:
    float GetCosPhi(const pandora::Cluster *const pCluster) const;

    float GetCorrectedHitNumber(int nHit, float cosPhi) const;


  private:
    float                       m_lowEnergyCut;

    pandora::FloatVector                m_sdhcalThresholds;             
    // pandora::FloatVector                m_energyConstantParameter;    ///< The energy constant parameters
  };

  //------------------------------------------------------------------------------------------------------------------------------------------
  //------------------------------------------------------------------------------------------------------------------------------------------

    class CleanCluster : public pandora::EnergyCorrectionPlugin
    {
    public:
        CleanCluster();

        pandora::StatusCode MakeEnergyCorrections(const pandora::Cluster *const pCluster, float &correctedEnergy) const;

    private:
        float GetHadronicEnergyInLayer(const pandora::OrderedCaloHitList &orderedCaloHitList, const unsigned int pseudoLayer) const;

        pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle);

        float           m_minCleanHitEnergy;                
        float           m_minCleanHitEnergyFraction;        
        float           m_minCleanCorrectedHitEnergy;       
    };

} 

#endif  //  APRIL_CONTENT_ENERGYCORRECTIONPLUGIN_H