inra.ijpb.label.conncomp

Class BoundarySet

java.lang.Object

inra.ijpb.label.conncomp.BoundarySet

public class BoundarySet
extends Object

A list of boundaries, indexed by an integer label. Provides utility method to generate new boundaries when required.

Author:

dlegland

Constructor Summary

Constructors

Constructor and Description
BoundarySet() Creates a new (empty) BoundarySet.

Method Summary

Modifier and Type	Method and Description
Boundary	createBoundary(Collection<Integer> neighborLabels) Creates a new Boundary from the list of adjacent regions, add it to the set, and returns the new instance of Boundary.
Boundary	findBoundary(Collection<Integer> neighborLabels) Try to find a Boundary that has same adjacent regions as the ones specified in the argument.
Boundary	findOrCreateBoundary(Collection<Integer> neighborLabels) Try to find a Boundary that has same adjacent regions as the ones specified in the argument.
Boundary	getBoundary(int label) Retrieve a Boundary from its label.
int	size()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BoundarySet

public BoundarySet()

Creates a new (empty) BoundarySet.

Method Detail

size

public int size()

Returns:

the number of boundaries within the set.

getBoundary

public Boundary getBoundary(int label)

Retrieve a Boundary from its label.

Parameters:

label - the label of the boundary

Returns:

the boundary instance associated to the specified label

findOrCreateBoundary

public Boundary findOrCreateBoundary(Collection<Integer> neighborLabels)

Try to find a Boundary that has same adjacent regions as the ones specified in the argument. If no such Boundary can be found, creates a new one, adds it to the set, and returns the new Boundary.

Parameters:

neighborLabels - the (integer) labels of the regions adjacent to the boundary

Returns:

the (existing or new) Boundary instance with the specified labels as adjacent regions

findBoundary

public Boundary findBoundary(Collection<Integer> neighborLabels)

Try to find a Boundary that has same adjacent regions as the ones specified in the argument. If no such Boundary can be found, return null.

Parameters:

neighborLabels - the (integer) labels of the regions adjacent to the boundary

Returns:

the existing Boundary instance with the specified labels as adjacent regions, or null if no such boundary exist.

createBoundary

public Boundary createBoundary(Collection<Integer> neighborLabels)

Creates a new Boundary from the list of adjacent regions, add it to the set, and returns the new instance of Boundary.

Parameters:

neighborLabels - the list of labels of the (usually two) regions adjacent to the boundary.

Returns:

the new boundary.

toString

public String toString()

Overrides:

toString in class Object