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

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

All Implemented Interfaces:

GPTool

public class CreateReferencedMosaicDataset
extends AbstractGPTool

Creates a new mosaic dataset from an existing raster catalog, a selection set from a raster catalog, or a mosaic dataset. The Create Referenced Mosaic Dataset tool is contained in the Data Management Tools tool box.

Usage tips:

• This mosaic dataset can be created within or outside a geodatabase. When not created within a geodatabase
  • a boundary will not be created
  • the file will have a .amd extension
• If the input is an RPF raster catalog created using Military Analyst, the Scale Field should be specified.
• Overviews cannot be created for a referenced mosaic dataset.
• A referenced mosaic dataset is one option for serving a raster catalog as an image service; however, you can also create fully capable mosaic dataset from a raster catalog using the followed by the tool.
• You may use this tool to create a mosaic dataset from another mosaic dataset, to create a mosaic dataset with a different output. For example, you may create one mosaic dataset with elevation data, then create another that will be used to produce a derived product, such as slope or hillshade.

Field Summary

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

vals

Constructor Summary

CreateReferencedMosaicDataset()
Creates the Create Referenced Mosaic Dataset tool with defaults.

CreateReferencedMosaicDataset(Object inDataset, Object outMosaicDataset)
Creates the Create Referenced Mosaic Dataset tool with the required parameters.

Method Summary

String	getBuildBoundary() Returns the Build Boundary parameter of this tool .
Object	getCoordinateSystem() Returns the Coordinate System parameter of this tool .
Object	getExtent() Returns the Extent parameter of this tool .
Object	getInDataset() Returns the Input Raster Catalog or Mosaic Dataset parameter of this tool .
Object	getInTemplateDataset() Returns the Extent from Dataset parameter of this tool .
Object	getLodField() Returns the Scale Field parameter of this tool .
Object	getMaxPSField() Returns the Maximum Cell Size Field parameter of this tool .
Object	getMinPSField() Returns the Minimum Cell Size Field parameter of this tool .
int	getNumberOfBands() Returns the Number of Bands parameter of this tool .
Object	getOutMosaicDataset() Returns the Output Mosaic Dataset parameter of this tool .
double	getPixelSize() Returns the Maximum Visible Cell Size parameter of this tool .
String	getPixelType() Returns the Pixel Type parameter of this tool .
String	getSelectUsingFeatures() Returns the Using Input Geometry for Selection 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.
Object	getWhereClause() Returns the Query Definition parameter of this tool .
void	setBuildBoundary(String buildBoundary) Sets the Build Boundary parameter of this tool .
void	setCoordinateSystem(Object coordinateSystem) Sets the Coordinate System parameter of this tool .
void	setExtent(Object extent) Sets the Extent parameter of this tool .
void	setInDataset(Object inDataset) Sets the Input Raster Catalog or Mosaic Dataset parameter of this tool .
void	setInTemplateDataset(Object inTemplateDataset) Sets the Extent from Dataset parameter of this tool .
void	setLodField(Object lodField) Sets the Scale Field parameter of this tool .
void	setMaxPSField(Object maxPSField) Sets the Maximum Cell Size Field parameter of this tool .
void	setMinPSField(Object minPSField) Sets the Minimum Cell Size Field parameter of this tool .
void	setNumberOfBands(int numberOfBands) Sets the Number of Bands parameter of this tool .
void	setOutMosaicDataset(Object outMosaicDataset) Sets the Output Mosaic Dataset parameter of this tool .
void	setPixelSize(double pixelSize) Sets the Maximum Visible Cell Size parameter of this tool .
void	setPixelType(String pixelType) Sets the Pixel Type parameter of this tool .
void	setSelectUsingFeatures(String selectUsingFeatures) Sets the Using Input Geometry for Selection parameter of this tool .
void	setWhereClause(Object whereClause) Sets the Query Definition 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

CreateReferencedMosaicDataset

public CreateReferencedMosaicDataset()

Creates the Create Referenced Mosaic Dataset tool with defaults.

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

CreateReferencedMosaicDataset

public CreateReferencedMosaicDataset(Object inDataset,
                                     Object outMosaicDataset)

Creates the Create Referenced 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:

inDataset - path and name of the input raster catalog or mosaic dataset.

outMosaicDataset - the path and folder location or geodatabase where the mosaic dataset will be created.

Method Detail

getInDataset

public Object getInDataset()

Returns the Input Raster Catalog or Mosaic Dataset parameter of this tool . This parameter is path and name of the input raster catalog or mosaic dataset. This is a required parameter.

Returns:

the Input Raster Catalog or Mosaic Dataset

setInDataset

public void setInDataset(Object inDataset)

