public class CutFillPostParameter
extends java.lang.Object
implements java.io.Serializable
The parameter class submitted by Post operation of the cut and fill analysis. Three methods are provided currently: Doing cut and fill analysis based on result raster data (Cut and Fill of Raster data); Doing cut and fill analysis according to the specified region and evaluation of the result data (Cut and Fill with region); Doing cut and fill analysis according to the specified 3D line and buffer radius (Cut and Fill with slope).
1. Cut and Fill of Raster data CutFillType.GRID
Surface materials on the Earth surface usually move as they are eroded and deposited, which result in accumulation of surface materials in some area and loss in some other. In an engineering project, the loss of surface materials is called "Cut", and the increase of surface materials is called "Fill". A grid cut and fill calculation requires two input grid datasets: the dataset before a cutting and filling operation and the one after. The value of each cell in the result dataset is the difference between the values of the corresponding cell in the two input datasets. A positive cell value indicates that the surface material at that cell has reduced; a negative cell value indicates the surface material there has increased. The two input grid datasets must have the same coordinate system and projection, so that a point on the Earth would have the same coordinates in the two datasets. If the coordinate systems of the two grid datasets are not the same, an erroneous result may be produced. Theoretically, the spatial extents of the two input grid datasets should be the same. If not, only the overlapped part will participate in the cut and fill calculation. If a cell in a grid dataset has a null value, the corresponding cell in the result dataset will have a null value too.2. Cut and Fill of Raster data CutFillType.REGIONANDALTITUDE
It can be applied when a region with ridges and valleys is to be flattened. The user can specify the region to be flattened and the target elevation. This method can be used to calculate the filled area, the cut area, the fill volume, and the cut volume.
3. Cut and Fill with slope CutFillType.LINE3DANDBUFFERRADIUS
The incline cut and fill. This function calculates the volume needed to be cut and filled to create a slope on the terrain surface. The principle is similar to cutting and filling for a selected region. It makes use of specifying cut and fill route, buffer radius to construct the required filled area, cut area, fill volume, and cut volume.
Modifier and Type | Field and Description |
---|---|
java.lang.String |
afterCutFillDataset
The result dataset after doing cut and fill analysis is valid if the type is GRID.
|
double |
baseAltitude
The specified result eveluation of cut and fill analysis is valid if the type is REGIONANDALTITUDE.
|
double |
bufferRadius
The buffer radius of cut and fill analysis is valid if the type is LINE3DANDBUFFERRADIUS.
|
boolean |
buildPyramid
Whether creating image pyramid or not for the result raster dataset.
|
CutFillType |
cutFillType
The types of cut and fill analysis.
|
boolean |
deleteExistResultDataset
Whether to delete the existing dataset if the name of the result dataset named by users is the same as that of an existing dataset.
|
boolean |
isRoundHead
Whether use a round buffer of the cut and fill route or not.
|
Geometry3D |
line3D
The route of cut and fill analysis is valid if the type is LINE3DANDBUFFERRADIUS.
|
Geometry |
region
The region of cut and fill analysis is valid if the type is REGIONANDALTITUDE.
|
Geometry3D |
region3D
3D region, valid when cutFillTyoe is REGION3D.
|
java.lang.String |
resultDataset
The result dataset of a cut and fill analysis.
|
Constructor and Description |
---|
CutFillPostParameter()
The constructor.
|
CutFillPostParameter(CutFillPostParameter cutFillParameter)
The constructor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Determines whether the specific objects equals the current
CutFillPostParameter object. |
int |
hashCode()
Gets the hash value of the current object.
|
public CutFillType cutFillType
The types of cut and fill analysis. The default one is doing cut and fill analysis based on result raster data.
public java.lang.String afterCutFillDataset
The result dataset after doing cut and fill analysis is valid if the type is GRID.
public Geometry3D line3D
The route of cut and fill analysis is valid if the type is LINE3DANDBUFFERRADIUS.
public double bufferRadius
The buffer radius of cut and fill analysis is valid if the type is LINE3DANDBUFFERRADIUS.
public boolean isRoundHead
Whether use a round buffer of the cut and fill route or not. The default value is false. It is valid if the type is LINE3DANDBUFFERRADIUS.
public Geometry region
The region of cut and fill analysis is valid if the type is REGIONANDALTITUDE.
public double baseAltitude
The specified result eveluation of cut and fill analysis is valid if the type is REGIONANDALTITUDE.
public java.lang.String resultDataset
The result dataset of a cut and fill analysis.
public boolean deleteExistResultDataset
Whether to delete the existing dataset if the name of the result dataset named by users is the same as that of an existing dataset.
public boolean buildPyramid
Whether creating image pyramid or not for the result raster dataset.
public Geometry3D region3D
3D region, valid when cutFillTyoe is REGION3D.
public CutFillPostParameter()
The constructor.
public CutFillPostParameter(CutFillPostParameter cutFillParameter)
The constructor.
cutFillParameter
- The parameter object of cut and fill analysis.public int hashCode()
Gets the hash value of the current object.
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
Determines whether the specific objects equals the current CutFillPostParameter
object.
equals
in class java.lang.Object
obj
- The object that compares with the current CutFillPostParameter
object.