figureflow.figure_panel.FigurePanel.label_frames

figureflow.figure_panel.FigurePanel.label_frames = <function FigurePanel.label_frames>

Label a category (images, channels, frames or slices; also _subs).

Parameters:

  • texts – Text that should be used as labels; should match the number of different values in the defined category Same labels that are adjacent are only labeled once across all affected images

  • site – String of site at image grid at which labels should be adde (“top”, “bottom”, “left” or “right”). Depending on the dimension (columns or rows) in which the category is, top/bottom (for columns) might is better for left/right (for rows).

  • label_sub_remapped – Whether the new image numbers after remapped accoding to defined _sub categories should be used (if True) or whether original image numbers should be used (if False)

  • font_size – font_size of labels; if None default for figure_panel will be used

  • padding – Padding in pt of labels from images

  • font_size_factor – Factor by which the default font_size should be scaled to obtain font size for labels

  • label_orientation – “hor” or “vert” default is horizontal for “top” and “bottom” site and vertical for “left” and “right” site

  • start_time – number of first timeframe

  • time_per_frame – string of number and unit (“m” for min, “h” for hour, or “s” for second) for time difference between frames

  • format – format of how time should be displayed. The number of letter indicates the number of digits in that category. Possible categories are “s” for seconds, “m” for minutes or “h” for hours.

  • show_unit – Whether to show unit name in the label of the time

  • first_time_difference – Difference of timesteps from first to second frame (helpful if after a first frame there was an imaging break, longer than the normal time between frames)

  • frame_jumps – Dictionary with keys being timepoint before which timejumps happened and values being number of frames that the jump was long (e.g. {4: 2, 10:20} for a timejump of 2 timeframes before timeframe 5 and a timejump of 20 timeframes before timeframe 11)

  • long_unit_names – Whether to use long unit names (“min” instead of “m”, “hour” instead of “h” and “sec” instead of “s”).

  • all_units_shown – Whether to show the unit name of the first unit in the format (e.g. “h” for “hh:mm) (if False) or both unit names separated by “:” (if True)