PropertyCollection#

class deapi.PropertyCollection(client, name, properties)#

Bases: object

Class to interact with collections of properties in the DE API

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

  • name (str) – Name of the property collection

  • properties (list) – List of property names in the collection

Notes

This class is mostly used via the client.”property_collection” attribute which groups properties together for easier access. Groups are determined by properties which have names that start with the same string. For example, the properties “Group - Property 1” would allow access to the property using client.group[“Property 1”]

Methods

PropertyCollection.gui([properties])

Examples using PropertyCollection#

Monitoring Bright Spot Intensity

Monitoring Bright Spot Intensity

Taking an Image every 10 seconds

Taking an Image every 10 seconds

Viewing Sensor Data During Acquisition

Viewing Sensor Data During Acquisition

Setting up a STEM Experiment

Setting up a STEM Experiment

Creating a Custom Virtual Mask

Creating a Custom Virtual Mask

Virtual Dark/Bright Field (VDF/VBF) Imaging

Virtual Dark/Bright Field (VDF/VBF) Imaging