org.anchoranalysis.mpp.mark

Class MarkCollection

Object

MarkCollection

All Implemented Interfaces:

Serializable, Iterable<Mark>

public final class MarkCollection
extends Object
implements Iterable<Mark>, Serializable

An ordered collection of Marks.

This is often termed a configuration in marked-point-processes academic literature.

Author:

Owen Feehan

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MarkCollection() Creates with no elements in the collection.
MarkCollection(List<Mark> marks)
MarkCollection(Mark mark) Creates from a single Mark.
MarkCollection(java.util.stream.Stream<Mark> stream) Creates from a stream of Marks.

Method Summary

Modifier and Type	Method and Description
boolean	add(Mark arg0)
void	addAll(MarkCollection marks)
List<BoundingBox>	boxList(Dimensions dimensions, int regionID)
boolean	contains(Object arg0)
Map<Mark,Integer>	createHashMapToId()
int[]	createIdArr()
Map<Integer,Mark>	createIdHashMap()
MarkCollection	createMerged(MarkCollection toMerge)
Set<Mark>	createSet()
MarkCollection	deepCopy()
ObjectCollection	deriveObjects(Dimensions dimensions, RegionMembershipWithFlags regionMembership)
boolean	equalsDeep(MarkCollection other)
void	exchange(int index, Mark markToAssign)
Mark	get(int index)
List<Mark>	getMarks() The underlying List that stores the Marks in the collection.
int	indexOf(Mark mark)
boolean	isEmpty()
Iterator<Mark>	iterator()
MarkCollection	marksAt(Point3i point, RegionMap regionMap, int regionID)
int	randomIndex(RandomNumberGenerator randomNumberGenerator)
Mark	randomMark(RandomNumberGenerator randomNumberGenerator)
Mark	remove(int index)
void	removeTwo(int index1, int index2)
void	scaleXY(ScaleFactor scaleFactor) Scales the mark in X and Y dimensions.
Mark	set(int index, Mark element)
MarkCollection	shallowCopy()
int	size()
String	toString()

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Detail

MarkCollection

public MarkCollection()

Creates with no elements in the collection.

MarkCollection

public MarkCollection(java.util.stream.Stream<Mark> stream)

Creates from a stream of Marks.

Parameters:

stream - the stream.

MarkCollection

public MarkCollection(Mark mark)

Creates from a single Mark.

Parameters:

mark - the mark.

MarkCollection

public MarkCollection(List<Mark> marks)

Method Detail

shallowCopy

public MarkCollection shallowCopy()

deepCopy

public MarkCollection deepCopy()

add

public boolean add(Mark arg0)

addAll

public void addAll(MarkCollection marks)

contains

public boolean contains(Object arg0)

isEmpty

public final boolean isEmpty()

size

public final int size()

iterator

public final Iterator<Mark> iterator()

Specified by:

iterator in interface Iterable<Mark>

toString

public String toString()

Overrides:

toString in class Object

remove

public Mark remove(int index)

removeTwo

public void removeTwo(int index1,
                      int index2)

randomIndex

public final int randomIndex(RandomNumberGenerator randomNumberGenerator)

get

public Mark get(int index)

randomMark

public final Mark randomMark(RandomNumberGenerator randomNumberGenerator)

exchange

public final void exchange(int index,
                           Mark markToAssign)

indexOf

public int indexOf(Mark mark)

deriveObjects

public ObjectCollection deriveObjects(Dimensions dimensions,
                                      RegionMembershipWithFlags regionMembership)

scaleXY

public void scaleXY(ScaleFactor scaleFactor)
             throws CheckedUnsupportedOperationException

Scales the mark in X and Y dimensions.

Parameters:

scaleFactor - how much to scale by.

Throws:

CheckedUnsupportedOperationException - if the type of mark used in the annotation does not supported scaling.

marksAt

public MarkCollection marksAt(Point3i point,
                              RegionMap regionMap,
                              int regionID)

equalsDeep

public boolean equalsDeep(MarkCollection other)

createIdHashMap

public Map<Integer,Mark> createIdHashMap()

createIdArr

public int[] createIdArr()

createSet

public Set<Mark> createSet()

createHashMapToId

public Map<Mark,Integer> createHashMapToId()

createMerged

public MarkCollection createMerged(MarkCollection toMerge)

boxList

public List<BoundingBox> boxList(Dimensions dimensions,
                                 int regionID)

set

public Mark set(int index,
                Mark element)

getMarks

public List<Mark> getMarks()

The underlying List that stores the Marks in the collection.