babysister.roi_manager module

class babysister.roi_manager.ROIManager

Bases: object

ROI managing routines.

default

ROI default data in {column: default} format.

Type:dict
classmethod add_default(roi_data)

Add default for non-existing column of roi_data.

Parameters:roi_data (dict) – ROI data in {column: value} format.
classmethod create_roi_data(values)

Return a roi_data with values in {column: value} format.

Parameters:values (list) – values in the same format as default.
default = {'h': None, 'id': None, 'w': None, 'x': None, 'y': None}
classmethod read_rois(rois_file, delimiter=', ', quotechar='"', quoting=2)

Returns ROIs data read from rois_file.

Parameters:
  • rois_file (str) – ROIs data file path.
  • delimiter (str) – delimiter.
  • quotechar (str) – quote char.
  • quoting (csv.QUOTE_xxx constant) – quoting instruction.
Returns:

ROIs data, with ROI format {column: value}.
Return type:

list of dict
classmethod select_rois(in_file, is_video=False, save_to='rois.csv', delimiter=', ', quotechar='"', quoting=2)

Select ROIs over an image or video file.

Parameters:
  • in_file (str) – input file path.
  • is_video (bool) – whether in_file is a video file.
  • save_to (str) – csv file path to save ROIs data to.
  • delimiter (str) – delimiter.
  • quotechar (str) – quote char.
  • quoting (csv.QUOTE_xxx constant) – quoting instruction.
classmethod select_rois_over_image(im, save_to, delimiter, quotechar, quoting)

Select ROIs over a ndarray image.

Parameters:
  • im (ndarray) – image to select ROIs over.
  • save_to (str) – csv file path to save ROIs data to.
  • delimiter (str) – delimiter.
  • quotechar (str) – quote char.
  • quoting (csv.QUOTE_xxx constant) – quoting instruction.