ExportRaster

java.lang.Object
- com.agisoft.metashape.Task
- - com.agisoft.metashape.tasks.ExportRaster

All Implemented Interfaces:

java.lang.AutoCloseable
```
public class ExportRaster
extends Task
```
Task class containing processing parameters.

Nested Class Summary
- Nested classes/interfaces inherited from class com.agisoft.metashape.Task
  Task.TaskTarget

Field Summary
- Fields inherited from class com.agisoft.metashape.Task
  swigCMemOwn

Constructor Summary

Constructors
Constructor and Description

ExportRaster()

Constructors
Constructor and Description
`ExportRaster()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAsset()` Asset key to export.
`int`	`getBlockHeight()` Raster block height in pixels.
`int`	`getBlockWidth()` Raster block width in pixels.
`boolean`	`getClipToBoundary()` Clip raster to boundary shapes.
`java.lang.String`	`getDescription()` Export description.
`RasterFormat`	`getFormat()` Export format.
`boolean`	`getGlobalProfile()` Use global profile (GeoPackage and TMS formats only).
`int`	`getHeight()` Raster height.
`ImageCompression`	`getImageCompression()` Image compression parameters.
`java.lang.String`	`getImageDescription()` Optional description to be added to image files.
`ImageFormat`	`getImageFormat()` Tile format.
`int`	`getMaxZoomLevel()` Maximum zoom level (GeoPackage, Google Map Tiles, MBTiles and World Wind Tiles formats only).
`int`	`getMinZoomLevel()` Minimum zoom level (GeoPackage, Google Map Tiles, MBTiles and World Wind Tiles formats only).
`boolean`	`getNetworkLinks()` Enable network links generation for KMZ format.
`double`	`getNodataValue()` No-data value (DEM export only).
`boolean`	`getNorthUp()` Use north-up orientation for export.
`java.lang.String`	`getPath()` Path to output orthomosaic.
`OrthoProjection`	`getProjection()` Output projection.
`RasterTransformType`	`getRasterTransform()` Raster band transformation.
`BBox`	`getRegion()` Region to be exported.
`double`	`getResolution()` Output resolution in meters.
`double`	`getResolutionX()` Pixel size in the X dimension in projected units.
`double`	`getResolutionY()` Pixel size in the Y dimension in projected units.
`boolean`	`getSaveAlpha()` Enable alpha channel generation.
`boolean`	`getSaveKml()` Enable kml file generation.
`boolean`	`getSaveScheme()` Enable tile scheme files generation.
`boolean`	`getSaveWorld()` Enable world file generation.
`DataSource`	`getSourceData()` Selects between DEM and orthomosaic.
`boolean`	`getSplitInBlocks()` Split raster in blocks.
`int`	`getTileHeight()` Tile height in pixels.
`int`	`getTileWidth()` Tile width in pixels.
`java.lang.String`	`getTitle()` Export title.
`boolean`	`getWhiteBackground()` Enable white background.
`int`	`getWidth()` Raster width.
`Matrix`	`getWorldTransform()` 2x3 raster-to-world transformation matrix.
`void`	`setAsset(int value)` Asset key to export.
`void`	`setBlockHeight(int value)` Raster block height in pixels.
`void`	`setBlockWidth(int value)` Raster block width in pixels.
`void`	`setClipToBoundary(boolean value)` Clip raster to boundary shapes.
`void`	`setDescription(java.lang.String value)` Export description.
`void`	`setFormat(RasterFormat value)` Export format.
`void`	`setGlobalProfile(boolean value)` Use global profile (GeoPackage and TMS formats only).
`void`	`setHeight(int value)` Raster height.
`void`	`setImageCompression(ImageCompression value)` Image compression parameters.
`void`	`setImageDescription(java.lang.String value)` Optional description to be added to image files.
`void`	`setImageFormat(ImageFormat value)` Tile format.
`void`	`setMaxZoomLevel(int value)` Maximum zoom level (GeoPackage, Google Map Tiles, MBTiles and World Wind Tiles formats only).
`void`	`setMinZoomLevel(int value)` Minimum zoom level (GeoPackage, Google Map Tiles, MBTiles and World Wind Tiles formats only).
`void`	`setNetworkLinks(boolean value)` Enable network links generation for KMZ format.
`void`	`setNodataValue(double value)` No-data value (DEM export only).
`void`	`setNorthUp(boolean value)` Use north-up orientation for export.
`void`	`setPath(java.lang.String value)` Path to output orthomosaic.
`void`	`setProjection(OrthoProjection value)` Output projection.
`void`	`setRasterTransform(RasterTransformType value)` Raster band transformation.
`void`	`setRegion(BBox value)` Region to be exported.
`void`	`setResolution(double value)` Output resolution in meters.
`void`	`setResolutionX(double value)` Pixel size in the X dimension in projected units.
`void`	`setResolutionY(double value)` Pixel size in the Y dimension in projected units.
`void`	`setSaveAlpha(boolean value)` Enable alpha channel generation.
`void`	`setSaveKml(boolean value)` Enable kml file generation.
`void`	`setSaveScheme(boolean value)` Enable tile scheme files generation.
`void`	`setSaveWorld(boolean value)` Enable world file generation.
`void`	`setSourceData(DataSource value)` Selects between DEM and orthomosaic.
`void`	`setSplitInBlocks(boolean value)` Split raster in blocks.
`void`	`setTileHeight(int value)` Tile height in pixels.
`void`	`setTileWidth(int value)` Tile width in pixels.
`void`	`setTitle(java.lang.String value)` Export title.
`void`	`setWhiteBackground(boolean value)` Enable white background.
`void`	`setWidth(int value)` Raster width.
`void`	`setWorldTransform(Matrix value)` 2x3 raster-to-world transformation matrix.

