mpicbg.imglib.container.shapelist

Class ShapeList<T extends Type<T>>

java.lang.Object

mpicbg.imglib.container.ContainerImpl<T>

mpicbg.imglib.container.shapelist.ShapeList<T>

All Implemented Interfaces:

Container<T>

Direct Known Subclasses:

ShapeListCached

public class ShapeList<T extends Type<T>>
extends ContainerImpl<T>

TODO

Author:

Stephan Saalfeld, Stephan Saalfeld

Field Summary

Fields

Modifier and Type	Field and Description
protected T	background
ShapeListContainerFactory	factory
protected ArrayList<ArrayList<Shape>>	shapeLists
protected ArrayList<ArrayList<T>>	typeLists

Fields inherited from class mpicbg.imglib.container.ContainerImpl

dim, id, numDimensions, numPixels

Constructor Summary

Constructors

Constructor and Description
ShapeList(int[] dim, T background)
ShapeList(ShapeListContainerFactory factory, int[] dim, T background)

Method Summary

Modifier and Type	Method and Description
void	addShape(Shape shape, T type, int[] position)
void	close()
boolean	compareStorageContainerCompatibility(Container<?> container)
ShapeListLocalizableByDimCursor<T>	createCursor(Image<T> image)
ShapeListLocalizableByDimCursor<T>	createLocalizableByDimCursor(Image<T> image)
ShapeListLocalizableByDimOutOfBoundsCursor<T>	createLocalizableByDimCursor(Image<T> image, OutOfBoundsStrategyFactory<T> outOfBoundsFactory)
ShapeListLocalizableByDimCursor<T>	createLocalizableCursor(Image<T> image)
ShapeListLocalizablePlaneCursor<T>	createLocalizablePlaneCursor(Image<T> image)
T	getBackground()
ShapeListContainerFactory	getFactory()
ArrayList<ArrayList<Shape>>	getShapeLists()
T	getShapeType(int[] position) Find the upper most Shape visible at the given position and return its Type.
protected T	getShapeType(int x, int y, int p) Find the upper most Shape visible at the given position and return its Type.

Methods inherited from class mpicbg.imglib.container.ContainerImpl

compareStorageContainerDimensions, getDimension, getDimensions, getDimensions, getId, getNumDimensions, getNumPixels, getNumPixels, toString

Methods inherited from class java.lang.Object

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

Field Detail

factory

public final ShapeListContainerFactory factory

shapeLists

protected final ArrayList<ArrayList<Shape>> shapeLists

typeLists

protected final ArrayList<ArrayList<T extends Type<T>>> typeLists

background

protected final T extends Type<T> background

Constructor Detail

ShapeList

public ShapeList(ShapeListContainerFactory factory,
                 int[] dim,
                 T background)

ShapeList

public ShapeList(int[] dim,
                 T background)

Method Detail

getBackground

public T getBackground()

addShape

public void addShape(Shape shape,
                     T type,
                     int[] position)

getShapeLists

public ArrayList<ArrayList<Shape>> getShapeLists()

Returns:

a shallow copy of the lists of Shape instances. That is, the Shape instances themselves are the originals.

getFactory

public ShapeListContainerFactory getFactory()

Specified by:

getFactory in interface Container<T extends Type<T>>

Overrides:

getFactory in class ContainerImpl<T extends Type<T>>

createCursor

public ShapeListLocalizableByDimCursor<T> createCursor(Image<T> image)

createLocalizableCursor

public ShapeListLocalizableByDimCursor<T> createLocalizableCursor(Image<T> image)

createLocalizablePlaneCursor

public ShapeListLocalizablePlaneCursor<T> createLocalizablePlaneCursor(Image<T> image)

createLocalizableByDimCursor

public ShapeListLocalizableByDimCursor<T> createLocalizableByDimCursor(Image<T> image)

createLocalizableByDimCursor

public ShapeListLocalizableByDimOutOfBoundsCursor<T> createLocalizableByDimCursor(Image<T> image,
                                                                                  OutOfBoundsStrategyFactory<T> outOfBoundsFactory)

close

public void close()

getShapeType

protected T getShapeType(int x,
                         int y,
                         int p)

Find the upper most Shape visible at the given position and return its Type. Does not perform bounds checking. For shape planes, this doesn't matter, but for all other dimensions, the result is undefined or an IndexOutOfBoundsException.

Parameters:

x -

y -

p - pre-multiplied index of all dimensions >1

Returns:

getShapeType

public T getShapeType(int[] position)

Find the upper most Shape visible at the given position and return its Type. This random access and, therefore, not efficient. Use only if the dimensions >1 cannot be pre-calculated. Does not perform bounds checking. For shape planes, this doesn't matter, but for all other dimensions, the result is undefined or an IndexOutOfBoundsException.

Parameters:

position -

Returns:

compareStorageContainerCompatibility

public boolean compareStorageContainerCompatibility(Container<?> container)