the tool to create NN calibrator. More...

#include <NNClusterCalibratorToolImpl.h>

Inheritance diagram for ActsTrk::detail::NNClusterCalibratorToolImpl< calib_data_t, traj_t >:

Collaboration diagram for ActsTrk::detail::NNClusterCalibratorToolImpl< calib_data_t, traj_t >:

Public Types
using	BASE = AnalogueClusteringToolImpl<calib_data_t, traj_t>
using	base_class = typename extends<AthAlgTool, ActsTrk::IPixelOnTrackCalibratorTool<traj_t>>::base_class

Public Member Functions
virtual StatusCode	initialize () override
	initializes this base class (must be called by the derived class)
virtual std::unique_ptr< PixelOnBoundStateCalibratorBase >	create (const EventContext &ctx) const override
	convenience class to create an OnBoundState calibrator from an OnTrack calibrator.
virtual std::unique_ptr< PixelOnTrackCalibratorBase< traj_t > >	createOnTrackCalibrator (const EventContext &ctx) const override
virtual bool	calibrateAfterMeasurementSelection () const override
	test whether the calibration should be applied after measurement selection (faster)

Protected Member Functions
const AnalogueClusteringCalibrator< calib_data_t, traj_t >::error_data_t *	getErrorData (const EventContext &ctx) const
PixelClusterCalibratorOptionsBase	createBaseOptions (const EventContext &) const
	create options needed by the calibrator base class.

Protected Attributes
SG::ReadCondHandleKey< calib_data_t >	m_clusterErrorKey
Gaudi::Property< bool >	m_correctCovariance {this, "PerformCovarianceCalibration", true}
Gaudi::Property< double >	m_calibratedCovarianceLowerBound {this, "CalibratedCovarianceLowerBound", 0.}
Gaudi::Property< int >	m_errorStrategy {this, "errorStrategy", 1, "Which error strategy to use for clusters on track: 0 - calibrated, 1 - cluster pitch, to be used only if broadClusters is used during clustering"}
ToolHandle< ISiLorentzAngleTool >	m_lorentzAngleTool
Gaudi::Property< bool >	m_postCalibration {this, "CalibrateAfterMeasurementSelection", true}
const PixelID *	m_pixelID {}

Private Member Functions
NNClusterCalibratorOptions< calib_data_t, traj_t >	createOptions (const EventContext &ctx) const
	Create a Options object This is needed to configure the per-event calibrator instances.

Private Attributes
Gaudi::Property< int >	m_minClusterSizeForNN
SG::ReadCondHandleKey< OnnxNNCollection >	m_readKeyONNX

Detailed Description

template<typename calib_data_t, typename traj_t>
class ActsTrk::detail::NNClusterCalibratorToolImpl< calib_data_t, traj_t >

the tool to create NN calibrator.

Definition at line 105 of file NNClusterCalibratorToolImpl.h.

Member Typedef Documentation

◆ BASE

template<typename calib_data_t, typename traj_t>

using ActsTrk::detail::NNClusterCalibratorToolImpl< calib_data_t, traj_t >::BASE = AnalogueClusteringToolImpl<calib_data_t, traj_t>

Definition at line 108 of file NNClusterCalibratorToolImpl.h.

◆ base_class

template<typename traj_t>

using ActsTrk::detail::PixelClusterCalibrationToolBase< traj_t >::base_class = typename extends<AthAlgTool, ActsTrk::IPixelOnTrackCalibratorTool<traj_t>>::base_class

inherited

Definition at line 137 of file PixelClusterCalibrationToolBase.h.

Member Function Documentation

◆ calibrateAfterMeasurementSelection()

template<typename traj_t>

virtual bool ActsTrk::detail::PixelClusterCalibrationToolBase< traj_t >::calibrateAfterMeasurementSelection ( ) const

overridevirtualinherited

test whether the calibration should be applied after measurement selection (faster)

◆ create()

template<typename calib_data_t, typename traj_t>

virtual std::unique_ptr< PixelOnBoundStateCalibratorBase > ActsTrk::detail::NNClusterCalibratorToolImpl< calib_data_t, traj_t >::create ( const EventContext & ctx ) const

inlineoverridevirtual

convenience class to create an OnBoundState calibrator from an OnTrack calibrator.

Reimplemented from ActsTrk::detail::AnalogueClusteringToolImpl< calib_data_t, traj_t >.

Definition at line 113 of file NNClusterCalibratorToolImpl.h.

                                              {
    return createOnTrackCalibrator(ctx);
  }

◆ createBaseOptions()

template<typename traj_t>

PixelClusterCalibratorOptionsBase ActsTrk::detail::PixelClusterCalibrationToolBase< traj_t >::createBaseOptions ( const EventContext & ) const

inlineprotectedinherited

create options needed by the calibrator base class.

Definition at line 153 of file PixelClusterCalibrationToolBase.h.

                                                                                       {
         return PixelClusterCalibratorOptionsBase{
            .m_lorentzAngleTool=&(*m_lorentzAngleTool),
            .m_pixelID=m_pixelID,
         };
      }

◆ createOnTrackCalibrator()

template<typename calib_data_t, typename traj_t>

virtual std::unique_ptr< PixelOnTrackCalibratorBase< traj_t > > ActsTrk::detail::NNClusterCalibratorToolImpl< calib_data_t, traj_t >::createOnTrackCalibrator ( const EventContext & ctx ) const

inlineoverridevirtual

Reimplemented from ActsTrk::detail::AnalogueClusteringToolImpl< calib_data_t, traj_t >.

Definition at line 125 of file NNClusterCalibratorToolImpl.h.

                                                                  {
    return std::make_unique<NNClusterCalibrator<calib_data_t, traj_t>>(
        BASE::createBaseOptions(ctx), createOptions(ctx));
  }

◆ createOptions()

template<typename calib_data_t, typename traj_t>

NNClusterCalibratorOptions< calib_data_t, traj_t > ActsTrk::detail::NNClusterCalibratorToolImpl< calib_data_t, traj_t >::createOptions ( const EventContext & ctx ) const

private

Create a Options object This is needed to configure the per-event calibrator instances.

Returns: NNClusterCalibratorOptions

◆ getErrorData()

template<typename calib_data_t, typename traj_t>

const AnalogueClusteringCalibrator< calib_data_t, traj_t >::error_data_t * ActsTrk::detail::AnalogueClusteringToolImpl< calib_data_t, traj_t >::getErrorData ( const EventContext & ctx ) const

protectedinherited

◆ initialize()

template<typename calib_data_t, typename traj_t>

virtual StatusCode ActsTrk::detail::NNClusterCalibratorToolImpl< calib_data_t, traj_t >::initialize ( )

overridevirtual

initializes this base class (must be called by the derived class)

Reimplemented from ActsTrk::detail::AnalogueClusteringToolImpl< calib_data_t, traj_t >.

Member Data Documentation

◆ m_calibratedCovarianceLowerBound

template<typename calib_data_t, typename traj_t>

Gaudi::Property<double> ActsTrk::detail::AnalogueClusteringToolImpl< calib_data_t, traj_t >::m_calibratedCovarianceLowerBound {this, "CalibratedCovarianceLowerBound", 0.}

protectedinherited

Definition at line 123 of file AnalogueClusteringToolImpl.h.

123{this, "CalibratedCovarianceLowerBound", 0.};

◆ m_clusterErrorKey

template<typename calib_data_t, typename traj_t>

SG::ReadCondHandleKey<calib_data_t> ActsTrk::detail::AnalogueClusteringToolImpl< calib_data_t, traj_t >::m_clusterErrorKey

protectedinherited

Initial value:

{this, "PixelOfflineCalibData", "ITkPixelOfflineCalibData",
      "Calibration data for pixel clusters"
    }

Definition at line 117 of file AnalogueClusteringToolImpl.h.

                                                        {this, "PixelOfflineCalibData", "ITkPixelOfflineCalibData",
      "Calibration data for pixel clusters"
    };

◆ m_correctCovariance

template<typename calib_data_t, typename traj_t>

