DEDXEstimationTrainer Class Reference

Inheritance diagram for DEDXEstimationTrainer:

Public Member Functions
def	__init__ (self)
def	train (self, data)
def	test (self, data)

Public Attributes
	dedx_estimator_function
	by default, the dE/dx-particle-identification trainer has not run yet
	dedx_column
	the default data column is 'dedx'

Detailed Description

Train a neural network for dE/dx-based particle identification

Definition at line 19 of file train.py.

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

Constructor

Reimplemented in GaussianEstimatorTrainer, LandauEstimatorTrainer, MaximumEstimatorTrainer, MedianEstimatorTrainer, GaussianEstimatorTrainerSQRT, LandauEstimatorTrainerSQRT, MaximumEstimatorTrainerSQRT, MedianEstimatorTrainerSQRT, MVADEDXEstimationTrainer, FunctionFittedGroupedDEDXEstimatorTrainer, and FittedGroupedDEDXEstimatorTrainer.

Definition at line 22 of file train.py.

    def __init__(self):
        """Constructor"""
        
        self.dedx_estimator_function = None
        
        self.dedx_column = "dedx"
 

Member Function Documentation

test()

def test	(		self,
			data
	)

Get the trained neural-network output value for test data

Reimplemented in MVADEDXEstimationTrainer.

Definition at line 34 of file train.py.

    def test(self, data):
        """Get the trained neural-network output value for test data"""
        if self.dedx_estimator_function is None:
            raise ValueError("Train the estimator first!")
 
        return self.dedx_estimator_function(data[self.dedx_column])
 
 

train()

def train	(		self,
			data
	)

Train on the input data

Reimplemented in FittedGroupedDEDXEstimatorTrainer, and MVADEDXEstimationTrainer.

Definition at line 29 of file train.py.

    def train(self, data):
        """Train on the input data"""
        # We have everything
        raise NotImplementedError("Use this class as a base class only")
 

Member Data Documentation

dedx_column

dedx_column

the default data column is 'dedx'

Definition at line 27 of file train.py.

dedx_estimator_function

dedx_estimator_function

by default, the dE/dx-particle-identification trainer has not run yet

Definition at line 25 of file train.py.

---

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

• tracking/studies/low_momentum_vxd_estimation/train.py