ExportPointCloud

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

All Implemented Interfaces:

java.lang.AutoCloseable
```
public class ExportPointCloud
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

ExportPointCloud()

Constructors
Constructor and Description
`ExportPointCloud()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getBinary()` Enables/disables binary encoding for selected format (if applicable).
`double`	`getBlockHeight()` Block height in meters.
`double`	`getBlockWidth()` Block width in meters.
`int[]`	`getClasses()` List of point classes to be exported.
`boolean`	`getClipToBoundary()` Clip point cloud to boundary shapes.
`boolean`	`getClipToRegion()` Clip point cloud to chunk region.
`boolean`	`getColorsRgb8Bit()` Convert colors to 8 bit RGB.
`java.lang.String`	`getComment()` Optional comment (if supported by selected format).
`boolean`	`getCompression()` Enable compression (Cesium format only).
`CoordinateSystem`	`getCRS()` Output coordinate system.
`int`	`getFolderDepth()` Tileset subdivision depth (Cesium format only).
`PointCloudFormat`	`getFormat()` Export format.
`ImageFormat`	`getImageFormat()` Image data format.
`java.lang.String`	`getPath()` Path to output file.
`int`	`getPointCloud()` Point cloud key to export.
`RasterTransformType`	`getRasterTransform()` Raster band transformation.
`BBox`	`getRegion()` Region to be exported.
`boolean`	`getSaveComment()` Enable comment export.
`boolean`	`getSaveImages()` Enable image export.
`boolean`	`getSavePointClassification()` Enables/disables export of point classification.
`boolean`	`getSavePointColor()` Enables/disables export of point color.
`boolean`	`getSavePointConfidence()` Enables/disables export of point confidence.
`boolean`	`getSavePointIndex()` Enables/disables export of point row and column indices.
`boolean`	`getSavePointIntensity()` Enables/disables export of point intensity.
`boolean`	`getSavePointNormal()` Enables/disables export of point normal.
`boolean`	`getSavePointReturnNumber()` Enables/disables export of point return number.
`boolean`	`getSavePointScanAngle()` Enables/disables export of point scan angle.
`boolean`	`getSavePointSourceId()` Enables/disables export of point source ID.
`boolean`	`getSavePointTimestamp()` Enables/disables export of point timestamp.
`double`	`getScreenSpaceError()` Target screen space error (Cesium format only).
`Vector`	`getShift()` Optional shift to be applied to point coordinates.
`DataSource`	`getSourceData()` Selects between point cloud and tie points.
`boolean`	`getSplitInBlocks()` Enable tiled export.
`boolean`	`getSubdivideTask()` Enable fine-level task subdivision.
`java.lang.String`	`getTilesetVersion()` Cesium 3D Tiles format version to export (1.0 or 1.1).
`Viewpoint`	`getViewpoint()` Default view.
`void`	`setBinary(boolean value)` Enables/disables binary encoding for selected format (if applicable).
`void`	`setBlockHeight(double value)` Block height in meters.
`void`	`setBlockWidth(double value)` Block width in meters.
`void`	`setClasses(int[] value)` List of point classes to be exported.
`void`	`setClipToBoundary(boolean value)` Clip point cloud to boundary shapes.
`void`	`setClipToRegion(boolean value)` Clip point cloud to chunk region.
`void`	`setColorsRgb8Bit(boolean value)` Convert colors to 8 bit RGB.
`void`	`setComment(java.lang.String value)` Optional comment (if supported by selected format).
`void`	`setCompression(boolean value)` Enable compression (Cesium format only).
`void`	`setCRS(CoordinateSystem value)` Output coordinate system.
`void`	`setFolderDepth(int value)` Tileset subdivision depth (Cesium format only).
`void`	`setFormat(PointCloudFormat value)` Export format.
`void`	`setImageFormat(ImageFormat value)` Image data format.
`void`	`setPath(java.lang.String value)` Path to output file.
`void`	`setPointCloud(int value)` Point cloud key to export.
`void`	`setRasterTransform(RasterTransformType value)` Raster band transformation.
`void`	`setRegion(BBox value)` Region to be exported.
`void`	`setSaveComment(boolean value)` Enable comment export.
`void`	`setSaveImages(boolean value)` Enable image export.
`void`	`setSavePointClassification(boolean value)` Enables/disables export of point classification.
`void`	`setSavePointColor(boolean value)` Enables/disables export of point color.
`void`	`setSavePointConfidence(boolean value)` Enables/disables export of point confidence.
`void`	`setSavePointIndex(boolean value)` Enables/disables export of point row and column indices.
`void`	`setSavePointIntensity(boolean value)` Enables/disables export of point intensity.
`void`	`setSavePointNormal(boolean value)` Enables/disables export of point normal.
`void`	`setSavePointReturnNumber(boolean value)` Enables/disables export of point return number.
`void`	`setSavePointScanAngle(boolean value)` Enables/disables export of point scan angle.
`void`	`setSavePointSourceId(boolean value)` Enables/disables export of point source ID.
`void`	`setSavePointTimestamp(boolean value)` Enables/disables export of point timestamp.
`void`	`setScreenSpaceError(double value)` Target screen space error (Cesium format only).
`void`	`setShift(Vector value)` Optional shift to be applied to point coordinates.
`void`	`setSourceData(DataSource value)` Selects between point cloud and tie points.
`void`	`setSplitInBlocks(boolean value)` Enable tiled export.
`void`	`setSubdivideTask(boolean value)` Enable fine-level task subdivision.
`void`	`setTilesetVersion(java.lang.String value)` Cesium 3D Tiles format version to export (1.0 or 1.1).
`void`	`setViewpoint(Viewpoint value)` Default view.

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
  - ExportPointCloud
```
public ExportPointCloud()
```
- Method Detail
  - setBinary
```
public void setBinary(boolean value)
```
    Enables/disables binary encoding for selected format (if applicable).
  - getBinary
```
public boolean getBinary()
```
    Enables/disables binary encoding for selected format (if applicable).
  - setBlockHeight
```
public void setBlockHeight(double value)
```
    Block height in meters. Default: 1000.0
  - getBlockHeight
```
public double getBlockHeight()
```
    Block height in meters. Default: 1000.0
  - setBlockWidth
```
public void setBlockWidth(double value)
```
    Block width in meters. Default: 1000.0
  - getBlockWidth
```
public double getBlockWidth()
```
    Block width in meters. Default: 1000.0
  - setClasses
```
public void setClasses(int[] value)
```
    List of point classes to be exported.
  - getClasses
```
public int[] getClasses()
```
    List of point classes to be exported.
  - setClipToBoundary
```
public void setClipToBoundary(boolean value)
```
    Clip point cloud to boundary shapes.
  - getClipToBoundary
```
public boolean getClipToBoundary()
```
    Clip point cloud to boundary shapes.
  - setClipToRegion
```
public void setClipToRegion(boolean value)
```
    Clip point cloud to chunk region.
  - getClipToRegion
```
public boolean getClipToRegion()
```
    Clip point cloud to chunk region.
  - setColorsRgb8Bit
```
public void setColorsRgb8Bit(boolean value)
```
    Convert colors to 8 bit RGB.
  - getColorsRgb8Bit
```
public boolean getColorsRgb8Bit()
```
    Convert colors to 8 bit RGB.
  - setComment
```
public void setComment(java.lang.String value)
```
    Optional comment (if supported by selected format).
  - getComment
```
public java.lang.String getComment()
```
    Optional comment (if supported by selected format).
  - setCompression
```
public void setCompression(boolean value)
```
    Enable compression (Cesium format only).
  - getCompression
```
public boolean getCompression()
```
    Enable compression (Cesium format only).
  - setCRS
```
public void setCRS(CoordinateSystem value)
```
    Output coordinate system.
  - getCRS
```
public CoordinateSystem getCRS()
```
    Output coordinate system.
  - setFolderDepth
```
public void setFolderDepth(int value)
```
    Tileset subdivision depth (Cesium format only). Default: 5
  - getFolderDepth
```
public int getFolderDepth()
```
    Tileset subdivision depth (Cesium format only). Default: 5
  - setFormat
```
public void setFormat(PointCloudFormat value)
```
    Export format. Default: PointCloudFormat.PointCloudFormatNone
  - getFormat
```
public PointCloudFormat getFormat()
```
    Export format. Default: PointCloudFormat.PointCloudFormatNone
  - setImageFormat
```
public void setImageFormat(ImageFormat value)
```
    Image data format. Default: ImageFormat.ImageFormatJPEG
  - getImageFormat
```
public ImageFormat getImageFormat()
```
    Image data format. Default: ImageFormat.ImageFormatJPEG
  - setPath
```
public void setPath(java.lang.String value)
```
    Path to output file.
  - getPath
```
public java.lang.String getPath()
```
    Path to output file.
  - setPointCloud
```
public void setPointCloud(int value)
```
    Point cloud key to export.
  - getPointCloud
```
public int getPointCloud()
```
    Point cloud key to export.
  - 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.
  - setSaveComment
```
public void setSaveComment(boolean value)
```
    Enable comment export.
  - getSaveComment
```
public boolean getSaveComment()
```
    Enable comment export.
  - setSaveImages
```
public void setSaveImages(boolean value)
```
    Enable image export.
  - getSaveImages
```
public boolean getSaveImages()
```
    Enable image export.
  - setSavePointClassification
```
public void setSavePointClassification(boolean value)
```
    Enables/disables export of point classification.
  - getSavePointClassification
```
public boolean getSavePointClassification()
```
    Enables/disables export of point classification.
  - setSavePointColor
```
public void setSavePointColor(boolean value)
```
    Enables/disables export of point color.
  - getSavePointColor
```
public boolean getSavePointColor()
```
    Enables/disables export of point color.
  - setSavePointConfidence
```
public void setSavePointConfidence(boolean value)
```
    Enables/disables export of point confidence.
  - getSavePointConfidence
```
public boolean getSavePointConfidence()
```
    Enables/disables export of point confidence.
  - setSavePointIndex
```
public void setSavePointIndex(boolean value)
```
    Enables/disables export of point row and column indices.
  - getSavePointIndex
```
public boolean getSavePointIndex()
```
    Enables/disables export of point row and column indices.
  - setSavePointIntensity
```
public void setSavePointIntensity(boolean value)
```
    Enables/disables export of point intensity.
  - getSavePointIntensity
```
public boolean getSavePointIntensity()
```
    Enables/disables export of point intensity.
  - setSavePointNormal
```
public void setSavePointNormal(boolean value)
```
    Enables/disables export of point normal.
  - getSavePointNormal
```
public boolean getSavePointNormal()
```
    Enables/disables export of point normal.
  - setSavePointReturnNumber
```
public void setSavePointReturnNumber(boolean value)
```
    Enables/disables export of point return number.
  - getSavePointReturnNumber
```
public boolean getSavePointReturnNumber()
```
    Enables/disables export of point return number.
  - setSavePointScanAngle
```
public void setSavePointScanAngle(boolean value)
```
    Enables/disables export of point scan angle.
  - getSavePointScanAngle
```
public boolean getSavePointScanAngle()
```
    Enables/disables export of point scan angle.
  - setSavePointSourceId
```
public void setSavePointSourceId(boolean value)
```
    Enables/disables export of point source ID.
  - getSavePointSourceId
```
public boolean getSavePointSourceId()
```
    Enables/disables export of point source ID.
  - setSavePointTimestamp
```
public void setSavePointTimestamp(boolean value)
```
    Enables/disables export of point timestamp.
  - getSavePointTimestamp
```
public boolean getSavePointTimestamp()
```
    Enables/disables export of point timestamp.
  - setScreenSpaceError
```
public void setScreenSpaceError(double value)
```
    Target screen space error (Cesium format only). Default: 16.0
  - getScreenSpaceError
```
public double getScreenSpaceError()
```
    Target screen space error (Cesium format only). Default: 16.0
  - setShift
```
public void setShift(Vector value)
```
    Optional shift to be applied to point coordinates.
  - getShift
```
public Vector getShift()
```
    Optional shift to be applied to point coordinates.
  - setSourceData
```
public void setSourceData(DataSource value)
```
    Selects between point cloud and tie points. If not specified, uses point cloud if available. Default: DataSource.PointCloudData
  - getSourceData
```
public DataSource getSourceData()
```
    Selects between point cloud and tie points. If not specified, uses point cloud if available. Default: DataSource.PointCloudData
  - setSplitInBlocks
```
public void setSplitInBlocks(boolean value)
```
    Enable tiled export.
  - getSplitInBlocks
```
public boolean getSplitInBlocks()
```
    Enable tiled export.
  - setSubdivideTask
```
public void setSubdivideTask(boolean value)
```
    Enable fine-level task subdivision.
  - getSubdivideTask
```
public boolean getSubdivideTask()
```
    Enable fine-level task subdivision.
  - setTilesetVersion
```
public void setTilesetVersion(java.lang.String value)
```
    Cesium 3D Tiles format version to export (1.0 or 1.1).
  - getTilesetVersion
```
public java.lang.String getTilesetVersion()
```
    Cesium 3D Tiles format version to export (1.0 or 1.1).
  - setViewpoint
```
public void setViewpoint(Viewpoint value)
```
    Default view.
  - getViewpoint
```
public Viewpoint getViewpoint()
```
    Default view.

Class ExportPointCloud

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

ExportPointCloud

Method Detail

setBinary

getBinary

setBlockHeight

getBlockHeight

setBlockWidth

getBlockWidth

setClasses

getClasses

setClipToBoundary

getClipToBoundary

setClipToRegion

getClipToRegion

setColorsRgb8Bit

getColorsRgb8Bit

setComment

getComment

setCompression

getCompression

setCRS

getCRS

setFolderDepth

getFolderDepth

setFormat

getFormat

setImageFormat

getImageFormat

setPath

getPath

setPointCloud

getPointCloud

setRasterTransform

getRasterTransform

setRegion

getRegion

setSaveComment

getSaveComment

setSaveImages

getSaveImages

setSavePointClassification

getSavePointClassification

setSavePointColor

getSavePointColor

setSavePointConfidence

getSavePointConfidence

setSavePointIndex

getSavePointIndex

setSavePointIntensity

getSavePointIntensity

setSavePointNormal

getSavePointNormal

setSavePointReturnNumber

getSavePointReturnNumber

setSavePointScanAngle

getSavePointScanAngle

setSavePointSourceId

getSavePointSourceId

setSavePointTimestamp

getSavePointTimestamp

setScreenSpaceError

getScreenSpaceError

setShift

getShift

setSourceData

getSourceData

setSplitInBlocks

getSplitInBlocks

setSubdivideTask

getSubdivideTask