Methods inherited from class com.agisoft.metashape.Task
apply, apply, close, delete, finalize, getCPtr, getGpuSupport, getName, getParameter, getParameterNames, getTarget, getWorkitemCount, setParameter, setWorkitemCount, toNetworkTask, toNetworkTask, toNetworkTask, toNetworkTask

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ExportRaster
```
public ExportRaster()
```
- Method Detail
  - setAsset
```
public void setAsset(int value)
```
    Asset key to export.
  - getAsset
```
public int getAsset()
```
    Asset key to export.
  - setBlockHeight
```
public void setBlockHeight(int value)
```
    Raster block height in pixels. Default: 10000
  - getBlockHeight
```
public int getBlockHeight()
```
    Raster block height in pixels. Default: 10000
  - setBlockWidth
```
public void setBlockWidth(int value)
```
    Raster block width in pixels. Default: 10000
  - getBlockWidth
```
public int getBlockWidth()
```
    Raster block width in pixels. Default: 10000
  - setClipToBoundary
```
public void setClipToBoundary(boolean value)
```
    Clip raster to boundary shapes.
  - getClipToBoundary
```
public boolean getClipToBoundary()
```
    Clip raster to boundary shapes.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    Export description.
  - getDescription
```
public java.lang.String getDescription()
```
    Export description.
  - setFormat
```
public void setFormat(RasterFormat value)
```
    Export format. Default: RasterFormat.RasterFormatTiles
  - getFormat
```
public RasterFormat getFormat()
```
    Export format. Default: RasterFormat.RasterFormatTiles
  - setGlobalProfile
```
public void setGlobalProfile(boolean value)
```
    Use global profile (GeoPackage and TMS formats only).
  - getGlobalProfile
```
public boolean getGlobalProfile()
```
    Use global profile (GeoPackage and TMS formats only).
  - setHeight
```
public void setHeight(int value)
```
    Raster height. Default: 0
  - getHeight
```
public int getHeight()
```
    Raster height. Default: 0
  - setImageCompression
```
public void setImageCompression(ImageCompression value)
```
    Image compression parameters.
  - getImageCompression
```
public ImageCompression getImageCompression()
```
    Image compression parameters.
  - setImageDescription
```
public void setImageDescription(java.lang.String value)
```
    Optional description to be added to image files.
  - getImageDescription
```
public java.lang.String getImageDescription()
```
    Optional description to be added to image files.
  - setImageFormat
```
public void setImageFormat(ImageFormat value)
```
    Tile format. Default: ImageFormat.ImageFormatNone
  - getImageFormat
```
public ImageFormat getImageFormat()
```
    Tile format. Default: ImageFormat.ImageFormatNone
  - setMaxZoomLevel
```
public void setMaxZoomLevel(int value)
```
    Maximum zoom level (GeoPackage, Google Map Tiles, MBTiles and World Wind Tiles formats only). Default: -1
  - getMaxZoomLevel
```
public int getMaxZoomLevel()
```
    Maximum zoom level (GeoPackage, Google Map Tiles, MBTiles and World Wind Tiles formats only). Default: -1
  - setMinZoomLevel
```
public void setMinZoomLevel(int value)
```
    Minimum zoom level (GeoPackage, Google Map Tiles, MBTiles and World Wind Tiles formats only). Default: -1
  - getMinZoomLevel
```
public int getMinZoomLevel()
```
    Minimum zoom level (GeoPackage, Google Map Tiles, MBTiles and World Wind Tiles formats only). Default: -1
  - setNetworkLinks
```
public void setNetworkLinks(boolean value)
```
    Enable network links generation for KMZ format.
  - getNetworkLinks
```
public boolean getNetworkLinks()
```
    Enable network links generation for KMZ format.
  - setNodataValue
```
public void setNodataValue(double value)
```
    No-data value (DEM export only). Default: -32767.0
  - getNodataValue
```
public double getNodataValue()
```
    No-data value (DEM export only). Default: -32767.0
  - setNorthUp
```
public void setNorthUp(boolean value)
```
    Use north-up orientation for export.
  - getNorthUp
```
public boolean getNorthUp()
```
    Use north-up orientation for export.
  - setPath
```
public void setPath(java.lang.String value)
```
    Path to output orthomosaic.
  - getPath
```
public java.lang.String getPath()
```
    Path to output orthomosaic.
  - setProjection
```
public void setProjection(OrthoProjection value)
```
    Output projection.
  - getProjection
```
public OrthoProjection getProjection()
```
    Output projection.
  - setRasterTransform
```
public void setRasterTransform(RasterTransformType value)
```
    Raster band transformation. Default: RasterTransformType.RasterTransformNone
  - getRasterTransform
```
public RasterTransformType getRasterTransform()
```
    Raster band transformation. Default: RasterTransformType.RasterTransformNone
  - setRegion
```
public void setRegion(BBox value)
```
    Region to be exported.
  - getRegion
```
public BBox getRegion()
```
    Region to be exported.
  - setResolution
```
public void setResolution(double value)
```
    Output resolution in meters. Default: 0.0
  - getResolution
```
public double getResolution()
```
    Output resolution in meters. Default: 0.0
  - setResolutionX
```
public void setResolutionX(double value)
```
    Pixel size in the X dimension in projected units. Default: 0.0
  - getResolutionX
```
public double getResolutionX()
```
    Pixel size in the X dimension in projected units. Default: 0.0
  - setResolutionY
```
public void setResolutionY(double value)
```
    Pixel size in the Y dimension in projected units. Default: 0.0
  - getResolutionY
```
public double getResolutionY()
```
    Pixel size in the Y dimension in projected units. Default: 0.0
  - setSaveAlpha
```
public void setSaveAlpha(boolean value)
```
    Enable alpha channel generation.
  - getSaveAlpha
```
public boolean getSaveAlpha()
```
    Enable alpha channel generation.
  - setSaveKml
