DefaultLabelingCursorStrategy (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.labeling.DefaultLabelingCursorStrategy<T,L>

Type Parameters:

T -

L -

All Implemented Interfaces:

LabelingCursorStrategy<T,L>
```
public class DefaultLabelingCursorStrategy<T extends Comparable<T>,L extends Labeling<T>>
extends Object
implements LabelingCursorStrategy<T,L>
```
A relatively conservative strategy suitable for blobby objects - retain the bounding boxes and raster starts and reconstruct the cursors by scanning.

Author:

Lee Kamentsky, leek

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`generation`
`protected L`	`labeling`
`protected Map<T,mpicbg.imglib.labeling.DefaultLabelingCursorStrategy.LabelStatistics>`	`statistics`
`protected LabelingType<T>`	`type`

Constructor Summary

Constructors
Constructor and Description

DefaultLabelingCursorStrategy(L labeling)

Constructors
Constructor and Description
`DefaultLabelingCursorStrategy(L labeling)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`computeStatistics()` Compute all statistics on the labels if cache is dirty.
`LocalizableCursor<FakeType>`	`createLocalizableLabelCursor(T label)` A localizable cursor that iterates over every pixel with the given label.
`LocalizableCursor<FakeType>`	`createLocalizablePerimeterCursor(T label)` A localizable cursor that iterates over every pixel in the perimeter of the labeled object.
`long`	`getArea(T label)` Return the area of the labeled object in units of pixels or the volume of the labeled object in voxels (or the hyper-volume of the 4/5-d object in ?toxels? or ?spectracels? or ?spectratoxels?)
`boolean`	`getExtents(T label, int[] minExtents, int[] maxExtents)` Get the extents of the bounding box around the labeled object
`Collection<T>`	`getLabels()` Find all of the labels used to label pixels.
`boolean`	`getRasterStart(T label, int[] start)` The coordinates of the first pixel with the given label when raster scanning through the space.

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

- Field Detail
  - labeling
```
protected final L extends Labeling<T> labeling
```
  - generation
```
protected long generation
```
  - type
```
protected LabelingType<T extends Comparable<T>> type
```
  - statistics
```
protected Map<T extends Comparable<T>,mpicbg.imglib.labeling.DefaultLabelingCursorStrategy.LabelStatistics> statistics
```
- Constructor Detail
  - DefaultLabelingCursorStrategy
```
public DefaultLabelingCursorStrategy(L labeling)
```
- Method Detail
  - computeStatistics
```
protected void computeStatistics()
```
    Compute all statistics on the labels if cache is dirty.
  - createLocalizableLabelCursor
```
public LocalizableCursor<FakeType> createLocalizableLabelCursor(T label)
```
    Description copied from interface: LabelingCursorStrategy
    
    A localizable cursor that iterates over every pixel with the given label.
    
    Specified by:
    
    createLocalizableLabelCursor in interface LabelingCursorStrategy<T extends Comparable<T>,L extends Labeling<T>>
    
    Parameters:
    
    label - - the label of the pixels to be traversed
    
    Returns:
    
    a localizable cursor that can be used to find the position of every pixel with the given label.
  - createLocalizablePerimeterCursor
```
public LocalizableCursor<FakeType> createLocalizablePerimeterCursor(T label)
```
    Description copied from interface: LabelingCursorStrategy
    
    A localizable cursor that iterates over every pixel in the perimeter of the labeled object. Given a space S(x[1],...x[D]) of dimension D, a pixel is a perimeter pixel of a label if the pixel has that label and there is some pixel S(x[1]+y[1],..x[D]+y[D]) that is not labeled for sum(abs(y[i in 1..D])) == 1 - in other words, the pixel is adjacent to a non-labeled pixel where diagonals don't count.
    
    Specified by:
    
    createLocalizablePerimeterCursor in interface LabelingCursorStrategy<T extends Comparable<T>,L extends Labeling<T>>
    
    Parameters:
    
    label - - the label to be traversed
    
    Returns:
    
    a cursor over the perimeter of the labeled object
  - getExtents
```
public boolean getExtents(T label,
                          int[] minExtents,
                          int[] maxExtents)
```
    Description copied from interface: LabelingCursorStrategy
    
    Get the extents of the bounding box around the labeled object
    
    Specified by:
    
    getExtents in interface LabelingCursorStrategy<T extends Comparable<T>,L extends Labeling<T>>
    
    Parameters:
    
    label - - the label of the object in question
    
    minExtents - - on input, must be an array of size D or larger where D is the dimension of the space. On output, the minimum value of the pixel coordinates for the labeled object is stored in the array.
    
    maxExtents - - the maximum value of the pixel coordinates for the labeled object.
    
    Returns:
    
    true if some pixel has the label
  - getRasterStart
```
public boolean getRasterStart(T label,
                              int[] start)
```
    Description copied from interface: LabelingCursorStrategy
    
    The coordinates of the first pixel with the given label when raster scanning through the space. There is a class of algorithms on labeled objects that trace around the perimeter or surface of the object, starting with the first pixel encountered in a raster scan (given a space S(x[1],..x[D]) of dimension D, sort the coordinates of the labeled pixels by increasing x[1], then increasing x[2], etc and pick the first in the list). This function can be used to find the pixel. Note: the algorithms typically assume that all similarly labeled pixels are connected and that either there are no holes or holes are not significant.
    
    Specified by:
    
    getRasterStart in interface LabelingCursorStrategy<T extends Comparable<T>,L extends Labeling<T>>
    
    Parameters:
    
    label - - search on pixels of this label
    
    start - - on input, an array of at least size D, on output the coordinates of the raster start.
    
    Returns:
    
    true if some pixel has the label
  - getArea
```
public long getArea(T label)
```
    Description copied from interface: LabelingCursorStrategy
    
    Return the area of the labeled object in units of pixels or the volume of the labeled object in voxels (or the hyper-volume of the 4/5-d object in ?toxels? or ?spectracels? or ?spectratoxels?)
    
    Specified by:
    
    getArea in interface LabelingCursorStrategy<T extends Comparable<T>,L extends Labeling<T>>
    
    Returns:
    
    the area of the labeled object in pixels.
  - getLabels
```
public Collection<T> getLabels()
```
    Description copied from interface: LabelingCursorStrategy
    
    Find all of the labels used to label pixels.
    
    Specified by:
    
    getLabels in interface LabelingCursorStrategy<T extends Comparable<T>,L extends Labeling<T>>
    
    Returns:
    
    array of labels used.

Class DefaultLabelingCursorStrategy<T extends Comparable<T>,L extends Labeling<T>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

labeling

generation

type

statistics

Constructor Detail

DefaultLabelingCursorStrategy

Method Detail

computeStatistics

createLocalizableLabelCursor

createLocalizablePerimeterCursor

getExtents

getRasterStart

getArea

getLabels