LiHistogram2D (Fiji Javadocs 0-SNAPSHOT API)

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

Type Parameters:

T -
```
public class LiHistogram2D<T extends RealType<T>>
extends Histogram2D<T>
```
Represents the creation of a 2D histogram between two images. Channel 1 is set out in x direction, while channel 2 in y direction. The value calculation is done after Li.

Nested Class Summary
- Nested classes/interfaces inherited from class sc.fiji.coloc.algorithms.Histogram2D
  Histogram2D.DrawingFlags

Field Summary
- Fields inherited from class sc.fiji.coloc.algorithms.Histogram2D
  ch1Label, ch2Label, swapChannels, title, xBins, yBins
- Fields inherited from class sc.fiji.coloc.algorithms.Algorithm
  name

Constructor Summary

Constructors
Constructor and Description
`LiHistogram2D(boolean useCh1)`
`LiHistogram2D(String title, boolean useCh1)`
`LiHistogram2D(String title, boolean swapChannels, boolean useCh1)`
`LiHistogram2D(String title, boolean swapChannels, boolean useCh1, EnumSet<Histogram2D.DrawingFlags> drawingSettings)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`execute(DataContainer<T> container)` Executes the previously initialized `Algorithm`.
`protected double`	`getXBinWidth(DataContainer<T> container)` Calculates the bin width of one bin in x/ch1 direction.
`protected double`	`getXMax(DataContainer<T> container)`
`protected double`	`getXMin(DataContainer<T> container)`
`protected int`	`getXValue(double ch1Val, double ch1BinWidth, double ch2Val, double ch2BinWidth)` Calculates the locations x value.
`protected double`	`getYBinWidth(DataContainer<T> container)` Calculates the bin width of one bin in y/ch2 direction.
`protected double`	`getYMax(DataContainer<T> container)`
`protected double`	`getYMin(DataContainer<T> container)`
`protected int`	`getYValue(double ch1Val, double ch1BinWidth, double ch2Val, double ch2BinWidth)` Calculates the locations y value.

Methods inherited from class sc.fiji.coloc.algorithms.Histogram2D
generateHistogramData, getData, getDrawingSettings, getImageCh1, getImageCh2, getLabelCh1, getLabelCh2, getMaxCh1, getMaxCh2, getMinCh1, getMinCh2, getPlotImage, getTitle, getXBinWidth, getXLabel, getXMax, getXMin, getYBinWidth, getYLabel, getYMax, getYMin, processResults

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
  - LiHistogram2D
```
public LiHistogram2D(boolean useCh1)
```
  - LiHistogram2D
```
public LiHistogram2D(String title,
                     boolean useCh1)
```
  - LiHistogram2D
```
public LiHistogram2D(String title,
                     boolean swapChannels,
                     boolean useCh1)
```
  - LiHistogram2D
```
public LiHistogram2D(String title,
                     boolean swapChannels,
                     boolean useCh1,
                     EnumSet<Histogram2D.DrawingFlags> drawingSettings)
```
- Method Detail
  - execute
```
public void execute(DataContainer<T> container)
             throws MissingPreconditionException
```
    Description copied from class: Algorithm
    
    Executes the previously initialized Algorithm.
    
    Overrides:
    
    execute in class Histogram2D<T extends RealType<T>>
    
    Throws:
    
    MissingPreconditionException
  - getXBinWidth
```
protected double getXBinWidth(DataContainer<T> container)
```
    Description copied from class: Histogram2D
    
    Calculates the bin width of one bin in x/ch1 direction.
    
    Overrides:
    
    getXBinWidth in class Histogram2D<T extends RealType<T>>
    
    Parameters:
    
    container - The container with images to work on
    
    Returns:
    
    The width of one bin in x direction
  - getYBinWidth
```
protected double getYBinWidth(DataContainer<T> container)
```
    Description copied from class: Histogram2D
    
    Calculates the bin width of one bin in y/ch2 direction.
    
    Overrides:
    
    getYBinWidth in class Histogram2D<T extends RealType<T>>
    
    Parameters:
    
    container - The container with images to work on
    
    Returns:
    
    The width of one bin in y direction
  - getXValue
```
protected int getXValue(double ch1Val,
                        double ch1BinWidth,
                        double ch2Val,
                        double ch2BinWidth)
```
    Description copied from class: Histogram2D
    
    Calculates the locations x value.
    
    Overrides:
    
    getXValue in class Histogram2D<T extends RealType<T>>
    
    Parameters:
    
    ch1Val - The intensity of channel one
    
    ch1BinWidth - The bin width for channel one
    
    Returns:
    
    The x value of the data point location
  - getYValue
```
protected int getYValue(double ch1Val,
                        double ch1BinWidth,
                        double ch2Val,
                        double ch2BinWidth)
```
    Description copied from class: Histogram2D
    
    Calculates the locations y value.
    
    Overrides:
    
    getYValue in class Histogram2D<T extends RealType<T>>
    
    ch2Val - The intensity of channel one
    
    ch2BinWidth - The bin width for channel one
    
    Returns:
    
    The x value of the data point location
  - getXMin
```
protected double getXMin(DataContainer<T> container)
```
    Overrides:
    
    getXMin in class Histogram2D<T extends RealType<T>>
  - getXMax
```
protected double getXMax(DataContainer<T> container)
```
    Overrides:
    
    getXMax in class Histogram2D<T extends RealType<T>>
  - getYMin
```
protected double getYMin(DataContainer<T> container)
```
    Overrides:
    
    getYMin in class Histogram2D<T extends RealType<T>>
  - getYMax
```
protected double getYMax(DataContainer<T> container)
```
    Overrides:
    
    getYMax in class Histogram2D<T extends RealType<T>>

Class LiHistogram2D<T extends RealType<T>>

Nested Class Summary

Nested classes/interfaces inherited from class sc.fiji.coloc.algorithms.Histogram2D

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

LiHistogram2D

LiHistogram2D

LiHistogram2D

LiHistogram2D

Method Detail

execute

getXBinWidth

getYBinWidth

getXValue

getYValue

getXMin

getXMax

getYMin

getYMax