Low Level Commands

class obi.commands.low_level_commands.SynchronizeCommand(*, cookie, output, raster)[source]
Parameters:
class obi.commands.low_level_commands.AbortCommand[source]

End the current RasterRegionCommand

class obi.commands.low_level_commands.FlushCommand[source]

Submits the data in the FPGA FIFO over USB, regardless of whether the FIFO is full.

class obi.commands.low_level_commands.ExternalCtrlCommand(enable)[source]

Enable or disable external control of the beam

Parameters:

enable (bool)

class obi.commands.low_level_commands.BeamSelectCommand(beam_type)[source]

Select a beam type. Blanking will be enabled on all other beams if blanking IO is available.

Parameters:

beam_type (BeamType)

class obi.commands.low_level_commands.BlankCommand(enable, inline=False)[source]

Triggers beam blanking

Parameters:

  • enable (bool) – True if blanking, False if unblanking.

  • inline (bool) – True if blanking in sync with the next pixel, False if blanking immediately upon command execution. Defaults to False.

class obi.commands.low_level_commands.DelayCommand(delay)[source]

Starts a counter, pausing execution of subsequent commands until the time is up. One unit of delay is one 48MHz clock cycle, or 20.83 ns.

Parameters:

delay (u16)

class obi.commands.low_level_commands.RasterRegionCommand(x_range, y_range)[source]

Sets the region of the internal raster scanner module. Takes DACCodeRange as input.

Parameters:
class obi.commands.low_level_commands.RasterPixelCommand(*, dwell_time)[source]

One pixel dwell value. The position at which this pixel is executed depends on the current RasterRegionCommand.

Parameters:

dwell_time (DwellTime)

class obi.commands.low_level_commands.ArrayCommand(cmdtype, array_length)[source]
Parameters:
class obi.commands.low_level_commands.RasterPixelFillCommand(dwell_time)[source]
Parameters:

dwell_time (DwellTime)

class obi.commands.low_level_commands.RasterPixelRunCommand(length, dwell_time)[source]

One pixel dwell value, to be repeated for a specified length. The position at which these pixels are executed depends on the current RasterRegionCommand.

Parameters:
class obi.commands.low_level_commands.RasterPixelFreeRunCommand(dwell_time)[source]

One pixel dwell value, to be repeated indefinitely. The position at which these pixels are executed depends on the current RasterRegionCommand.

Parameters:

dwell_time (DwellTime)

class obi.commands.low_level_commands.VectorPixelCommand(x_coord, y_coord, dwell_time)[source]

Sets DAC output to the coordinate X, Y for the specified dwell time.

Parameters:

  • x_coord (u14)

  • y_coord (u14)

  • dwell_time (u16)

as_dict()[source]

Convert to nested dictionary of field names:values :rtype: class: dict