removed example (since the repo sort of already is one)

Author: m7r

events/choice.py

@@ -0,0 +1,252 @@
+## Python Standard Library
+import sys
+import os
+import random
+import csv
+
+## External Dependencies
+from psychopy import core, gui, visual, event
+
+## Internal Dependencies
+sys.path.append(os.path.abspath(os.path.join(__file__, '..')))
+import event_utils
+
+
+
+##__Forced Choice Phase
+def run(
+	stimuli,
+	labels = None,
+	randomize_presentation = True,
+
+	supervised = True, # this determines whether participants recieve feedback
+	num_blocks = 1,
+
+	experiment_id = 'experiment',
+	phase_id = 'forced_choice',
+	subject_info = None,
+	save_data = False,
+
+	window = None,
+
+	stim_position = [0,0],
+
+	fixation_symbol = '',
+
+	click_instructions_txt = 'Click a button to select the correct category.',
+	click_instructions_txt_color = [-1,-1,-1], 
+	click_instructions_position = [0, -120],
+
+	feedback_txt_position = [0, -90],
+	feedback_txt_color = [-1,-1,-1],
+	
+	continue_txt_position = [0, -145],
+	continue_txt_color = [-1,-1,-1],
+
+	response_btn_labels = None,
+	response_btn_ypos = -280,
+	response_btn_padding = 150,
+	response_btn_box_size = [160, 80],
+	response_btn_box_color = [.5, .8, .5],
+	response_btn_txt_size = 22,
+	response_btn_txt_font = 'Consolas',
+	response_btn_txt_color = [-1,-1,-1],
+
+	quit_keys = ['escape'],
+	debug_mode = False,
+):
+
+	# Initialize Main Psychopy win if one isn't included
+	if window == None:
+		window = event_utils.build_window()
+
+	cursor = event.Mouse() # set initial cursor
+	timer = core.Clock()
+
+	if subject_info == None:
+		subject_info = {
+			'id': '0000',
+			'condition': 0,
+			'datafile_path': './subject_data.csv'
+		}
+
+	if (labels == None) & (supervised == True):
+		print(phase_id + ' is set to "supeprvised", but no labels were provided. quitting experiment.')
+		sys.exit()
+
+	if response_btn_labels == None:
+		if labels != None:
+			response_btn_labels = list(set(labels))
+		else:
+			response_btn_labels = ['no', 'labels', 'provided']
+
+
+	## Prepare Stimuli and Text Objects
+	object_bin = {} 
+	
+	object_bin['stim'] = visual.ImageStim(
+		window,
+		pos = stim_position,
+		name = 'image_stim',
+		interpolate = True,
+	)
+	
+	object_bin['response_btns'] = event_utils.make_button_row(
+		window,    # psychopy win object (required argument)
+		labels = response_btn_labels, 
+		ypos = response_btn_ypos, 
+		padding = 100,  # this determines how far apart butons will be evenly placed
+		btn_box_size = response_btn_box_size, 
+		btn_box_color = response_btn_box_color, 
+		btn_txt_size = response_btn_txt_size,
+		btn_txt_color = response_btn_txt_color,
+		btn_txt_font = response_btn_txt_font,
+	)
+	
+	object_bin['click_msg'] = visual.TextStim(
+		window,
+		text = click_instructions_txt,
+		pos = click_instructions_position,
+		color = click_instructions_txt_color
+	)
+
+	object_bin['feedback_msg'] = visual.TextStim(
+		window,
+		pos = feedback_txt_position,
+		color = feedback_txt_color,
+	)
+
+	object_bin['click_anywhere_msg'] = visual.TextStim(
+		window,
+		text = 'Click anywhere to continue...',
+		pos = continue_txt_position, 
+		color = continue_txt_color,
+	)
+
+
+	##__ Start Phase
+	trial_num = 0
+	accuracy = []
+	presentation_order = list(range(len(stimuli)))
+
+	for block in range(num_blocks):
+		if randomize_presentation == True:
+			random.shuffle(presentation_order)
+
+		for i in presentation_order:
+			
+			# set stimulus image
+			object_bin['stim'].setImage(stimuli[i])
+
+			# initially draw stimulus and response buttons
+			event_utils.draw_objects_in_bin(
+				window,
+				object_bin, 
+				object_list = ['stim', 'response_btns'],
+			)           
+
+			# wait some time
+			if debug_mode == False: core.wait(.77)
+
+			# draw click message
+			event_utils.draw_objects_in_bin(
+				window,
+				object_bin, 
+				object_list = ['stim', 'response_btns', 'click_msg'],
+			)
+
+			# wait some time
+			if debug_mode == False: core.wait(.35)
+
+			# wait for user to click a response button
+			response, rt = event_utils.wait_for_btn_response(cursor, timer, object_bin['response_btns'], quit_keys=quit_keys)
+
+			# check accuracy of subject's response
+			correct_category = labels[i]
+			if (supervised == True) & (correct_category != 'gen'):
+				hit = response == correct_category
+			else:
+				hit = 'gen'
+			accuracy.append(hit)
+
+			if supervised == True:
+				if response == correct_category:
+					object_bin['feedback_msg'].setText(correct_feedback + correct_category)
+				else:
+					object_bin['feedback_msg'].setText('Incorrect... This is a member of category: ' + correct_category)
+
+				# draw feedback message
+				event_utils.draw_objects_in_bin(
+					window,
+					object_bin, 
+					object_list = ['stim', 'response_btns', 'feedback_msg'],
+				)
+			else:
+				event_utils.draw_objects_in_bin(
+					window,
+					object_bin, 
+					object_list = ['stim', 'response_btns'],
+				)
+
+
+			if debug_mode == False: core.wait(1)
+			
+			# draw continue message
+			if supervised == True:
+				event_utils.draw_objects_in_bin(
+					window,
+					object_bin, 
+					object_list = ['stim', 'response_btns', 'feedback_msg', 'click_anywhere_msg'],
+				)
+
+			else:
+				event_utils.draw_objects_in_bin(
+					window,
+					object_bin, 
+					object_list = ['stim', 'response_btns', 'click_anywhere_msg'],
+				)
+
+			if debug_mode == False: core.wait(.35)
+
+			event_utils.wait_for_click_response(cursor, timer, quit_keys=quit_keys)
+
+			event_utils.draw_objects_in_bin(
+				window,
+				object_bin,
+				object_list = ['response_btns'],
+			)
+
+			if save_data == True:
+				subject_data = [
+					subject_info['id'],
+					phase_id,
+					subject_info['condition'],
+					block,
+					trial_num,
+					stimuli[i],
+					correct_category,
+					response,
+					hit,
+					rt,
+				]
+				with open(subject_info['datafile_path'], 'a') as file:
+					csv_object = csv.writer(file)
+					csv_object.writerow(subject_data)
+
+
+
+			# if early_finish_accuracy_criterion != None:
+			# 	if trial_num > minimum_trials:
+			# 		if sum(accuracy[-early_finish_lookback:]) / len(accuracy[-early_finish_lookback:]) >= early_finish_accuracy_criterion:
+			# 			return
+
+			trial_num = trial_num + 1
+
+
+
+
+
+
+
+
+

events/classification.py

@@ -171,7 +171,7 @@ def run(
 
 			if supervised == True:
 				if response == correct_category:
-					object_bin['feedback_msg'].setText('Correct! This is a member of category: ' + correct_category)
+					object_bin['feedback_msg'].setText(correct_feedback + correct_category)
 				else:
 					object_bin['feedback_msg'].setText('Incorrect... This is a member of category: ' + correct_category)