org.hortonmachine.modules.CutOut Maven / Gradle / Ivy

/*
 * This file is part of HortonMachine (http://www.hortonmachine.org)
 * (C) HydroloGIS - www.hydrologis.com 
 * 
 * The HortonMachine 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program.  If not, see .
 */
package org.hortonmachine.modules;

import static org.hortonmachine.gears.modules.r.cutout.OmsCutOut.OMSCUTOUT_AUTHORCONTACTS;
import static org.hortonmachine.gears.modules.r.cutout.OmsCutOut.OMSCUTOUT_AUTHORNAMES;
import static org.hortonmachine.gears.modules.r.cutout.OmsCutOut.OMSCUTOUT_DESCRIPTION;
import static org.hortonmachine.gears.modules.r.cutout.OmsCutOut.OMSCUTOUT_DO_INVERSE_DESCRIPTION;
import static org.hortonmachine.gears.modules.r.cutout.OmsCutOut.OMSCUTOUT_IN_MASK_DESCRIPTION;
import static org.hortonmachine.gears.modules.r.cutout.OmsCutOut.OMSCUTOUT_IN_RASTER_DESCRIPTION;
import static org.hortonmachine.gears.modules.r.cutout.OmsCutOut.OMSCUTOUT_KEYWORDS;
import static org.hortonmachine.gears.modules.r.cutout.OmsCutOut.OMSCUTOUT_LABEL;
import static org.hortonmachine.gears.modules.r.cutout.OmsCutOut.OMSCUTOUT_LICENSE;
import static org.hortonmachine.gears.modules.r.cutout.OmsCutOut.OMSCUTOUT_NAME;
import static org.hortonmachine.gears.modules.r.cutout.OmsCutOut.OMSCUTOUT_OUT_RASTER_DESCRIPTION;
import static org.hortonmachine.gears.modules.r.cutout.OmsCutOut.OMSCUTOUT_P_MAX_DESCRIPTION;
import static org.hortonmachine.gears.modules.r.cutout.OmsCutOut.OMSCUTOUT_P_MIN_DESCRIPTION;
import static org.hortonmachine.gears.modules.r.cutout.OmsCutOut.OMSCUTOUT_STATUS;

import org.hortonmachine.gears.libs.modules.HMConstants;
import org.hortonmachine.gears.libs.modules.HMModel;
import org.hortonmachine.gears.modules.r.cutout.OmsCutOut;

import oms3.annotations.Author;
import oms3.annotations.Description;
import oms3.annotations.Execute;
import oms3.annotations.In;
import oms3.annotations.Keywords;
import oms3.annotations.Label;
import oms3.annotations.License;
import oms3.annotations.Name;
import oms3.annotations.Status;
import oms3.annotations.UI;

@Description(OMSCUTOUT_DESCRIPTION)
@Author(name = OMSCUTOUT_AUTHORNAMES, contact = OMSCUTOUT_AUTHORCONTACTS)
@Keywords(OMSCUTOUT_KEYWORDS)
@Label(OMSCUTOUT_LABEL)
@Name("_" + OMSCUTOUT_NAME)
@Status(OMSCUTOUT_STATUS)
@License(OMSCUTOUT_LICENSE)
public class CutOut extends HMModel {

    @Description(OMSCUTOUT_IN_RASTER_DESCRIPTION)
    @UI(HMConstants.FILEIN_UI_HINT_RASTER)
    @In
    public String inRaster;

    @Description(OMSCUTOUT_IN_MASK_DESCRIPTION)
    @UI(HMConstants.FILEIN_UI_HINT_RASTER)
    @In
    public String inMask;

    @Description(OMSCUTOUT_P_MAX_DESCRIPTION)
    @In
    public Double pMax;

    @Description(OMSCUTOUT_P_MIN_DESCRIPTION)
    @In
    public Double pMin;

    @Description(OMSCUTOUT_DO_INVERSE_DESCRIPTION)
    @In
    public boolean doInverse = false;

    @Description(OMSCUTOUT_OUT_RASTER_DESCRIPTION)
    @UI(HMConstants.FILEOUT_UI_HINT)
    @In
    public String outRaster = null;

    @Execute
    public void process() throws Exception {
        OmsCutOut c = new OmsCutOut();
        c.pm = pm;
        c.inRaster = getRaster(inRaster);
        c.inMask = getRaster(inMask);
        c.pMax = pMax;
        c.pMin = pMin;
        c.doInverse = doInverse;
        c.process();
        dumpRaster(c.outRaster, outRaster);
    }
}