GenerateMasks

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

```
public class GenerateMasks
extends Task
```
Task class containing processing parameters.

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

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

Constructor Summary

Constructors
Modifier Constructor and Description

GenerateMasks()

protected GenerateMasks(long cPtr, boolean cMemoryOwn)

Constructors
Modifier	Constructor and Description
	`GenerateMasks()`
`protected`	`GenerateMasks(long cPtr, boolean cMemoryOwn)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`delete()`
`protected void`	`finalize()`
`double`	`getBlurThreshold()` Allowed blur radius on a photo in pix (only if mask_defocus=True).
`int[]`	`getCameras()` Optional list of cameras to be processed.
`protected static long`	`getCPtr(GenerateMasks obj)`
`boolean`	`getFixCoverage()` Extend masks to cover whole mesh (only if mask_defocus=True).
`boolean`	`getMaskDefocus()` Mask defocus areas.
`MaskingMode`	`getMaskingMode()` Mask generation mode.
`MaskOperation`	`getMaskOperation()` Mask operation.
`java.lang.String`	`getPath()` Mask file name template.
`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`	`setFixCoverage(boolean value)` Extend masks to cover whole mesh (only if mask_defocus=True).
`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`	`setTolerance(int value)` Background masking tolerance.

Methods inherited from class com.agisoft.metashape.tasks.Task
apply, apply, getCPtr, getName, getParameter, getParameterNames, getTarget, getWorkitemCount, isGPUSupported, 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
```
protected GenerateMasks(long cPtr,
                        boolean cMemoryOwn)
```
  - GenerateMasks
```
public GenerateMasks()
```
- Method Detail
  - getCPtr
```
protected static long getCPtr(GenerateMasks obj)
```
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class Task
  - delete
```
public void delete()
```
    Overrides:
    
    delete in class Task
  - 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.
  - setFixCoverage
```
public void setFixCoverage(boolean value)
```
    Extend masks to cover whole mesh (only if mask_defocus=True). Default: false
  - getFixCoverage
```
public boolean getFixCoverage()
```
    Extend masks to cover whole mesh (only if mask_defocus=True). Default: false
  - setMaskDefocus
```
public void setMaskDefocus(boolean value)
```
    Mask defocus areas. Default: false
  - getMaskDefocus
```
public boolean getMaskDefocus()
```
    Mask defocus areas. Default: false
  - 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.
  - 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.tasks.Task

Field Summary

Fields inherited from class com.agisoft.metashape.tasks.Task

Constructor Summary

Method Summary

Methods inherited from class com.agisoft.metashape.tasks.Task

Methods inherited from class java.lang.Object

Constructor Detail

GenerateMasks

GenerateMasks

Method Detail

getCPtr

finalize

delete

setBlurThreshold

getBlurThreshold

setCameras

getCameras

setFixCoverage

getFixCoverage

setMaskDefocus

getMaskDefocus

setMaskOperation

getMaskOperation

setMaskingMode

getMaskingMode

setPath

getPath

setTolerance

getTolerance