Package com.esri.arcgisruntime.raster

Class AddRastersParameters

java.lang.Object

com.esri.arcgisruntime.raster.AddRastersParameters

Direct Known Subclasses:

FrameCameraAddRastersParameters

public class AddRastersParameters
extends Object

Adds raster datasets to a MosaicDatasetRaster by setting various parameters. Mosaic datasets (via the MosaicDatasetRaster class) are used to manage, display, serve, and share raster data. When you create a new mosaic dataset, it is created as an empty container in a geodatabase to which you can add raster data. The AddRastersParameters object provides the mechanism to set various properties, so that a raster can be added to a mosaic dataset via the MosaicDatasetRaster.addRastersAsync(AddRastersParameters) method.

Some of the parameters (aka. properties) on AddRastersParameters class that enable adding a raster into a mosaic dataset include specifying the file filter type (like .tif or .jpg) of the rasters that are to be included (setFilter(String)), the directory location (setInputDirectory(String)) of the raster files, the minimum pixel cell size of the raster to be included (setMinPixelSizeFactor(double)) and more.

Since:

100.2.0

See Also:

MosaicDatasetRaster.addRastersAsync(AddRastersParameters)

Constructor Summary

Constructors

Constructor	Description
AddRastersParameters()	Creates an AddRastersParameters instance.

Method Summary

Modifier and Type	Method	Description
String	getFilter()	Gets the raster filename filter.
String	getInputDirectory()	Gets the input directory that contains the raster files.
String	getInputFile()	Gets the raster input file.
double	getMaxPixelSizeFactor()	Gets the maximum pixel size factor.
double	getMinPixelSizeFactor()	Gets the minimum pixel size factor.
String	getRasterFunctionTemplateFile()	Gets the raster function template file.
void	setFilter(String filter)	Sets the raster filename filter.
void	setInputDirectory(String inputDirectory)	Sets the input directory that contains the raster files.
void	setInputFile(String inputFile)	Sets the raster input file.
void	setMaxPixelSizeFactor(double maxPixelSizeFactor)	Sets the maximum pixel size factor.
void	setMinPixelSizeFactor(double minPixelSizeFactor)	Sets the minimum pixel size factor.
void	setRasterFunctionTemplateFile(String rasterFunctionTemplateFile)	Sets the raster function template file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddRastersParameters

public AddRastersParameters()

Creates an AddRastersParameters instance.

Since:

100.2.0

Method Detail

getFilter

public String getFilter()

Gets the raster filename filter. The file name filter is a regular expression with ECMA-262 grammar (https://262.ecma-international.org/5.1/#sec-15.10)..

Returns:

the raster filename filter string

Since:

100.2.0

setFilter

public void setFilter(String filter)

Sets the raster filename filter. The file name filter is a regular expression with ECMA-262 grammar (https://262.ecma-international.org/5.1/#sec-15.10).

Parameters:

filter - a raster filename filter string

Since:

100.2.0

getInputDirectory

public String getInputDirectory()

Gets the input directory that contains the raster files.

Returns:

the absolute path to the directory that contains the raster files

Since:

100.2.0

setInputDirectory

public void setInputDirectory(String inputDirectory)

Sets the input directory that contains the raster files.

Parameters:

inputDirectory - the absolute path to the directory that contains the raster files

Since:

100.2.0

getInputFile

public String getInputFile()

Gets the raster input file.

Returns:

the raster input file name

Since:

100.2.0

setInputFile

public void setInputFile(String inputFile)

Sets the raster input file.

Parameters:

inputFile - the raster input file name

Since:

100.2.0

getMinPixelSizeFactor

public double getMinPixelSizeFactor()

Gets the minimum pixel size factor.

Returns:

the minimum pixel size factor

Since:

100.2.0

setMinPixelSizeFactor

public void setMinPixelSizeFactor(double minPixelSizeFactor)

Sets the minimum pixel size factor.

Parameters:

minPixelSizeFactor - the minimum pixel size factor

Since:

100.2.0

getMaxPixelSizeFactor

public double getMaxPixelSizeFactor()

Gets the maximum pixel size factor.

Returns:

the maximum pixel size factor

Since:

100.2.0

setMaxPixelSizeFactor

public void setMaxPixelSizeFactor(double maxPixelSizeFactor)

Sets the maximum pixel size factor.

Parameters:

maxPixelSizeFactor - the maximum pixel size factor

Since:

100.2.0

getRasterFunctionTemplateFile

public String getRasterFunctionTemplateFile()

Gets the raster function template file.

Returns:

the raster function template file

Since:

100.2.0

setRasterFunctionTemplateFile

public void setRasterFunctionTemplateFile(String rasterFunctionTemplateFile)

Sets the raster function template file.

Parameters:

rasterFunctionTemplateFile - the raster function template file

Since:

100.2.0