Sets the Input Raster Catalog or Mosaic Dataset parameter of this tool . This parameter is path and name of the input raster catalog or mosaic dataset. This is a required parameter.

Parameters:

inDataset - path and name of the input raster catalog or mosaic dataset.

getOutMosaicDataset

public Object getOutMosaicDataset()

Returns the Output Mosaic Dataset parameter of this tool . This parameter is the path and folder location or geodatabase where the mosaic dataset will be created. This is a required parameter.

Returns:

the Output Mosaic Dataset

setOutMosaicDataset

public void setOutMosaicDataset(Object outMosaicDataset)

Sets the Output Mosaic Dataset parameter of this tool . This parameter is the path and folder location or geodatabase where the mosaic dataset will be created. This is a required parameter.

Parameters:

outMosaicDataset - the path and folder location or geodatabase where the mosaic dataset will be created.

getCoordinateSystem

public Object getCoordinateSystem()

Returns the Coordinate System parameter of this tool . This parameter is the coordinate system defined for the mosaic dataset, which will be used for all the associated files created. This is an optional parameter.

Returns:

the Coordinate System

setCoordinateSystem

public void setCoordinateSystem(Object coordinateSystem)

Sets the Coordinate System parameter of this tool . This parameter is the coordinate system defined for the mosaic dataset, which will be used for all the associated files created. This is an optional parameter.

Parameters:

coordinateSystem - the coordinate system defined for the mosaic dataset, which will be used for all the associated files created.

getNumberOfBands

public int getNumberOfBands()

Returns the Number of Bands parameter of this tool . This parameter is the number of raster dataset bands supported by the mosaic dataset. This is an optional parameter.

Returns:

the Number of Bands

setNumberOfBands

public void setNumberOfBands(int numberOfBands)

Sets the Number of Bands parameter of this tool . This parameter is the number of raster dataset bands supported by the mosaic dataset. This is an optional parameter.

Parameters:

numberOfBands - the number of raster dataset bands supported by the mosaic dataset.

getPixelType

public String getPixelType()

Returns the Pixel Type parameter of this tool . This parameter is the bit depth of a cell, used to determine the range of values that the mosaic dataset outputs. For example, an 8-bit mosaic dataset can have 256 unique pixel values, which range from 0 to 255. if it is not defined it will be taken from the first raster dataset. This is an optional parameter.

Returns:

the Pixel Type

setPixelType

public void setPixelType(String pixelType)

Sets the Pixel Type parameter of this tool . This parameter is the bit depth of a cell, used to determine the range of values that the mosaic dataset outputs. For example, an 8-bit mosaic dataset can have 256 unique pixel values, which range from 0 to 255. if it is not defined it will be taken from the first raster dataset. This is an optional parameter.

Parameters:

pixelType - the bit depth of a cell, used to determine the range of values that the mosaic dataset outputs. For example, an 8-bit mosaic dataset can have 256 unique pixel values, which range from 0 to 255. if it is not defined it will be taken from the first raster dataset.

getWhereClause

public Object getWhereClause()

Returns the Query Definition parameter of this tool . This parameter is use SQL to define a query, or use the Query Builder to build a query that identifies the raster datasets to be added to the mosaic dataset from the raster catalog or mosaic definition. This is an optional parameter.

Returns:

the Query Definition

setWhereClause

public void setWhereClause(Object whereClause)

Sets the Query Definition parameter of this tool . This parameter is use SQL to define a query, or use the Query Builder to build a query that identifies the raster datasets to be added to the mosaic dataset from the raster catalog or mosaic definition. This is an optional parameter.

Parameters:

whereClause - use SQL to define a query, or use the Query Builder to build a query that identifies the raster datasets to be added to the mosaic dataset from the raster catalog or mosaic definition.

getInTemplateDataset

public Object getInTemplateDataset()

Returns the Extent from Dataset parameter of this tool . This parameter is uses the extent of the specified raster dataset or feature class to define the extent of the raster datasets used in the mosaic dataset from the raster catalog or mosaic dataset. rasters that lay along the defined extent will be included in the mosaic dataset. the input is not limited to a polygon feature class. This is an optional parameter.

Returns:

the Extent from Dataset

setInTemplateDataset

public void setInTemplateDataset(Object inTemplateDataset)

Sets the Extent from Dataset parameter of this tool . This parameter is uses the extent of the specified raster dataset or feature class to define the extent of the raster datasets used in the mosaic dataset from the raster catalog or mosaic dataset. rasters that lay along the defined extent will be included in the mosaic dataset. the input is not limited to a polygon feature class. This is an optional parameter.

Parameters:

