jaitools.jiffle.runtime.JiffleRuntime Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jt-jiffle Show documentation

Jiffle is a raster algebra language that can be used to create new images from logical and mathematical expressions involving source images and user defined variables. It is intended to let users concentrate on algorithms rather than tedious boiler-plate code.

The newest version!

/*
 * Copyright 2011 Michael Bedward
 * 
 * This file is part of jai-tools.
 *
 * jai-tools is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the 
 * License, or (at your option) any later version.
 *
 * jai-tools is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public 
 * License along with jai-tools.  If not, see .
 * 
 */

package jaitools.jiffle.runtime;

/**
 * The root interface for Jiffle runtime classes.
 *
 * @author Michael Bedward
 * @since 1.1
 * @version $Id: JiffleRuntime.java 1383 2011-02-10 11:22:29Z michael.bedward $
 */
public interface JiffleRuntime {

    /**
     * Set the bounds of the processing area. Usually this will be
     * the bounds of the destination image(s).
     *
     * @param minx min X pixel ordinate
     * @param miny min Y pixel ordinate
     * @param width width of processing area
     * @param height height of processing area
     */
    void setBounds(int minx, int miny, int width, int height);
    
    /**
     * Returns the value of a variable that was declared in the
     * script's init block.
     *
     * @param varName variable name
     *
     * @return the values or {@code null} if the variable name is
     *         not found
     */
    Double getVar(String varName);

}