VirtualMask

class deapi.VirtualMask(client, index)

Bases: object

Class to interact with virtual masks in the DE API

Parameters:

• client (deapi.Client) – Client object to interact with the DE API

• index (int) – Index of the virtual mask

Notes

This class is mostly used via the client.virtual_masks property which is a list of VirtualMask objects.

Attributes

VirtualMask.calculation

Calculation mode for the virtual mask

Methods

VirtualMask.plot([ax])

Plot the virtual mask using matplotlib

Examples using VirtualMask

Creating a Custom Virtual Mask

Creating a Custom Virtual Mask