buildPyramids method

Starts building pyramids stored in a pyramid file (.ovr) for the owning raster.

This method starts an operation that builds pyramids in a separate pyramid file (.ovr) for the owning raster and returns a handle to that operation.

Use the returned BuildRasterPyramidsOperation to observe progress, request cancellation, and await the RasterPyramidInfo result. While the operation is running, it is also available from RasterPyramids.activeBuildOperation so other callers can join, observe, or cancel the same operation.

Only one pyramid build request can be in progress for a raster at a time. If another pyramid build request is in progress for the raster, this method throws an ArcGISExceptionType.commonInvalidCall error and no build request is started. Use RasterPyramids.activeBuildOperation to access the operation that is already running.

Errors that occur after the build starts, including the raster not supporting pyramid building, are reported by BuildRasterPyramidsOperation.getResult.

If the raster already has pyramids, this method throws an ArcGISExceptionType.commonInvalidCall error and pyramids are not built. To rebuild pyramids stored in a separate pyramid file (.ovr), call RasterPyramids.deletePyramids before calling this method.

When the build operation completes successfully, RasterPyramids.pyramidInfo is refreshed with information about the pyramid set that was built.

This method is supported only for file-based rasters that support pyramids stored in a separate pyramid file (.ovr). Rasters with existing embedded pyramids are not supported.

For details of the build request, see BuildRasterPyramidsParameters.

Parameters:

• parameters — Options for building pyramids.

Return Value: The operation that builds pyramids for the raster.