tilt.handler.post.Options.java Source code

Introduction

Here is the source code for tilt.handler.post.Options.java

Source

/*
 * This file is part of TILT.
 *
 *  TILT is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  TILT 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with TILT.  If not, see <http://www.gnu.org/licenses/>.
 *  (c) copyright Desmond Schmidt 2015
 */

package tilt.handler.post;

import tilt.Utils;
import org.json.simple.*;
import java.util.HashMap;
import java.util.Set;
import java.util.Iterator;

/**
 * Store options for TILT2
 * @author desmond
 */
public class Options extends HashMap<Options.Keys, Object> {
    private void setDefaults() {
        // preflight
        /** turn this on to remove blue-lines from exercise books */
        this.put(Keys.blueGreenFilter, false);
        /** proportion of black vs white pixels that defines a blob as "dense" */
        this.put(Keys.minBlackPC, 0.5);
        /** size of white standoff around speckles */
        this.put(Keys.whiteStandoff, 0.01);
        /** horizontal standoff around outlier blobs at line-ends */
        this.put(Keys.outlierStandoff, 0.05);
        /** maximum number of black pixels tolerated in white standoff */
        this.put(Keys.maxRoguePixels, 2);
        /** individual blobs bigger than this will be removed */
        this.put(Keys.maxFeatureSize, 0.1);
        /** k value for Sauvola's binarise threshold */
        this.put(Keys.binariseThreshold, 0.34);
        /** size of a "speckle" */
        this.put(Keys.speckleSize, 0.008);
        /** definition of odd shaped blobs to be removed */
        this.put(Keys.oddShape, 4.0);
        /** maximum amount times line depth to accept new lines */
        this.put(Keys.lineDepthFactor, 1.0);
        /** image will be scaled if wider than this */
        this.put(Keys.maximumWidth, 1200);
        /** whether to remove speckles in the body of the page */
        this.put(Keys.despeckleBody, true);
        /** range of moving average smoothing +- N*/
        this.put(Keys.smoothN, 0.01);
        /** true if we are testing */
        this.put(Keys.test, false);
        /** fraction of height for line-blur radius */
        this.put(Keys.blurForLines, 0.006/*8*/);
        /** width of vertical strips */
        this.put(Keys.verticalSliceSize, 0.05);
        /** blur radius for blur radius to construct mask for reconstructing image */
        this.put(Keys.reconstructBlurRadius, 0.0067);
    }

    /**
     * Blank constructor required by getDefaults
     */
    protected Options() {
    }

    /**
     * Initialise an options object from a possibly empty set of properties
     * @param opts a RAW JSON object
     */
    public Options(JSONObject opts) {
        setDefaults();
        HashMap<String, Object> map = (HashMap) opts;
        Set<String> keys = map.keySet();
        Iterator<String> iter = keys.iterator();
        while (iter.hasNext()) {
            try {
                Options.Keys key = Options.Keys.valueOf(iter.next());
                Object value = map.get(key.toString());
                this.put(key, value);
            } catch (Exception e) {
                // ignore it
            }
        }
    }

    public static JSONObject getDefaults() {
        Options opts = new Options();
        JSONObject obj = new JSONObject();
        Set<Keys> keys = opts.keySet();
        Iterator<Keys> iter = keys.iterator();
        while (iter.hasNext()) {
            Keys key = iter.next();
            obj.put(key.toString(), opts.get(key));
        }
        return obj;
    }

    /**
     * Get the options for a given docid, if any
     * @param serverName the server where it all resides
     * @param docid the docid to get the options of
     * @return the options, default or privately set
     */
    public static Options get(String serverName, String docid) {
        try {
            String url = "http://" + serverName + "/tilt/options?docid=" + docid;
            String jstr = Utils.getFromUrl(url);
            if (jstr != null) {
                JSONObject jobj = (JSONObject) JSONValue.parse(jstr);
                System.out.println("Custom options:");
                Set<String> keys = jobj.keySet();
                Iterator<String> iter = keys.iterator();
                while (iter.hasNext()) {
                    String key = iter.next();
                    System.out.println(key + ":" + jobj.get(key));
                }
                return new Options(jobj);
            } else {
                System.out.println("Using default options");
                return new Options(getDefaults());
            }
        } catch (Exception e) {
            //System.out.println("Options get:"+e.getMessage());
            return new Options(getDefaults());
        }
    }

    public enum Keys {
        minBlackPC, whiteStandoff, outlierStandoff, oddShape, lineDepthFactor, binariseThreshold, speckleSize, blueGreenFilter, maximumWidth, maxFeatureSize, maxRoguePixels, verticalSliceSize, smoothN, despeckleBody, blurForLines, reconstructBlurRadius, test;
    }

    public float getFloat(Keys key) {
        Object obj = this.get(key);
        if (obj != null && obj instanceof Number)
            return ((Number) obj).floatValue();
        else
            return 0.0f;
    }

    public int getInt(Keys key) {
        Object obj = this.get(key);
        if (obj != null && obj instanceof Number)
            return ((Number) obj).intValue();
        else
            return 0;
    }

    public boolean getBoolean(Keys key) {
        Object obj = this.get(key);
        if (obj != null && obj instanceof Boolean)
            return (Boolean) obj;
        else
            return false;
    }

    public void setBoolean(Keys key, boolean value) {
        put(key, value);
    }
    // add methods to cover other data types
}