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

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

All Implemented Interfaces:

GPTool

public class ColorBalanceMosaicDataset
extends AbstractGPTool

Color balances a mosaic dataset, so that the tiles appear seamless. The Color Balance Mosaic Dataset tool is contained in the Data Management Tools tool box.

Usage tips:

• Use this tool on a mosaic dataset, to help make the adjacent tiles appear seamless.
• Color balancing can only take place if the following is true about your data:
• The Pre-processing Options are performed before any color balancing takes place.
• There are three balancing algorithms available: Dodging, Histogram, and Standard deviation.
• The target color surface is only available if the dodging balancing technique is chosen. When using the dodging technique, each pixel needs a target color, which is picked up from the target color surface. There are five types of target color surfaces that you can choose from: single color, color grid, first order surface, second order surface, and third order surface.
• Use Reference Target Image allows you to specify the target raster to balance your rasters.
  • When dodging balancing is used—The target color that will be derived depends on the target color surface type that was chosen. For single color, the average value of the reference target image is used. For color grid, the reference target image is resampled to a suitable grid. For the polynomial order surfaces, the coefficients of the polynomial is obtained by the Least Square Fitting, from the reference target image.
  • When histogram balancing is used—The target histogram is obtained from the reference target image.
  • When standard deviation balancing is used—The target standard deviation is obtained from the reference target image.

Field Summary

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

vals

Constructor Summary

ColorBalanceMosaicDataset()
Creates the Color Balance Mosaic Dataset tool with defaults.

ColorBalanceMosaicDataset(java.lang.Object inMosaicDataset)
Creates the Color Balance Mosaic Dataset tool with the required parameters.

Method Summary

java.lang.String	getBalancingMethod() Returns the Balance Method parameter of this tool .
java.lang.String	getColorSurfaceType() Returns the Color Surface Type parameter of this tool .
java.lang.Object	getExcludeRaster() Returns the Exclude Area Raster parameter of this tool .
double	getGamma() Returns the Gamma parameter of this tool .
java.lang.Object	getInMosaicDataset() Returns the Mosaic Dataset parameter of this tool .
java.lang.Object	getOutMosaicDataset() Returns the Mosaic Dataset parameter of this tool (Read only).
java.lang.String	getStretchType() Returns the Stretch Type parameter of this tool .
java.lang.Object	getTargetRaster() Returns the Target Raster parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setBalancingMethod(java.lang.String balancingMethod) Sets the Balance Method parameter of this tool .
void	setColorSurfaceType(java.lang.String colorSurfaceType) Sets the Color Surface Type parameter of this tool .
void	setExcludeRaster(java.lang.Object excludeRaster) Sets the Exclude Area Raster parameter of this tool .
void	setGamma(double gamma) Sets the Gamma parameter of this tool .
void	setInMosaicDataset(java.lang.Object inMosaicDataset) Sets the Mosaic Dataset parameter of this tool .
void	setStretchType(java.lang.String stretchType) Sets the Stretch Type parameter of this tool .
void	setTargetRaster(java.lang.Object targetRaster) Sets the Target Raster 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

ColorBalanceMosaicDataset

public ColorBalanceMosaicDataset()

Creates the Color Balance Mosaic Dataset tool with defaults.

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

ColorBalanceMosaicDataset

public ColorBalanceMosaicDataset(java.lang.Object inMosaicDataset)

Creates the Color Balance Mosaic Dataset 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:

inMosaicDataset - type or navigate to the mosaic dataset that you want to color balance.

Method Detail

getInMosaicDataset

public java.lang.Object getInMosaicDataset()

Returns the Mosaic Dataset parameter of this tool . This parameter is type or navigate to the mosaic dataset that you want to color balance. This is a required parameter.

Returns:

the Mosaic Dataset

setInMosaicDataset

public void setInMosaicDataset(java.lang.Object inMosaicDataset)

Sets the Mosaic Dataset parameter of this tool . This parameter is type or navigate to the mosaic dataset that you want to color balance. This is a required parameter.

Parameters:

inMosaicDataset - type or navigate to the mosaic dataset that you want to color balance.

getBalancingMethod

public java.lang.String getBalancingMethod()

Returns the Balance Method parameter of this tool . This parameter is choose the balancing algorithm to use. This is an optional parameter.

Returns:

the Balance Method

setBalancingMethod

public void setBalancingMethod(java.lang.String balancingMethod)

Sets the Balance Method parameter of this tool . This parameter is choose the balancing algorithm to use. This is an optional parameter.

Parameters:

balancingMethod - choose the balancing algorithm to use.

getColorSurfaceType

public java.lang.String getColorSurfaceType()

Returns the Color Surface Type parameter of this tool . This parameter is the Target Color Surface Type is only available if the dodging balancing technique is chosen. When using the dodging technique, each pixel needs a target color, which is determined by which surface type is chosen. This is an optional parameter.

Returns:

the Color Surface Type

setColorSurfaceType

public void setColorSurfaceType(java.lang.String colorSurfaceType)

Sets the Color Surface Type parameter of this tool . This parameter is the Target Color Surface Type is only available if the dodging balancing technique is chosen. When using the dodging technique, each pixel needs a target color, which is determined by which surface type is chosen. This is an optional parameter.

Parameters:

colorSurfaceType - the Target Color Surface Type is only available if the dodging balancing technique is chosen. When using the dodging technique, each pixel needs a target color, which is determined by which surface type is chosen.

getTargetRaster

public java.lang.Object getTargetRaster()

