PK_BCURVE_fitted_fault_t

struct PK_BCURVE_fitted_fault_s
    {
    PK_BCURVE_fitted_t status;          --- status for the fit
    double             distance_error;  --- final maximum distance error
    double             angular_error;   --- final maximum angular error
    double             error_parameter; --- parameter at which the
                                        --- algorithm failed
    };

typedef struct PK_BCURVE_fitted_fault_s PK_BCURVE_fitted_fault_t;



This structure returns fit status and related data.

Used in:

PK_BCURVE_create_fitted

The structure's fields are:

'status'            a value specifying the final status of the attempt to
                    fit the input curve with a B-curve.

'distance_error'    the maximum distance error for the fit.  In a
                    successful fitting this distance will be less than the
                    'tolerance' supplied.  If fitting failed this value may be
                    undefined, depending on the 'status' for the B-curve.

'angular_error'     the maximum angular error for the fit, if a
                    non-zero angular tolerance was provided.  If no angular
                    tolerance was supplied this value will be zero. If fitting
                    failed this value may be undefined, depending on the
                    'status' for the B-curve.

'error_parameter'   the parameter on the B-curve at which the fitting
                    algorithm has failed, if such a failure has occurred. Error
                    parameter will only be returned for certain 'status' values
                    and should be interpreted accordingly.

The 'status' values which return a B-curve and associated 'distance_error' and
'angular_error' are:

    PK_BCURVE_fitted_success_c
    PK_BCURVE_fitted_eval_failure_c

The 'status' values which return associated 'error_parameter' and the
appropriate interpretations are:

    PK_BCURVE_fitted_eval_failure_c     the parameter at which the
                                        evaluator failed
    PK_BCURVE_fitted_bad_interp_parm_c  the bad interpolation parameter