figureflow.figure_panel.FigurePanel.add_timestamp

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

Add timestamp text to each image in panel. timestamps MUST be added after other annotations were added to the figure. Otherwise the timestamp might be cut off.

Parameters:

• time_per_frame – how much frame is between frames, add as string with unit (s, sec, m, min or h) after number

• start_time – what frame-frame does number 1 equal (start at negative value positive to indicate it was before e.g. a treatment)

• 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)

• position – define where the timestamp should be added set as “first_dimension-second dimension” - e.g. “bottom-left” or “top-right”

• font_size – font size of timestamp label

• padding – padding of timestamp from edges of image in inches