Trk::FitterStatusCode Class Reference

Status codes for track fitters. More...

#include <FitterStatusCode.h>

Collaboration diagram for Trk::FitterStatusCode:

Public Types
enum	FitCode {   Success = 0, StraightTrackModelUsed = 1, BadInput = 2, UpdateFailure = 3,   FitQualityFailure = 4, MissingCovariance = 5, ExtrapolationFailure = 6, ExtrapolationFailureDueToSmallMomentum = 7,   CombineStatesFailure = 8, WeaklyConstraintPars = 9, OutlierLogicFailure = 10, PerigeeMakingFailure = 11,   ForwardFilterFailure = 12, SmootherFailure = 13, FewFittableMeasurements = 14, SeedFailure = 15,   MatrixInversionFailure = 16, NoConvergence = 17, InvalidAngles = 18, NumberOfStatusCodes = 19 }
	fitter status codes More...

Public Member Functions
	FitterStatusCode ()
	default constructor More...
	FitterStatusCode (FitCode)
	constructor More...
bool	isFailure () const
	operator unsigned long () const
	Cast operator. More...
	operator StatusCode () const
	Cast operator. More...
unsigned long	getCode () const
	Get the status code by value. More...
std::string	getString () const
	Get the status code as descriptive string. More...

Private Attributes
unsigned long	m_code
	fitter status code More...

Detailed Description

Status codes for track fitters.

This class can be returned by track fitters to give a more detailed feedback of fit failures.

Author

Sebastian.Fleischmann -at- cern.ch

Definition at line 32 of file FitterStatusCode.h.

Member Enumeration Documentation

FitCode

enum Trk::FitterStatusCode::FitCode

fitter status codes

Enumerator
Success	fit successfull
StraightTrackModelUsed	fit successfull, but straight track model was used
BadInput	bad input
UpdateFailure	parameter update failed
FitQualityFailure	fit quality production failed
MissingCovariance	covariance missed
ExtrapolationFailure	extrapolation failed
ExtrapolationFailureDueToSmallMomentum	extrapolation failed due to small momentum
CombineStatesFailure	fit states could not be combined
WeaklyConstraintPars	parameters only weakly constrained
OutlierLogicFailure	outlier logic failed
PerigeeMakingFailure	perigee could not be produced
ForwardFilterFailure	forward filter failed
SmootherFailure	smoother failed
FewFittableMeasurements	number of fittable measurements on trajectory too small
SeedFailure	wrong seed, not recoverable or recovery off.
MatrixInversionFailure
NoConvergence
InvalidAngles
NumberOfStatusCodes	number of different status codes

Definition at line 37 of file FitterStatusCode.h.

                 {
        Success                 =  0,       
        StraightTrackModelUsed  =  1,       
        BadInput                =  2,       
        UpdateFailure           =  3,       
        FitQualityFailure       =  4,       
        MissingCovariance       =  5,       
        ExtrapolationFailure    =  6,       
        ExtrapolationFailureDueToSmallMomentum  = 7,    
        CombineStatesFailure    =  8,       
        WeaklyConstraintPars    =  9,       
        OutlierLogicFailure     = 10,       
        PerigeeMakingFailure    = 11,       
        ForwardFilterFailure    = 12,       
        SmootherFailure         = 13,       
        FewFittableMeasurements = 14,       
        SeedFailure             = 15,       
        MatrixInversionFailure  = 16,
        NoConvergence           = 17,
        InvalidAngles           = 18,
        NumberOfStatusCodes     = 19        
 
    };

Constructor & Destructor Documentation

FitterStatusCode() [1/2]

Trk::FitterStatusCode::FitterStatusCode

(

)

default constructor

Definition at line 15 of file FitterStatusCode.cxx.

        :
        //StatusCode( ),
        m_code( 0 ) {}

FitterStatusCode() [2/2]

Trk::FitterStatusCode::FitterStatusCode

(

FitCode

thecode

)

constructor

Parameters

code	status code according to the enum

Definition at line 20 of file FitterStatusCode.cxx.

        :
        //StatusCode( (thecode>1)?StatusCode::SUCCESS : StatusCode::FAILURE ),
        m_code( thecode ) {}

Member Function Documentation

getCode()

unsigned long Trk::FitterStatusCode::getCode

(

)

const

Get the status code by value.

Definition at line 37 of file FitterStatusCode.cxx.

                                                 {
    return m_code;
}

getString()

std::string Trk::FitterStatusCode::getString

(

)

const

Get the status code as descriptive string.

Definition at line 41 of file FitterStatusCode.cxx.

                                               {
    switch(m_code)
    {
    case Success:
       return "success";
    case StraightTrackModelUsed:
       return "success, using straight track model";
    case BadInput:
       return "bad input";
    case UpdateFailure:
       return "parameter update failure";
    case FitQualityFailure:
       return "fit quality production failed";
    case MissingCovariance:
       return "covariance missing";
    case ExtrapolationFailure:
       return "extrapolation failed";
    case ExtrapolationFailureDueToSmallMomentum:
       return "extrapolation failed due to small momentum";
    case CombineStatesFailure:
       return "fit states combination failed";
    case WeaklyConstraintPars:
       return "parameters only weakly constrained";
    case OutlierLogicFailure:
       return "outlier logic failed";
    case PerigeeMakingFailure:
       return "perigee could not be produced";
    case ForwardFilterFailure:
       return "forward filter failed";
    case SmootherFailure:
       return "smoother failed";
    case FewFittableMeasurements:
       return "too few fittable measurements";
    case MatrixInversionFailure:
       return "matrix inversion failed";
    case NoConvergence:
       return "fit did not converge";
    case InvalidAngles:
       return "invalid results for theta, phi";
    default :
       return "unknown";
    };
}

isFailure()

bool Trk::FitterStatusCode::isFailure

(

)

const

Definition at line 25 of file FitterStatusCode.cxx.

                                          {
    return m_code>1;
}

operator StatusCode()

Trk::FitterStatusCode::operator StatusCode

(

)

const

Cast operator.

Definition at line 33 of file FitterStatusCode.cxx.

                                                {
    return { (m_code>1)?StatusCode::SUCCESS : StatusCode::FAILURE };
}

operator unsigned long()

Trk::FitterStatusCode::operator unsigned long

(

)

const

Cast operator.

Definition at line 29 of file FitterStatusCode.cxx.

                                                   {
    return m_code;
}

Member Data Documentation

m_code

unsigned long Trk::FitterStatusCode::m_code

private

fitter status code

Definition at line 90 of file FitterStatusCode.h.

---

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

• FitterStatusCode.h
• FitterStatusCode.cxx