org.jgrasstools.lesto.modules.vegetation.GeomorphonMaximaFinder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jgt-lesto Show documentation
The newest version!
/*
 * This file is part of JGrasstools (http://www.jgrasstools.org)
 * (C) HydroloGIS - www.hydrologis.com 
 * 
 * JGrasstools 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.jgrasstools.lesto.modules.vegetation;
import static org.jgrasstools.lesto.modules.vegetation.OmsGeomorphonMaximaFinder.inDSM_DESC;
import static org.jgrasstools.lesto.modules.vegetation.OmsGeomorphonMaximaFinder.inDTM_DESC;
import static org.jgrasstools.lesto.modules.vegetation.OmsGeomorphonMaximaFinder.outMaxima_DESC;
import static org.jgrasstools.lesto.modules.vegetation.OmsGeomorphonMaximaFinder.pElevDiff_DESC;
import static org.jgrasstools.lesto.modules.vegetation.OmsGeomorphonMaximaFinder.pRadius_DESC;
import static org.jgrasstools.lesto.modules.vegetation.OmsGeomorphonMaximaFinder.pThreshold_DESC;

import org.jgrasstools.gears.libs.modules.JGTConstants;
import org.jgrasstools.gears.libs.modules.JGTModel;

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;
import oms3.annotations.Unit;

@Description(OmsGeomorphonMaximaFinder.DESCRIPTION)
@Author(name = OmsGeomorphonMaximaFinder.AUTHORS, contact = OmsGeomorphonMaximaFinder.CONTACTS)
@Keywords(OmsGeomorphonMaximaFinder.KEYWORDS)
@Label(JGTConstants.RASTERPROCESSING)
@Name(OmsGeomorphonMaximaFinder.NAME)
@Status(Status.EXPERIMENTAL)
@License(JGTConstants.GPL3_LICENSE)
public class GeomorphonMaximaFinder extends JGTModel {
    @Description(inDTM_DESC)
    @UI(JGTConstants.FILEIN_UI_HINT)
    @In
    public String inDTM;

    @Description(inDSM_DESC)
    @UI(JGTConstants.FILEIN_UI_HINT)
    @In
    public String inDSM;

    @Description(pRadius_DESC)
    @Unit("m")
    @In
    public double pRadius;

    @Description(pThreshold_DESC)
    @Unit("degree")
    @In
    public double pThreshold = 1;

    @Description(pElevDiff_DESC)
    @Unit("m")
    @In
    public double pElevDiffThres = 1;

    @Description(outMaxima_DESC)
    @UI(JGTConstants.FILEOUT_UI_HINT)
    @In
    public String outMaxima;

    @Execute
    public void process() throws Exception {
        OmsGeomorphonMaximaFinder gmf = new OmsGeomorphonMaximaFinder();
        gmf.inDSM = getRaster(inDSM);
        gmf.inDTM = getRaster(inDTM);
        gmf.pRadius = pRadius;
        gmf.pThreshold = pThreshold;
        gmf.pElevDiffThres = pElevDiffThres;
        gmf.pm = pm;
        gmf.process();
        dumpVector(gmf.outMaxima, outMaxima);
    }

}