PAASS
Software suite to Acquire and Analyze Data from Pixie16
Namespaces | Functions | Variables
TraceFunctions Namespace Reference

Namespaces

 Validation
 This namespace holds functions that are used to validate the functions. Impelement the validation functions for the functions in the TraceFunctions namespace. Necessary to simplify the codebase.
 

Functions

template<class T >
pair< double, double > CalculateBaseline (const vector< T > &data, const pair< unsigned int, unsigned int > &range)
 Compute the trace baseline and its standard deviation. This function takes a data range in the event that someone wants to specify a range that is not at the beginning of the trace, or specify some other range. The range given must have a minimum given by the minimum_baseline_length variable. More...
 
template<class T >
pair< double, vector< double > > ExtrapolateMaximum (const vector< T > &data, const pair< unsigned int, double > &maxInfo)
 This function uses a third order polynomial to calculate the true position of the maximum for the given data. We look at the points on either side of the maximum value to determine which side the true maximum lies on. We then pass the data vector and the bin that we want to start the fit on to the fitting class. More...
 
template<class T >
pair< unsigned int, double > FindMaximum (const vector< T > &data, const unsigned int &traceDelayInBins)
 This function finds the maximum bin and the value of the maximum bin for the provided vector. The search is targeted by using the trace delay that was set for the traces. At this point we are not going to be calculating the high resolution maximum. We need additional information about the bit resolution of the module to check for a saturated trace. Since that would remove the generality of this function we do not perform this check here. It's up to the user to verify the results of this function for saturations. NOTE: We do not subtract the baseline at this stage. More...
 
template<class T >
unsigned int FindLeadingEdge (const vector< T > &data, const double &fraction, const pair< unsigned int, double > &maxInfo)
 Fix this method so that it works properly. More...
 
template<class T >
double CalculateQdc (const vector< T > &data, const pair< unsigned int, unsigned int > &range)
 
template<class T >
double CalculateTailRatio (const vector< T > &data, const pair< unsigned int, unsigned int > &range, const double &qdc)
 

Variables

static const unsigned int minimum_baseline_length = 10
 The minimum length that is necessary for a good baseline calculation. More...
 

Function Documentation

§ CalculateBaseline()

template<class T >
pair<double, double> TraceFunctions::CalculateBaseline ( const vector< T > &  data,
const pair< unsigned int, unsigned int > &  range 
)
inline

Compute the trace baseline and its standard deviation. This function takes a data range in the event that someone wants to specify a range that is not at the beginning of the trace, or specify some other range. The range given must have a minimum given by the minimum_baseline_length variable.

Parameters
[in]data: The vector of data containing only the baseline.
[in]range: the low and high range that we are going to use for the baseline
Returns
A pair with the first element being the average of the baseline and the second element being the standard deviation of the baseline.

Definition at line 223 of file HelperFunctions.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

§ CalculateQdc()

template<class T >
double TraceFunctions::CalculateQdc ( const vector< T > &  data,
const pair< unsigned int, unsigned int > &  range 
)
inline

This is an exclusive calculation, meaning that the value at the low and high end of the calculation will not be used to calculate the integral.

Definition at line 376 of file HelperFunctions.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

§ CalculateTailRatio()

template<class T >
double TraceFunctions::CalculateTailRatio ( const vector< T > &  data,
const pair< unsigned int, unsigned int > &  range,
const double &  qdc 
)
inline

Definition at line 400 of file HelperFunctions.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

§ ExtrapolateMaximum()

template<class T >
pair<double, vector<double> > TraceFunctions::ExtrapolateMaximum ( const vector< T > &  data,
const pair< unsigned int, double > &  maxInfo 
)
inline

This function uses a third order polynomial to calculate the true position of the maximum for the given data. We look at the points on either side of the maximum value to determine which side the true maximum lies on. We then pass the data vector and the bin that we want to start the fit on to the fitting class.

Parameters
[in]data: The data that we would like to find the true maximum of
[in]maxInfo: The low resolution maximum information that we need to determine where to start the fit.
Returns
An STL pair containing the maximum that we found and the

Definition at line 265 of file HelperFunctions.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

§ FindLeadingEdge()

template<class T >
unsigned int TraceFunctions::FindLeadingEdge ( const vector< T > &  data,
const double &  fraction,
const pair< unsigned int, double > &  maxInfo 
)
inline

Fix this method so that it works properly.

Definition at line 348 of file HelperFunctions.hpp.

Here is the caller graph for this function:

§ FindMaximum()

template<class T >
pair<unsigned int, double> TraceFunctions::FindMaximum ( const vector< T > &  data,
const unsigned int &  traceDelayInBins 
)
inline

This function finds the maximum bin and the value of the maximum bin for the provided vector. The search is targeted by using the trace delay that was set for the traces. At this point we are not going to be calculating the high resolution maximum. We need additional information about the bit resolution of the module to check for a saturated trace. Since that would remove the generality of this function we do not perform this check here. It's up to the user to verify the results of this function for saturations. NOTE: We do not subtract the baseline at this stage.

Parameters
[in]data: The vector of data that we will be using to find the maximum
[in]traceDelayInBins: The value of the trace delay that was set for this particular trace.
Returns
A STL pair containing the bin and value of the maximum found in the trace.

Definition at line 303 of file HelperFunctions.hpp.

Here is the caller graph for this function:

Variable Documentation

§ minimum_baseline_length

const unsigned int TraceFunctions::minimum_baseline_length = 10
static

The minimum length that is necessary for a good baseline calculation.

Definition at line 209 of file HelperFunctions.hpp.