org.scijava.ops.image.stats.IterableMinMax Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scijava-ops-image Show documentation
Image processing operations for SciJava Ops.
The newest version!
/*
 * #%L
 * Image processing operations for SciJava Ops.
 * %%
 * Copyright (C) 2014 - 2024 SciJava developers.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package org.scijava.ops.image.stats;

import java.util.NoSuchElementException;
import java.util.function.Function;

import net.imglib2.type.numeric.RealType;
import net.imglib2.util.Pair;
import net.imglib2.util.ValuePair;

import org.scijava.ops.spi.Op;

/**
 * Op to calculate the {@code stats.minMax}.
 *
 * @author Daniel Seebacher (University of Konstanz)
 * @author Christian Dietz (University of Konstanz)
 * @param  input type
 * @implNote op names='stats.minMax'
 */
public class IterableMinMax> implements
	Function, Pair>
{

	/**
	 * TODO
	 *
	 * @param input the {@link Iterable} to compute over
	 * @return the minimum and maximum of the {@code input}, partitioned within a
	 *         {@link Pair}
	 */
	@Override
	public Pair apply(final Iterable input) {

		// set minVal to the largest possible value and maxVal to the smallest
		// possible.
		I minVal, maxVal;
		try {
			minVal = input.iterator().next().createVariable();
			minVal.setReal(minVal.getMaxValue());
			maxVal = minVal.createVariable();
			maxVal.setReal(maxVal.getMinValue());
		}
		catch (NoSuchElementException e) {
			throw new IllegalArgumentException(
				"Cannot determine minimum/maximum of an empty Iterator!");
		}

		for (final I in : input) {
			if (in.compareTo(minVal) < 0) minVal.set(in);
			if (in.compareTo(maxVal) > 0) maxVal.set(in);
		}
		return new ValuePair<>(minVal, maxVal);
	}

}