Package org.hortonmachine.gears.modules.r.cutout

Class OmsCutOut

java.lang.Object

org.hortonmachine.gears.libs.modules.HMModel

org.hortonmachine.gears.libs.modules.multiprocessing.MultiProcessing

org.hortonmachine.gears.libs.modules.multiprocessing.GridMultiProcessing

org.hortonmachine.gears.modules.r.cutout.OmsCutOut

public class OmsCutOut
extends GridMultiProcessing

Nested Class Summary

Nested classes/interfaces inherited from class org.hortonmachine.gears.libs.modules.multiprocessing.GridMultiProcessing

GridMultiProcessing.Calculator

Field Summary

Fields

Modifier and Type	Field	Description
boolean	doInverse
org.geotools.coverage.grid.GridCoverage2D	inMask
org.geotools.coverage.grid.GridCoverage2D	inRaster
static String	OMSCUTOUT_AUTHORCONTACTS
static String	OMSCUTOUT_AUTHORNAMES
static String	OMSCUTOUT_DESCRIPTION
static String	OMSCUTOUT_DO_INVERSE_DESCRIPTION
static String	OMSCUTOUT_DOCUMENTATION
static String	OMSCUTOUT_IN_MASK_DESCRIPTION
static String	OMSCUTOUT_IN_RASTER_DESCRIPTION
static String	OMSCUTOUT_KEYWORDS
static String	OMSCUTOUT_LABEL
static String	OMSCUTOUT_LICENSE
static String	OMSCUTOUT_NAME
static String	OMSCUTOUT_OUT_RASTER_DESCRIPTION
static String	OMSCUTOUT_P_MAX_DESCRIPTION
static String	OMSCUTOUT_P_MIN_DESCRIPTION
static int	OMSCUTOUT_STATUS
org.geotools.coverage.grid.GridCoverage2D	outRaster
Double	pMax
Double	pMin

Fields inherited from class org.hortonmachine.gears.libs.modules.HMModel

doProcess, doReset, gf, pm

Constructor Summary

Constructors

Constructor	Description
OmsCutOut()

Method Summary

Modifier and Type	Method	Description
static org.geotools.coverage.grid.GridCoverage2D	cut(org.geotools.coverage.grid.GridCoverage2D raster, org.geotools.coverage.grid.GridCoverage2D mask)	Cut a raster on a mask using the default parameters.
void	process()

Methods inherited from class org.hortonmachine.gears.libs.modules.multiprocessing.GridMultiProcessing

processGrid, processGrid

Methods inherited from class org.hortonmachine.gears.libs.modules.multiprocessing.MultiProcessing

createDefaultPlanner

Methods inherited from class org.hortonmachine.gears.libs.modules.HMModel

checkCancel, checkFileExists, checkNull, checkWorkingFolderInPath, concatOr, dumpRaster, dumpVector, getDefaultThreadsNum, getRaster, getVector, help, isCanceled, template

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

inRaster

public org.geotools.coverage.grid.GridCoverage2D inRaster

inMask

public org.geotools.coverage.grid.GridCoverage2D inMask

pMax

public Double pMax

pMin

public Double pMin

doInverse

public boolean doInverse

outRaster

public org.geotools.coverage.grid.GridCoverage2D outRaster

OMSCUTOUT_DESCRIPTION

public static final String OMSCUTOUT_DESCRIPTION

See Also:

Constant Field Values

OMSCUTOUT_DOCUMENTATION

public static final String OMSCUTOUT_DOCUMENTATION

See Also:

Constant Field Values

OMSCUTOUT_KEYWORDS

public static final String OMSCUTOUT_KEYWORDS

See Also:

Constant Field Values

OMSCUTOUT_LABEL

public static final String OMSCUTOUT_LABEL

See Also:

Constant Field Values

OMSCUTOUT_NAME

public static final String OMSCUTOUT_NAME

See Also:

Constant Field Values

OMSCUTOUT_STATUS

public static final int OMSCUTOUT_STATUS

See Also:

Constant Field Values

OMSCUTOUT_LICENSE

public static final String OMSCUTOUT_LICENSE

See Also:

Constant Field Values

OMSCUTOUT_AUTHORNAMES

public static final String OMSCUTOUT_AUTHORNAMES

See Also:

Constant Field Values

OMSCUTOUT_AUTHORCONTACTS

public static final String OMSCUTOUT_AUTHORCONTACTS

See Also:

Constant Field Values

OMSCUTOUT_IN_RASTER_DESCRIPTION

public static final String OMSCUTOUT_IN_RASTER_DESCRIPTION

See Also:

Constant Field Values

OMSCUTOUT_IN_MASK_DESCRIPTION

public static final String OMSCUTOUT_IN_MASK_DESCRIPTION

See Also:

Constant Field Values

OMSCUTOUT_P_MAX_DESCRIPTION

public static final String OMSCUTOUT_P_MAX_DESCRIPTION

See Also:

Constant Field Values

OMSCUTOUT_P_MIN_DESCRIPTION

public static final String OMSCUTOUT_P_MIN_DESCRIPTION

See Also:

Constant Field Values

OMSCUTOUT_DO_INVERSE_DESCRIPTION

public static final String OMSCUTOUT_DO_INVERSE_DESCRIPTION

See Also:

Constant Field Values

OMSCUTOUT_OUT_RASTER_DESCRIPTION

public static final String OMSCUTOUT_OUT_RASTER_DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

OmsCutOut

public OmsCutOut()

Method Detail

process

public void process()
             throws Exception

Throws:

Exception

cut

public static org.geotools.coverage.grid.GridCoverage2D cut(org.geotools.coverage.grid.GridCoverage2D raster,
                                                            org.geotools.coverage.grid.GridCoverage2D mask)
                                                     throws Exception

Cut a raster on a mask using the default parameters.

Parameters:

raster - the raster to cut.

mask - the mask to apply.

Returns:

the cut map.

Throws:

Exception