boofcv.abst.filter.ImageFunctionSparse Maven / Gradle / Ivy

/*
 * Copyright (c) 2011-2016, Peter Abeles. All Rights Reserved.
 *
 * This file is part of BoofCV (http://boofcv.org).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package boofcv.abst.filter;

import boofcv.struct.image.ImageGray;

/**
 * Interface for computing the output of functions which take as an input an image and a pixel coordinate.
 *
 * @author Peter Abeles
 */
public interface ImageFunctionSparse< T extends ImageGray> {

	/**
	 * Specify which image is to provide the input.
	 *
	 * @param image
	 */
	public void setImage( T image );

	/**
	 * Compute the output of the function at the specified location.
	 *
	 * @param x pixel coordinate the function is be centered at.
	 * @param y pixel coordinate the function is be centered at.
	 * @return The function's output.
	 */
	public double compute( int x , int y );
}