slmsuite.hardware.slms.santec.Santec

class Santec(slm_number=1, display_number=2, verbose=True, **kwargs)

Bases: SLM

Interfaces with Santec SLMs.

slm_number

USB port number assigned by Santec SDK.

Type

int

display_number

Display number assigned by Santec SDK.

Type

int

optionboard_id

ID of the option board

Type

str

driveboard_id

ID of the drive board

Type

str

product_code_id

Product code of the device

Type

str

Methods

close	See SLM.close().
get_error	Read the drive board and option board errors.
get_status	Gets SLM_STATUS return from a Santec SLM and parses the result.
get_temperature	Read the drive board and option board temperatures.
info	Discovers the names of all the displays.
load_vendor_phase_correction	Load phase correction provided by Santec from file, setting phase_correction.
point_spread_function_knm	Fourier transforms the wavefront calibration's measured amplitude to find the expected diffraction-limited perfomance of the system in "knm" space.
set_measured_amplitude_analytic	Sets measured_amplitude used for hologram generation in the absence of a proper wavefront calibration.
spot_radius_kxy	Approximates the expected radius of farfield spots in the "kxy" basis based on the near-field amplitude distribution measured_amplitude.
write	Checks, cleans, and adds to data, then sends the data to the SLM and potentially waits for settle.
write_csv	Write the phase image contained in a .csv file to the SLM.

__init__(slm_number=1, display_number=2, verbose=True, **kwargs)

Initializes an instance of a Santec SLM.

Parameters

• slm_number – See slm_number.

• display_number – See display_number.

• verbose (bool) – Whether to print extra information.

• kwargs – See SLM.__init__() for permissible options.

Note

Santec SLMs can reconfigure their phase table: the correspondence between grayscale values and applied voltages. This is configured based upon the wavelength supplied to SLM.wav_design_um. This allows SLM.phase_scaling to be one if desired, and make use of optimized routines (see :meth`.write()`). However, sometimes setting the phase table runs into issues, where the maximum value doesn’t correspond to exactly \(2\pi\) at the target wavelength. This is noted in the initialization, and the user should update SLM.wav_design_um or otherwise to avoid undesired behavior.

Caution

Santec defaults to 8 micron SLM pixel size (SLM.dx_um = SLM.dy_um = 8) and 10-bit SLM.bitdepth. This is valid for SLM-200, SLM-210, and SLM-300, but may not be valid for future Santec models.

static info(verbose=True)

Discovers the names of all the displays. Checks all 8 possible supported by Santec’s SDK.

Parameters

verbose (bool) – Whether to print the discovered information.

Returns

The number and name of each potential display.

Return type

list of (int, str) tuples

load_vendor_phase_correction(file_path, smooth=False, overwrite=True)

Load phase correction provided by Santec from file, setting phase_correction.

Parameters

• file_path (str) – File path for the vendor-provided phase correction.

• smooth (bool) – Whether to apply a Gaussian blur to smooth the data.

• overwrite (bool) – Whether to overwrite the previous phase_correction.

Note

This correction is only fully valid at the wavelength at which it was collected.

Returns

phase_correction, the Santec-provided phase correction.

Return type

numpy.ndarray

close()

See SLM.close().

get_temperature()

Read the drive board and option board temperatures.

Returns

Temperature in Celsius of the drive and option board

Return type

(float, float)

get_error(raise_error=True, return_codes=False)

Read the drive board and option board errors.

Parameters

• raise_error (bool) – Whether to raise an error (if True) or a warning (if False) if error(s) are detected.

• return_codes (bool) – Whether to return an error string or integer error codes (in (drive_error, option_error) form).

Returns

List of errors.

Return type

list of str OR (int, int)

get_status(raise_error=True)

Gets SLM_STATUS return from a Santec SLM and parses the result.

Parameters

raise_error (bool) – Whether to raise an error (if True) or a warning (if False) when status is not SLM_OK.

Returns

Status in (num, name, note) form.

Return type

(int, str, str)

write_csv(filename)

Write the phase image contained in a .csv file to the SLM. This image should have the size of the SLM.

Parameters

filename (str) – Path to the .csv file.

point_spread_function_knm(padded_shape=None)

Fourier transforms the wavefront calibration’s measured amplitude to find the expected diffraction-limited perfomance of the system in "knm" space.

Parameters

padded_shape ((int, int) OR None) – The point spread function changes in resolution depending on the padding. Use this variable to provide this padding. If None, do not pad.

Returns

The point spread function of shape padded_shape.

Return type

numpy.ndarray

set_measured_amplitude_analytic(radius, units='norm')

