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

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

All Implemented Interfaces:

GPTool

public class CreatePansharpenedRasterDataset
extends AbstractGPTool

Fuses a high-resolution panchromatic raster dataset with a lower-resolution multiband raster dataset to create a red-green-blue (RGB) raster with the resolution of the panchromatic raster. The Create Pan-sharpened Raster Dataset tool is contained in the Data Management Tools tool box.

Usage tips:

• Only the areas that fully overlap will be affected by this tool.
• You can save your output to BIL, BIP, BMP, BSQ, DAT, GIF, GRID, IMG, JPEG, JPEG 2000, PNG, TIFF, or any geodatabase raster dataset.
• IHS uses Intensity, Hue, and Saturation color space for data fusion. Brovey and ESRI use an algorithm based on spectral modeling for data fusion.
• The Simple Mean method uses the averaged pixel value between the original red, green, and blue values and the panchromatic pixel value. This is done for each of the colors (red, green, and blue).
• The four weight values allow you to adjust the pan-sharpening algorithms. All weights when summed should equal a total of one.
• Pan-sharpening that is performed on a three-band raster dataset will produce a raster dataset that has three bands.Pan-sharpening that is performed on a four-band raster dataset will produce a raster dataset that has four bands (three bands that have been pan-sharpened and the infrared band).

Field Summary

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

vals

Constructor Summary

CreatePansharpenedRasterDataset()
Creates the Create Pan-sharpened Raster Dataset tool with defaults.

CreatePansharpenedRasterDataset(Object inRaster, int redChannel, int greenChannel, int blueChannel, Object outRasterDataset, Object inPanchromaticImage, String pansharpeningType)
Creates the Create Pan-sharpened Raster Dataset tool with the required parameters.

Method Summary

int	getBlueChannel() Returns the Blue Channel parameter of this tool .
double	getBlueWeight() Returns the Blue Weight parameter of this tool .
int	getGreenChannel() Returns the Green Channel parameter of this tool .
double	getGreenWeight() Returns the Green Weight parameter of this tool .
int	getInfraredChannel() Returns the Infrared Channel parameter of this tool .
double	getInfraredWeight() Returns the Infrared Weight parameter of this tool .
Object	getInPanchromaticImage() Returns the Panchromatic Image parameter of this tool .
Object	getInRaster() Returns the Input Raster parameter of this tool .
Object	getOutRasterDataset() Returns the Output Raster Dataset parameter of this tool .
String	getPansharpeningType() Returns the Pan-sharpening Type parameter of this tool .
int	getRedChannel() Returns the Red Channel parameter of this tool .
double	getRedWeight() Returns the Red Weight 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	setBlueChannel(int blueChannel) Sets the Blue Channel parameter of this tool .
void	setBlueWeight(double blueWeight) Sets the Blue Weight parameter of this tool .
void	setGreenChannel(int greenChannel) Sets the Green Channel parameter of this tool .
void	setGreenWeight(double greenWeight) Sets the Green Weight parameter of this tool .
void	setInfraredChannel(int infraredChannel) Sets the Infrared Channel parameter of this tool .
void	setInfraredWeight(double infraredWeight) Sets the Infrared Weight parameter of this tool .
void	setInPanchromaticImage(Object inPanchromaticImage) Sets the Panchromatic Image parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input Raster parameter of this tool .
void	setOutRasterDataset(Object outRasterDataset) Sets the Output Raster Dataset parameter of this tool .
void	setPansharpeningType(String pansharpeningType) Sets the Pan-sharpening Type parameter of this tool .
void	setRedChannel(int redChannel) Sets the Red Channel parameter of this tool .
void	setRedWeight(double redWeight) Sets the Red Weight 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

CreatePansharpenedRasterDataset

public CreatePansharpenedRasterDataset()

Creates the Create Pan-sharpened Raster Dataset tool with defaults.

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

CreatePansharpenedRasterDataset

public CreatePansharpenedRasterDataset(Object inRaster,
                                       int redChannel,
                                       int greenChannel,
                                       int blueChannel,
                                       Object outRasterDataset,
                                       Object inPanchromaticImage,
                                       String pansharpeningType)

