AutoThresholdRegression (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- sc.fiji.coloc.algorithms.Algorithm<T>
- - sc.fiji.coloc.algorithms.AutoThresholdRegression<T>

```
public class AutoThresholdRegression<T extends RealType<T>>
extends Algorithm<T>
```
A class implementing the automatic finding of a threshold used for Pearson colocalisation calculation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AutoThresholdRegression.Implementation

Nested Classes
Modifier and Type	Class and Description
`static class`	`AutoThresholdRegression.Implementation`

Field Summary
- Fields inherited from class sc.fiji.coloc.algorithms.Algorithm
  name

Constructor Summary

Constructors
Constructor and Description
`AutoThresholdRegression(PearsonsCorrelation<T> pc)`
`AutoThresholdRegression(PearsonsCorrelation<T> pc, AutoThresholdRegression.Implementation impl)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static double`	`clamp(double val, double min, double max)` Clamp a value to a min or max value.
`void`	`execute(DataContainer<T> container)` Executes the previously initialized `Algorithm`.
`double`	`getAutoThresholdIntercept()`
`double`	`getAutoThresholdSlope()`
`double`	`getBToYMeanRatio()`
`T`	`getCh1MaxThreshold()`
`T`	`getCh1MinThreshold()`
`T`	`getCh2MaxThreshold()`
`T`	`getCh2MinThreshold()`
`double`	`getWarnYInterceptToYMaxRatioThreshold()`
`void`	`processResults(ResultHandler<T> handler)` A method to give the algorithm the opportunity to let its results being processed by the passed handler.

Methods inherited from class sc.fiji.coloc.algorithms.Algorithm
addWarning, getName, getWarnings

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

- Constructor Detail
  - AutoThresholdRegression
```
public AutoThresholdRegression(PearsonsCorrelation<T> pc)
```
  - AutoThresholdRegression
```
public AutoThresholdRegression(PearsonsCorrelation<T> pc,
                               AutoThresholdRegression.Implementation impl)
```
- Method Detail
  - execute
```
public void execute(DataContainer<T> container)
             throws MissingPreconditionException
```
    Description copied from class: Algorithm
    
    Executes the previously initialized Algorithm.
    
    Specified by:
    
    execute in class Algorithm<T extends RealType<T>>
    
    Throws:
    
    MissingPreconditionException
  - clamp
```
public static double clamp(double val,
                           double min,
                           double max)
```
    Clamp a value to a min or max value. If the value is below min, min is returned. Accordingly, max is returned if the value is larger. If it is neither, the value itself is returned.
  - processResults
```
public void processResults(ResultHandler<T> handler)
```
    Description copied from class: Algorithm
    
    A method to give the algorithm the opportunity to let its results being processed by the passed handler. By default this methods passes the collected warnings to the handler and sub-classes should make use of this by adding custom behavior and call the super class.
    
    Overrides:
    
    processResults in class Algorithm<T extends RealType<T>>
    
    Parameters:
    
    handler - The ResultHandler to process the results.
  - getBToYMeanRatio
```
public double getBToYMeanRatio()
```
  - getWarnYInterceptToYMaxRatioThreshold
```
public double getWarnYInterceptToYMaxRatioThreshold()
```
  - getAutoThresholdSlope
```
public double getAutoThresholdSlope()
```
  - getAutoThresholdIntercept
```
public double getAutoThresholdIntercept()
```
  - getCh1MinThreshold
```
public T getCh1MinThreshold()
```
  - getCh1MaxThreshold
```
public T getCh1MaxThreshold()
```
  - getCh2MinThreshold
```
public T getCh2MinThreshold()
```
  - getCh2MaxThreshold
```
public T getCh2MaxThreshold()
```

Class AutoThresholdRegression<T extends RealType<T>>

Nested Class Summary

Field Summary

Fields inherited from class sc.fiji.coloc.algorithms.Algorithm

Constructor Summary

Method Summary

Methods inherited from class sc.fiji.coloc.algorithms.Algorithm

Methods inherited from class java.lang.Object

Constructor Detail

AutoThresholdRegression

AutoThresholdRegression

Method Detail

execute

clamp

processResults

getBToYMeanRatio

getWarnYInterceptToYMaxRatioThreshold

getAutoThresholdSlope

getAutoThresholdIntercept

getCh1MinThreshold

getCh1MaxThreshold

getCh2MinThreshold

getCh2MaxThreshold