[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
HEADER_TEMPLATE
PURPOSE:
Procedure to do something or another!
CATEGORY:
EIS Technical Planning
Database
INPUTS:
none
MODIFICATION HISTORY:
Written by: John Rainnie, RAL - j.rainnie@rl.ac.uk (Dec 2005)
[Previous]
[Next]
NAME:
HW_AUX__DEFINE
PURPOSE:
Defines the class HW_AUX. This is the superclass for auxiliary
objects used by the Hansteen/Wikstøl data analysis SW. It
contains nothing except defines the general structure for auxiliary
objects. The HW_AUX class is inherited by auxiliary classes for a
specific data source. The purpose of the auxiliary objects are
to provide information to the display/analysis SW
(xdisplay.pro) about the contents of the companyng data class,
in order to provide correct titles on axes, widget menus etc.
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
INPUTS:
None
KEYWORD PARAMETERS:
OUTPUTS:
Objects of class HW_AUX includes the following parameters:
maintitle: Title describing the data source (e.g. 'EIS
Quicklook: Spectral data')
variablename: Contents of data (e.g. 'Intensity')
xytitle: Name on x-axis (e.g. '!4k!3 (pixels)')
menu: Structure with the following fields
action: Name of window actions in the display window
(used for naming widget buttons in xdisplay.pro)
(e.g. ['Zoom','Average along slit','Average
along wavelength'])
naction: Number of actions (e.g. 3 in this example)
mode: Name of the diiferent modes the data may be
displayed in (e.g. ['Detector
image','Raster','Imap']). Again this is used
for naming widget menus in xdisplay.pro.
nmode: Number of display modes (e.g. 3 in this example
CALLS: ***
HW_AUX::GETDISPMODE, HW_AUX::GETMENU, HW_AUX::GETTITLE
HW_AUX::GETVARIABLENAME, HW_AUX::GETXRASTERTITLE, HW_AUX::GETXTITLE
HW_AUX::GETXYTITLE, HW_AUX::GETYTITLE, HW_AUX::INIT, HW_AUX::SETDISPMODE
HW_AUX::SETXRASTERTITLE, HW_AUX::SETXTITLE, HW_AUX::SETYTITLE
COMMON BLOCKS:
PROCEDURE:
Defines the structure of auxiliary class objects.
RESTRICTIONS:
MODIFICATION HISTORY:
XX-Aug-2001: Viggo Hansteen
20-Sep-2001: Oivind Wikstol. Added documentation.
11-Sep-2002: Oivind Wikstol. Modified structure.
[Previous]
[Next]
NAME:
HW_CAL__DEFINE
PURPOSE:
HW_CAL__DEFINE defines the class HW_CAL. Objects of this
class contains calibration data and routines
for the EIS instrument on SOLAR-B.
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
The HW_CAL__DEFINE procedure is not called directly. An
object of class HW_CAL is created with the following
statement:
cal = obj_new('hw_cal')
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
Objects of type HW_CAL. The object has the following
instances:
caldir: calibration data directory
(e.g. /ssw/solarb/eis/data/cal/)
dc_file: File name of dark current data
ff_file: File name of flat field
aeff_file: Name of file containing effective area data
CALLS: ***
HW_CAL::GETAEFF_FILE, HW_CAL::GETCALDIR, HW_CAL::GETDC_FILE
HW_CAL::GETFF_FILE, HW_CAL::INIT, HW_CAL::SETAEFF_FILE, HW_CAL::SETCALDIR
HW_CAL::SETDC_FILE, HW_CAL::SETFF_FILE
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
03-March-2004: Oivind Wikstol. First version.
[Previous]
[Next]
NAME:
HW_DATA__DEFINE
PURPOSE:
The hw_data object is the generalized superclass for data
class objects used by the Hansteen/Wikstøl QL/data analysis
SW. All data (independent of source) following this structure
can use the Hansteen/Wikstøl SW for visualization and analysis.
For a specific source of a data, a new class must be defined
(i.e. eis_data__define.pro for SOLAR-B EIS instrument). This class
inherits the hw_data superclass. The data class must
provide a read-routine for reading the specific data
(i.e. eis_data__read.pro).
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
INPUTS:
None
KEYWORD PARAMETERS:
OUTPUTS:
Objects of class HW_DATA includes the following parameters:
nx Number of wavelength pixels
ny Number of pixels along the slit
nraster Number of raster posistions
nwin Number of wavelength windows on detector
ccd_sz Size of CCD [wavelength, slit]
xs[nwin] Pixel start position of window along wavelength
xw[nwin] Pixel Width of window along wavelength
ys[nwin] Pixel start position of window along the slit
yw[nwin] Pixel width of window allong the slit
w[nwin] Array of pointers to the nwin numbers of pixel data
unit: String describing data units (e.g. ['Counts/pixel']
wid: Line ID string for each data window
(e.g. 'Fe IX 195.03 Å')
CALLS: ***
HD_DATA::SETWID, HW_DATA::GETASPECT, HW_DATA::GETAUX, HW_DATA::GETCOMMENT
HW_DATA::GETDATASOURCE, HW_DATA::GETEXP, HW_DATA::GETHDR
HW_DATA::GETHOME_INST, HW_DATA::GETNEXP, HW_DATA::GETNRASTER
HW_DATA::GETNTIME, HW_DATA::GETNWIN, HW_DATA::GETTITLE, HW_DATA::GETVAR
HW_DATA::GETWIN, HW_DATA::GETXS, HW_DATA::GETXW, HW_DATA::GETYS, HW_DATA::GETYW
HW_DATA::INIT, HW_DATA::READ, HW_DATA::SAVE, HW_DATA::SETASPECT
HW_DATA::SETCOMMENT, HW_DATA::SETNWIN, HW_DATA::SETVAR, HW_DATA::SETXW
COMMON BLOCKS:
PROCEDURE:
Defines the structure of data class objects.
RESTRICTIONS:
MODIFICATION HISTORY:
XX-Aug-2001: Viggo Hansteen
20-Sep-2001: Oivind Wikstol. Added documentation.
22-Jan-2003: Oivind Wikstol - Removed nx and ny, as they were the same as xw
and yw (width of line windows in pixels in x and y direction)
23-Feb-2004: Oivind Wikstol - Added wid to object: Line
IDs. Added methods to get and
set wid.
05-May-2004: Oivind Wiksto - Added save method
11-May-2004: Oivind Wiksto - Added setnwin method. Added 'unit'
to hw_data struct.
15-Dec-2005: Oivind Wikstol - Added home institution. Name of institution
where software is run.
[Previous]
[Next]
NAME:
HW_HDR__DEFINE
PURPOSE:
Defines the class HW_HDR. This is the superclass for header
objects used by the Hansteen/Wikstøl data analysis SW. It
contains nothing except defines the general structure for header
objects. The HW_HDR class is inherited by header classes for a
specific data source.
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
INPUTS:
None
KEYWORD PARAMETERS:
OUTPUTS:
None
CALLS: ***
EIS_HDR::GETVER_NO, EIS_HDR::SETVER_NO, HW_HDR::DISPLAY, HW_HDR::GETLINE_ID
HW_HDR::GETNCCD, HW_HDR::GETTITLE, HW_HDR::INIT, HW_HDR::READ
COMMON BLOCKS:
PROCEDURE:
Defines the structure of header class objects.
RESTRICTIONS:
MODIFICATION HISTORY:
XX-Aug-2001: Viggo Hansteen
20-Sep-2001: Oivind Wikstol. Added documentation.
13-Oct-2004: Oivind Wikstol. Added line_id
14-Oct-2004: Oivind Wikstol. Added nccd as instance to data
object
25-Oct-2004: Oivind Wikstol - Added ver_no with methods (get/set)
[Previous]
[Next]
NAME:
HW_PLAN__DEFINE
PURPOSE:
The hw_plan object is the general superclass for plan
class objects used by the Hansteen/Wikstøl QL/data analysis
SW. The plan object contains data that is aqcuired from
an instruments planning tool. These data should be found
in the main header unit (HDU) of the fits-files
For a specific instrument, a new class must be defined
(i.e. eis_plan__define.pro for SOLAR-B EIS instrument). This class
inherits the hw_plan superclass. The plan class must
provide a read-routine for reading the specific plan
(i.e. eis_plan__read.pro).
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
INPUTS:
None
KEYWORD PARAMETERS:
OUTPUTS:
Objects of class HW_PLAN includes the following parameters:
CALLS: ***
HW_PLAN::GETTITLE, HW_PLAN::INIT, HW_PLAN::READ
COMMON BLOCKS:
PROCEDURE:
Defines the structure of plan class objects.
RESTRICTIONS:
MODIFICATION HISTORY:
28-Nov-2002: Oivind Wikstol
[Previous]
[Next]
NAME:
HW_SYNSPEC__DEFINE defines the class HW_SYNSPEC. Objects of this
class form the interface between the "Chianti" package and the HW QL
software.
PURPOSE:
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE: HW_SYNSPEC is created by
hw_synspec = obj_new('hw_synspec',lambda,name=name,title=title)
generates and loads a spectrum for the wavelengths given by lambda
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
CH_SYNTHETIC, HW_SYNSPEC::GENERATE, HW_SYNSPEC::GETINFO, HW_SYNSPEC::GETSPEC
HW_SYNSPEC::GETTITLE, HW_SYNSPEC::INIT, HW_SYNSPEC::LOAD
HW_SYNSPEC::SETDEFAULTS, HW_SYNSPEC::SETTITLE, HW_SYNSPEC__DEFINE
MAKE_CHIANTI_SPEC, restgen [1], restgen [2], savegen [1], savegen [2]
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
06-Jan-2006: Viggo H. Hansteen