Package org.anchoranalysis.image.voxel.object

Class ObjectMaskStream

Object

org.anchoranalysis.image.voxel.object.ObjectMaskStream

public final class ObjectMaskStream
extends Object

A custom "stream" like class for various functional-programming operations on ObjectCollection

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
ObjectMaskStream(ObjectCollection delegate)

Method Summary

Modifier and Type	Method	Description
boolean	anyMatch(Predicate<ObjectMask> predicate)	Does the predicate evaluate to true on any object in the collection?
ObjectCollection	filter(Predicate<ObjectMask> predicate)	Filters a ObjectCollection to include certain items based on a predicate
<E extends Exception> ObjectCollection	filter(CheckedPredicate<ObjectMask,E> predicate, Class<? extends Exception> throwableClass)	Filters a ObjectCollection to include certain items based on a predicate
ObjectCollection	filterAndMap(Predicate<ObjectMask> predicate, UnaryOperator<ObjectMask> mapFunction)	Performs a filter(java.util.function.Predicate<org.anchoranalysis.image.voxel.object.ObjectMask>) and then a map(org.anchoranalysis.core.functional.checked.CheckedFunction<org.anchoranalysis.image.voxel.object.ObjectMask, org.anchoranalysis.image.voxel.object.ObjectMask, E>).
ObjectCollection	filterExclude(Predicate<ObjectMask> predicate)	Filters a ObjectCollection to exclude certain items based on a predicate
ObjectCollection	filterSubset(Predicate<ObjectMask> predicate, Collection<Integer> indices)	Like filter(java.util.function.Predicate<org.anchoranalysis.image.voxel.object.ObjectMask>) but only operates on certain indices of the collection.
Stream<ObjectMask>	filterSubsetStream(Predicate<ObjectMask> predicate, Collection<Integer> indices)	Like filterSubset(java.util.function.Predicate<org.anchoranalysis.image.voxel.object.ObjectMask>, java.util.Collection<java.lang.Integer>) but returns a stream rather than a ObjectCollection.
<E extends Exception> ObjectCollection	flatMap(Class<? extends Exception> throwableClass, CheckedFunction<ObjectMask,ObjectCollection,E> mapFunction)	Like a typical flatMap() operation but accepts a mapping function that throws a checked exception.
ObjectCollection	flatMap(Function<ObjectMask,ObjectCollection> mapFunction)	Creates a new ObjectCollection after mapping each item to several others.
<E extends Exception> ObjectCollection	map(CheckedFunction<ObjectMask,ObjectMask,E> mapFunction)	Creates a new ObjectCollection after mapping each item to another.
ObjectCollection	mapBoundingBoxChangeExtent(BoundingBox boxToAssign)	Creates a new ObjectCollection after mapping the bounding-box on each object (while maybe changing the extent).
ObjectCollection	mapBoundingBoxPreserveExtent(UnaryOperator<BoundingBox> mapFunction)	Creates a new ObjectCollection after mapping the bounding-box on each object (whose extent should remain unchanged).
<T, E extends Exception> List<T>	mapToList(CheckedFunction<ObjectMask,T,E> mapFunction)	Creates a new List after mapping each item to another type.
<T, E extends Exception> List<T>	mapToListOptional(CheckedFunction<ObjectMask,Optional<T>,E> mapFunction)	Creates a new List after mapping each item to another (optional) type
<T, E extends Exception> SortedSet<T>	mapToSortedSet(CheckedFunction<ObjectMask,T,E> mapFunction)	Creates a new SortedSet after mapping each item to another type.
OptionalInt	maxAsInt(ToIntFunction<ObjectMask> function)	Finds the maximum value of a function applied to each object in the collection.
OptionalInt	minAsInt(ToIntFunction<ObjectMask> function)	Finds the minimum value of a function applied to each object in the collection.
Set<ObjectMask>	toSet()	Converts to a HashSet.

