Fill (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- sc.fiji.snt.Fill

```
public class Fill
extends Object
```
Defines a filled structure.

Author:

Mark Longair, Tiago Ferreira, Cameron Arshadi

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Fill.Node
Defines a node in a filled structure.

Nested Classes
Modifier and Type	Class and Description
`class`	`Fill.Node` Defines a node in a filled structure.

Field Summary

Fields
Modifier and Type Field and Description

double distanceThreshold

SNT.CostType metric

String spacing_units

double x_spacing

double y_spacing

double z_spacing

Fields
Modifier and Type	Field and Description
`double`	`distanceThreshold`
`SNT.CostType`	`metric`
`String`	`spacing_units`
`double`	`x_spacing`
`double`	`y_spacing`
`double`	`z_spacing`

Constructor Summary

Constructors
Constructor and Description

Fill()

Constructors
Constructor and Description
`Fill()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(int x, int y, int z, double distance, int previous, boolean open)`
`SNT.CostType`	`getMetric()`
`List<Fill.Node>`	`getNodeList()`
`Set<Path>`	`getSourcePaths()`
`String`	`getSourcePathsStringHuman()`
`String`	`getSourcePathsStringMachine()`
`double`	`getThreshold()`
`double`	`getVolume()` Returns the Fill volume.
`void`	`setMetric(SNT.CostType cost)`
`void`	`setSourcePaths(Path[] newSourcePaths)`
`void`	`setSourcePaths(Set<Path> newSourcePaths)`
`void`	`setSpacing(double x_spacing, double y_spacing, double z_spacing, String units)`
`void`	`setThreshold(double threshold)`
`String`	`toString()`
`void`	`writeNodesXML(PrintWriter pw)`
`void`	`writeXML(PrintWriter pw, int fillIndex)`

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

Field Detail

distanceThreshold
```
public double distanceThreshold
```

metric
```
public SNT.CostType metric
```

x_spacing
```
public double x_spacing
```

y_spacing
```
public double y_spacing
```

z_spacing
```
public double z_spacing
```

spacing_units
```
public String spacing_units
```

Constructor Detail
- Fill
```
public Fill()
```

Method Detail

getNodeList
```
public List<Fill.Node> getNodeList()
```

add

public void add(int x,
                int y,
                int z,
                double distance,
                int previous,
                boolean open)

getSourcePaths
```
public Set<Path> getSourcePaths()
```

setSourcePaths

public void setSourcePaths(Path[] newSourcePaths)

setSourcePaths

public void setSourcePaths(Set<Path> newSourcePaths)

setMetric

public void setMetric(SNT.CostType cost)

getMetric
```
public SNT.CostType getMetric()
```

setSpacing

public void setSpacing(double x_spacing,
                       double y_spacing,
                       double z_spacing,
                       String units)

setThreshold

public void setThreshold(double threshold)

getThreshold
```
public double getThreshold()
```

writeNodesXML

public void writeNodesXML(PrintWriter pw)

writeXML

public void writeXML(PrintWriter pw,
                     int fillIndex)

getVolume
```
public double getVolume()
```
Returns the Fill volume. It assumes that the volume is just the number of sub-threshold nodes multiplied by x_spacing * y_spacing * z_spacing.

Returns:

the volume

getSourcePathsStringMachine

public String getSourcePathsStringMachine()

getSourcePathsStringHuman

public String getSourcePathsStringHuman()

toString
```
public String toString()
```
Overrides:

toString in class Object

Class Fill

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

distanceThreshold

metric

x_spacing

y_spacing

z_spacing

spacing_units

Constructor Detail

Fill

Method Detail

getNodeList

add

getSourcePaths

setSourcePaths

setSourcePaths

setMetric

getMetric

setSpacing

setThreshold

getThreshold

writeNodesXML

writeXML

getVolume

getSourcePathsStringMachine

getSourcePathsStringHuman

toString