GenerateMasks

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

All Implemented Interfaces:

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

GenerateMasks()

Constructors
Constructor and Description
`GenerateMasks()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getBlurThreshold()` Allowed blur radius on a photo in pix (only if mask_defocus=True).
`int[]`	`getCameras()` Optional list of cameras to be processed.
`double`	`getDepthThreshold()` Maximum depth of masked areas in meters (only if mask_defocus=False).
`boolean`	`getFixCoverage()` Extend masks to cover whole mesh (only if mask_defocus=True).
`int[]`	`getFrames()` List of frames to process.
`boolean`	`getMaskDefocus()` Mask defocus areas.
`MaskingMode`	`getMaskingMode()` Mask generation mode.
`MaskOperation`	`getMaskOperation()` Mask operation.
`java.lang.String`	`getPath()` Mask file name template.
`boolean`	`getReplaceAsset()` Update default set of masks with generated masks.
`int`	`getTolerance()` Background masking tolerance.
`void`	`setBlurThreshold(double value)` Allowed blur radius on a photo in pix (only if mask_defocus=True).
`void`	`setCameras(int[] value)` Optional list of cameras to be processed.
`void`	`setDepthThreshold(double value)` Maximum depth of masked areas in meters (only if mask_defocus=False).
`void`	`setFixCoverage(boolean value)` Extend masks to cover whole mesh (only if mask_defocus=True).
`void`	`setFrames(int[] value)` List of frames to process.
`void`	`setMaskDefocus(boolean value)` Mask defocus areas.
`void`	`setMaskingMode(MaskingMode value)` Mask generation mode.
`void`	`setMaskOperation(MaskOperation value)` Mask operation.
`void`	`setPath(java.lang.String value)` Mask file name template.
`void`	`setReplaceAsset(boolean value)` Update default set of masks with generated masks.
`void`	`setTolerance(int value)` Background masking tolerance.

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
  - GenerateMasks
```
public GenerateMasks()
```
- Method Detail
  - setBlurThreshold
```
public void setBlurThreshold(double value)
```
    Allowed blur radius on a photo in pix (only if mask_defocus=True). Default: 3.0
  - getBlurThreshold
```
public double getBlurThreshold()
```
    Allowed blur radius on a photo in pix (only if mask_defocus=True). Default: 3.0
  - setCameras
```
public void setCameras(int[] value)
```
    Optional list of cameras to be processed.
  - getCameras
```
public int[] getCameras()
```
    Optional list of cameras to be processed.
  - setDepthThreshold
```
public void setDepthThreshold(double value)
```
    Maximum depth of masked areas in meters (only if mask_defocus=False). Default: 3.4028234663852886e+38
  - getDepthThreshold
```
public double getDepthThreshold()
```
    Maximum depth of masked areas in meters (only if mask_defocus=False). Default: 3.4028234663852886e+38
  - setFixCoverage
```
public void setFixCoverage(boolean value)
```
    Extend masks to cover whole mesh (only if mask_defocus=True).
  - getFixCoverage
```
public boolean getFixCoverage()
```
    Extend masks to cover whole mesh (only if mask_defocus=True).
  - setFrames
```
public void setFrames(int[] value)
```
    List of frames to process.
  - getFrames
```
public int[] getFrames()
```
    List of frames to process.
  - setMaskDefocus
```
public void setMaskDefocus(boolean value)
```
    Mask defocus areas.
  - getMaskDefocus
```
public boolean getMaskDefocus()
```
    Mask defocus areas.
  - setMaskOperation
```
public void setMaskOperation(MaskOperation value)
```
    Mask operation. Default: MaskOperation.MaskOperationReplacement
  - getMaskOperation
```
public MaskOperation getMaskOperation()
```
    Mask operation. Default: MaskOperation.MaskOperationReplacement
  - setMaskingMode
```
public void setMaskingMode(MaskingMode value)
```
    Mask generation mode. Default: MaskingMode.MaskingModeAlpha
  - getMaskingMode
```
public MaskingMode getMaskingMode()
```
    Mask generation mode. Default: MaskingMode.MaskingModeAlpha
  - setPath
```
public void setPath(java.lang.String value)
```
    Mask file name template.
  - getPath
```
public java.lang.String getPath()
```
    Mask file name template.
  - setReplaceAsset
```
public void setReplaceAsset(boolean value)
```
    Update default set of masks with generated masks.
  - getReplaceAsset
```
public boolean getReplaceAsset()
```
    Update default set of masks with generated masks.
  - setTolerance
```
public void setTolerance(int value)
```
    Background masking tolerance. Default: 10
  - getTolerance
```
public int getTolerance()
```
    Background masking tolerance. Default: 10

Class GenerateMasks

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

GenerateMasks

Method Detail

setBlurThreshold

getBlurThreshold

setCameras

getCameras

setDepthThreshold

getDepthThreshold

setFixCoverage

getFixCoverage

setFrames

getFrames

setMaskDefocus

getMaskDefocus

setMaskOperation

getMaskOperation

setMaskingMode

getMaskingMode

setPath

getPath

setReplaceAsset

getReplaceAsset

setTolerance

getTolerance