roi

class sunpy.roi.roi(times=None, description=None, source=None)[source] [edit on github]

Bases: object

A generalized region of interest (ROI) object

Parameters:
  • times (list (optional)) – A list of 1 or 2 parse_time-readable times
  • description (str (optional)) – A text description of the ROI
  • source (str (optional)) – A description of where this ROI comes from (e.g. the instrument, ‘RHESSI’, ‘LYRA LYTAF’)
start_time
Type:datetime object containing the start time of the ROI
end_time
Type:datetime object containing the end time of the ROI
description

(e.g. ‘attenuator change’, ‘LAR’, ‘SAA’, ‘flare’)

Type:A string descriptor of the ROI event type
source
Type:A string descriptor of the ROI source (e.g. ‘LYRA’, ‘RHESSI’)
time_range()[source] [edit on github]

Return a time range object from the start and end times of the ROI

Examples

>>> from sunpy.roi import roi
>>> result = roi(times=['2011-02-15 04:34:09','2011-02-15 04:48:21'], description='UV occult.',source='LYRA LYTAF')
>>> result = roi(times='2013-05-12 03:12:00')

Methods Summary

time_range() Returns a TimeRange using the start and end times

Methods Documentation

time_range()[source] [edit on github]

Returns a TimeRange using the start and end times