org.scijava.ops.image.topology.eulerCharacteristic.Octant 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.topology.eulerCharacteristic;

import java.util.Arrays;

import net.imglib2.RandomAccess;
import net.imglib2.RandomAccessibleInterval;
import net.imglib2.type.BooleanType;
import net.imglib2.view.Views;

/**
 * A convenience class for storing a 2x2x2 voxel neighborhood in an image
 *
 * @author Richard Domander (Royal Veterinary College, London)
 * @author Mark Hiner
 */
public class Octant> {

	private final boolean[] neighborhood = new boolean[8];
	private final RandomAccess access;
	private int foregroundNeighbors;

	/**
	 * Constructs a new 2x2x2 neighborhood
	 * 
	 * NB: Copies reference
	 * 
	 *
	 * @param interval Image space where the neighborhood is located
	 */
	public Octant(final RandomAccessibleInterval interval) {
		access = Views.extendZero(interval).randomAccess();
	}

	/** Returns the number of foreground voxels in the neighborhood */
	public int getNeighborCount() {
		return foregroundNeighbors;
	}

	/**
	 * Check if the nth neighbor in the 8-neighborhood is foreground
	 *
	 * @param n number of neighbor, {@literal 1 <= n <= 8}
	 */
	public boolean isNeighborForeground(final int n) {
		return neighborhood[n - 1];
	}

	/** True if none of the elements in the neighborhood are foreground (true) */
	public boolean isNeighborhoodEmpty() {
		return foregroundNeighbors == 0;
	}

	/**
	 * Set the starting coordinates of the neighborhood in the interval NB: All
	 * voxels outside the image bounds are considered 0
	 */
	public void setNeighborhood(final long x, final long y, final long z) {
		Arrays.fill(neighborhood, false);

		neighborhood[0] = getAtLocation(access, x - 1, y - 1, z - 1);
		neighborhood[1] = getAtLocation(access, x - 1, y, z - 1);
		neighborhood[2] = getAtLocation(access, x, y - 1, z - 1);
		neighborhood[3] = getAtLocation(access, x, y, z - 1);
		neighborhood[4] = getAtLocation(access, x - 1, y - 1, z);
		neighborhood[5] = getAtLocation(access, x - 1, y, z);
		neighborhood[6] = getAtLocation(access, x, y - 1, z);
		neighborhood[7] = getAtLocation(access, x, y, z);

		countForegroundNeighbors();
	}

	private void countForegroundNeighbors() {
		foregroundNeighbors = 0;
		for (boolean neighbor : neighborhood) {
			if (neighbor) {
				foregroundNeighbors++;
			}
		}
	}

	private boolean getAtLocation(final RandomAccess access, final long x,
		final long y, final long z)
	{
		access.setPosition(x, 0);
		access.setPosition(y, 1);
		access.setPosition(z, 2);
		return access.get().get();
	}
}