LabelingType (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.roi.labeling.LabelingType<T>

Type Parameters:

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

All Implemented Interfaces:

Iterable<T>, Collection<T>, Set<T>, ValueEquals<LabelingType<T>>, Type<LabelingType<T>>
```
public class LabelingType<T>
extends Object
implements Type<LabelingType<T>>, Set<T>
```
The LabelingType represents a labeling of a pixel with zero or more labels of type T. Each label names a distinct object in the image space.

Author:

Lee Kamentsky, Tobias Pietzsch

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class LabelingType.ModCount

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`LabelingType.ModCount`

Field Summary

Fields
Modifier and Type Field and Description

protected LabelingType.ModCount generation

protected LabelingMapping<T> mapping

protected IntegerType<?> type

Fields
Modifier and Type	Field and Description
`protected LabelingType.ModCount`	`generation`
`protected LabelingMapping<T>`	`mapping`
`protected IntegerType<?>`	`type`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`LabelingType(IntegerType<?> type, LabelingMapping<T> mapping, LabelingType.ModCount modCount)` Constructor for mirroring state with another labeling

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(T label)`
`boolean`	`addAll(Collection<? extends T> c)`
`void`	`clear()`
`boolean`	`contains(Object label)`
`boolean`	`containsAll(Collection<?> labels)`
`LabelingType<T>`	`copy()` Note: The copy shares the mapping of this `LabelingType`.
`LabelingType<T>`	`createVariable()` Note: This creates an "independent" `LabelingType` instance that has its own `LabelingMapping`.
`<L> LabelingType<L>`	`createVariable(Class<? extends L> newType)` Creates a new `LabelingType` based on the underlying `IntegerType` of the existing `LabelingType` with a different label type L
`boolean`	`equals(Object obj)`
`int`	`getGeneration()` The underlying storage has an associated generation which is incremented every time the storage is modified.
`IntegerType<?>`	`getIndex()`
`LabelingMapping<T>`	`getMapping()`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`Iterator<T>`	`iterator()` Note: the returned iterator reflects the label set at the time this method was called.
`boolean`	`remove(Object label)`
`boolean`	`removeAll(Collection<?> c)`
`boolean`	`retainAll(Collection<?> c)`
`void`	`set(LabelingType<T> c)` Sets the value of another `Type`.
`int`	`size()`
`Object[]`	`toArray()`
`<T1> T1[]`	`toArray(T1[] a)`
`String`	`toString()`
`boolean`	`valueEquals(LabelingType<T> t)`

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

Methods inherited from interface java.util.Set
spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - generation
```
protected final LabelingType.ModCount generation
```
  - mapping
```
protected final LabelingMapping<T> mapping
```
  - type
```
protected IntegerType<?> type
```
- Constructor Detail
  - LabelingType
```
protected LabelingType(IntegerType<?> type,
                       LabelingMapping<T> mapping,
                       LabelingType.ModCount modCount)
```
    Constructor for mirroring state with another labeling
    
    Parameters:
    
    type - Wrapped type
    
    mapping - Mapping from wrapped type to LabelingList
    
    modCount - Generation of the type
- Method Detail
  - set
```
public void set(LabelingType<T> c)
```
    Description copied from interface: Type
    
    Sets the value of another Type.
    
    Specified by:
    
    set in interface Type<LabelingType<T>>
    
    Parameters:
    
    c - the new value
  - createVariable
```
public LabelingType<T> createVariable()
```
    Note: This creates an "independent" LabelingType instance that has its own LabelingMapping.
    
    Specified by:
    
    createVariable in interface Type<LabelingType<T>>
    
    Returns:
    
    a new Type variable
  - copy
```
public LabelingType<T> copy()
```
    Note: The copy shares the mapping of this LabelingType. The rationale is that clients will use this to remember the value at a given position, and this.set( this.copy() ) will be fast if the copy has the same mapping. If this causes problems, we may change it later.
    
    Specified by:
    
    copy in interface Type<LabelingType<T>>
    
    Returns:
    
    a new Type variable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getGeneration
```
public int getGeneration()
```
    The underlying storage has an associated generation which is incremented every time the storage is modified. For cacheing, it's often convenient or necessary to know whether the storage has changed to know when the cache is invalid. The strategy is to save the generation number at the time of cacheing and invalidate the cache if the number doesn't match.
    
    Returns:
    
    the generation of the underlying storage
  - getMapping
```
public LabelingMapping<T> getMapping()
```
  - getIndex
```
public IntegerType<?> getIndex()
```
    Returns:
    
    IntegerType holding the current index at the position of the LabelingType. NB: The returned IntegerType should be used read-only. Don't write to this type. The value of the IntegerType refers to a key in the LabelingMapping. Writing to this type may invalidate the caching of the LabelingROIStrategy.
  - add
```
public boolean add(T label)
```
    Specified by:
    
    add in interface Collection<T>
    
    Specified by:
    
    add in interface Set<T>
  - addAll
```
public boolean addAll(Collection<? extends T> c)
```
    Specified by:
    
    addAll in interface Collection<T>
    
    Specified by:
    
    addAll in interface Set<T>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<T>
    
    Specified by:
    
    clear in interface Set<T>
  - contains
```
public boolean contains(Object label)
```
    Specified by:
    
    contains in interface Collection<T>
    
    Specified by:
    
    contains in interface Set<T>
  - containsAll
```
public boolean containsAll(Collection<?> labels)
```
    Specified by:
    
    containsAll in interface Collection<T>
    
    Specified by:
    
    containsAll in interface Set<T>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<T>
    
    Specified by:
    
    isEmpty in interface Set<T>
  - iterator
```
public Iterator<T> iterator()
```
    Note: the returned iterator reflects the label set at the time this method was called. Subsequent changes to the position of the LabelingType or the label set are not reflected!
    
    Specified by:
    
    iterator in interface Iterable<T>
    
    Specified by:
    
    iterator in interface Collection<T>
    
    Specified by:
    
    iterator in interface Set<T>
  - remove
```
public boolean remove(Object label)
```
    Specified by:
    
    remove in interface Collection<T>
    
    Specified by:
    
    remove in interface Set<T>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Specified by:
    
    removeAll in interface Collection<T>
    
    Specified by:
    
    removeAll in interface Set<T>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<T>
    
    Specified by:
    
    retainAll in interface Set<T>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<T>
    
    Specified by:
    
    size in interface Set<T>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<T>
    
    Specified by:
    
    toArray in interface Set<T>
  - toArray
```
public <T1> T1[] toArray(T1[] a)
```
    Specified by:
    
    toArray in interface Collection<T>
    
    Specified by:
    
    toArray in interface Set<T>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<T>
    
    Specified by:
    
    hashCode in interface Set<T>
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface Collection<T>
    
    Specified by:
    
    equals in interface Set<T>
    
    Overrides:
    
    equals in class Object
  - createVariable
```
public <L> LabelingType<L> createVariable(Class<? extends L> newType)
```
    Creates a new LabelingType based on the underlying IntegerType of the existing LabelingType with a different label type L
    
    Parameters:
    
    newType - the type of the labels of the created LabelingType
    
    Returns:
    
    new LabelingType
  - valueEquals
```
public boolean valueEquals(LabelingType<T> t)
```
    Specified by:
    
    valueEquals in interface ValueEquals<LabelingType<T>>

Class LabelingType<T>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

generation

mapping

type

Constructor Detail

LabelingType

Method Detail

set

createVariable

copy

toString

getGeneration

getMapping

getIndex

add

addAll

clear

contains

containsAll

isEmpty

iterator

remove

removeAll

retainAll

size

toArray

toArray

hashCode

equals

createVariable

valueEquals