org.scijava.ops.image.coloc.ShuffledView 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.coloc;

import java.util.Random;

import net.imglib2.AbstractInterval;
import net.imglib2.FinalInterval;
import net.imglib2.Interval;
import net.imglib2.Localizable;
import net.imglib2.Point;
import net.imglib2.RandomAccess;
import net.imglib2.RandomAccessibleInterval;
import net.imglib2.Sampler;
import net.imglib2.View;
import net.imglib2.util.IntervalIndexer;
import net.imglib2.view.Views;

/**
 * Randomly shuffles an image blockwise.
 *
 * @author Curtis Rueden
 * @author Ellen T Arena
 * @param  Type of image to be shuffled.
 */
public class ShuffledView extends AbstractInterval implements
	RandomAccessibleInterval, View
{

	private Random rng;
	private final RandomAccessibleInterval image;
	private int[] blockIndices;
	private int[] blockSize;
	private int[] blockDims;

	public ShuffledView(final RandomAccessibleInterval image,
		final int[] blockSize, final long seed)
	{
		this(image, blockSize, null, seed);
	}

	private ShuffledView(final RandomAccessibleInterval image,
		final int[] blockSize, final int[] blockIndices, final long seed)
	{
		super(image); // uses same bounds as the input image
		this.image = image;
		this.blockSize = blockSize;

		// compute some info about our block sizes
		final int numDims = image.numDimensions();
		blockDims = new int[numDims];
		long totalBlocks = 1;
		for (int d = 0; d < numDims; d++) {
			final long blockDim = image.dimension(d) / blockSize[d];
			if (blockDim * blockSize[d] != image.dimension(d)) {
				throw new IllegalArgumentException("Image dimension #" + d +
					" is not evenly divisible by block size:" + blockSize[d] +
					"; Please call a ShuffledView.cropAt method to adjust the input.");
			}
			if (blockDim > Integer.MAX_VALUE) {
				throw new UnsupportedOperationException("Block dimension #" + d +
					" is too large: " + blockDim);
			}
			blockDims[d] = (int) blockDim;
			totalBlocks *= blockDims[d];
		}
		if (totalBlocks > Integer.MAX_VALUE) {
			throw new UnsupportedOperationException("Too many blocks: " +
				totalBlocks);
		}
		if (blockIndices == null) {
			this.blockIndices = new int[(int) totalBlocks];
			initializeBlocks();
			rng = new Random(seed);
			shuffleBlocks();
		}
		else {
			this.blockIndices = blockIndices;
		}
	}

	private void initializeBlocks() {
		// generate the identity mapping of indices
		for (int b = 0; b < blockIndices.length; b++)
			blockIndices[b] = b;
	}

	public void shuffleBlocks() {
		if (rng == null) {
			throw new IllegalStateException("No seed provided. Cannot shuffle.");
		}
		ColocUtil.shuffle(blockIndices, rng);
	}

	public void shuffleBlocks(long seed) {
		rng.setSeed(seed);
		initializeBlocks();
		shuffleBlocks();
	}

	@Override
	public RandomAccess randomAccess() {
		return new ShuffledRandomAccess();
	}

	@Override
	public RandomAccess randomAccess(final Interval interval) {
		return randomAccess(); // FIXME
	}

	private class ShuffledRandomAccess extends Point implements RandomAccess {

		private final RandomAccess imageRA;
		private final long[] blockPos;
		private final long[] blockOffset;
		private final long[] shuffledBlockPos;

		public ShuffledRandomAccess() {
			super(image.numDimensions());
			imageRA = image.randomAccess();
			blockPos = new long[position.length];
			blockOffset = new long[position.length];
			shuffledBlockPos = new long[position.length];
		}

		@Override
		public T get() {
			// Convert from image coordinates to block coordinates.
			for (int d = 0; d < position.length; d++) {
				blockPos[d] = position[d] / blockSize[d];
				blockOffset[d] = position[d] % blockSize[d];
			}

			// Convert N-D block coordinates to 1D block index.
			final int blockIndex = IntervalIndexer.positionToIndex(blockPos,
				blockDims);

			// Map block index to shuffled block index.
			final int shuffledBlockIndex = blockIndices[blockIndex];

			// Now convert our 1D shuffled block index back to N-D block
			// coordinates.
			IntervalIndexer.indexToPosition(shuffledBlockIndex, blockDims,
				shuffledBlockPos);

			// Finally, position the original image according to our shuffled
			// position.
			for (int d = 0; d < position.length; d++) {
				final long pd = shuffledBlockPos[d] * blockSize[d] + blockOffset[d];
				imageRA.setPosition(pd, d);
			}
			return imageRA.get();
		}

		@Override
		public ShuffledRandomAccess copy() {
			throw new UnsupportedOperationException();
		}
	}

	public static  RandomAccessibleInterval cropAtMin(
		final RandomAccessibleInterval image, final int[] blockSize)
	{
		return cropAt(image, blockSize, new Point(image.numDimensions()));
	}

	public static  RandomAccessibleInterval cropAtMax(
		final RandomAccessibleInterval image, final int[] blockSize)
	{
		final long[] pos = new long[image.numDimensions()];
		for (int d = 0; d < pos.length; d++) {
			pos[d] = image.dimension(d) % blockSize[d];
		}
		return cropAt(image, blockSize, new Point(pos));
	}

	public static  RandomAccessibleInterval cropAtCenter(
		final RandomAccessibleInterval image, final int[] blockSize)
	{
		final long[] pos = new long[image.numDimensions()];
		for (int d = 0; d < pos.length; d++) {
			pos[d] = (image.dimension(d) % blockSize[d]) / 2;
		}
		return cropAt(image, blockSize, new Point(pos));
	}

	private static  RandomAccessibleInterval cropAt(
		final RandomAccessibleInterval image, final int[] blockSize,
		final Localizable offset)
	{
		final int numDims = image.numDimensions();
		final long[] minsize = new long[numDims * 2];
		for (int d = 0; d < numDims; d++) {
			minsize[d] = offset.getLongPosition(d);
			final long shaveSize = image.dimension(d) % blockSize[d];
			minsize[numDims + d] = image.dimension(d) - shaveSize;
		}
		return Views.interval(image, FinalInterval.createMinSize(minsize));
	}
}