label_actuator_centroid_positions

hcipy.optics.label_actuator_centroid_positions(influence_functions, label_format='{:d}', **text_kwargs)

Display centroid positions for a set of influence functions.

The location of each of the actuators is calculated using a weighted centroid, and at that location a label is written to the open Matplotlib Figure. The text can be modified with label_format, which is formatted with new-style Python formatting: label_format.format(i) where i is the actuator index.

Parameters

influence_functionsModeBasis

The influence function for each actuator.

label_formatstring

The text that will be displayed at the actuator centroid. This must be a new-style formattable string.

Raises

ValueError

If the influence functions mode basis does not contain a grid.