Polytec vibrometer plugin

The Polytech vibrometer instrument.

This plugin allows interfacing with Polytec vibrometer OFV-5000 controller and OFV-505 sensor head. Functions based on Polytec “RS-232 Interface Commands: OFV-5000 User Manual”

NOTE For each polytec controller, different decoders may be installed. These values should be stored in the your PLACE config file. (~/.place.cfg)

Settings

The Polytec plugin will need entries in your .place.cfg file. Specifically, it needs the communication port, the baudrate, and names for any decoders you have installed. Here is an example:

[Polytec]
port = /dev/ttyS0
baudrate = 115200
dd_300 = DisplDec,0
dd_900 = DisplDec,1
vd_08 = VeloDec,0
vd_09 = VeloDec,1

Metadata

The Polytec plugin will produce the following experimental metadata:

Key Type Meaning
actual_area_min int the actual minimum autofocus range used (if using custom autofocus)
actual_area_max int the actual maximum autofocus range used (if using custom autofocus)
vd_08_time_delay float the decoder time delay (if used)
vd_08_maximum_frequency float the decoder maximum frequency (if used)
vd_09_time_delay float the decoder time delay (if used)
vd_09_maximum_frequency float the decoder maximum frequency (if used)

Data

The Polytec plugin will produce the following experimental data:

Heading Type Meaning
Polytec-signal uint64 the signal level recorded from the vibrometer
class place.plugins.polytec.polytec.Polytec(config, plotter)[source]

Bases: place.plugins.instrument.Instrument

The polytec class

config(metadata, total_updates)[source]

Configure the vibrometer.

Parameters:
  • metadata (dict) – experiment metadata
  • total_updates (int) – number of updates for the experiment
update(update_number, progress)[source]

Update the vibrometer.

Parameters:
  • update_number (int) – the count of the current update (0-indexed)
  • progress (dict) – a dictionary of values passed back to your Elm app
Returns:

an array containing the signal level
Return type:

numpy.array dtype=’uint64’
cleanup(abort=False)[source]

Closes the serial port to the Polytec.

Parameters:abort (bool) – indicates that the experiment is being aborted and is unfinished