Chi2Data

java.lang.Object

group3dlocaliser.algorithm.Chi2Data

All Implemented Interfaces:: FitTestValue

public class Chi2Data extends Object implements FitTestValue

Constructor Summary

Constructors

Constructor

Description

Chi2Data(double chi2, int ndf)
Method Summary

Modifier and Type

Method

Description

double

getChi2()

int

getDegreesOfFreedom()

double

getTestScore()

the test score.

double

getTestValue()

The value of the test in it's normal units, e.g.

void

setChi2(double chi2)

void

setDegreesOfFreedom(int ndf)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- Chi2Data
  
  public Chi2Data(double chi2, int ndf)
Method Details
- getChi2
  
  public double getChi2()
  
  Returns:
  
  the chi2
- setChi2
  
  public void setChi2(double chi2)
  
  Parameters:
  
  chi2 - the chi2 to set
- getDegreesOfFreedom
  
  public int getDegreesOfFreedom()
  
  Specified by:
  
  getDegreesOfFreedom in interface FitTestValue
  
  Returns:
  
  the number of degrees of freedom in the test
- setDegreesOfFreedom
  
  public void setDegreesOfFreedom(int ndf)
  
  Parameters:
  
  ndf - the ndf to set
- getTestValue
  
  public double getTestValue()
  
  Description copied from interface: FitTestValue
  
  The value of the test in it's normal units, e.g. a Chi2 test will return something positive and a Log Likelihood test will return something negative.
  
  Specified by:
  
  getTestValue in interface FitTestValue
  
  Returns:
  
  test result value
- getTestScore
  
  public double getTestScore()
  
  Description copied from interface: FitTestValue
  
  the test score. This is the same as the value returned by getTestValue, except that it may be flipped so that a larger value is always better, i.e. for a Chi2 test it will return -getTestValue, whereas for a Log Likelihood test it will return +testValue
  
  Specified by:
  
  getTestScore in interface FitTestValue
  
  Returns:
  
  score - where more positive (or less negative) results are always better