Methods inherited from class java.lang.Object

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

Constructor Details

ObjectMaskStream

public ObjectMaskStream(ObjectCollection delegate)

Method Details

map

public <E extends Exception> ObjectCollection map(CheckedFunction<ObjectMask,ObjectMask,E> mapFunction) throws E extends Exception

Creates a new ObjectCollection after mapping each item to another.

This is an immutable operation.

Type Parameters:

E - exception-type that can occur during mapping

Parameters:

mapFunction - performs mapping

Returns:

a newly created object-collection

Throws:

E - if an exception is thrown by the mapping function.

E extends Exception

mapBoundingBoxPreserveExtent

public ObjectCollection mapBoundingBoxPreserveExtent(UnaryOperator<BoundingBox> mapFunction)

Creates a new ObjectCollection after mapping the bounding-box on each object (whose extent should remain unchanged).

See ObjectMask.mapBoundingBoxPreserveExtent(UnaryOperator) for details on the mapping.

This is an immutable operation.

Parameters:

mapFunction - maps the bounding-box to a new bounding-box

Returns:

a newly created object-collection

mapBoundingBoxChangeExtent

public ObjectCollection mapBoundingBoxChangeExtent(BoundingBox boxToAssign)

Creates a new ObjectCollection after mapping the bounding-box on each object (while maybe changing the extent).

See ObjectMask.mapBoundingBoxChangeExtent(org.anchoranalysis.spatial.box.BoundingBox) for details on the mapping.

This is an immutable operation.

Precondition: the new bounding-box's extent must be greater than or equal to the existing extent in all dimensions.

Parameters:

boxToAssign - the bounding box to assign to the newly created object

Returns:

a newly created object-collection

mapToList

public <T, E extends Exception> List<T> mapToList(CheckedFunction<ObjectMask,T,E> mapFunction) throws E extends Exception

Creates a new List after mapping each item to another type.

This is an immutable operation.

Type Parameters:

T - destination type for the mapping

E - exception that can be thrown during mapping

Parameters:

mapFunction - performs mapping

Returns:

a newly created list contained the mapped objects

Throws:

E - if an exception occurs during mapping

E extends Exception

mapToListOptional

public <T, E extends Exception> List<T> mapToListOptional(CheckedFunction<ObjectMask,Optional<T>,E> mapFunction) throws E extends Exception

Creates a new List after mapping each item to another (optional) type

Items are only included if the output type is not-empty()

This is an immutable operation.

Type Parameters:

T - destination type for the mapping

E - exception that can be thrown during mapping

Parameters:

mapFunction - performs mapping

Returns:

