RSquaredTest (PULsE 1.98 API)

java.lang.Object
- pulse.util.UpwardsNavigable
- - pulse.util.Group
  - - pulse.util.Accessible
    - - pulse.util.PropertyHolder
      - pulse.search.statistics.Statistic
        
        pulse.search.statistics.ResidualStatistic
        
        pulse.search.statistics.NormalityTest
        
        pulse.search.statistics.RSquaredTest

All Implemented Interfaces:

Serializable, Descriptive, Reflexive
```
public class RSquaredTest
extends NormalityTest
```
The coefficient of determination represents the goodness of fit that a HeatingCurve provides for the ExperimentalData

See Also:

Serialized Form

Field Summary
- Fields inherited from class pulse.search.statistics.NormalityTest
  significance

Constructor Summary

Constructors
Constructor Description

RSquaredTest()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`evaluate(GeneralTask t)`	Calculates the coefficient of determination, or simply the $R^{2}$ value.
`String`	`getDescriptor()`	If not null, will return the prefix, otherwise calls the superclass method.
`SumOfSquares`	`getSumOfSquares()`
`void`	`setSumOfSquares(SumOfSquares sos)`
`boolean`	`test(GeneralTask task)`

Methods inherited from class pulse.search.statistics.NormalityTest
getSelectedTestDescriptor, getStatistic, getStatisticalSignifiance, set, setSelectedTestDescriptor, setStatistic, setStatisticalSignificance

Methods inherited from class pulse.search.statistics.ResidualStatistic
calculateResiduals, calculateResiduals, calculateResiduals, equals, getResiduals, getTimeSequence, hashCode, residualsArray

Methods inherited from class pulse.util.PropertyHolder
addListener, areDetailsHidden, data, describe, firePropertyChanged, getListeners, getPrefix, ignoreSiblings, initListeners, isListedNumericType, isListedParameter, listedKeywords, listedTypes, numericData, parameterListChanged, removeListeners, setPrefix, updateProperties, updateProperty

Methods inherited from class pulse.util.Accessible
accessibleChildren, genericProperties, genericProperty, numericProperties, numericProperty, property, update, update

Methods inherited from class pulse.util.Group
access, children, contents, getSimpleName, subgroups

Methods inherited from class pulse.util.UpwardsNavigable
addHierarchyListener, getHierarchyListeners, getParent, identify, removeHierarchyListener, removeHierarchyListeners, setParent, specificAncestor, tellParent

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

- Constructor Detail
  - RSquaredTest
```
public RSquaredTest()
```
- Method Detail
  - test
```
public boolean test(GeneralTask task)
```
    Specified by:
    
    test in class NormalityTest
  - evaluate
```
public void evaluate(GeneralTask t)
```
    Calculates the coefficient of determination, or simply the $R^{2}$ value.
    First, the mean temperature of the data is calculated. Then, the TSS (total sum of squares) is calculated as proportional to the variance of data. The residual sum of squares (RSS) is calculated by calling this.deviationSquares(curve). Finally, these values are combined together as: 1 - RSS/TSS.
    
    Specified by:
    
    evaluate in class Statistic
    
    Parameters:
    
    t - the task containing the reference data
    
    See Also:
    
    Wikipedia page
  - getSumOfSquares
```
public SumOfSquares getSumOfSquares()
```
  - setSumOfSquares
```
public void setSumOfSquares(SumOfSquares sos)
```
  - getDescriptor
```
public String getDescriptor()
```
    Description copied from class: PropertyHolder
    
    If not null, will return the prefix, otherwise calls the superclass method.
    
    Overrides:
    
    getDescriptor in class PropertyHolder
    
    Returns:
    
    the descriptor
    
    See Also:
    
    Group.getSimpleName()