net.imglib2.view.iteration.SubIntervalIterable 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 - 2020 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.view.iteration;

import net.imglib2.Cursor;
import net.imglib2.Interval;
import net.imglib2.IterableRealInterval;

/**
 * Implementing this interface enables the implementor to return optimized
 * {@link Cursor}s for certain {@link Interval}s
 * 
 * @author Tobias Pietzsch
 */
public interface SubIntervalIterable< T >
{
	/**
	 * Determine whether a {@link Cursor} can be created that iterates the given
	 * {@link Interval}.
	 * 
	 * @param interval
	 *            to be checked
	 * 
	 * @return true if a {@link Cursor} can be optimized given the
	 *         {@link Interval}
	 */
	public boolean supportsOptimizedCursor( Interval interval );

	/**
	 * Returns the iteration order given the interval.
	 * 
	 * @param interval
	 *            {@link Interval} over which to iterate
	 * 
	 * @return the iteration order object @see {@link IterableRealInterval}
	 */
	public Object subIntervalIterationOrder( Interval interval );

	/**
	 * Create a {@link Cursor} to iterate over the given {@link Interval}.
	 * 
	 * @param interval
	 *            {@link Interval} over which to iterate
	 * 
	 * @return {@link Cursor}
	 */
	public Cursor< T > cursor( Interval interval );

	/**
	 * Create a {@link Cursor} to iterate over the given {@link Interval}.
	 * 
	 * @param interval
	 *            {@link Interval} over which to iterate
	 * 
	 * @return {@link Cursor}
	 */
	public Cursor< T > localizingCursor( Interval interval );
}