inTemplateDataset - uses the extent of the specified raster dataset or feature class to define the extent of the raster datasets used in the mosaic dataset from the raster catalog or mosaic dataset. rasters that lay along the defined extent will be included in the mosaic dataset. the input is not limited to a polygon feature class.

getExtent

public Object getExtent()

Returns the Extent parameter of this tool . This is an optional parameter.

Returns:

the Extent

setExtent

public void setExtent(Object extent)

Sets the Extent parameter of this tool . This is an optional parameter.

Parameters:

extent - null

getSelectUsingFeatures

public String getSelectUsingFeatures()

Returns the Using Input Geometry for Selection parameter of this tool . This parameter is if a feature class is specified you can choose to limit the extent to its envelope or clipped to the feature. to use this, the input must be a polygon feature class. This is an optional parameter.

Returns:

the Using Input Geometry for Selection

setSelectUsingFeatures

public void setSelectUsingFeatures(String selectUsingFeatures)

Sets the Using Input Geometry for Selection parameter of this tool . This parameter is if a feature class is specified you can choose to limit the extent to its envelope or clipped to the feature. to use this, the input must be a polygon feature class. This is an optional parameter.

Parameters:

selectUsingFeatures - if a feature class is specified you can choose to limit the extent to its envelope or clipped to the feature. to use this, the input must be a polygon feature class.

getLodField

public Object getLodField()

Returns the Scale Field parameter of this tool . This parameter is a field in the raster catalog table defining the map scales at which the mosaic should be displayed; otherwise a wire frame will be displayed. This is an optional parameter.

Returns:

the Scale Field

setLodField

public void setLodField(Object lodField)

Sets the Scale Field parameter of this tool . This parameter is a field in the raster catalog table defining the map scales at which the mosaic should be displayed; otherwise a wire frame will be displayed. This is an optional parameter.

Parameters:

lodField - a field in the raster catalog table defining the map scales at which the mosaic should be displayed; otherwise a wire frame will be displayed.

getMinPSField

public Object getMinPSField()

Returns the Minimum Cell Size Field parameter of this tool . This parameter is a field in the raster catalog table defining the minimum cell size of the raster at which the mosaic should be displayed; otherwise a wire frame will be displayed. This is an optional parameter.

Returns:

the Minimum Cell Size Field

setMinPSField

public void setMinPSField(Object minPSField)

Sets the Minimum Cell Size Field parameter of this tool . This parameter is a field in the raster catalog table defining the minimum cell size of the raster at which the mosaic should be displayed; otherwise a wire frame will be displayed. This is an optional parameter.

Parameters:

minPSField - a field in the raster catalog table defining the minimum cell size of the raster at which the mosaic should be displayed; otherwise a wire frame will be displayed.

getMaxPSField

public Object getMaxPSField()

Returns the Maximum Cell Size Field parameter of this tool . This parameter is a field in the raster catalog table defining the maximum cell size of the raster at which the mosaic should be displayed; otherwise a wire frame will be displayed. This is an optional parameter.

Returns:

the Maximum Cell Size Field

setMaxPSField

public void setMaxPSField(Object maxPSField)

Sets the Maximum Cell Size Field parameter of this tool . This parameter is a field in the raster catalog table defining the maximum cell size of the raster at which the mosaic should be displayed; otherwise a wire frame will be displayed. This is an optional parameter.

Parameters:

maxPSField - a field in the raster catalog table defining the maximum cell size of the raster at which the mosaic should be displayed; otherwise a wire frame will be displayed.

getPixelSize

public double getPixelSize()

Returns the Maximum Visible Cell Size parameter of this tool . This is an optional parameter.

Returns:

the Maximum Visible Cell Size

setPixelSize

public void setPixelSize(double pixelSize)

Sets the Maximum Visible Cell Size parameter of this tool . This is an optional parameter.

Parameters:

pixelSize - null

getBuildBoundary

public String getBuildBoundary()

Returns the Build Boundary parameter of this tool . This parameter is generates the boundary polygon for the mosaic dataset. By default, the boundary merges all the footprint polygons to create a single boundary representing the extent of the valid pixels. this is only available if the mosaic dataset is created within a geodatabase. This is an optional parameter.

Returns:

the Build Boundary

setBuildBoundary

public void setBuildBoundary(String buildBoundary)

Sets the Build Boundary parameter of this tool . This parameter is generates the boundary polygon for the mosaic dataset. By default, the boundary merges all the footprint polygons to create a single boundary representing the extent of the valid pixels. this is only available if the mosaic dataset is created within a geodatabase. This is an optional parameter.

Parameters:

buildBoundary - generates the boundary polygon for the mosaic dataset. By default, the boundary merges all the footprint polygons to create a single boundary representing the extent of the valid pixels. this is only available if the mosaic dataset is created within a geodatabase.

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