package ie.dcu.image;

import ie.dcu.matrix.MatrixProvider;

/**
 * Interface for classes that implement operations on images.
 * 
 * The following is an example of how it can be used:
 * <pre>
 *   ByteMatrix input = ... 
 *   ImageOp op = createImageOp(); 
 *   op.setInputProvider(input);
 *   ByteMatrix matrix = (ByteMatrix) op.getMatrix(Matrix.Type.Byte, false);
 * </pre>
 * 
 * The above assumes that <code>createImageOp()</code> creates and returns
 * an instance of <code>ImageOp</code>.
 * 
 * @author Kevin McGuinness
 */
public interface ImageOp extends MatrixProvider {
	
	/**
	 * Set the class that will provide the input for this image operation.
	 * 
	 * @param provider
	 *        A {@link MatrixProvider} instance.
	 */
	public void setInputProvider(MatrixProvider provider);
}