BiSearch (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- sc.fiji.snt.tracing.AbstractSearch
- - sc.fiji.snt.tracing.BiSearch

All Implemented Interfaces:

Runnable, SearchInterface
```
public class BiSearch
extends AbstractSearch
```
A flexible implementation of the bidirectional heuristic search algorithm described in Pijls, W.H.L.M. & Post, H., 2009. "Yet another bidirectional algorithm for shortest paths," Econometric Institute Research Papers EI 2009-10, Erasmus University Rotterdam, Erasmus School of Economics (ESE), Econometric Institute.
The search distance function (Cost) and heuristic estimate (Heuristic) are supplied by the caller.

Author:

Cameron Arshadi

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`closed_from_goal_count`
`protected long`	`closed_from_start_count`
`protected Cost`	`costFunction`
`protected int`	`goal_x`
`protected int`	`goal_y`
`protected int`	`goal_z`
`protected Heuristic`	`heuristic`
`protected SearchImageStack<BiSearchNode>`	`nodes_as_image`
`protected org.jheaps.AddressableHeap<BiSearchNode,Void>`	`open_from_goal`
`protected org.jheaps.AddressableHeap<BiSearchNode,Void>`	`open_from_start`
`protected Path`	`result`
`protected int`	`start_x`
`protected int`	`start_y`
`protected int`	`start_z`

Fields inherited from class sc.fiji.snt.tracing.AbstractSearch
img, imgAccess, imgDepth, imgHeight, imgWidth, progressListeners, reportEveryMilliseconds, spacing_units, timeoutSeconds, verbose, xMax, xMin, xSep, yMax, yMin, ySep, zMax, zMin, zSep

Constructor Summary

Constructors
Constructor and Description
`BiSearch(RandomAccessibleInterval<? extends RealType<?>> image, ij.measure.Calibration calibration, int start_x, int start_y, int start_z, int goal_x, int goal_y, int goal_z, int timeoutSeconds, long reportEveryMilliseconds, SNT.SearchImageType searchImageType, Cost costFunction, Heuristic heuristic)`
`BiSearch(SNT snt, int start_x, int start_y, int start_z, int goal_x, int goal_y, int goal_z)`
`BiSearch(SNT snt, int start_x, int start_y, int start_z, int goal_x, int goal_y, int goal_z, Cost costFunction, Heuristic heuristic)`
`BiSearch(SNT snt, RandomAccessibleInterval<? extends RealType<?>> image, int start_x, int start_y, int start_z, int goal_x, int goal_y, int goal_z, Cost costFunction, Heuristic heuristic)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addProgressListener(SearchProgressCallback callback)`
`protected boolean`	`checkStatus()`
`protected void`	`expandNeighbors(BiSearchNode p, boolean fromStart)`
`SearchImageStack<BiSearchNode>`	`getNodesAsImage()`
`Path`	`getResult()`
`long`	`pointsConsideredInSearch()`
`void`	`printStatus()`
`protected Path`	`reconstructPath(double x_spacing, double y_spacing, double z_spacing, String spacing_units)`
`void`	`reportFinished(boolean success)`
`protected void`	`reportPointsInSearch()`
`void`	`run()`

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

Field Detail

start_x
```
protected final int start_x
```

start_y
```
protected final int start_y
```

start_z
```
protected final int start_z
```

goal_x
```
protected final int goal_x
```

goal_y
```
protected final int goal_y
```

goal_z
```
protected final int goal_z
```

costFunction
```
protected final Cost costFunction
```

heuristic
```
protected final Heuristic heuristic
```

open_from_start

protected org.jheaps.AddressableHeap<BiSearchNode,Void> open_from_start

open_from_goal

protected org.jheaps.AddressableHeap<BiSearchNode,Void> open_from_goal

closed_from_start_count
```
protected long closed_from_start_count
```

closed_from_goal_count
```
protected long closed_from_goal_count
```

nodes_as_image

protected final SearchImageStack<BiSearchNode> nodes_as_image

result
```
protected Path result
```

Constructor Detail

BiSearch

public BiSearch(RandomAccessibleInterval<? extends RealType<?>> image,
                ij.measure.Calibration calibration,
                int start_x,
                int start_y,
                int start_z,
                int goal_x,
                int goal_y,
                int goal_z,
                int timeoutSeconds,
                long reportEveryMilliseconds,
                SNT.SearchImageType searchImageType,
                Cost costFunction,
                Heuristic heuristic)

BiSearch

public BiSearch(SNT snt,
                RandomAccessibleInterval<? extends RealType<?>> image,
                int start_x,
                int start_y,
                int start_z,
                int goal_x,
                int goal_y,
                int goal_z,
                Cost costFunction,
                Heuristic heuristic)

BiSearch

public BiSearch(SNT snt,
                int start_x,
                int start_y,
                int start_z,
                int goal_x,
                int goal_y,
                int goal_z,
                Cost costFunction,
                Heuristic heuristic)

BiSearch

public BiSearch(SNT snt,
                int start_x,
                int start_y,
                int start_z,
                int goal_x,
                int goal_y,
                int goal_z)

Method Detail

run
```
public void run()
```

expandNeighbors

protected void expandNeighbors(BiSearchNode p,
                               boolean fromStart)

reconstructPath

protected Path reconstructPath(double x_spacing,
                               double y_spacing,
                               double z_spacing,
                               String spacing_units)

addProgressListener
```
public void addProgressListener(SearchProgressCallback callback)
```
Specified by:

addProgressListener in class AbstractSearch

reportFinished

public void reportFinished(boolean success)

pointsConsideredInSearch
```
public long pointsConsideredInSearch()
```
Specified by:

pointsConsideredInSearch in class AbstractSearch

checkStatus
```
protected boolean checkStatus()
```

getResult
```
public Path getResult()
```

printStatus
```
public void printStatus()
```
Specified by:

printStatus in class AbstractSearch

reportPointsInSearch
```
protected void reportPointsInSearch()
```
Specified by:

reportPointsInSearch in class AbstractSearch

getNodesAsImage

public SearchImageStack<BiSearchNode> getNodesAsImage()

Class BiSearch

Field Summary

Fields inherited from class sc.fiji.snt.tracing.AbstractSearch

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

start_x

start_y

start_z

goal_x

goal_y

goal_z

costFunction

heuristic

open_from_start

open_from_goal

closed_from_start_count

closed_from_goal_count

nodes_as_image

result

Constructor Detail

BiSearch

BiSearch

BiSearch

BiSearch

Method Detail

run

expandNeighbors

reconstructPath

addProgressListener

reportFinished

pointsConsideredInSearch

checkStatus

getResult

printStatus

reportPointsInSearch

getNodesAsImage