Returns the Target Raster parameter of this tool . This parameter is the target raster image allows you to specify the target raster to balance your rasters. when dodging balancing is used, the target color that will be derived depend on the target color surface type that was chosen. For Single Color, the average value of the reference target image is used. For Color Grid, the reference target image is resampled to a suitable grid. For the polynomial order surfaces, the coefficients of the polynomial is obtained by the Least Square Fitting, from the reference target image. when Histogram Balancing is used the target histogram is obtained from the reference target image. when Standard Deviation balancing is used the target standard deviation is obtained from the reference target image. This is an optional parameter.

Returns:

the Target Raster

setTargetRaster

public void setTargetRaster(java.lang.Object targetRaster)

Sets the Target Raster parameter of this tool . This parameter is the target raster image allows you to specify the target raster to balance your rasters. when dodging balancing is used, the target color that will be derived depend on the target color surface type that was chosen. For Single Color, the average value of the reference target image is used. For Color Grid, the reference target image is resampled to a suitable grid. For the polynomial order surfaces, the coefficients of the polynomial is obtained by the Least Square Fitting, from the reference target image. when Histogram Balancing is used the target histogram is obtained from the reference target image. when Standard Deviation balancing is used the target standard deviation is obtained from the reference target image. This is an optional parameter.

Parameters:

targetRaster - the target raster image allows you to specify the target raster to balance your rasters. when dodging balancing is used, the target color that will be derived depend on the target color surface type that was chosen. For Single Color, the average value of the reference target image is used. For Color Grid, the reference target image is resampled to a suitable grid. For the polynomial order surfaces, the coefficients of the polynomial is obtained by the Least Square Fitting, from the reference target image. when Histogram Balancing is used the target histogram is obtained from the reference target image. when Standard Deviation balancing is used the target standard deviation is obtained from the reference target image.

getExcludeRaster

public java.lang.Object getExcludeRaster()

Returns the Exclude Area Raster parameter of this tool . This parameter is navigate to the raster which you would like to use as an exclude layer. The Generate Exclude Area tool can be used to create the exclude area. the exclude area is taken into consideration before any color balancing takes place. This is an optional parameter.

Returns:

the Exclude Area Raster

setExcludeRaster

public void setExcludeRaster(java.lang.Object excludeRaster)

Sets the Exclude Area Raster parameter of this tool . This parameter is navigate to the raster which you would like to use as an exclude layer. The Generate Exclude Area tool can be used to create the exclude area. the exclude area is taken into consideration before any color balancing takes place. This is an optional parameter.

Parameters:

excludeRaster - navigate to the raster which you would like to use as an exclude layer. The Generate Exclude Area tool can be used to create the exclude area. the exclude area is taken into consideration before any color balancing takes place.

getStretchType

public java.lang.String getStretchType()

Returns the Stretch Type parameter of this tool . This parameter is pre-stretching can be performed on each raster catalog item before any other color correction takes place. This means that the original raster catalog item will be using its stretched pixel values, rather than its raw pixel values, in the color correction process. You may want to use this option in order to change the color to a expected distribution, before applying color correction. This is an optional parameter.

Returns:

the Stretch Type

setStretchType

public void setStretchType(java.lang.String stretchType)

Sets the Stretch Type parameter of this tool . This parameter is pre-stretching can be performed on each raster catalog item before any other color correction takes place. This means that the original raster catalog item will be using its stretched pixel values, rather than its raw pixel values, in the color correction process. You may want to use this option in order to change the color to a expected distribution, before applying color correction. This is an optional parameter.

Parameters:

stretchType - pre-stretching can be performed on each raster catalog item before any other color correction takes place. This means that the original raster catalog item will be using its stretched pixel values, rather than its raw pixel values, in the color correction process. You may want to use this option in order to change the color to a expected distribution, before applying color correction.

getGamma

public double getGamma()

Returns the Gamma parameter of this tool . This parameter is type the gamma value to use in the pre-processing stretch. This is only available if the Standard Deviation or Minimum-Maximum pre-stretch type is chosen. by applying the gamma stretch, you can control the overall brightness of an image. If the gamma coefficient is set too low, the middle tones appear too dark; however, if the gamma coefficient is set too high, the middle tones appear too light. Gamma changes not only the brightness, but also the ratios of red to green to blue. This is an optional parameter.

Returns:

the Gamma

setGamma

public void setGamma(double gamma)

Sets the Gamma parameter of this tool . This parameter is type the gamma value to use in the pre-processing stretch. This is only available if the Standard Deviation or Minimum-Maximum pre-stretch type is chosen. by applying the gamma stretch, you can control the overall brightness of an image. If the gamma coefficient is set too low, the middle tones appear too dark; however, if the gamma coefficient is set too high, the middle tones appear too light. Gamma changes not only the brightness, but also the ratios of red to green to blue. This is an optional parameter.

Parameters:

gamma - type the gamma value to use in the pre-processing stretch. This is only available if the Standard Deviation or Minimum-Maximum pre-stretch type is chosen. by applying the gamma stretch, you can control the overall brightness of an image. If the gamma coefficient is set too low, the middle tones appear too dark; however, if the gamma coefficient is set too high, the middle tones appear too light. Gamma changes not only the brightness, but also the ratios of red to green to blue.

getOutMosaicDataset

public java.lang.Object getOutMosaicDataset()

Returns the Mosaic Dataset parameter of this tool (Read only). This is an derived parameter.

Returns:

the Mosaic Dataset

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias