2.3.17 Capture Configuration

A Capture Configuration describes the sensor settings that were used for a Capture file in your Project. All of the Captures in your project have a Capture Configuration associated with them. Capture configurations are used to:

  1. Maintain data providence and help you maintain your data collection strategy

  2. Enforce that data used in training a model was collected with consistent methodology

The Capture Configuration is typically created by the MPLAB Data Visualizer when you begin collecting data. However, you can also generate Capture Configurations programmatically using the API methods.

Examples:

client.list_capture_configurations()

client.project._capture_configurations.create_capture_configuration(name, configuration, uuid)
class mplabml.datamanager.capture_configurations. CaptureConfigurations(connection, project)

Base class for a collection of Captures

build_capture_list()

Populates the function_list property from the server

create_capture_configuration(name, configuration, uuid=None)

Creates a capture object from the given filename and filepath

Parameters

  • name (str) – Desired name of the file on the server

  • configuration (dict) – Configuration file

  • uuid (str) – Specify the uuid this configuration will be created with

Returns

capture_configuration object

Raises

CaptureClonfigurationExistsError , if the Capture already exists on the server –

get_capture_configuration_by_name(name)

Gets a capture configuration object from the server using its name property

Parameters

name (str) – The capture configuration’s name

Returns

capture configuration object or None if it does not exist

get_capture_configurations()

Gets all capture configurations from the server

Returns

list of capture configurations for the project

class mplabml.datamanager.capture_configuration. CaptureConfiguration(connection, project, name='', uuid='', configuration=None, created_at=None, **kwargs)

Base class for a Capture

property configuration

The local or server path to the Capture file data

property created_at

Date of the Pipeline creation

delete()

Calls the REST API to delete the capture from the server

classmethod initialize_from_dict(data)

Reads a dictionary or properties and populates a single capture

Parameters

capture_dict (dict) – Contains the capture’s Name property

Returns

capture object

insert(asynchronous=False)

Calls the REST API to insert a new Capture

refresh()

Calls the REST API and self populates properties from the server

update()

Calls the REST API to update the capture

property uuid

Auto-generated unique identifier for the Capture object