entry_exit_mouse_box package

Submodules

entry_exit_mouse_box.mask_from_video module

class entry_exit_mouse_box.mask_from_video.MaskFromBackground(input_video_path, output_video_path, ref, tr=75, st={}, r=None, frame_count=64)

Bases: object

add_frames_to_video(frames)

process_frames(batch, frames)

read_frames()

release_resources()

start_processing(num_workers=16)

worker()

class entry_exit_mouse_box.mask_from_video.QtWorkerMFV(in_path, out_path, ref, t, s, r)

Bases: QObject

mask_ready

run()

entry_exit_mouse_box.measures module

class entry_exit_mouse_box.measures.MiceVisibilityProcessor(mask_path, areas, ma, start, duration)

Bases: object

Calculates an array indicating for each box (designated by the labels in ‘areas’) if a mouse is inside or not. The process is realized on several threads. The input video was saved as a mask (0=BG, 255=FG) but it requires thresholding anyway due to compression. The areas are a grayscale image with one value per box (0=BG). To process the presence of a mouse, we use the length of the ellipse fitted to the mouse’s label. It requires the input image to be calibrated. The process doesn’t start from the frame 0 but from the frame ‘start’. We don’t need a control structure to write in the buffer as the threads are not writing in the same place.

fix_visibility()

process_n_in_out()

process_sessions()

We call ‘session’ the span of time during which the mouse is hidden or visible. For each box, a video is a succession of sessions, alternating between hidden and visible. During a session, the mouse is either hidden or visible. A session is defined by a duration (in seconds) and a distance (in pixels).

process_visibility_pos(batch, frames)

read_frames(frames_count=32)

release_resources()

smooth_centroids()

start_processing(num_workers=4)

worker()

class entry_exit_mouse_box.measures.QtWorkerMVP(mask_path, areas, ma, start, duration)

Bases: QObject

measures_ready

run()

entry_exit_mouse_box.measures.calculate_maximal_length(mask)

entry_exit_mouse_box.media_manager module

class entry_exit_mouse_box.media_manager.MediaManager(viewer)

Bases: object

add_source(file_path, target_layer, img_type, process=None)

Add a new video source to the manager.

Parameters:

• file_path – Path of the video file to be opened.

• target_layer – Name of the layer to which each frame of the video will be loaded.

• img_type – Type of the image to be loaded (‘image’ or ‘labels’).

• process – Function to be applied to each frame of the video before displaying it.

Raises:

• FileNotFoundError – If the file is not found at the specified path.

• IOError – If the file cannot be opened.

• ValueError – If the properties of the video do not match the properties of the media already opened.

Returns:

The properties of the last video added under the form of a dictionary.

get_current_frame_number()

get_fps()

get_height()

get_n_frames()

get_n_sources()

get_source_by_index(index)

get_source_by_name(name)

get_video_properties()

get_width()

release()

release_source(index)

set_frame(frame_target)

set_logger(logger)

entry_exit_mouse_box.media_manager.properties_match(p1, p2)

entry_exit_mouse_box.results_table module

class entry_exit_mouse_box.results_table.FrameWiseResultsTable(data, parent=None)

Bases: ResultsTable

set_data(data)

class entry_exit_mouse_box.results_table.ResultsTable(data, name='Data Table', parent=None)

Bases: QMainWindow

export_data()

export_table_to_csv(tableWidget: QTableWidget, filename: str)

init_ui()

set_data(data)

set_exp_name(name)

class entry_exit_mouse_box.results_table.SessionsResultsTable(data, parent=None)

Bases: ResultsTable

set_data(data)

entry_exit_mouse_box.results_table.main_sessions()

entry_exit_mouse_box.results_table.read_names(f_path)

entry_exit_mouse_box.utils module

entry_exit_mouse_box.utils.apply_lut(tags, to_pass, classes)

tags: Layer that will receive the LUT. to_pass: List of gray levels to which we will have to bind a color. classes: Dictionary of colors to bind to the gray levels.

entry_exit_mouse_box.utils.cast_to_pixels(unit_str_src, length_float_src, unit_str_tgt, scale_tgt)

Converts a length from its unit to the viewer’s unit and then to pixels.

Args: - unit_str_src: str The unit of the length to convert (ex: the pillar’s unit). - length_float_src: float The length to convert (ex: the diameter of the pillar). - unit_str_tgt: str The unit of the viewer (ex: the calibration unit). - scale_tgt: float The scale factor to convert the length to pixels (the calibration of the scalebar).

Returns: - int The length in pixels.

entry_exit_mouse_box.utils.merge_close_points(path, min_distance, dot_threshold=-0.7)

Merge points in a 2D path that are closer than a specified minimum distance. Points are merged into their average position. The operation preserves the path order and does not merge non-consecutive points if the path crosses over itself.

Parameters: - path: A list or numpy array of 2D points (e.g., [[x1, y1], [x2, y2], …]). - min_distance: The minimum allowed distance between consecutive points.

Returns: - A new list of points with no consecutive points closer than the minimum distance.

entry_exit_mouse_box.utils.setup_logger(file_path)

entry_exit_mouse_box.utils.smooth_path_2d(points, window_size=3)

