DeltaRayRemovalTool.h

Go to the documentation of this file.

/**
 *  @file   larpandoracontent/LArThreeDReco/LArCosmicRay/DeltaRayRemovalTool.h
 *
 *  @brief  Header file for the delta ray removal tool class.
 *
 *  $Log: $
 */
#ifndef DELTA_RAY_REMOVAL_TOOL_H
#define DELTA_RAY_REMOVAL_TOOL_H 1

#include "larpandoracontent/LArThreeDReco/LArCosmicRay/RemovalBaseTool.h"
#include "larpandoracontent/LArThreeDReco/LArCosmicRay/ThreeViewDeltaRayMatchingAlgorithm.h"

namespace lar_content
{
/**
 *  @brief  DeltaRayRemovalTool class
 */
class DeltaRayRemovalTool : public RemovalBaseTool
{
public:
    /**
     *  @brief  Default constructor
     */
    DeltaRayRemovalTool();

private:
    bool Run(ThreeViewDeltaRayMatchingAlgorithm *const pAlgorithm, TensorType &overlapTensor);
    pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle);

    /**
     *  @brief  Remove hits from cosmic ray clusters that belong to a child delta ray
     *
     *  @param  elementList the tensor element list
     *
     *  @return  changesMade whether clusters in element have been modified
     */
    bool RemoveDeltaRayHits(const TensorType::ElementList &elementList) const;

    /**
     *  @brief  Determine whether element satifies simple checks
     *
     *  @param  element the tensor element
     *  @param  hitType the hit type of the cluster under investigation
     *
     *  @return  whether the checks pass
     */
    virtual bool PassElementChecks(const TensorType::Element &element, const pandora::HitType hitType) const;

    /**
     *  @brief  Determine whether the cosmic ray cluster under investigation has delta ray contamination
     *
     *  @param  element the tensor element
     *  @param  hitType the hit type of the view under investigation
     *
     *  @return  whether the cosmic ray cluster is likely to contain delta ray hits that can be removed
     */
    bool IsContaminated(const TensorType::Element &element, const pandora::HitType hitType) const;

    /**
     *  @brief  Remove collected delta ray hits from the cosmic ray pfo
     *
     *  @param  element the tensor element
     *  @param  hitType the hit type of the cluster under investigation
     *  @param  deltaRayHits the list of delta ray hits to remove
     */
    void SplitMuonCluster(const TensorType::Element &element, const pandora::HitType hitType, const pandora::CaloHitList &deltaRayHits) const;

    unsigned int m_slidingFitWindow;        ///< The sliding fit window used in cosmic ray parameterisations
    float m_minDeviationFromTransverse;     ///< The minimum deviation from transverse required to avoid mistakes
    float m_contaminationWindow;            ///< The distance in which to search for delta ray contamination in the cosmic ray track
    unsigned int m_significantHitThreshold; ///< The threshold number of hits which define significant contimination
    float m_minDistanceFromMuon;            ///< The minimum distance of a hit from the cosmic ray track required for removal
    float m_maxDistanceToCollected;         ///< The maximim distance of a hit from the projected delta ray hits required for removal
};

} // namespace lar_content

#endif // #ifndef DELTA_RAY_REMOVAL_TOOL_H