roi

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

Bases: object

A generalized Region Of Interest (ROI) class.

Parameters
  • times (list, optional) – A list of 1 or 2 sunpy.time.parse_time readable times.

  • description (str, optional) – A text description of the ROI.

  • source (str, optional) – A description of of the source where this ROI comes from.

start_time

The start time of the ROI.

Type

astropy.time.Time

end_time

The end time of the ROI.

Type

astropy.time.Time

description

A string descriptor of the ROI event type (e.g., ‘attenuator change’, ‘LAR’, ‘SAA’, ‘flare’).

Type

str

source

A string descriptor of the ROI source (e.g., ‘LYRA’, ‘RHESSI’).

Type

str

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 sunpy.time.TimeRange using the start and end times.

Methods Documentation

time_range()[source] [edit on github]

Returns a sunpy.time.TimeRange using the start and end times.