Creates the Create Pan-sharpened Raster 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:

inRaster - the input raster dataset that you want to pan-sharpen. typically, this is a low-resolution multiband raster dataset.

redChannel - the input raster band that you want to display with the red color gun.

greenChannel - the input raster band that you want to display with the green color gun.

blueChannel - the input raster band that you want to display with the blue color gun.

outRasterDataset - the output raster dataset. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality.

inPanchromaticImage - the panchromatic raster dataset. Typically, this is a high-resolution grayscale image.

pansharpeningType - the pan-sharpening method: older scripts and models may use still the old keyword. With the ArcGIS 10.0 release, this keyword was replaced with "Simple_Mean". Both keywords will continue to work, but for clarity it may be worthwhile to update it to the new keyword.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input Raster parameter of this tool . This parameter is the input raster dataset that you want to pan-sharpen. typically, this is a low-resolution multiband raster dataset. 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 input raster dataset that you want to pan-sharpen. typically, this is a low-resolution multiband raster dataset. This is a required parameter.

Parameters:

inRaster - the input raster dataset that you want to pan-sharpen. typically, this is a low-resolution multiband raster dataset.

getRedChannel

public int getRedChannel()

Returns the Red Channel parameter of this tool . This parameter is the input raster band that you want to display with the red color gun. This is a required parameter.

Returns:

the Red Channel

setRedChannel

public void setRedChannel(int redChannel)

Sets the Red Channel parameter of this tool . This parameter is the input raster band that you want to display with the red color gun. This is a required parameter.

Parameters:

redChannel - the input raster band that you want to display with the red color gun.

getGreenChannel

public int getGreenChannel()

Returns the Green Channel parameter of this tool . This parameter is the input raster band that you want to display with the green color gun. This is a required parameter.

Returns:

the Green Channel

setGreenChannel

public void setGreenChannel(int greenChannel)

Sets the Green Channel parameter of this tool . This parameter is the input raster band that you want to display with the green color gun. This is a required parameter.

Parameters:

greenChannel - the input raster band that you want to display with the green color gun.

getBlueChannel

public int getBlueChannel()

Returns the Blue Channel parameter of this tool . This parameter is the input raster band that you want to display with the blue color gun. This is a required parameter.

Returns:

the Blue Channel

setBlueChannel

public void setBlueChannel(int blueChannel)

Sets the Blue Channel parameter of this tool . This parameter is the input raster band that you want to display with the blue color gun. This is a required parameter.

Parameters:

blueChannel - the input raster band that you want to display with the blue color gun.

getInfraredChannel

public int getInfraredChannel()

Returns the Infrared Channel parameter of this tool . This parameter is the input infrared raster band. An infrared band does not exist for every raster dataset. This is an optional parameter.

Returns:

the Infrared Channel

setInfraredChannel

public void setInfraredChannel(int infraredChannel)

Sets the Infrared Channel parameter of this tool . This parameter is the input infrared raster band. An infrared band does not exist for every raster dataset. This is an optional parameter.

Parameters:

infraredChannel - the input infrared raster band. An infrared band does not exist for every raster dataset.

getOutRasterDataset

public Object getOutRasterDataset()

Returns the Output Raster Dataset parameter of this tool . This parameter is the output raster dataset. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality. This is a required parameter.

Returns:

the Output Raster Dataset

setOutRasterDataset

public void setOutRasterDataset(Object outRasterDataset)

Sets the Output Raster Dataset parameter of this tool . This parameter is the output raster dataset. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality. This is a required parameter.

Parameters:

outRasterDataset - the output raster dataset. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality.

getInPanchromaticImage

public Object getInPanchromaticImage()

Returns the Panchromatic Image parameter of this tool . This parameter is the panchromatic raster dataset. Typically, this is a high-resolution grayscale image. This is a required parameter.

Returns:

the Panchromatic Image

setInPanchromaticImage

public void setInPanchromaticImage(Object inPanchromaticImage)