Smooth a path of 2D points using a simple moving average with a sliding window.

Parameters: - points: A NumPy array of 2D points, shape (n_points, 2). - window_size: The size of the sliding window for the moving average.

Returns: - A NumPy array of the smoothed 2D points.

entry_exit_mouse_box.video_mean_processor module

class entry_exit_mouse_box.video_mean_processor.QtWorkerVMP(video_path, shape)

Bases: QObject

bg_ready

run()

class entry_exit_mouse_box.video_mean_processor.VideoMeanProcessor(video_path, shape)

Bases: object

process_frames(frames)

read_frames(frames_count=32)

release_resources()

start_processing(num_workers=16)

worker()

Module contents

class entry_exit_mouse_box.MediaManager(viewer)

Bases: object

add_source(file_path, target_layer, img_type, process=None)

Add a new video source to the manager.

Parameters:

• file_path – Path of the video file to be opened.

• target_layer – Name of the layer to which each frame of the video will be loaded.

• img_type – Type of the image to be loaded (‘image’ or ‘labels’).

• process – Function to be applied to each frame of the video before displaying it.

Raises:

• FileNotFoundError – If the file is not found at the specified path.

• IOError – If the file cannot be opened.

• ValueError – If the properties of the video do not match the properties of the media already opened.

Returns:

The properties of the last video added under the form of a dictionary.

get_current_frame_number()

get_fps()

get_height()

get_n_frames()

get_n_sources()

get_source_by_index(index)

get_source_by_name(name)

get_video_properties()

get_width()

release()

release_source(index)

set_frame(frame_target)

set_logger(logger)

class entry_exit_mouse_box.MouseInOutWidget(napari_viewer: Viewer)

Bases: QWidget

add_calibration_ui()

add_media_control_ui()

add_row()

add_tracking_ui()

add_video_control_ui()

apply_calibration()

background_ready

build_labels_from_polygon()

calibrate_results()

Applies the calibration to the distance traveled by the mice, stored in the sessions table.

clear_state()

Resets the state of the widget to its initial state.

create_temp_dir(root=None)

dump_table()

Dumps the content of the table in a dictionary.

duration_to_frames()

experiment_duration_ui()

export_results()

extract_classes()

extract_measures()

hide_paths(state)

init_ui()

jump_backward()

jump_forward()

launch_mask_processing()

launch_tracking()

make_start_frame(row, button)

Sets the frame at which we start measures from the current frame being displayed. The saved index is the one displayed on the screen. (The real one + 1). A source is required before we can set the start frame.

measures_ready

on_slider_change(value)

on_spinbox_change(value)

on_table_item_changed(item)

Called when the user modifies an existing line of the table containing the colors and names of the boxes. The new name is processed here before it is provided by the user. Both the layer’s name and the box’s name are updated.

on_threshold_update(value)

Creates a preview layer showing what the mask would be for the current frame for a given threshold. Updates are made only when the threshold is edited. The background reference is required. The produced layer is named ‘threshold_preview’ and is temporary, it will be discarded. This function is the callback for the threshold spinbox.

Parameters:

value – int - The threshold value to use for the preview.

remove_row()

select_color(row, button, k=None)

select_file()

set_calibration(pixelSize, unit)

set_frame(n)

set_media(file_path)

set_min_area()

Uses a polygon drawn by the user over the head of a mouse to define the minimal area to consider that a mouse is present. When summoned, this function must find a shape layer as the active layer, and extract the area of the polygon. The shape layer is then deleted. The value extracted is not stored, it is written in the spinbox.

start_extract_background()

switch_log_file(new_file_name)

Creates a new log file when we switch to a new experiment video.

terminate_extract_background(ref, src_path)

terminate_mask_processing(mask_path)

terminate_measures(visibility, in_out_count, sessions, centroids)

toggle_inputs(t)

Used to disable the inputs (buttons and text fields) when a long process is running.

Parameters:

t – bool - True to enable the inputs, False to disable them.

tracking_ready

update_boxes()

update_calibration(event)

update_centroids()

update_face_color()

update_mice_path()

update_playback_info()

class entry_exit_mouse_box.QtWorkerMFV(in_path, out_path, ref, t, s, r)

Bases: QObject

mask_ready

run()

class entry_exit_mouse_box.QtWorkerMVP(mask_path, areas, ma, start, duration)

Bases: QObject

measures_ready

run()

class entry_exit_mouse_box.QtWorkerVMP(video_path, shape)

Bases: QObject

bg_ready

run()

class entry_exit_mouse_box.ResultsTable(data, name='Data Table', parent=None)

Bases: QMainWindow

export_data()

export_table_to_csv(tableWidget: QTableWidget, filename: str)

init_ui()

set_data(data)

set_exp_name(name)

entry_exit_mouse_box.napari_get_reader(path)

A basic implementation of a Reader contribution.

Parameters:

path (str or list of str) – Path to file, or list of paths.

Returns:

If the path is a recognized format, return a function that accepts the same path or list of paths, and returns a list of layer data tuples.

Return type:

function or None

entry_exit_mouse_box.setup_logger(file_path)