net.imglib2.img.planar.PlanarCursor2D Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of imglib2 Show documentation
A multidimensional, type-agnostic image processing library.
There is a newer version: 7.1.4
/*
 * #%L
 * ImgLib2: a general-purpose, multidimensional image processing library.
 * %%
 * Copyright (C) 2009 - 2024 Tobias Pietzsch, Stephan Preibisch, Stephan Saalfeld,
 * John Bogovic, Albert Cardona, Barry DeZonia, Christian Dietz, Jan Funke,
 * Aivar Grislis, Jonathan Hale, Grant Harris, Stefan Helfrich, Mark Hiner,
 * Martin Horn, Steffen Jaensch, Lee Kamentsky, Larry Lindsey, Melissa Linkert,
 * Mark Longair, Brian Northan, Nick Perry, Curtis Rueden, Johannes Schindelin,
 * Jean-Yves Tinevez and Michael Zinsmaier.
 * %%
 * 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 net.imglib2.img.planar;

import net.imglib2.type.NativeType;

/**
 * Basic Iterator for 2d {@link PlanarImg PlanarContainers}
 * 
 * @param 
 * 
 * @author Stephan Saalfeld
 */
public class PlanarCursor2D< T extends NativeType< T > > extends PlanarCursor< T >
{
	public PlanarCursor2D( final PlanarImg< T, ? > container )
	{
		super( container );
	}

	@Override
	public boolean hasNext()
	{
		return typeIndex.get() < lastIndex;
	}

	@Override
	public void fwd()
	{
		typeIndex.inc();
	}

	@Override
	public void localize( final int[] position )
	{
		final int indexInSlice = typeIndex.get();
		final int dim0 = container.dimensions[ 0 ];
		position[ 1 ] = indexInSlice / dim0;
		position[ 0 ] = indexInSlice - position[ 1 ] * dim0;
	}

	@Override
	public int getIntPosition( final int dim )
	{
		final int indexInSlice = typeIndex.get();
		final int dim0 = container.dimensions[ 0 ];
		final int pos1 = indexInSlice / dim0;
		if ( dim == 0 )
			return indexInSlice - pos1 * dim0;
		else if ( dim == 1 )
			return pos1;
		else
			return 0;
	}
}