com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class GenerateExcludeArea

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.GenerateExcludeArea

All Implemented Interfaces:

GPTool

public class GenerateExcludeArea
extends AbstractGPTool

Allows you to set the exclude area, based on color mask or histogram percentage. The output of this tool can then be used within the Color Balance Mosaic Dataset tool. The Generate Exclude Area tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool is used to exclude areas that will be difficult to color correct, such as water, clouds, and anomalous areas.The output of this tool can then be used in the Color Balance Mosaic Dataset tool.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

GenerateExcludeArea()
Creates the Generate Exclude Area tool with defaults.

GenerateExcludeArea(Object inRaster, Object outRaster, String pixelType, String generateMethod)
Creates the Generate Exclude Area tool with the required parameters.

Method Summary

String	getGenerateMethod() Returns the Generate Method parameter of this tool .
Object	getInRaster() Returns the Input Raster parameter of this tool .
double	getMaxBlack() Returns the Maximum Black parameter of this tool .
double	getMaxBlue() Returns the Maximum Blue parameter of this tool .
double	getMaxCyan() Returns the Maximum Cyan parameter of this tool .
double	getMaxGreen() Returns the Maximum Green parameter of this tool .
double	getMaxMagenta() Returns the Maximum Magenta parameter of this tool .
double	getMaxRed() Returns the Maximum Red parameter of this tool .
double	getMaxWhite() Returns the Maximum White parameter of this tool .
double	getMaxYellow() Returns the Maximum Yellow parameter of this tool .
Object	getOutRaster() Returns the Output Raster Dataset parameter of this tool .
double	getPercentageHigh() Returns the High Percentage parameter of this tool .
double	getPercentageLow() Returns the Low Percentage parameter of this tool .
String	getPixelType() Returns the Pixel Type parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setGenerateMethod(String generateMethod) Sets the Generate Method parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input Raster parameter of this tool .
void	setMaxBlack(double maxBlack) Sets the Maximum Black parameter of this tool .
void	setMaxBlue(double maxBlue) Sets the Maximum Blue parameter of this tool .
void	setMaxCyan(double maxCyan) Sets the Maximum Cyan parameter of this tool .
void	setMaxGreen(double maxGreen) Sets the Maximum Green parameter of this tool .
void	setMaxMagenta(double maxMagenta) Sets the Maximum Magenta parameter of this tool .
void	setMaxRed(double maxRed) Sets the Maximum Red parameter of this tool .
void	setMaxWhite(double maxWhite) Sets the Maximum White parameter of this tool .
void	setMaxYellow(double maxYellow) Sets the Maximum Yellow parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output Raster Dataset parameter of this tool .
void	setPercentageHigh(double percentageHigh) Sets the High Percentage parameter of this tool .
void	setPercentageLow(double percentageLow) Sets the Low Percentage parameter of this tool .
void	setPixelType(String pixelType) Sets the Pixel Type parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerateExcludeArea

public GenerateExcludeArea()

Creates the Generate Exclude Area tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

GenerateExcludeArea

public GenerateExcludeArea(Object inRaster,
                           Object outRaster,
                           String pixelType,
                           String generateMethod)

Creates the Generate Exclude Area tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inRaster - the file path and file name of the input raster. Valid inputs include raster layers and mosaic datasets layers.

outRaster - the file path and file name of the input raster. The output will be a raster dataset. the output can then be used as the Exclude Area Raster parameter within the Color Balance Mosaic Dataset tool.

pixelType - choose the pixel depth of your input raster dataset. This parameter is important, since any pixel depth above 8-bit will need to have the color mask and histogram values adjusted.

generateMethod - choose which method you would like to use, to exclude areas of your input.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input Raster parameter of this tool . This parameter is the file path and file name of the input raster. Valid inputs include raster layers and mosaic datasets layers. This is a required parameter.

Returns:

the Input Raster

setInRaster

public void setInRaster(Object inRaster)

Sets the Input Raster parameter of this tool . This parameter is the file path and file name of the input raster. Valid inputs include raster layers and mosaic datasets layers. This is a required parameter.

Parameters:

inRaster - the file path and file name of the input raster. Valid inputs include raster layers and mosaic datasets layers.

getOutRaster

public Object getOutRaster()

Returns the Output Raster Dataset parameter of this tool . This parameter is the file path and file name of the input raster. The output will be a raster dataset. the output can then be used as the Exclude Area Raster parameter within the Color Balance Mosaic Dataset tool. This is a required parameter.

Returns:

the Output Raster Dataset

setOutRaster

public void setOutRaster(Object outRaster)

Sets the Output Raster Dataset parameter of this tool . This parameter is the file path and file name of the input raster. The output will be a raster dataset. the output can then be used as the Exclude Area Raster parameter within the Color Balance Mosaic Dataset tool. This is a required parameter.

Parameters:

outRaster - the file path and file name of the input raster. The output will be a raster dataset. the output can then be used as the Exclude Area Raster parameter within the Color Balance Mosaic Dataset tool.

getPixelType

public String getPixelType()

Returns the Pixel Type parameter of this tool . This parameter is choose the pixel depth of your input raster dataset. This parameter is important, since any pixel depth above 8-bit will need to have the color mask and histogram values adjusted. This is a required parameter.

Returns:

the Pixel Type

setPixelType

public void setPixelType(String pixelType)

Sets the Pixel Type parameter of this tool . This parameter is choose the pixel depth of your input raster dataset. This parameter is important, since any pixel depth above 8-bit will need to have the color mask and histogram values adjusted. This is a required parameter.

Parameters:

pixelType - choose the pixel depth of your input raster dataset. This parameter is important, since any pixel depth above 8-bit will need to have the color mask and histogram values adjusted.

getGenerateMethod

public String getGenerateMethod()

Returns the Generate Method parameter of this tool . This parameter is choose which method you would like to use, to exclude areas of your input. This is a required parameter.

Returns:

the Generate Method

setGenerateMethod

public void setGenerateMethod(String generateMethod)

Sets the Generate Method parameter of this tool . This parameter is choose which method you would like to use, to exclude areas of your input. This is a required parameter.

Parameters:

generateMethod - choose which method you would like to use, to exclude areas of your input.

getMaxRed

public double getMaxRed()

Returns the Maximum Red parameter of this tool . This parameter is this is the maximum red value to exclude. The default is 255. This is an optional parameter.

Returns:

the Maximum Red

setMaxRed

public void setMaxRed(double maxRed)

Sets the Maximum Red parameter of this tool . This parameter is this is the maximum red value to exclude. The default is 255. This is an optional parameter.

Parameters:

maxRed - this is the maximum red value to exclude. The default is 255.

getMaxGreen

public double getMaxGreen()

Returns the Maximum Green parameter of this tool . This parameter is this is the maximum green value to exclude. The default is 255. This is an optional parameter.

Returns:

the Maximum Green

setMaxGreen

public void setMaxGreen(double maxGreen)

Sets the Maximum Green parameter of this tool . This parameter is this is the maximum green value to exclude. The default is 255. This is an optional parameter.

Parameters:

maxGreen - this is the maximum green value to exclude. The default is 255.

getMaxBlue

public double getMaxBlue()

Returns the Maximum Blue parameter of this tool . This parameter is this is the maximum blue value to exclude. The default is 255. This is an optional parameter.

Returns:

the Maximum Blue

setMaxBlue

public void setMaxBlue(double maxBlue)

Sets the Maximum Blue parameter of this tool . This parameter is this is the maximum blue value to exclude. The default is 255. This is an optional parameter.

Parameters:

maxBlue - this is the maximum blue value to exclude. The default is 255.

getMaxWhite

public double getMaxWhite()

Returns the Maximum White parameter of this tool . This parameter is this is the maximum white value to exclude. The default is 255. This is an optional parameter.

Returns:

the Maximum White

setMaxWhite

public void setMaxWhite(double maxWhite)

Sets the Maximum White parameter of this tool . This parameter is this is the maximum white value to exclude. The default is 255. This is an optional parameter.

Parameters:

maxWhite - this is the maximum white value to exclude. The default is 255.

getMaxBlack

public double getMaxBlack()

Returns the Maximum Black parameter of this tool . This parameter is this is the maximum black value to exclude. The default is 0. This is an optional parameter.

Returns:

the Maximum Black

setMaxBlack

public void setMaxBlack(double maxBlack)

Sets the Maximum Black parameter of this tool . This parameter is this is the maximum black value to exclude. The default is 0. This is an optional parameter.

Parameters:

maxBlack - this is the maximum black value to exclude. The default is 0.

getMaxMagenta

public double getMaxMagenta()

Returns the Maximum Magenta parameter of this tool . This parameter is this is the maximum magenta value to exclude. The default is 255. This is an optional parameter.

Returns:

the Maximum Magenta

setMaxMagenta

public void setMaxMagenta(double maxMagenta)

Sets the Maximum Magenta parameter of this tool . This parameter is this is the maximum magenta value to exclude. The default is 255. This is an optional parameter.

Parameters:

maxMagenta - this is the maximum magenta value to exclude. The default is 255.

getMaxCyan

public double getMaxCyan()

Returns the Maximum Cyan parameter of this tool . This parameter is this is the maximum cyan value to exclude. The default is 255. This is an optional parameter.

Returns:

the Maximum Cyan

setMaxCyan

public void setMaxCyan(double maxCyan)

Sets the Maximum Cyan parameter of this tool . This parameter is this is the maximum cyan value to exclude. The default is 255. This is an optional parameter.

Parameters:

maxCyan - this is the maximum cyan value to exclude. The default is 255.

getMaxYellow

public double getMaxYellow()

Returns the Maximum Yellow parameter of this tool . This parameter is this is the maximum yellow value to exclude. The default is 255. This is an optional parameter.

Returns:

the Maximum Yellow

setMaxYellow

public void setMaxYellow(double maxYellow)

Sets the Maximum Yellow parameter of this tool . This parameter is this is the maximum yellow value to exclude. The default is 255. This is an optional parameter.

Parameters:

maxYellow - this is the maximum yellow value to exclude. The default is 255.

getPercentageLow

public double getPercentageLow()

Returns the Low Percentage parameter of this tool . This parameter is this is the minimum percentage of the histogram to exclude. The default is 0. This is an optional parameter.

Returns:

the Low Percentage

setPercentageLow

public void setPercentageLow(double percentageLow)

Sets the Low Percentage parameter of this tool . This parameter is this is the minimum percentage of the histogram to exclude. The default is 0. This is an optional parameter.

Parameters:

percentageLow - this is the minimum percentage of the histogram to exclude. The default is 0.

getPercentageHigh

public double getPercentageHigh()

Returns the High Percentage parameter of this tool . This parameter is this is the maximum percentage of the histogram to exclude. The default is 100 This is an optional parameter.

Returns:

the High Percentage

setPercentageHigh

public void setPercentageHigh(double percentageHigh)

Sets the High Percentage parameter of this tool . This parameter is this is the maximum percentage of the histogram to exclude. The default is 100 This is an optional parameter.

Parameters:

percentageHigh - this is the maximum percentage of the histogram to exclude. The default is 100

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias