org.scijava.ops.image.copy.Copiers 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.copy;

import java.lang.reflect.Array;

import org.scijava.function.Computers;
import org.scijava.ops.spi.OpDependency;

import net.imglib2.Dimensions;
import net.imglib2.IterableInterval;
import net.imglib2.RandomAccessibleInterval;
import net.imglib2.img.array.ArrayImg;
import net.imglib2.img.basictypeaccess.array.ArrayDataAccess;
import net.imglib2.loops.LoopBuilder;
import net.imglib2.roi.labeling.ImgLabeling;
import net.imglib2.roi.labeling.LabelingMapping;
import net.imglib2.type.NativeType;
import net.imglib2.type.Type;
import net.imglib2.type.numeric.IntegerType;
import net.imglib2.util.Intervals;
import net.imglib2.util.Util;

public final class Copiers {

	private Copiers() {
		// Prevent instantiation of static utility class
	}

	/**
	 * Copy {@link Type} to another {@link Type}
	 *
	 * @author Christian Dietz (University of Konstanz)
	 * @param  the {@link Type} of the objects involved
	 * @param input the input {@link Type}
	 * @param output the {@link Type} that will be filled with the value of
	 *          {@code input}
	 * @implNote op names='copy.type, engine.copy', type=Computer
	 */
	public static > void copyType(final T input,
		final T output)
	{
		output.set(input);
	}

	/**
	 * Copies a {@link RandomAccessibleInterval} into another
	 * {@link RandomAccessibleInterval}
	 *
	 * @param  the element type of each image
	 * @param copier a {@link Computers.Arity1} that knows how to copy each pixel.
	 * @param input the {@link RandomAccessibleInterval} whose data will be copied
	 * @param copy the {@link RandomAccessibleInterval} that will be filled with
	 *          the contents of {@code input}
	 * @author Christian Dietz (University of Konstanz)
	 * @implNote op names='copy.rai, copy.img, engine.copy', priority='10.0',
	 *           type=Computer
	 */
	public static  void copyRAI( //
		final @OpDependency(name = "copy.type") Computers.Arity1 copier, //
		final RandomAccessibleInterval input, //
		final RandomAccessibleInterval copy //
	) {
		ensureEqualDimensions(input, copy);
		LoopBuilder.setImages(input, copy).multiThreaded().forEachPixel(
			copier::compute);
	}

	/**
	 * Copying {@link ImgLabeling} into another {@link ImgLabeling}
	 *
	 * @param  the element type of each image
	 * @param raiCopier an Op that can copy {@link RandomAccessibleInterval}s
	 * @param mappingCopier an Op that can copy {@link LabelingMapping}s
	 * @param input the {@link ImgLabeling} to copy
	 * @param output the destination container of the copy operation
	 * @author Christian Dietz (University of Konstanz)
	 * @implNote op names='copy.imgLabeling, engine.copy', type=Computer
	 */
	public static  & NativeType, L> void
		copyImgLabeling( //
			final @OpDependency(
				name = "copy.img") Computers.Arity1, RandomAccessibleInterval> raiCopier, //
			final @OpDependency(
				name = "copy.labelingMapping") Computers.Arity1, LabelingMapping> mappingCopier, //
			final ImgLabeling input, //
			final ImgLabeling output //
	) {
		ensureEqualDimensions(input, output);
		if (Util.getTypeFromInterval(input.getIndexImg()).getClass() != Util
			.getTypeFromInterval(output.getIndexImg()).getClass())
			throw new IllegalArgumentException(
				"input and output index images must be of the same type!");
		raiCopier.compute(input.getIndexImg(), output.getIndexImg());
		mappingCopier.compute(input.getMapping(), output.getMapping());
	}

	/**
	 * Copies a {@link LabelingMapping} into another {@link LabelingMapping}
	 *
	 * @author Christian Dietz (University of Konstanz)
	 * @param  the type of the {@link LabelingMapping} elements
	 * @param input the {@link LabelingMapping} to copy
	 * @param output the destination container of the copy operation
	 * @implNote op names='copy.labelingMapping, engine.copy', priority='10000.',
	 *           type=Computer
	 */
	public static  void copyLabelingMapping(final LabelingMapping input,
		final LabelingMapping output)
	{
		output.setLabelSets(input.getLabelSets());
	}

	/**
	 * Copying {@link ArrayImg} into another {@link ArrayImg}
	 *
	 * @author Christian Dietz (University of Konstanz)
	 * @param  the type of the elements of each image
	 * @param  the type of the backing data storage for each image
	 * @param input the {@link ArrayImg} to copy
	 * @param output the destination container of the copy operation
	 * @implNote op names='copy.img, engine.copy', priority='10000.',
	 *           type=Computer
	 */
	public static , A extends ArrayDataAccess> void
		copyArrayImage( //
			final ArrayImg input, final ArrayImg output)
	{
		ensureEqualDimensions(input, output);

		final Object inArray = input.update(null).getCurrentStorageArray();
		final Object outArray = output.update(null).getCurrentStorageArray();
		System.arraycopy(inArray, 0, outArray, 0, Array.getLength(inArray));
	}

	/**
	 * Copies an {@link IterableInterval} into another {@link IterableInterval}
	 *
	 * @author Christian Dietz (University of Konstanz)
	 * @param  the element type of the {@link IterableInterval}s
	 * @param copier an Op responsible for copying element types
	 * @param input the {@link IterableInterval} to copy
	 * @param output the destination container of the copy operation
	 * @implNote op names='copy.iterableInterval, copy.img, engine.copy',
	 *           priority='1.0', type=Computer
	 */
	public static  void copyIterableInterval( //
		@OpDependency(
			name = "copy.type") final Computers.Arity1, Iterable> copier, //
		final IterableInterval input, //
		final IterableInterval output)
	{
		if (!input.iterationOrder().equals(output.iterationOrder()))
			throw new IllegalArgumentException(
				"input and output must be of the same dimensions!");
		copier.compute(input, output);
	}

	private static void ensureEqualDimensions(Dimensions d1, Dimensions d2) {
		if (!Intervals.equalDimensions(d1, d2)) throw new IllegalArgumentException(
			"The Dimensions of the input and copy images must be the same!");
	}
}