a newly created list contained the mapped objects (which aren't Optional.empty())

Throws:

E - if an exception occurs during mapping

E extends Exception

mapToSortedSet

public <T, E extends Exception> SortedSet<T> mapToSortedSet(CheckedFunction<ObjectMask,T,E> mapFunction) throws E extends Exception

Creates a new SortedSet after mapping each item to another type.

This is an immutable operation.

Type Parameters:

T - destination type for the mapping

E - exception that can be thrown during mapping

Parameters:

mapFunction - performs mapping

Returns:

a newly created tree-set contained the mapped objects

Throws:

E - if an exception occurs during mapping

E extends Exception

flatMap

public ObjectCollection flatMap(Function<ObjectMask,ObjectCollection> mapFunction)

Creates a new ObjectCollection after mapping each item to several others.

This is an immutable operation.

Parameters:

mapFunction - performs flat-mapping

Returns:

a newly created object-collection

flatMap

public <E extends Exception> ObjectCollection flatMap(Class<? extends Exception> throwableClass, CheckedFunction<ObjectMask,ObjectCollection,E> mapFunction) throws E extends Exception

Like a typical flatMap() operation but accepts a mapping function that throws a checked exception.

This is an immutable operation.

Type Parameters:

E - exception-type that can be thrown by mapFunction.

Parameters:

throwableClass - the class of E.

mapFunction - performs flat-mapping.

Returns:

a newly created object-collection.

Throws:

E - if its thrown by mapFunction.

E extends Exception

filter

public ObjectCollection filter(Predicate<ObjectMask> predicate)

Filters a ObjectCollection to include certain items based on a predicate

This is an immutable operation.

Parameters:

predicate - iff true object is included, otherwise excluded.

Returns:

a newly created object-collection, a filtered version of all objects.

filter

public <E extends Exception> ObjectCollection filter(CheckedPredicate<ObjectMask,E> predicate, Class<? extends Exception> throwableClass) throws E extends Exception

Filters a ObjectCollection to include certain items based on a predicate

This is an immutable operation.

Type Parameters:

E - an exception that may be thrown by predicate.

Parameters:

predicate - iff true object is included, otherwise excluded.

throwableClass - the class of E.

Returns:

a newly created object-collection, a filtered version of all objects.

Throws:

E - if the exception is thrown during filtering.

E extends Exception

filterExclude

public ObjectCollection filterExclude(Predicate<ObjectMask> predicate)

Filters a ObjectCollection to exclude certain items based on a predicate

This is an immutable operation.

Parameters:

predicate - iff true object is excluded, otherwise included

Returns:

a newly created object-collection, a filtered version of all objects

filterAndMap

public ObjectCollection filterAndMap(Predicate<ObjectMask> predicate, UnaryOperator<ObjectMask> mapFunction)

Performs a filter(java.util.function.Predicate<org.anchoranalysis.image.voxel.object.ObjectMask>) and then a map(org.anchoranalysis.core.functional.checked.CheckedFunction<org.anchoranalysis.image.voxel.object.ObjectMask, org.anchoranalysis.image.voxel.object.ObjectMask, E>).

This is an immutable operation.

Parameters:

mapFunction - performs mapping

predicate - iff true object is included, otherwise excluded

Returns:

a newly created object-collection, a filtered version of all objects, then mapped

filterSubset

public ObjectCollection filterSubset(Predicate<ObjectMask> predicate, Collection<Integer> indices)

Like filter(java.util.function.Predicate<org.anchoranalysis.image.voxel.object.ObjectMask>) but only operates on certain indices of the collection.

This is an immutable operation

Parameters:

predicate - iff true object is included, otherwise excluded

indices - which indices of the collection to consider

Returns:

a newly created object-collection, a filtered version of particular elements

filterSubsetStream

public Stream<ObjectMask> filterSubsetStream(Predicate<ObjectMask> predicate, Collection<Integer> indices)

Like filterSubset(java.util.function.Predicate<org.anchoranalysis.image.voxel.object.ObjectMask>, java.util.Collection<java.lang.Integer>) but returns a stream rather than a ObjectCollection.

This is an immutable operation

Parameters:

predicate - iff true object is included, otherwise excluded

indices - which indices of the collection to consider

Returns:

a stream of filtered objects

anyMatch

public boolean anyMatch(Predicate<ObjectMask> predicate)

Does the predicate evaluate to true on any object in the collection?

Parameters:

predicate - evaluates to true or false for a particular object

Returns:

true if the predicate returns true on ANY one of the contained objects

toSet

public Set<ObjectMask> toSet()

Converts to a HashSet.

Returns:

a newly-created set, containing the items in the stream.

maxAsInt

public OptionalInt maxAsInt(ToIntFunction<ObjectMask> function)

Finds the maximum value of a function applied to each object in the collection.

Parameters:

function - function to apply

Returns:

the maximum-int found by applying the function to each object (so long as the collection isn't empty)

minAsInt

public OptionalInt minAsInt(ToIntFunction<ObjectMask> function)

Finds the minimum value of a function applied to each object in the collection.

Parameters:

function - function to apply

Returns:

the minimum-int found by applying the function to each object (so long as the collection isn't empty)