Sets the Panchromatic Image parameter of this tool . This parameter is the panchromatic raster dataset. Typically, this is a high-resolution grayscale image. This is a required parameter.

Parameters:

inPanchromaticImage - the panchromatic raster dataset. Typically, this is a high-resolution grayscale image.

getPansharpeningType

public String getPansharpeningType()

Returns the Pan-sharpening Type parameter of this tool . This parameter is the pan-sharpening method: older scripts and models may use still the old keyword. With the ArcGIS 10.0 release, this keyword was replaced with "Simple_Mean". Both keywords will continue to work, but for clarity it may be worthwhile to update it to the new keyword. This is a required parameter.

Returns:

the Pan-sharpening Type

setPansharpeningType

public void setPansharpeningType(String pansharpeningType)

Sets the Pan-sharpening Type parameter of this tool . This parameter is the pan-sharpening method: older scripts and models may use still the old keyword. With the ArcGIS 10.0 release, this keyword was replaced with "Simple_Mean". Both keywords will continue to work, but for clarity it may be worthwhile to update it to the new keyword. This is a required parameter.

Parameters:

pansharpeningType - the pan-sharpening method: older scripts and models may use still the old keyword. With the ArcGIS 10.0 release, this keyword was replaced with "Simple_Mean". Both keywords will continue to work, but for clarity it may be worthwhile to update it to the new keyword.

getRedWeight

public double getRedWeight()

Returns the Red Weight parameter of this tool . This parameter is the weight value for the red band. all the weight values (red, green, blue, and infrared) should equal a sum of one. This is an optional parameter.

Returns:

the Red Weight

setRedWeight

public void setRedWeight(double redWeight)

Sets the Red Weight parameter of this tool . This parameter is the weight value for the red band. all the weight values (red, green, blue, and infrared) should equal a sum of one. This is an optional parameter.

Parameters:

redWeight - the weight value for the red band. all the weight values (red, green, blue, and infrared) should equal a sum of one.

getGreenWeight

public double getGreenWeight()

Returns the Green Weight parameter of this tool . This parameter is the weight value for the green band. all the weight values (red, green, blue, and infrared) should equal a sum of one. This is an optional parameter.

Returns:

the Green Weight

setGreenWeight

public void setGreenWeight(double greenWeight)

Sets the Green Weight parameter of this tool . This parameter is the weight value for the green band. all the weight values (red, green, blue, and infrared) should equal a sum of one. This is an optional parameter.

Parameters:

greenWeight - the weight value for the green band. all the weight values (red, green, blue, and infrared) should equal a sum of one.

getBlueWeight

public double getBlueWeight()

Returns the Blue Weight parameter of this tool . This parameter is the weight value for the blue band. all the weight values (red, green, blue, and infrared) should equal a sum of one. This is an optional parameter.

Returns:

the Blue Weight

setBlueWeight

public void setBlueWeight(double blueWeight)

Sets the Blue Weight parameter of this tool . This parameter is the weight value for the blue band. all the weight values (red, green, blue, and infrared) should equal a sum of one. This is an optional parameter.

Parameters:

blueWeight - the weight value for the blue band. all the weight values (red, green, blue, and infrared) should equal a sum of one.

getInfraredWeight

public double getInfraredWeight()

Returns the Infrared Weight parameter of this tool . This parameter is the weight value for the infrared band. This parameter is only valid if an infrared band exists and the infrared option is used. all the weight values (red, green, blue, and infrared) should equal a sum of one. This is an optional parameter.

Returns:

the Infrared Weight

setInfraredWeight

public void setInfraredWeight(double infraredWeight)

Sets the Infrared Weight parameter of this tool . This parameter is the weight value for the infrared band. This parameter is only valid if an infrared band exists and the infrared option is used. all the weight values (red, green, blue, and infrared) should equal a sum of one. This is an optional parameter.

Parameters:

infraredWeight - the weight value for the infrared band. This parameter is only valid if an infrared band exists and the infrared option is used. all the weight values (red, green, blue, and infrared) should equal a sum of one.

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