Sets measured_amplitude used for hologram generation in the absence of a proper wavefront calibration. FourierSLM includes capabilities for wavefront calibration via wavefront_calibrate(). This process also measures the amplitude of the source on the SLM and stores this in measured_amplitude. measured_amplitude is used for better refinement of holograms during numerical optimization. If one does not have a camera to use for wavefront_calibrate(), this method allows the user to set an approximation of the source amplitude based on an assumed \(1/e\) amplitude (\(1/e^2\) power) Gaussian beam radius.

Parameters

• radius (float) – Radius in normalized units to assume for the source Gaussian beam.

• units (str in {"norm", "nm", "um", "mm", "m"}) – Units for the given radius.

Returns

measured_amplitude.

Return type

numpy.ndarray

spot_radius_kxy()

Approximates the expected radius of farfield spots in the "kxy" basis based on the near-field amplitude distribution measured_amplitude.

Returns

Average radius of the farfield spot.

Return type

float

write(phase, phase_correct=True, settle=False)

Checks, cleans, and adds to data, then sends the data to the SLM and potentially waits for settle. This method calls the SLM-specific private method _write_hw() which transfers the data to the SLM.

Warning

Subclasses implementing vendor-specific software should not overwrite this method. Subclasses should overwrite _write_hw() instead.

Caution

The sign on phase is flipped before converting to integer data. This is to convert between the ‘increasing value ==> increasing voltage (= decreasing phase delay)’ convention in most SLMs and slmsuite’s ‘increasing value ==> increasing phase delay’ convention. As a result, zero phase will appear entirely white (255 for an 8-bit SLM), and increasing phase will darken the displayed pattern. If integer data is passed, this data is displayed directly and the sign is not flipped.

Important

The user does not need to wrap (e.g. numpy.mod(data, 2*numpy.pi)) the passed phase data, unless they are pre-caching data for speed (see below). write() uses optimized routines to wrap the phase (see the private method _phase2gray()). Which routine is used depends on phase_scaling:

• phase_scaling is one.

  Fast bitwise integer modulo is used. Much faster than the other routines which depend on numpy.mod().

• phase_scaling is less than one.

  In this case, the SLM has more phase tuning range than necessary. If the data is within the SLM range [0, 2*pi/phase_scaling], then the data is passed directly. Otherwise, the data is wrapped by \(2\pi\) using the very slow numpy.mod(). Try to avoid this in applications where speed is important.

• phase_scaling is more than one.

  In this case, the SLM has less phase tuning range than necessary. Processed the same way as the phase_scaling is less than one case, with the important exception that phases (after wrapping) between 2*pi/phase_scaling and 2*pi are set to zero. For instance, a sawtooth blaze would be truncated at the tips.

Caution

After scale conversion, data is floor() ed to integers with np.copyto, rather than rounded to the nearest integer (np.around() equivalent). While this is irrelevant for the average user, it may be significant in some cases. If this behavior is undesired consider either: write() integer data directly or modifying the behavior of the private method _phase2gray() in a pull request. We have not been able to find an example of np.copyto producing undesired behavior, but will change this if such behavior is found.

Parameters

• phase (numpy.ndarray or None) –

  Phase data to display in units of \(2\pi\), unless the passed data is of integer type and the data is applied directly.

  • If None is passed to write(), data is zeroed.

  • If the array has a larger shape than the SLM shape, then the data is cropped to size in a centered manner (unpad).

  • If integer data is passed with the same type as display (np.uint8 for <=8-bit SLMs, np.uint16 otherwise), then this data is directly passed to the SLM, without going through the “phase delay to grayscale” conversion defined in the private method _phase2gray(). In this situation, phase_correct is ignored. This is error-checked such that bits with greater significance than the bitdepth of the SLM are zero (e.g. the final 6 bits of 16 bit data for a 10-bit SLM). Integer data with type different from display leads to a TypeError.

  Usually, an exact stored copy of the data passed by the user under phase is stored in the attribute phase. However, in cases where phase_scaling not one, this copy is modified to include how the data was wrapped. If the data was cropped, then the cropped data is stored, etc. If integer data was passed, the equivalent floating point phase is computed and stored in the attribute phase.

• phase_correct (bool) – Whether or not to add phase_correction to phase.

• settle (bool) – Whether to sleep for settle_time_s.

Returns

display, the integer data sent to the SLM.

Return type

numpy.ndarray

Raises

TypeError – If integer data is incompatible with the bitdepth or if the passed phase is otherwise incompatible (not a 2D array or smaller than the SLM shape, etc).