expyriment.io.extras.TbvNetworkInterface¶

class expyriment.io.extras.TbvNetworkInterface(host, port, timeout=None, connect=None)[source]¶

A class implementing a network interface to Turbo Brain Voyager.

See http://www.brainvoyager.com/products/turbobrainvoyager.html for more information.

Methods

__init__(host, port, timeout=None, connect=None)[source]¶: Create a TbvNetworkInterface.

close()[source]¶: Close the connection.

connect()[source]¶: Connect to the TBV server.

get_all_coords_of_voxels_of_roi(roi)[source]¶

Get coordinates for all voxels for a ROI.

roi : int: The ROI.

get_beta_maps()[source]¶: Get the beta maps.

get_beta_of_roi(roi, beta)[source]¶

Get the value of a beta of a ROI.

roi : int: The ROI.
beta : int: The beta.

get_beta_of_voxel(beta, coords)[source]¶

Get a specific beta value of a voxel.

beta : int: The beta.
coords : list: The coordinates of the voxel. [x, y, z]

get_contrast_maps()[source]¶: Get the contrast maps.

get_coord_of_voxel_of_roi(roi, voxel)[source]¶

Get the coordinates of a voxel of a ROI.

roi : int: The ROI.
voxel : int: The voxel.

get_current_classifier_output()[source]¶: Get the current classifier output.

get_current_nr_of_predictors()[source]¶: Get the current number of predictors.

get_current_protocol_condition()[source]¶: Get the current protocol condition.

get_current_time_point()[source]¶: Get the current time point.

get_dims_of_functional_data()[source]¶: Get the dimensions of the functional data.

get_existing_means_of_roi(roi, to_time_point)[source]¶

Get the existing means of a ROI.

roi : int: The ROI.
to_time_point : int: Get all the means up to this point.

get_expected_nr_of_time_points()[source]¶: Get the expected number of time points.

get_feedback_folder()[source]¶: Get the feedback folder.

get_full_nr_of_predictors()[source]¶: Get the full number of predictors.

get_map_value_of_voxel(map, coords)[source]¶

Get a specific map value of a voxel.

map : int: The map.
coords : list: The coordinates of the voxel. [x, y, z]

get_mean_of_roi(roi)[source]¶: Get the mean of a ROI.

get_mean_of_roi_at_time_point(roi, time_point)[source]¶

Get the mean of a ROI at a time point.

roi : int: The ROI.
time_point : int: The time point.

get_nr_of_confound_predictors()[source]¶: Get the number of confound predictors.

get_nr_of_contrasts()[source]¶: Get the number of contrasts.

get_nr_of_rois()[source]¶: Get the number of ROIs.

get_nr_of_voxels_of_roi(roi)[source]¶: Get the number of voxels of a ROI.

get_number_of_classes()[source]¶: Get the number of classes.

get_project_name()[source]¶: Get the project name.

get_raw_value_of_all_voxels_at_time(time_point)[source]¶

Get the raw value of all voxels at a certain time point.

time_point : int: The time point.

get_target_folder()[source]¶: Get the target folder.

get_value_of_all_voxels_at_time(time_point)[source]¶

Get the value of all voxels at a certain time point.

time_point : int: The time point.

get_value_of_design_matrix(pred, time_point)[source]¶

Get the value of the design matrix.

pred : int: The predictor.
time_point : int: The time point.

get_value_of_voxel_at_time(coords, time_point)[source]¶

Get the value of a voxel at a certain time point.

coords : list: The coordinates of the voxel. [x, y, z]
time_point : int: The time point.

get_watch_folder()[source]¶: Get the watch folder.

host¶: Getter for host.

is_connected¶: Getter for is_connected.

logging¶: Getter for logging.

port¶: Getter for port.

request_data(request, *args)[source]¶: Request data from Turbo Brain Voyager.

set_logging(onoff)¶

Set logging of this object on or off

Parameters:

onoff : bool

set logging on (True) or off (False)

Notes

See also design.experiment.set_log_level fur further information about event logging.

tbv_plugin_version¶: Getter for tbv_plugin_version.

timeout¶: Getter for timeout.