Module gonioimsoft.core
GonioImsoft main components.
Classes
class GonioImsoftCore (dynamic_parameters={'isi': 10.0, 'repeats': 1, 'pre_stim': 0.0, 'stim': 0.2, 'post_stim': 0.0, 'frame_length': 0.01, 'ir_imaging': 5, 'ir_waiting': 0, 'ir_livefeed': 1, 'flash_on': 5, 'flash_off': 0, 'ir_channel': 'Dev1/ao1', 'flash_channel': 'Dev1/ao0', 'suffix': '', 'trigger_channel': '/Dev1/PFI0', 'trigger_out_channel': 'Dev1/ao7', 'biosyst_stimulus': '', 'biosyst_channel': 2, 'avgint_adaptation': 0, 'flash_type': 'square', 'save_stack': True, 'reboot_cameras': False, 'ROI': None})-
Main interface to control GonioImsoft recordings.
Attributes
reader:obj- Reading rotary encoder values from the Arduino Board.
cameras:list- Camera client objects that each talk to a specific server over IPv4 sockets. The server's can be local (on the same machine) or remote.
vios:list- Analog voltage input/ouput clients. Similar to the cameras, they talk to a vio server.
Sets up ArduinoReader, CameraClient/Server.
Expand source code
class GonioImsoftCore: '''Main interface to control GonioImsoft recordings. Attributes ---------- reader : obj Reading rotary encoder values from the Arduino Board. cameras : list Camera client objects that each talk to a specific server over IPv4 sockets. The server's can be local (on the same machine) or remote. vios : list Analog voltage input/ouput clients. Similar to the cameras, they talk to a vio server. ''' def __init__(self, dynamic_parameters=DEFAULT_DYNAMIC_PARAMETERS): ''' Sets up ArduinoReader, CameraClient/Server. ''' # Angle pairs reader (rotary encoder values) self.reader = ArduinoReader() self.cameras = [] self.vios = [] # Details about preparation (name, sex, age) are saved in this self.preparation = {'name': 'test', 'sex': '', 'age': ''} self.dynamic_parameters = dynamic_parameters self.previous_angle = None # Suffix to be appended in the subfolders, see set_subfolder_suffix method self.suffix = '' # Set up motors followingly # 0) Horizontal + sensor # 1) Vertical + sensor # 2) Microscope focus (no sensor) self.motors = [] if ENABLE_MOTORS: for i_motor, i_sensor in zip([0,1,2],[0,1,None]): self.motors.append(Motor(self.reader, i_motor, i_sensor)) # Macro imaging: Automatically move motors and take images # self macro is a list of anglepairs where to move the horizontal/vertical, # take image "commands" (string 'image') and other functions. # For more details see the tick method of this class. self.macro = None self.i_macro = 0 self.waittime = 0 self.trigger_rotation = False self.trigger_signal = np.array([3,3,3,0]) self.triggered_anglepairs = None self.data_savedir = None self.local_camera_servers_running_index = 0 self.local_vio_servers_running_index = 0 self.pause_livefeed = False self.vio_livefeed = False self.vio_livefeed_dur = 0.1 self._last_vio = time.time() def _add_client(self, name, host, port): '''Adds a camera client to the given host and port. If host is None uses the localhost and starts a local server if no local server running at that port Arguments --------- name : string The name of the client. "camera" or "vio" ''' if name == 'camera': Client = CameraClient register = self.cameras self.local_camera_servers_running_index += 1 index = self.local_camera_servers_running_index elif name == 'vio': Client = VIOClient register = self.vios self.local_vio_servers_running_index += 1 index = self.local_vio_servers_running_index else: raise ValueError client = Client(host, port, running_index=index-1) if host is None and not client.is_server_running(): client.start_server() register.append(client) return client def add_camera_client(self, host, port): return self._add_client('camera', host, port) def add_vio_client(self, host, port): return self._add_client('vio', host, port) def _remove_client(self, name, i_client): if name == 'camera': register = self.cameras elif name == 'vio': reigster = self.vios # Popping is enough and the client should be garbage collected # by Python (the sockets are not kept alive so nothing is # left open etc. by the client) if isinstance(i_client, int): client = self.register.pop(i_client) elif isinstance(i_client, (CameraClient, VIOClient)): client = i_client self.register.remove(client) else: raise ValueError(f'Cannot remove {i_client} from clients') # If the client started a local server, close the server if client.local_server is not None: client.close_server() return client def remove_camera_client(self, client): '''Removes a camera client and closes its server if local server Arguments --------- client : object or int Index of the client in self.cameras or the CameraClient object to be removed ''' return self._remove_client('camera', client) def remove_vio_client(self, client): '''Removes the vio client and closes its server if local server Arguments --------- client: object or int Index of the client in self.vios or the VIOClient object to be removed ''' return self._remove_client('vio', client) def analog_output(self, channels, stimuli, fs, wait_trigger, camera=True): ''' channels List of channel names stimuli List of 1D numpy arrays fs Sampling frequency of the stimuli camera : bool If True, send the camera server a "ready" command ''' if nidaqmx is None: print(' pretending analog_output on channels {}'.format(channels)) return None with nidaqmx.Task() as task: for i_channel, channel in enumerate(channels): if type(channel) == type('string'): task.ao_channels.add_ao_voltage_chan(channel) else: for subchan in channel: task.ao_channels.add_ao_voltage_chan(subchan) stimuli.insert(i_channel, stimuli[i_channel]) stimuli.pop(i_channel) task.timing.cfg_samp_clk_timing(float(fs), samps_per_chan=len(stimuli[0])) if len(stimuli) > 1: stimulus = stimuli[0] for s in stimuli[1:]: stimulus = np.vstack((stimulus, s)) else: stimulus = stimuli[0] task.write(stimulus) if wait_trigger: task.triggers.start_trigger.cfg_dig_edge_start_trig("/Dev1/PFI0", trigger_edge=nidaqmx.constants.Edge.RISING) task.start() if camera: for camera in self.cameras: camera.send_command('ready') task.wait_until_done(timeout=(len(stimuli[0])/fs)*1.5+20) def send_trigger(self): ''' Sending trigger. ''' chan = self.dynamic_parameters.get('trigger_out_channel', None) if nidaqmx is None: print(f' pretending to send trigger on chan {chan}') return None if chan: with nidaqmx.Task() as task: task.ao_channels.add_ao_voltage_chan(chan) task.timing.cfg_samp_clk_timing(1000., samps_per_chan=4) task.write(self.trigger_signal) task.start() task.wait_until_done(timeout=1.) else: print('trigger_out_channel not specified, no trigger out') self.triggered_anglepairs.append(self.reader.get_latest()) def set_led(self, device, value, wait_trigger=False, exclude=None): ''' Set an output channel to a specific voltage value. INPUT ARGUMENTS DESCRIPTION device A string (single device) or a list of strings (many devices at once) ''' if nidaqmx is None: print(f' pretending to set {device} on value {value}') return None excluded = 0 with nidaqmx.Task() as task: if type(device) == type('string'): # If there's only a single device task.ao_channels.add_ao_voltage_chan(device) else: # If device is actually a list of devices for dev in device: if exclude and dev in exclude: excluded += 1 continue task.ao_channels.add_ao_voltage_chan(dev) value = [value for i in range(len(device)-excluded)] if wait_trigger: task.timing.cfg_samp_clk_timing(10000) task.triggers.start_trigger.cfg_dig_edge_start_trig("/Dev1/PFI0", trigger_edge=nidaqmx.constants.Edge.FALLING) task.write(value) def wait_for_trigger(self): ''' Doesn't return until trigger signal is received. ''' if nidaqmx is None: print(f' waiting for trigger') return None with nidaqmx.Task() as task: device = nidaqmx.system.device.Device('Dev1') task.ai_channels.add_ai_voltage_chan('Dev1/ai0' ) task.timing.cfg_samp_clk_timing(10000) task.triggers.start_trigger.cfg_dig_edge_start_trig("/Dev1/PFI0", trigger_edge=nidaqmx.constants.Edge.RISING) task.read(number_of_samples_per_channel=1) # # IMAGING METHODS # def take_snap(self, save=False): ''' Takes a snap image. save Whether to save the image directly or not. ''' if save: self.set_led(self.dynamic_parameters['ir_channel'], self.dynamic_parameters['ir_imaging']) time.sleep(0.3) for camera in self.cameras: camera.acquireSingle(True, os.path.join(self.preparation['name'], 'snaps')) self.set_led(self.dynamic_parameters['ir_channel'], self.dynamic_parameters['ir_livefeed']) time.sleep(0.2) print('A snap image taken') else: if self.pause_livefeed: return for camera in self.cameras: camera.acquireSingle(False, '') time.sleep(0.1) def image_trigger_softhard(self): '''Software triggering of the cameras. How this works? CameraClient (self.camera) send message to CameraServer to start image acquisition. Starting image acquistion takes some time, so to synchronize, we wait a trigger signal from the camera before turning the LED on. What is done is essentially half software half hardware triggering. Not ideal but seems to work. ''' self.set_led(dynamic_parameters['ir_channel'], dynamic_parameters['ir_imaging']) time.sleep(0.5) # Subfolder suffix so if experimenter takes many images from the same position in different conditions self.camera.acquireSeries(frame_length, 0, N_frames, label, os.path.join(self.preparation['name'], 'pos{}_{}'.format(imaging_angle, dynamic_parameters['suffix']+self.suffix)), 'send') self.wait_for_trigger() time.sleep(dynamic_parameters['pre_stim']) self.set_led(dynamic_parameters['flash_channel'], dynamic_parameters['flash_on'][i]) time.sleep(dynamic_parameters['stim']) self.set_led(dynamic_parameters['flash_channel'], dynamic_parameters['flash_off']) time.sleep(dynamic_parameters['post_stim']) self.set_led(dynamic_parameters['ir_channel'], dynamic_parameters['ir_waiting']) def image_trigger_hard_cameraslave(self): ''' Where camera is triggered by square wave. Since the camera cannot be run this way at 100Hz at full frame, image_series3 is used instead. ''' fs = 1000 stimulus, illumination, camera = get_pulse_stimulus(dynamic_parameters['stim'], dynamic_parameters['pre_stim'], dynamic_parameters['post_stim'], dynamic_parameters['frame_length'], dynamic_parameters['flash_on'][i], dynamic_parameters['ir_imaging'], fs, stimulus_finalval=dynamic_parameters['flash_off'], illumination_finalval=dynamic_parameters['ir_waiting']) self.camera.acquireSeries(frame_length, 0, N_frames, label, os.path.join(self.preparation['name'], 'pos{}{}'.format(imaging_angle, dynamic_parameters['suffix']+self.suffix)), 'receive') time.sleep(5) self.analog_output([dynamic_parameters['flash_channel'], dynamic_parameters['ir_channel'], dynamic_parameters['trigger_channel']], [stimulus, illumination, camera], fs) def image_series(self, trigger='hard_cameramaster', inter_loop_callback=None): ''' Contains common steps for all image_series methods. triggering_type "softhard", "hard_cameraslave", "hard_cameramaster" Returns True if finished properly and False if user cancelled. ''' exit_imaging = False print('Starting dynamic imaging using {} triggering'.format(trigger)) if trigger == 'softhard': imaging_function = self.image_trigger_softhard elif trigger == 'hard_cameraslave': imaging_function = self.image_trigger_hard_cameraslave elif trigger == 'hard_cameramaster': imaging_function = self.image_trigger_hard_cameramaster # Wait ISI period here, if it has not passed since the last series imaging # Otherwise, continue. try: if time.time() < self.isi_slept_time: print('Waiting ISI to be fullfilled from the last run...') time.sleep(self.isi_slept_time - time.time()) print('READY') except AttributeError: pass dynamic_parameters = copy.deepcopy(self.dynamic_parameters) # Check that certain variables are actually lists (used for intensity series etc.) # Check also for correct length if a list for param in ['isi', 'flash_on']: if type(dynamic_parameters[param]) != type([]): dynamic_parameters[param] = [dynamic_parameters[param]] * dynamic_parameters['repeats'] elif len(dynamic_parameters[param]) != int(dynamic_parameters['repeats']): print('Warning! Dynamic parameter {} length is {} but repeats is set to {}'.format(param, len(dynamic_parameters[param]), dynamic_parameters['repeats'] )) dynamic_parameters[param] = [dynamic_parameters[param][0]] * dynamic_parameters['repeats'] # Set stack save option for camera in self.cameras: camera.set_save_stack(dynamic_parameters.get('save_stack', False)) # Get the current rotation stage angles and use this through the repeating # (even if it would change during imaging) imaging_angle = self.reader.get_latest() spaceless_angle = str(imaging_angle).replace(' ', '') # Prepare some variables that stay constant over imaging image_directory = os.path.join(self.preparation['name'], 'pos{}{}'.format(spaceless_angle, dynamic_parameters['suffix']+self.suffix)) N_frames = int((dynamic_parameters['pre_stim']+dynamic_parameters['stim']+dynamic_parameters['post_stim'])/dynamic_parameters['frame_length']) for i in range(dynamic_parameters['repeats']): label = 'im_pos{}_rep{}'.format(spaceless_angle, i) # INTER_LOOP_CALLBACK for showing info to the user and for exiting if callable(inter_loop_callback) and inter_loop_callback(label, i) == False: exit_imaging = True if exit_imaging: break fs = 1000 builder = StimulusBuilder(dynamic_parameters['stim'], dynamic_parameters['pre_stim'], dynamic_parameters['post_stim'], dynamic_parameters['frame_length'], dynamic_parameters['flash_on'][i], dynamic_parameters['ir_imaging'], fs, stimulus_finalval=dynamic_parameters['flash_off'], illumination_finalval=dynamic_parameters['ir_waiting'], wtype=dynamic_parameters['flash_type']) if dynamic_parameters.get('biosyst_stimulus', ''): bsstim, fs = builder.overload_biosyst_stimulus(dynamic_parameters['biosyst_stimulus'], dynamic_parameters['biosyst_channel']) N_frames = int(round((len(bsstim)/fs) / dynamic_parameters['frame_length'])) if i==0 and dynamic_parameters['avgint_adaptation']: self.set_led(dynamic_parameters['flash_channel'], np.mean(builder.get_stimulus_pulse()), exclude='Dev1/ao4') time.sleep(dynamic_parameters['avgint_adaptation']) imaging_function(dynamic_parameters, builder, label, N_frames, image_directory, set_led=bool(dynamic_parameters['isi'][i])) if i==0 and dynamic_parameters['avgint_adaptation']: self.set_led(dynamic_parameters['flash_channel'], np.mean(builder.get_stimulus_pulse()), exclude='Dev1/ao4') # Dirtyfix if dynamic_parameters['reboot_cameras']: print("Rebooting cameras") for i_camera, camera in enumerate(self.cameras): print(f' cam_{i_camera}...') camera.reboot() # Wait the total imaging period; If ISI is short and imaging period is long, we would # start the second imaging even before the camera is ready # Better would be wait everything clear signal from the camera. #total_imaging_time = dynamic_parameters['pre_stim'] + dynamic_parameters['stim'] + dynamic_parameters['post_stim'] #print("Total imaging time " + str(total_imaging_time)) # Do the actual waiting together with ISI, see just below # WAITING ISI PERIOD if i+1 == dynamic_parameters['repeats']: self.isi_slept_time = time.time() + dynamic_parameters['isi'][i] else: wakeup_time = time.time() + dynamic_parameters['isi'][i] #+ total_imaging_time while wakeup_time > time.time(): if callable(inter_loop_callback) and inter_loop_callback(None, i) == False: exit_imaging = True break time.sleep(0.01) self.set_led(dynamic_parameters['flash_channel'], dynamic_parameters['flash_off']) self.set_led(dynamic_parameters['ir_channel'], dynamic_parameters['ir_livefeed']) print('DONE!') if exit_imaging: return False else: return True def image_trigger_hard_cameramaster(self, dynamic_parameters, builder, label, N_frames, image_directory, set_led=True): ''' When starting the imaging, the camera sends a trigger pulse to NI board, leading to onset of the stimulus (hardware triggering by the camera). Illumination IR light is hardware triggered together with the stimulus. set_led Set IR to ir_waiting in between (if long enough ISI) ''' if set_led: self.set_led(dynamic_parameters['ir_channel'], dynamic_parameters['ir_imaging']) time.sleep(0.5) fs = builder.fs stimulus = builder.get_stimulus_pulse() if isinstance(stimulus, list): NN = len(stimulus[0]) else: NN = stimulus.shape irwave = dynamic_parameters['ir_imaging'] * np.ones(NN) #irwave = dynamic_parameters['ir_imaging'] * np.ones(stimulus.shape) if set_led: irwave[-1] = dynamic_parameters['ir_waiting'] stimuli = [] channels = [] if isinstance(stimulus, list): # Many stimulus channels print('Many stimulus channels') stimuli = [*stimulus, irwave] channels = [*dynamic_parameters['flash_channel'], dynamic_parameters['ir_channel']] else: # One stimulus channel stimuli = [stimulus, irwave] channels = [dynamic_parameters['flash_channel'], dynamic_parameters['ir_channel']] # Arm analog input recording if any vio clients for i_vio, vio in enumerate(self.vios): vio.set_save_directory(os.path.join(self.data_savedir, image_directory)) duration = N_frames * dynamic_parameters['frame_length'] vio_label = f'vi{i_vio}{label[2:]}' vio.analog_input(duration, save=vio_label, wait_trigger=True) if len(self.cameras) == 1: self.cameras[0].acquireSeries(dynamic_parameters['frame_length'], 0, N_frames, label, image_directory) elif len(self.cameras) > 1: # With many cameras, add camN suffix to the label for i_camera, camera in enumerate(self.cameras): camera.acquireSeries(dynamic_parameters['frame_length'], 0, N_frames, f'{label}_cam{i_camera}', image_directory) # If no cameras, we should not wait for trigger to come from them. # Create own trigger on the trigger channel if not self.cameras: wait_trigger = False trigwave = np.zeros(len(stimuli[0])) for i in range(min(100, len(trigwave))): trigwave[i] = 5 stimuli = [*stimuli, trigwave] channels = [*channels, dynamic_parameters['trigger_out_channel']] else: wait_trigger = True self.analog_output(channels, stimuli, fs, wait_trigger=wait_trigger) def set_savedir(self, savedir, camera=True): ''' Set the directory where the taken images are saved. camera : bool If False, do not attempt to update save folder to the camera server ''' if camera: for device in self.cameras+self.vios: device.set_save_directory(savedir) self.data_savedir = savedir def set_subfolder_suffix(self, suffix): ''' Set any suffix to a data folder containing the images. For example pos(-14,0) would become pos(-14,0)_highmag if suffix == "highmag" ''' if suffix: self.suffix = '_'+suffix else: self.suffix = '' def _update_descriptions_file(self): # Saving description file desc_string = "name {}\nsex {}\nage {}".format(self.preparation['name'], self.preparation['sex'], self.preparation['age']) desc_string += "\n\n#DYNAMIC PROTOCOL PARAMETERS\n" for name, value in self.dynamic_parameters.items(): desc_string += '{} {}\n'.format(name, value) for camera in self.cameras: camera.saveDescription(self.preparation['name'], desc_string) def initialize(self, name, sex, age, camera=False, libui=None): '''Call this to initialize the experiments. Returns True if worked or None if user cancelled. name, sex age Can be '' (empty string) ''' # Preparations, ask droso name if name != '': self.preparation['name'] = name if sex != '': self.preparation['sex'] = sex if age != '': self.preparation['age'] = age params = getModifiedParameters(libui) if params is None: return None self.dynamic_parameters = params if camera: self._update_descriptions_file() else: self.triggered_anglepairs = [] self.set_led(self.dynamic_parameters['ir_channel'], self.dynamic_parameters['ir_livefeed']) self.set_led(self.dynamic_parameters['flash_channel'], self.dynamic_parameters['flash_off']) roi = self.dynamic_parameters['ROI'] if roi is not None: for camera in self.cameras: camera.set_roi(roi) return True def load_preset(self, preset_name): fn = os.path.join('presets', preset_name) self.dynamic_parameters = load_parameters(fn) self._update_descriptions_file() def tick(self, horizontal_trigger=True, vertical_trigger=False): '''Updates the current angle and performs all "houskeeping" duties also. Meant to be called repeatedly inside the UI loop. ''' change = False if self.vio_livefeed: if time.time()-self._last_vio > max(self.vio_livefeed_dur+0.1, 0.1): for vio in self.vios: vio.analog_input(self.vio_livefeed_dur) self._last_vio = time.time() while True: # Update current angle and echo it to the console current_angle = [list(self.reader.read_angles())] toDegrees(current_angle) if self.previous_angle != current_angle: horchanged = self.previous_angle and self.previous_angle[0][0] != current_angle[0][0] verchanged = self.previous_angle and self.previous_angle[0][1] != current_angle[0][1] if (horizontal_trigger and horchanged) or (vertical_trigger and verchanged): self.trigger_rotation = True print("Horizontal-vertical is {}".format(current_angle[0])) self.previous_angle = current_angle change = True else: break if not change: self.trigger_rotation = False # Run macro if set if self.macro: next_macro_step = False action = self.macro[self.i_macro] print(action) if type(action) == type((0,0)): # Move motors only if they have reached their positions if self.motors and all([self.motors[i].reached_target() for i in [0,1]]): self.motors[0].move_to(action[0]) self.motors[1].move_to(action[1]) next_macro_step = True if 'wait' in action: self.waittime = time.time() + float(action.split(' ')[-1]) next_macro_step = True if next_macro_step and self.waittime < time.time(): self.i_macro += 1 if self.i_macro == len(self.macro): self.macro = None self.i_macro = 0 def set_zero(self): ''' Define the current angle pair as the zero point (Like tar button on scales) ''' self.reader.current_as_zero() def finalize(self): ''' Finalising the experiments, houskeeping stuff. ''' self.set_led(self.dynamic_parameters['ir_channel'], 0) self.set_led(self.dynamic_parameters['flash_channel'], 0) for motor in self.motors: motor.move_to(0) if self.triggered_anglepairs: fn = os.path.join(self.data_savedir, self.preparation['name'], 'anglepairs.txt') os.makedirs(os.path.dirname(fn), exist_ok=True) print(fn) with open(fn, 'w') as fp: for line in self.triggered_anglepairs: fp.write(str(line).strip('()').replace(' ', '')+'\n') self.triggered_anglepairs = None def exit(self): for camera in self.cameras: camera.close_server() # # CONTROLLING LEDS, MOTORS ETC # def move_motor(*args, **kwargs): self.reader.move_motor(*args, **kwargs) # # PROTOCOL QUEUE / MACRO # @staticmethod def list_macros(): return macro.list_macros() def run_macro(self, macro_name): self.macro = macro.load(macro_name) self.i_macro = 0Static methods
def list_macros()
Methods
def add_camera_client(self, host, port)def add_vio_client(self, host, port)def analog_output(self, channels, stimuli, fs, wait_trigger, camera=True)-
channels List of channel names stimuli List of 1D numpy arrays fs Sampling frequency of the stimuli camera : bool If True, send the camera server a "ready" command
def exit(self)def finalize(self)-
Finalising the experiments, houskeeping stuff.
def image_series(self, trigger='hard_cameramaster', inter_loop_callback=None)-
Contains common steps for all image_series methods.
triggering_type "softhard", "hard_cameraslave", "hard_cameramaster"
Returns True if finished properly and False if user cancelled.
def image_trigger_hard_cameramaster(self, dynamic_parameters, builder, label, N_frames, image_directory, set_led=True)-
When starting the imaging, the camera sends a trigger pulse to NI board, leading to onset of the stimulus (hardware triggering by the camera).
Illumination IR light is hardware triggered together with the stimulus.
set_led Set IR to ir_waiting in between (if long enough ISI)
def image_trigger_hard_cameraslave(self)-
Where camera is triggered by square wave. Since the camera cannot be run this way at 100Hz at full frame, image_series3 is used instead.
def image_trigger_softhard(self)-
Software triggering of the cameras.
How this works? CameraClient (self.camera) send message to CameraServer to start image acquisition. Starting image acquistion takes some time, so to synchronize, we wait a trigger signal from the camera before turning the LED on. What is done is essentially half software half hardware triggering. Not ideal but seems to work.
def initialize(self, name, sex, age, camera=False, libui=None)-
Call this to initialize the experiments.
Returns True if worked or None if user cancelled.
name, sex age Can be '' (empty string)
def load_preset(self, preset_name)def move_motor(*args, **kwargs)def remove_camera_client(self, client)-
Removes a camera client and closes its server if local server
Arguments
client:objectorint- Index of the client in self.cameras or the CameraClient object to be removed
def remove_vio_client(self, client)-
Removes the vio client and closes its server if local server
Arguments
client:objectorint- Index of the client in self.vios or the VIOClient object to be removed
def run_macro(self, macro_name)def send_trigger(self)-
Sending trigger.
def set_led(self, device, value, wait_trigger=False, exclude=None)-
Set an output channel to a specific voltage value.
INPUT ARGUMENTS DESCRIPTION device A string (single device) or a list of strings (many devices at once)
def set_savedir(self, savedir, camera=True)-
Set the directory where the taken images are saved.
camera : bool If False, do not attempt to update save folder to the camera server
def set_subfolder_suffix(self, suffix)-
Set any suffix to a data folder containing the images. For example pos(-14,0) would become pos(-14,0)_highmag if suffix == "highmag"
def set_zero(self)-
Define the current angle pair as the zero point (Like tar button on scales)
def take_snap(self, save=False)-
Takes a snap image.
save Whether to save the image directly or not.
def tick(self, horizontal_trigger=True, vertical_trigger=False)-
Updates the current angle and performs all "houskeeping" duties also.
Meant to be called repeatedly inside the UI loop.
def wait_for_trigger(self)-
Doesn't return until trigger signal is received.