com.esri.arcgis.datasourcesraster
Interface ILasToRasterFunctionArguments

All Superinterfaces:

Serializable

All Known Implementing Classes:

LasToRasterFunctionArguments

public interface ILasToRasterFunctionArguments
extends Serializable

Provides access to members that control Las to raster conversion.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

double	getAvgPointSpacing() Average point spacing.
int	getCacheMaxNumSurfaces() Maximum number of different Las surfaces kept in this cache folder.
double	getCacheRasterZTolerance() Z tolerance for Las rasters in the image cache folder, used for compression.
int	getCellAggregationType() Cell aggregation type (how to bin).
double	getCellWidth() Cell width.
ILongArray	getClassTypesSelected() Class types selected, e.g., esriRasterLasClassGround, 217.
int	getDataType() Data type.
IEnvelope	getExtent() Extent specified by the user, or extracted from the LAS files.
String	getLasFile() The input Las file.
String	getLasFileVersion() The input Las file version.
String	getLasFolder() The input Las folder.
double	getMaxHoleWidthFilled() Fill holes up to this width or height by interpolation from hole boundaries.
double	getNumPointsTotal() Total number of points for all Las files, all return types.
ILongArray	getReturnTypesSelected() Return types selected, e.g., esriRasterLasReturnFirst, 13.
ISpatialReference	getSpatialReference() The spatial reference to be used, if NOT set in the Las file(s).
int	getTinToRasterInterpolationType() Tin to raster interpolation type (how to rasterize the tin: Linear or NN).
int	getVoidFillMethod() Void fill method.
double	getZMax() Z Max.
double	getZMin() Z Min.
boolean	isIgnoreSpatialReferenceInLasFiles() Ignore spatial reference in Las files.
boolean	isUseTinning() Use tinning.
void	setAvgPointSpacing(double pAvgPointSpacing) Average point spacing.
void	setCacheMaxNumSurfaces(int pMaxNumSurfaces) Maximum number of different Las surfaces kept in this cache folder.
void	setCacheRasterZTolerance(double pZTolerance) Z tolerance for Las rasters in the image cache folder, used for compression.
void	setCellAggregationType(int pCellAggType) Cell aggregation type (how to bin).
void	setCellWidth(double pCellWidth) Cell width.
void	setClassTypesSelectedByRef(ILongArray ppClassTypesSelected) Class types selected, e.g., esriRasterLasClassGround, 217.
void	setDataType(int pDataType) Data type.
void	setExtentByRef(IEnvelope ppExtent) Extent specified by the user, or extracted from the LAS files.
void	setIgnoreSpatialReferenceInLasFiles(boolean pIgnoreLasSR) Ignore spatial reference in Las files.
void	setLasFile(String filename) The input Las file.
void	setLasFileVersion(String lasFileVersion) The input Las file version.
void	setLasFolder(String foldername) The input Las folder.
void	setMaxHoleWidthFilled(double pMaxHoleWidth) Fill holes up to this width or height by interpolation from hole boundaries.
void	setNumPointsTotal(double pNumPointsTotal) Total number of points for all Las files, all return types.
void	setReturnTypesSelectedByRef(ILongArray ppReturnTypesSelected) Return types selected, e.g., esriRasterLasReturnFirst, 13.
void	setSpatialReferenceByRef(ISpatialReference ppSpatialReference) The spatial reference to be used, if NOT set in the Las file(s).
void	setTinToRasterInterpolationType(int pType) Tin to raster interpolation type (how to rasterize the tin: Linear or NN).
void	setUseTinning(boolean pUseTinning) Use tinning.
void	setVoidFillMethod(int pVoidFillMethod) Void fill method.
void	setZMax(double pZMax) Z Max.
void	setZMin(double pZMin) Z Min.

Method Detail

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException

Extent specified by the user, or extracted from the LAS files.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtentByRef

void setExtentByRef(IEnvelope ppExtent)
                    throws IOException,
                           AutomationException

Extent specified by the user, or extracted from the LAS files.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

ppExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReturnTypesSelected

ILongArray getReturnTypesSelected()
                                  throws IOException,
                                         AutomationException

Return types selected, e.g., esriRasterLasReturnFirst, 13.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnTypesSelectedByRef

void setReturnTypesSelectedByRef(ILongArray ppReturnTypesSelected)
                                 throws IOException,
                                        AutomationException

Return types selected, e.g., esriRasterLasReturnFirst, 13.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

ppReturnTypesSelected - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassTypesSelected

ILongArray getClassTypesSelected()
                                 throws IOException,
                                        AutomationException

Class types selected, e.g., esriRasterLasClassGround, 217.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassTypesSelectedByRef

void setClassTypesSelectedByRef(ILongArray ppClassTypesSelected)
                                throws IOException,
                                       AutomationException

Class types selected, e.g., esriRasterLasClassGround, 217.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

ppClassTypesSelected - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellWidth

double getCellWidth()
                    throws IOException,
                           AutomationException

Cell width.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pCellWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCellWidth

void setCellWidth(double pCellWidth)
                  throws IOException,
                         AutomationException

Cell width.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pCellWidth - The pCellWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseTinning

boolean isUseTinning()
                     throws IOException,
                            AutomationException

Use tinning.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pUseTinning

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseTinning

void setUseTinning(boolean pUseTinning)
                   throws IOException,
                          AutomationException