Gaudi::Property<bool> ActsTrk::detail::AnalogueClusteringToolImpl< calib_data_t, traj_t >::m_correctCovariance {this, "PerformCovarianceCalibration", true}

protectedinherited

Definition at line 122 of file AnalogueClusteringToolImpl.h.

122{this, "PerformCovarianceCalibration", true};

◆ m_errorStrategy

template<typename calib_data_t, typename traj_t>

Gaudi::Property<int> ActsTrk::detail::AnalogueClusteringToolImpl< calib_data_t, traj_t >::m_errorStrategy {this, "errorStrategy", 1, "Which error strategy to use for clusters on track: 0 - calibrated, 1 - cluster pitch, to be used only if broadClusters is used during clustering"}

protectedinherited

Definition at line 125 of file AnalogueClusteringToolImpl.h.

125{this, "errorStrategy", 1, "Which error strategy to use for clusters on track: 0 - calibrated, 1 - cluster pitch, to be used only if broadClusters is used during clustering"};

◆ m_lorentzAngleTool

template<typename traj_t>

ToolHandle<ISiLorentzAngleTool> ActsTrk::detail::PixelClusterCalibrationToolBase< traj_t >::m_lorentzAngleTool

protectedinherited

Initial value:

{this, "PixelLorentzAngleTool", "",
                                                          "Tool to retreive Lorentz angle"
      }

Definition at line 161 of file PixelClusterCalibrationToolBase.h.

                                                         {this, "PixelLorentzAngleTool", "",
                                                          "Tool to retreive Lorentz angle"
      };

◆ m_minClusterSizeForNN

template<typename calib_data_t, typename traj_t>

Gaudi::Property<int> ActsTrk::detail::NNClusterCalibratorToolImpl< calib_data_t, traj_t >::m_minClusterSizeForNN

private

Initial value:

{
      this, "minClusterSizeForNN", 0,
      "how big the cluster needs to be to apply NN to it"}

Definition at line 140 of file NNClusterCalibratorToolImpl.h.

                                          {
      this, "minClusterSizeForNN", 0,
      "how big the cluster needs to be to apply NN to it"};

◆ m_pixelID

template<typename traj_t>

const PixelID* ActsTrk::detail::PixelClusterCalibrationToolBase< traj_t >::m_pixelID {}

protectedinherited

Definition at line 167 of file PixelClusterCalibrationToolBase.h.

167{}; // The helper object to interpret identifiers

◆ m_postCalibration

template<typename traj_t>

Gaudi::Property<bool> ActsTrk::detail::PixelClusterCalibrationToolBase< traj_t >::m_postCalibration {this, "CalibrateAfterMeasurementSelection", true}

protectedinherited

Definition at line 165 of file PixelClusterCalibrationToolBase.h.

165{this, "CalibrateAfterMeasurementSelection", true};

◆ m_readKeyONNX

template<typename calib_data_t, typename traj_t>

SG::ReadCondHandleKey<OnnxNNCollection> ActsTrk::detail::NNClusterCalibratorToolImpl< calib_data_t, traj_t >::m_readKeyONNX

private

Initial value:

{
      this, "NnCollectionONNXReadKey", "PixelClusterNNONNX",
      "The conditions key for ONNX-based pixel cluster NNs"}

Definition at line 144 of file NNClusterCalibratorToolImpl.h.

                                                      {
      this, "NnCollectionONNXReadKey", "PixelClusterNNONNX",
      "The conditions key for ONNX-based pixel cluster NNs"};

The documentation for this class was generated from the following file:

NNClusterCalibratorToolImpl.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ BASE

◆ base_class

Member Function Documentation

◆ calibrateAfterMeasurementSelection()

◆ create()

◆ createBaseOptions()

◆ createOnTrackCalibrator()

◆ createOptions()

◆ getErrorData()

◆ initialize()

Member Data Documentation

◆ m_calibratedCovarianceLowerBound

◆ m_clusterErrorKey

◆ m_correctCovariance

◆ m_errorStrategy

◆ m_lorentzAngleTool

◆ m_minClusterSizeForNN

◆ m_pixelID

◆ m_postCalibration

◆ m_readKeyONNX