```
public void setSaveKml(boolean value)
```
    Enable kml file generation.
  - getSaveKml
```
public boolean getSaveKml()
```
    Enable kml file generation.
  - setSaveScheme
```
public void setSaveScheme(boolean value)
```
    Enable tile scheme files generation.
  - getSaveScheme
```
public boolean getSaveScheme()
```
    Enable tile scheme files generation.
  - setSaveWorld
```
public void setSaveWorld(boolean value)
```
    Enable world file generation.
  - getSaveWorld
```
public boolean getSaveWorld()
```
    Enable world file generation.
  - setSourceData
```
public void setSourceData(DataSource value)
```
    Selects between DEM and orthomosaic. Default: DataSource.OrthomosaicData
  - getSourceData
```
public DataSource getSourceData()
```
    Selects between DEM and orthomosaic. Default: DataSource.OrthomosaicData
  - setSplitInBlocks
```
public void setSplitInBlocks(boolean value)
```
    Split raster in blocks.
  - getSplitInBlocks
```
public boolean getSplitInBlocks()
```
    Split raster in blocks.
  - setTileHeight
```
public void setTileHeight(int value)
```
    Tile height in pixels. Default: 256
  - getTileHeight
```
public int getTileHeight()
```
    Tile height in pixels. Default: 256
  - setTileWidth
```
public void setTileWidth(int value)
```
    Tile width in pixels. Default: 256
  - getTileWidth
```
public int getTileWidth()
```
    Tile width in pixels. Default: 256
  - setTitle
```
public void setTitle(java.lang.String value)
```
    Export title.
  - getTitle
```
public java.lang.String getTitle()
```
    Export title.
  - setWhiteBackground
```
public void setWhiteBackground(boolean value)
```
    Enable white background.
  - getWhiteBackground
```
public boolean getWhiteBackground()
```
    Enable white background.
  - setWidth
```
public void setWidth(int value)
```
    Raster width. Default: 0
  - getWidth
```
public int getWidth()
```
    Raster width. Default: 0
  - setWorldTransform
```
public void setWorldTransform(Matrix value)
```
    2x3 raster-to-world transformation matrix.
  - getWorldTransform
```
public Matrix getWorldTransform()
```
    2x3 raster-to-world transformation matrix.

Class ExportRaster

Nested Class Summary

Nested classes/interfaces inherited from class com.agisoft.metashape.Task

Field Summary

Fields inherited from class com.agisoft.metashape.Task

Constructor Summary

Method Summary

Methods inherited from class com.agisoft.metashape.Task

Methods inherited from class java.lang.Object

Constructor Detail

ExportRaster

Method Detail

setAsset

getAsset

setBlockHeight

getBlockHeight

setBlockWidth

getBlockWidth

setClipToBoundary

getClipToBoundary

setDescription

getDescription

setFormat

getFormat

setGlobalProfile

getGlobalProfile

setHeight

getHeight

setImageCompression

getImageCompression

setImageDescription

getImageDescription

setImageFormat

getImageFormat

setMaxZoomLevel

getMaxZoomLevel

setMinZoomLevel

getMinZoomLevel

setNetworkLinks

getNetworkLinks

setNodataValue

getNodataValue

setNorthUp

getNorthUp

setPath

getPath

setProjection

getProjection

setRasterTransform

getRasterTransform

setRegion

getRegion

setResolution

getResolution

setResolutionX

getResolutionX

setResolutionY

getResolutionY

setSaveAlpha

getSaveAlpha

setSaveKml

getSaveKml

setSaveScheme

getSaveScheme

setSaveWorld

getSaveWorld

setSourceData

getSourceData

setSplitInBlocks

getSplitInBlocks

setTileHeight

getTileHeight

setTileWidth

getTileWidth

setTitle

getTitle

setWhiteBackground

getWhiteBackground

setWidth

getWidth