Use tinning.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pUseTinning - The pUseTinning (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTinToRasterInterpolationType

int getTinToRasterInterpolationType()
                                    throws IOException,
                                           AutomationException

Tin to raster interpolation type (how to rasterize the tin: Linear or NN).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A com.esri.arcgis.geodatabase.esriSurfaceInterpolationType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTinToRasterInterpolationType

void setTinToRasterInterpolationType(int pType)
                                     throws IOException,
                                            AutomationException

Tin to raster interpolation type (how to rasterize the tin: Linear or NN).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pType - A com.esri.arcgis.geodatabase.esriSurfaceInterpolationType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellAggregationType

int getCellAggregationType()
                           throws IOException,
                                  AutomationException

Cell aggregation type (how to bin).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterLasCellAggregationType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCellAggregationType

void setCellAggregationType(int pCellAggType)
                            throws IOException,
                                   AutomationException

Cell aggregation type (how to bin).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pCellAggType - A com.esri.arcgis.datasourcesraster.esriRasterLasCellAggregationType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataType

int getDataType()
                throws IOException,
                       AutomationException

Data type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterLasDataType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataType

void setDataType(int pDataType)
                 throws IOException,
                        AutomationException

Data type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pDataType - A com.esri.arcgis.datasourcesraster.esriRasterLasDataType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVoidFillMethod

int getVoidFillMethod()
                      throws IOException,
                             AutomationException

Void fill method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterLasVoidFillMethod constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVoidFillMethod

void setVoidFillMethod(int pVoidFillMethod)
                       throws IOException,
                              AutomationException

Void fill method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pVoidFillMethod - A com.esri.arcgis.datasourcesraster.esriRasterLasVoidFillMethod constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxHoleWidthFilled

double getMaxHoleWidthFilled()
                             throws IOException,
                                    AutomationException

Fill holes up to this width or height by interpolation from hole boundaries.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pMaxHoleWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxHoleWidthFilled

void setMaxHoleWidthFilled(double pMaxHoleWidth)
                           throws IOException,
                                  AutomationException

Fill holes up to this width or height by interpolation from hole boundaries.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pMaxHoleWidth - The pMaxHoleWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference to be used, if NOT set in the Las file(s).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

void setSpatialReferenceByRef(ISpatialReference ppSpatialReference)
                              throws IOException,
                                     AutomationException

The spatial reference to be used, if NOT set in the Las file(s).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

ppSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIgnoreSpatialReferenceInLasFiles

boolean isIgnoreSpatialReferenceInLasFiles()
                                           throws IOException,
                                                  AutomationException

Ignore spatial reference in Las files.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pIgnoreLasSR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIgnoreSpatialReferenceInLasFiles

void setIgnoreSpatialReferenceInLasFiles(boolean pIgnoreLasSR)
                                         throws IOException,
                                                AutomationException

Ignore spatial reference in Las files.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pIgnoreLasSR - The pIgnoreLasSR (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheMaxNumSurfaces

int getCacheMaxNumSurfaces()
                           throws IOException,
                                  AutomationException

Maximum number of different Las surfaces kept in this cache folder.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pMaxNumSurfaces

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheMaxNumSurfaces

void setCacheMaxNumSurfaces(int pMaxNumSurfaces)
                            throws IOException,
                                   AutomationException

Maximum number of different Las surfaces kept in this cache folder.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pMaxNumSurfaces - The pMaxNumSurfaces (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheRasterZTolerance

double getCacheRasterZTolerance()
                                throws IOException,
                                       AutomationException

Z tolerance for Las rasters in the image cache folder, used for compression.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pZTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheRasterZTolerance

void setCacheRasterZTolerance(double pZTolerance)
                              throws IOException,
                                     AutomationException

Z tolerance for Las rasters in the image cache folder, used for compression.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pZTolerance - The pZTolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLasFile

String getLasFile()
                  throws IOException,
                         AutomationException

The input Las file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The filename

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLasFile

void setLasFile(String filename)
                throws IOException,
                       AutomationException

The input Las file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

filename - The filename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLasFolder

String getLasFolder()
                    throws IOException,
                           AutomationException

The input Las folder.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The foldername

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLasFolder

void setLasFolder(String foldername)
                  throws IOException,
                         AutomationException

The input Las folder.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

foldername - The foldername (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLasFileVersion

String getLasFileVersion()
                         throws IOException,
                                AutomationException

The input Las file version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The lasFileVersion

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLasFileVersion

void setLasFileVersion(String lasFileVersion)
                       throws IOException,
                              AutomationException

The input Las file version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

lasFileVersion - The lasFileVersion (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumPointsTotal

double getNumPointsTotal()
                         throws IOException,
                                AutomationException

Total number of points for all Las files, all return types.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pNumPointsTotal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumPointsTotal

void setNumPointsTotal(double pNumPointsTotal)
                       throws IOException,
                              AutomationException

Total number of points for all Las files, all return types.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pNumPointsTotal - The pNumPointsTotal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAvgPointSpacing

double getAvgPointSpacing()
                          throws IOException,
                                 AutomationException

Average point spacing.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pAvgPointSpacing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAvgPointSpacing

void setAvgPointSpacing(double pAvgPointSpacing)
                        throws IOException,
                               AutomationException

Average point spacing.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pAvgPointSpacing - The pAvgPointSpacing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZMin

double getZMin()
               throws IOException,
                      AutomationException

Z Min.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pZMin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZMin

void setZMin(double pZMin)
             throws IOException,
                    AutomationException

Z Min.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pZMin - The pZMin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZMax

double getZMax()
               throws IOException,
                      AutomationException

Z Max.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pZMax

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZMax

void setZMax(double pZMax)
             throws IOException,
                    AutomationException

Z Max.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pZMax - The pZMax (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.