Executable Commands

The following commands are installed with the purpledrop package, to be executed on a command line interface.

pdcli

pdcli [OPTIONS] COMMAND [ARGS]...

info

Get device information from a connected purpledrop

pdcli info [OPTIONS]

pdcam

pdcam [OPTIONS] COMMAND [ARGS]...

measure

Launch UI to make calibration measurements from an image of an electrode board.

pdcam measure [OPTIONS] IMAGEFILE OUTFILE

Options

--v4
--v4_1
--v5
--layout <layout>

JSON file to read board layout from

--point <points>

Control points in grid coordinates: ‘x, y’

-v, --verbose

verbose output

Arguments

IMAGEFILE

Required argument

OUTFILE

Required argument

overlay

pdcam overlay [OPTIONS] IMAGEFILE

Options

--reference <reference>

Arguments

IMAGEFILE

Required argument

server

Runs camera server process used to provide gateway to captured images and fiducial locations.

Serves HTTP API on port 5000, which can be used by pdserver.

pdcam server [OPTIONS]

Options

--registration <registration>

Provide a fiducial registration file to override board definition

--board <board>

Force usage of a particular electrode board (overrides auto detection)

--flip

pdrecord

Records the event stream to a file.

pdrecord [OPTIONS] FILENAME

Options

--host <host>

Websocket URI (e.g. ‘ws://localhost:7001’)

-v, --verbose

Arguments

FILENAME

Required argument

pdlog

A utility for processing log files

Currently provides only the –video flag, which can be used to extract the video frames from the log file.

pdlog [OPTIONS] LOGFILE

Options

--video <video>

Extract video frames from log

Arguments

LOGFILE

Required argument