SparseFieldLevelSet (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- levelsets.algorithm.SparseFieldLevelSet

All Implemented Interfaces:

StagedAlgorithm

Direct Known Subclasses:

LevelSetImplementation
```
public abstract class SparseFieldLevelSet
extends Object
implements StagedAlgorithm
```
Implementation of the Sparse Field Levelset algorithm.

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`CONVERGENCE_FACTOR`
`protected double`	`CONVERGENCE_WEIGHT`
`protected double`	`DELTA_T`
`protected ImageContainer`	`img`
`protected StateContainer`	`init_state`
`static int`	`INSIDE`
`static int`	`INSIDE_FAR`
`protected boolean`	`needInit`
`static int`	`OUTSIDE`
`static int`	`OUTSIDE_FAR`
`protected DeferredDoubleArray3D`	`phi`
`protected boolean`	`seed_grey_zero`
`protected int`	`seed_greyvalue`
`protected ImageContainer`	`source`
`static int`	`STATE_ZERO`
`protected double`	`zScale`

Constructor Summary

Constructors
Constructor and Description
`SparseFieldLevelSet(ImageContainer image, ImageProgressContainer img_progress, StateContainer init_state, double convergence)` Creates a new instance of LevelSet

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`cleanup()`
`void`	`dumpStateMap(String path)` Dums the statemap into a file
`protected abstract double`	`getDeltaPhi(int x, int y, int z)`
`StateContainer`	`getStateContainer()` Returns the state map as StateContainer
`int[][][]`	`getStateMap()` Returns the state map
`protected void`	`init()`
`boolean`	`step(int granularity)` See interface defintion for javadoc granularity is the max number of iterations that are executed before it returns returns true if no convergence reached (makes sense to continue), false if convergence has been reached
`protected abstract void`	`updateDeltaT()` Updates the time step for numerical solution.

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

- Field Detail
  - phi
```
protected DeferredDoubleArray3D phi
```
  - INSIDE
```
public static final int INSIDE
```
    See Also:
    
    Constant Field Values
  - OUTSIDE
```
public static final int OUTSIDE
```
    See Also:
    
    Constant Field Values
  - STATE_ZERO
```
public static final int STATE_ZERO
```
    See Also:
    
    Constant Field Values
  - INSIDE_FAR
```
public static final int INSIDE_FAR
```
    See Also:
    
    Constant Field Values
  - OUTSIDE_FAR
```
public static final int OUTSIDE_FAR
```
    See Also:
    
    Constant Field Values
  - source
```
protected ImageContainer source
```
  - img
```
protected ImageContainer img
```
  - init_state
```
protected StateContainer init_state
```
  - needInit
```
protected boolean needInit
```
  - seed_greyvalue
```
protected int seed_greyvalue
```
  - seed_grey_zero
```
protected boolean seed_grey_zero
```
  - DELTA_T
```
protected double DELTA_T
```
  - CONVERGENCE_WEIGHT
```
protected final double CONVERGENCE_WEIGHT
```
  - CONVERGENCE_FACTOR
```
protected double CONVERGENCE_FACTOR
```
  - zScale
```
protected double zScale
```
- Constructor Detail
  - SparseFieldLevelSet
```
public SparseFieldLevelSet(ImageContainer image,
                           ImageProgressContainer img_progress,
                           StateContainer init_state,
                           double convergence)
```
    Creates a new instance of LevelSet
    
    Parameters:
    
    image - The input image
    
    img_progress -
    
    init_state -
    
    convergence -
- Method Detail
  - getStateMap
```
public int[][][] getStateMap()
```
    Returns the state map
    
    Returns:
    
    The state map
  - getStateContainer
```
public StateContainer getStateContainer()
```
    Returns the state map as StateContainer
    
    Returns:
    
    The StateContainer
  - updateDeltaT
```
protected abstract void updateDeltaT()
```
    Updates the time step for numerical solution. Abstract class forces the derived class to implement it. If default settings are fine, just don't do anything
  - init
```
protected void init()
```
  - step
```
public boolean step(int granularity)
```
    See interface defintion for javadoc granularity is the max number of iterations that are executed before it returns returns true if no convergence reached (makes sense to continue), false if convergence has been reached
    
    Specified by:
    
    step in interface StagedAlgorithm
    
    Parameters:
    
    granularity - Number of steps to be executed before retuning (until further execution by a consecutive call)
    
    Returns:
    
    True if this algorithm can be continued by a further call, false otherwise.
  - getDeltaPhi
```
protected abstract double getDeltaPhi(int x,
                                      int y,
                                      int z)
```
  - cleanup
```
protected void cleanup()
```
  - dumpStateMap
```
public void dumpStateMap(String path)
```
    Dums the statemap into a file
    
    Parameters:
    
    path - Fully qualified filename of the output file

Class SparseFieldLevelSet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

phi

INSIDE

OUTSIDE

STATE_ZERO

INSIDE_FAR

OUTSIDE_FAR

source

img

init_state

needInit

seed_greyvalue

seed_grey_zero

DELTA_T

CONVERGENCE_WEIGHT

CONVERGENCE_FACTOR

zScale

Constructor Detail

SparseFieldLevelSet

Method Detail

getStateMap

getStateContainer

updateDeltaT

init

step

getDeltaPhi

cleanup

dumpStateMap