Method: Roi#time_to_display

Defined in:

lib/roi/roi.rb

#time_to_display(args = {}) ⇒ Object

Public: Measures the approximate time for the given Roi to be displayed.

Corresponds to: api_time_to_display_<ROI TYPE>

key - String key press to trigger evaluation (default: nil).

If default, no key will be pressed.

delay - Integer total milliseconds to delay before starting evaluation (default: 0). timeout - Integer total milliseconds to allow before timing out (default: nil).

If default, timeout will be calculated as [ delay + 5000 ].

scale - Boolean if the larger image should be scaled to the size of the smaller image (default: false).

Applies to image ROIs only.

expected - Boolean expected result of evaluation or Array of expected transition values (default: true). priority - Symbol evaluation priority used to throttle CPU usage (default: :normal):

:critical   - Sleep 10 ms between intensive tasks (USE SPARINGLY)
:high       - Sleep 100 ms between intensive tasks
:normal     - Sleep 1 second between intensive tasks
:low        - Sleep 10 seconds between intensive tasks
:background - Sleep 1 minute between intensive tasks (USE SPARINGLY)

log_every - Integer total milliseconds between logs (default: 1000). report - Boolean indicating whether to report measurements to ITMS (default: true).

Returns the Float total milliseconds for the ROI to be displayed.

# File 'lib/roi/roi.rb', line 187

def time_to_display(args={})
  logger.info("Measuring time to display #{self.class.name}")
  measure(args) do
    displayed?(:set_roi_options => args)
  end
end