|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.AbstractGPTool com.esri.arcgis.geoprocessing.tools.datamanagementtools.BuildFootprints
public class BuildFootprints
Computes the footprints for each raster dataset in a mosaic dataset. The Build Footprints tool is contained in the Data Management Tools tool box.
Field Summary |
---|
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool |
---|
vals |
Constructor Summary | |
---|---|
BuildFootprints()
Creates the Build Footprints tool with defaults. |
|
BuildFootprints(Object inMosaicDataset)
Creates the Build Footprints tool with the required parameters. |
Method Summary | |
---|---|
int |
getApproxNumVertices()
Returns the Approximate number of vertices parameter of this tool . |
Object |
getInMosaicDataset()
Returns the Mosaic Dataset parameter of this tool . |
String |
getMaintainEdges()
Returns the Maintain sheet edges parameter of this tool . |
double |
getMaxDataValue()
Returns the Maximum Data Value parameter of this tool . |
double |
getMinDataValue()
Returns the Minimum Data Value parameter of this tool . |
int |
getMinRegionSize()
Returns the Minimum Region Size parameter of this tool . |
Object |
getOutMosaicDataset()
Returns the Mosaic Dataset parameter of this tool (Read only). |
int |
getRequestSize()
Returns the Request Size parameter of this tool . |
String |
getResetFootprint()
Returns the Reset footprints to default parameter of this tool . |
double |
getShrinkDistance()
Returns the Shrink distance parameter of this tool . |
String |
getSkipDerivedImages()
Returns the Skip overviews 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. |
String |
getUpdateBoundary()
Returns the Update Boundary parameter of this tool . |
Object |
getWhereClause()
Returns the Query Definition parameter of this tool . |
void |
setApproxNumVertices(int approxNumVertices)
Sets the Approximate number of vertices parameter of this tool . |
void |
setInMosaicDataset(Object inMosaicDataset)
Sets the Mosaic Dataset parameter of this tool . |
void |
setMaintainEdges(String maintainEdges)
Sets the Maintain sheet edges parameter of this tool . |
void |
setMaxDataValue(double maxDataValue)
Sets the Maximum Data Value parameter of this tool . |
void |
setMinDataValue(double minDataValue)
Sets the Minimum Data Value parameter of this tool . |
void |
setMinRegionSize(int minRegionSize)
Sets the Minimum Region Size parameter of this tool . |
void |
setRequestSize(int requestSize)
Sets the Request Size parameter of this tool . |
void |
setResetFootprint(String resetFootprint)
Sets the Reset footprints to default parameter of this tool . |
void |
setShrinkDistance(double shrinkDistance)
Sets the Shrink distance parameter of this tool . |
void |
setSkipDerivedImages(String skipDerivedImages)
Sets the Skip overviews parameter of this tool . |
void |
setUpdateBoundary(String updateBoundary)
Sets the Update Boundary 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 |
---|
public BuildFootprints()
Initializes the array of tool parameters with the default values specified when the tool was created.
public BuildFootprints(Object inMosaicDataset)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.
inMosaicDataset
- the mosaic dataset for which the footprints will be calculated.Method Detail |
---|
public Object getInMosaicDataset()
public void setInMosaicDataset(Object inMosaicDataset)
inMosaicDataset
- the mosaic dataset for which the footprints will be calculated.public Object getWhereClause()
public void setWhereClause(Object whereClause)
whereClause
- using SQL you can define a query or use the Query Builder to build a query.public String getResetFootprint()
public void setResetFootprint(String resetFootprint)
resetFootprint
- the footprints will be redefined using the original parameters to generate them when the rasters were added.public double getMinDataValue()
public void setMinDataValue(double minDataValue)
minDataValue
- the lowest pixel value representing valid image data. This value is determined by the bit depth of the raster dataset. for example, with 8-bit data, the values can range from 0 to 255. A value around 0 represents very dark colors, like black border pixels. When you specify 1 then the only value less than 1 is 0, therefore all 0 values will be considered invalid data and will be removed from the perimeter of the footprint. If the imagery is compressed using a lossy compression method, then you should define a value slightly greater than 1 to remove all the black pixels. When dark areas, such as shadows, have been incorrectly removed from the footprint this value should be decreased.public double getMaxDataValue()
public void setMaxDataValue(double maxDataValue)
maxDataValue
- highest value representing valid data. This value is determined by the bit depth of the raster dataset. for example, with 8-bit data, the values can range from 0 to 255. A value around 255 represents very bright colors, such as white clouds and snow. If you specify 245, then all values between 246 and 255 will be removed from the perimeter of the footprint.public int getApproxNumVertices()
public void setApproxNumVertices(int approxNumVertices)
approxNumVertices
- approximate number of vertices with which the new footprint polygon will be created. the greater this value, the more accurate and irregular the polygon and longer the processing time.public double getShrinkDistance()
public void setShrinkDistance(double shrinkDistance)
shrinkDistance
- distance value specified in the units of the mosaic dataset's coordinate system by which the overall polygon will be reduced in size. shrinking of the polygon is used to counteract effects of lossy compression, which causes edges of the image to overlap into NoData areas.public String getMaintainEdges()
public void setMaintainEdges(String maintainEdges)
maintainEdges
- use when using raster datasets that have been tiled and are butt joined (or line up along the seams with little to no overlap).public String getSkipDerivedImages()
public void setSkipDerivedImages(String skipDerivedImages)
skipDerivedImages
- adjust the footprints for derived images, such as service overviews.public String getUpdateBoundary()
public void setUpdateBoundary(String updateBoundary)
updateBoundary
- generates or updates the boundary polygon of a mosaic dataset. By default, the boundary merges all the footprint polygons to create a single boundary representing the extent of the valid pixels.public int getRequestSize()
public void setRequestSize(int requestSize)
requestSize
- the size to which the raster will be resampled when it is examined using this process. The value (such as 2000) defines the dimension of rows and columns. you can increase or decrease this value based on the complexity of your raster data. Greater image resolution provides more detail in the raster dataset and thereby increases the processing time.public int getMinRegionSize()
public void setMinRegionSize(int minRegionSize)
minRegionSize
- determines a filter used to remove holes created in the footprint. this value is specified in pixels, and it is directly related to the Request Size, not to the pixel resolution of the source raster.public Object getOutMosaicDataset()
public String getToolName()
public String getToolboxName()
public String getToolboxAlias()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |