com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class ParticleTrack

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialanalysttools.ParticleTrack

All Implemented Interfaces:

GPTool

public class ParticleTrack
extends AbstractGPTool

Calculates the path of a particle through a velocity field, returning an ASCII file of particle tracking data and, optionally, a coverage of track information. The Particle Track tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The input direction and magnitude rasters should be from the same run of the Darcy Flow tool.
• The path file generated by this tool is an ASCII text file containing information about position, local velocity direction and magnitude, and cumulative length and time of travel along the path. This file is used for input by Porous Puff. The format of this file is as follows:
• No particular system of units is specified by Particle Track. It is important that all data be in a consistent set of units, using the same unit for time (seconds, days, years) and length (feet, meters).
• The source location must be within the boundary of the input rasters and cannot be in an area of NoData.
• The track file will end if the track reaches outside the study area and has not met the specified maximum tracking time.
• If the particle being tracked has reached the edge of the study area at the indicated time and the predictor point is outside the study area, the track file will end.
• If the particle being tracked migrates into a depression at the indicated time, the track file will end. A depression can be created by a discharge well or other sink.
• The two outputs from this tool are:

Field Summary

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

vals

Constructor Summary

ParticleTrack()
Creates the Particle Track tool with defaults.

ParticleTrack(Object inDirectionRaster, Object inMagnitudeRaster, Object sourcePoint, Object outTrackFile)
Creates the Particle Track tool with the required parameters.

Method Summary

Object	getInDirectionRaster() Returns the Input direction raster parameter of this tool .
Object	getInMagnitudeRaster() Returns the Input magnitude raster parameter of this tool .
Object	getOutTrackFile() Returns the Output particle track file parameter of this tool .
Object	getOutTrackPolylineFeatures() Returns the Output track polyline features parameter of this tool .
Object	getSourcePoint() Returns the Source point parameter of this tool .
double	getStepLength() Returns the Step length 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.
double	getTrackingTime() Returns the Tracking time parameter of this tool .
void	setInDirectionRaster(Object inDirectionRaster) Sets the Input direction raster parameter of this tool .
void	setInMagnitudeRaster(Object inMagnitudeRaster) Sets the Input magnitude raster parameter of this tool .
void	setOutTrackFile(Object outTrackFile) Sets the Output particle track file parameter of this tool .
void	setOutTrackPolylineFeatures(Object outTrackPolylineFeatures) Sets the Output track polyline features parameter of this tool .
void	setSourcePoint(Object sourcePoint) Sets the Source point parameter of this tool .
void	setStepLength(double stepLength) Sets the Step length parameter of this tool .
void	setTrackingTime(double trackingTime) Sets the Tracking time 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

ParticleTrack

public ParticleTrack()

Creates the Particle Track tool with defaults.

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

ParticleTrack

public ParticleTrack(Object inDirectionRaster,
                     Object inMagnitudeRaster,
                     Object sourcePoint,
                     Object outTrackFile)

Creates the Particle Track 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:

inDirectionRaster - an input raster where each cell value represents the direction of the seepage velocity vector (average linear velocity) at the center of the cell. directions are expressed in compass coordinates, in degrees clockwise from north. This can be created by the Darcy Flow tool. direction values must be floating point.

inMagnitudeRaster - an input raster where each cell value represents the magnitude of the seepage velocity vector (average linear velocity) at the center of the cell. units are length/time. This can be created by the Darcy Flow tool.

sourcePoint - the location of the source point from which to begin the particle tracking. this is entered as numbers identifying the x,y coordinates of the position in map units.

outTrackFile - the output ASCII text file that contains the particle tracking data.

Method Detail

getInDirectionRaster

public Object getInDirectionRaster()

Returns the Input direction raster parameter of this tool . This parameter is an input raster where each cell value represents the direction of the seepage velocity vector (average linear velocity) at the center of the cell. directions are expressed in compass coordinates, in degrees clockwise from north. This can be created by the Darcy Flow tool. direction values must be floating point. This is a required parameter.

Returns:

the Input direction raster

setInDirectionRaster

public void setInDirectionRaster(Object inDirectionRaster)

Sets the Input direction raster parameter of this tool . This parameter is an input raster where each cell value represents the direction of the seepage velocity vector (average linear velocity) at the center of the cell. directions are expressed in compass coordinates, in degrees clockwise from north. This can be created by the Darcy Flow tool. direction values must be floating point. This is a required parameter.

Parameters:

inDirectionRaster - an input raster where each cell value represents the direction of the seepage velocity vector (average linear velocity) at the center of the cell. directions are expressed in compass coordinates, in degrees clockwise from north. This can be created by the Darcy Flow tool. direction values must be floating point.

getInMagnitudeRaster

public Object getInMagnitudeRaster()

Returns the Input magnitude raster parameter of this tool . This parameter is an input raster where each cell value represents the magnitude of the seepage velocity vector (average linear velocity) at the center of the cell. units are length/time. This can be created by the Darcy Flow tool. This is a required parameter.

Returns:

the Input magnitude raster

setInMagnitudeRaster

public void setInMagnitudeRaster(Object inMagnitudeRaster)

Sets the Input magnitude raster parameter of this tool . This parameter is an input raster where each cell value represents the magnitude of the seepage velocity vector (average linear velocity) at the center of the cell. units are length/time. This can be created by the Darcy Flow tool. This is a required parameter.

Parameters:

inMagnitudeRaster - an input raster where each cell value represents the magnitude of the seepage velocity vector (average linear velocity) at the center of the cell. units are length/time. This can be created by the Darcy Flow tool.

getSourcePoint

public Object getSourcePoint()

Returns the Source point parameter of this tool . This parameter is the location of the source point from which to begin the particle tracking. this is entered as numbers identifying the x,y coordinates of the position in map units. This is a required parameter.

Returns:

the Source point

setSourcePoint

public void setSourcePoint(Object sourcePoint)

Sets the Source point parameter of this tool . This parameter is the location of the source point from which to begin the particle tracking. this is entered as numbers identifying the x,y coordinates of the position in map units. This is a required parameter.

Parameters:

sourcePoint - the location of the source point from which to begin the particle tracking. this is entered as numbers identifying the x,y coordinates of the position in map units.

getOutTrackFile

public Object getOutTrackFile()

Returns the Output particle track file parameter of this tool . This parameter is the output ASCII text file that contains the particle tracking data. This is a required parameter.

Returns:

the Output particle track file

setOutTrackFile

public void setOutTrackFile(Object outTrackFile)

Sets the Output particle track file parameter of this tool . This parameter is the output ASCII text file that contains the particle tracking data. This is a required parameter.

Parameters:

outTrackFile - the output ASCII text file that contains the particle tracking data.

getStepLength

public double getStepLength()

Returns the Step length parameter of this tool . This parameter is the step length to be used for calculating the particle track. the default is one-half the cell size. Units are length. This is an optional parameter.

Returns:

the Step length

setStepLength

public void setStepLength(double stepLength)

Sets the Step length parameter of this tool . This parameter is the step length to be used for calculating the particle track. the default is one-half the cell size. Units are length. This is an optional parameter.

Parameters:

stepLength - the step length to be used for calculating the particle track. the default is one-half the cell size. Units are length.

getTrackingTime

public double getTrackingTime()

Returns the Tracking time parameter of this tool . This parameter is maximum elapsed time for particle tracking. the algorithm will follow the track until either this time is met or the particle migrates off the raster or into a depression. the default value is infinity. Units are time. This is an optional parameter.

Returns:

the Tracking time

setTrackingTime

public void setTrackingTime(double trackingTime)

Sets the Tracking time parameter of this tool . This parameter is maximum elapsed time for particle tracking. the algorithm will follow the track until either this time is met or the particle migrates off the raster or into a depression. the default value is infinity. Units are time. This is an optional parameter.

Parameters:

trackingTime - maximum elapsed time for particle tracking. the algorithm will follow the track until either this time is met or the particle migrates off the raster or into a depression. the default value is infinity. Units are time.

getOutTrackPolylineFeatures

public Object getOutTrackPolylineFeatures()

Returns the Output track polyline features parameter of this tool . This parameter is the optional output line feature class containing the particle track. this feature class contains a series of arcs with attributes for position, local velocity direction and magnitude, and cumulative length and time of travel along the path. This is an optional parameter.

Returns:

the Output track polyline features

setOutTrackPolylineFeatures

public void setOutTrackPolylineFeatures(Object outTrackPolylineFeatures)

Sets the Output track polyline features parameter of this tool . This parameter is the optional output line feature class containing the particle track. this feature class contains a series of arcs with attributes for position, local velocity direction and magnitude, and cumulative length and time of travel along the path. This is an optional parameter.

Parameters:

outTrackPolylineFeatures - the optional output line feature class containing the particle track. this feature class contains a series of arcs with attributes for position, local velocity direction and magnitude, and cumulative length and time of travel along the path.

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