net.imglib2.roi.labeling

Class LabelingMapping<T>

java.lang.Object

net.imglib2.roi.labeling.LabelingMapping<T>

Type Parameters:

T - the desired type of the pixel labels, for instance Integer to number objects or String for user-assigned label names.

public class LabelingMapping<T>
extends Object

The LabelingMapping maps a set of labelings of a pixel to an index value which can be more compactly stored than the set of labelings. It provides an intern(Set) function that supplies a canonical object for each set of labelings in a container, and functions addLabelToSetAtIndex(Object, int), removeLabelFromSetAtIndex(Object, int) for efficiently adding and removing labels to the set at a given index value.

Author:

Lee Kamentsky, Tobias Pietzsch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LabelingMapping.SerialisationAccess<T> Internals.

Constructor Summary

Constructors

Constructor and Description
LabelingMapping(IntegerType<?> indexType) Create a new LabelingMapping that maps label sets to the given integral indexType.

Method Summary

Modifier and Type	Method and Description
Set<T>	getLabels() Return the set of all labels defined in this LabelingMapping.
Set<T>	labelsAtIndex(int index) Returns the (unmodifiable) set of labels for the given index value.
int	numSets() Returns the number of indexed labeling sets

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LabelingMapping

public LabelingMapping(IntegerType<?> indexType)

Create a new LabelingMapping that maps label sets to the given integral indexType.

Method Detail

numSets

public int numSets()

Returns the number of indexed labeling sets

labelsAtIndex

public Set<T> labelsAtIndex(int index)

Returns the (unmodifiable) set of labels for the given index value.

getLabels

public Set<T> getLabels()

Return the set of all labels defined in this LabelingMapping.