Skip to content

RHESSIVisibility class

pgabor edited this page Nov 3, 2017 · 1 revision

RHESSIVisibility class

Purpose

This is just like the Visibility class but it provides some extra field for information which are stored usually in fits files. It can even read the information from them (see below). Everything is true for that object what was true for the Visibility class.

How to use the class

First of all, you have to import the module:

from xrayvision.Visibility import RHESSIVisibility

Creating a RHESSIVisibility object

Creating an object with the constructor

You can create one just like in the case of the Visibility object, but you can specify some other parameter specified by the RHESSI documentation:

  • isc: Related to the grid/detector
  • harm: Harmonic used
  • erange: Energy range in [begin, end] format
  • trange: Time range in [begin, end] python time format
  • totflux: Total flux
  • sigamp: Sigma or error on visibility
  • chi2: Chi squared from fit
  • xyoffset: Offset from Sun centre
  • type_string: "count", "photon", "electron", etc..
  • units: If it is in idl format it will be converted to latex format
  • atten_state: State of the attenuator
  • count: Detector counts
  • pixel_size: size of a pixel in arcseconds [x, y] format

Creating RHESSIVisibility objects from fits files

You can read fits files what are containing RHESSI visibility data, and create objects based on that. It has to be used like this:

list_of_rhessi_visibility_objects = RHESSIVisibility.from_fits_file("filepath")

If there was no visibility data it is going to return with None. The number of the returned objects are equal with the different time and energy range data what was present in the files.

Converting IDL unit string into tex format

For that you can use the following function:

RHESSIVisibility.convert_units_to_tex("idl_unit_str")