Package org.anchoranalysis.image.bean.nonbean.spatial.arrange

Class StackArrangement

Object

StackArrangement

All Implemented Interfaces:

Iterable<BoundingBoxEnclosed>

public final class StackArrangement
extends Object
implements Iterable<BoundingBoxEnclosed>

A list of BoundingBoxes that indicate where to locate corresponding Stacks on a unified larger image.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
StackArrangement(Extent extent)	Create with the overall Extent and no boxes.
StackArrangement(Extent extent, List<BoundingBoxEnclosed> boxes)	Creates a new StackArrangement instance.
StackArrangement(Extent extent, BoundingBox box)	Create with a single BoundingBox.

Method Summary

Modifier and Type	Method	Description
void	add(BoundingBoxEnclosed box)	Adds a new BoundingBoxEnclosed to the arrangement.
void	add(BoundingBox box)	Adds a new BoundingBox to the arrangement, with no padding.
List<BoundingBoxEnclosed>	boxes()	Where to locate a respective image on a larger image.
boolean	equals(Object o)
Extent	extent()	The size of the larger image in which all the BoundingBoxes in list must fully reside.
BoundingBoxEnclosed	get(int index)	Gets the BoundingBox corresponding to a particular index.
int	hashCode()
Iterator<BoundingBoxEnclosed>	iterator()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

StackArrangement

public StackArrangement(Extent extent)

Create with the overall Extent and no boxes.

Parameters:

extent - the size of the larger image in which all the BoundingBoxes in list must fully reside.

StackArrangement

public StackArrangement(Extent extent,
 BoundingBox box)

Create with a single BoundingBox.

Parameters:

extent - the size of the larger image in which all the BoundingBoxes in list must fully reside.

box - the BoundingBox.

StackArrangement

public StackArrangement(Extent extent,
 List<BoundingBoxEnclosed> boxes)

Creates a new StackArrangement instance.

Parameters:

extent - The size of the larger image in which all the BoundingBoxes in list must fully reside.

boxes - Where to locate a respective image on a larger image.

Method Details

add

public void add(BoundingBox box)

Adds a new BoundingBox to the arrangement, with no padding.

Parameters:

box - the BoundingBox in which the image should be placed.

add

public void add(BoundingBoxEnclosed box)

Adds a new BoundingBoxEnclosed to the arrangement.

Parameters:

box - the BoundingBox in which the image should be placed, together with any enclosing box (e.g. with padding).

get

public BoundingBoxEnclosed get(int index)

Gets the BoundingBox corresponding to a particular index.

Parameters:

index - the index.

Returns:

the corresponding BoundingBox in the arrangement, and any enclosing bounding-box.

Throws:

IndexOutOfBoundsException - if the index is out of range.

iterator

public Iterator<BoundingBoxEnclosed> iterator()

Specified by:

iterator in interface Iterable<BoundingBoxEnclosed>

extent

public Extent extent()

The size of the larger image in which all the BoundingBoxes in list must fully reside.

boxes

public List<BoundingBoxEnclosed> boxes()

Where to locate a respective image on a larger image.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object