[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_abort__DEFINE
Purpose : Generates structure EIS_abort.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_abort. Tags are :
description : STRING description
onboard : UINT FLAG indicating whether the abort command should be sent from the 'OP' store (1)
or from the 'REAL' time control file (0).
abort_time : DOUBLE TAI time of abort.
Use : <dummy = {EIS_abort>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 04/10/06
Modified : Version 0.0, 04/10/06, MKC
Version : 0.0, 04/10/06
[Previous]
[Next]
NAME:
eis_acronym_input_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME: EIS_ADD_FITS_FILE
PURPOSE: Extracts the keywords from a FITS file header and uses
that information to add an entry into the EIS As-Run
database.
CATEGORY: EIS As-Run Database
CALLING SEQUENCE:
r = eis_add_fits_file (filename, [path], [KEYWORDS])
INPUTS: filename: The name of the FITS file to add to the
As-Run database.
path: directory path if seperate from the file
name.
OUTPUTS: none.
KEYWORDS: verbose: If set, then print a message when a FITS
file is added to athe database.
err: When passed, contains any error message on
completion.
RETURNS: The result of the operation. 1 = Success, 0 = failure.
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], EIS_FXH_2_REC, EIS_GET_HDR [1]
EIS_GET_HDR [2], MAKE_EIS_EXPER_LIST, MAKE_EIS_MAIN_LIST, break_file [4]
RESTRICTIONS:none.
AUTHOR: Ron Yurow (Adnet Systems)
MODIFICATION HISTORY:
August 28, 2006 Ron Yurow (Initial Release)
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_ADD_STUDY
PURPOSE
Procedure to do something or another!
CATEGORY
EIS Timeline Planning
INPUTS
Self - eis_mk_plan_gui tlb object
start_time - study time start (in TAI)
KEYWORDS
time_tagged - indicates whether the study
MODIFICATION HISTORY
V0.0 Written by John Rainnie (JAR), RAL, Dec 2005
V0.1 JAR May 2006
Updated procedure to take care of engineering studies
V0.3 JAR 17 August2006
Included XRTFlare hunter study properties
CALLS:
CALLED BY
eis_mk_plan_gui [1], eis_mk_plan_gui [2]
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_AEC_control__DEFINE
Purpose : Generates structure EIS_AEC_control.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_AEC_control. Tags are :
upper_threshold : UINT high energy pixel threshold. Range 0-2^14-1.
lower_threshold : UINT low energy pixel threshold. Range 0-2^14-1.
high_energy_pixel_count_limit : ULONG number of pixels above upper threshold
required to trigger increase in exposure ID.
Range 1-2^32-2.
low_energy_pixel_count_limit : ULONG number of pixels below lower threshold
required to trigger decrease in exposure ID.
Range 1-2^32-2.
exposure_ID : UINT start up exposure time index determining
exposure time :
Exposure time [ms] = sqrt(2)^(exposure ID - c).
Range 0-27.
binning_factor : UINT average over pixels in the Y direction. Since
OCB is not used this will be fixed at 1.
run_time : ULONG AEC run time in seconds. The sequence is
terminated internally when the run time has elapsed.
If 0 then continues until completes or intervention.
If no selected AEC reference line then runs at fixed exposure time.
Range 0-2^17-1.
Use : <dummy = {EIS_AEC_control>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.1, 02/12/04, MKC
Added the AEC flag.
Version 0.2, 24/06/05, MKC
Removed the AEC flag.
Changed INT values to UINT.
Version 0.3, 08/09/05, MKC
Changed pixelc ount limits.
Version : 0.3, 08/09/05
[Previous]
[Next]
NAME:
eis_aec_event_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
eis_aec_widgets
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_aece_CONTROL_TO_PROPS
PURPOSE
Procedure to do something or another!
CATEGORY
EIS Timeline Planning
INPUTS
st - an eis_study structure
aece_control -
KEYWORDS
None
MODIFICATION HISTORY
V0.0 Written by John Rainnie (JAR), RAL, Dec 2005
CALLED BY
eis_mk_study_gui [1], eis_mk_study_gui [2]
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_aece_CONTROL_TO_PROPS
PURPOSE
Procedure to do something or another!
CATEGORY
EIS Timeline Planning
INPUTS
st - an eis_study structure
aece_control -
KEYWORDS
None
MODIFICATION HISTORY
V0.0 Written by John Rainnie (JAR), RAL, Dec 2005
CALLED BY
eis_mk_study_gui [1], eis_mk_study_gui [2]
[Previous]
[Next]
NAME:
eis_author_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
EIS_AUX__DEFINE
PURPOSE:
Defines the class EIS_AUX, the class for auxiliary
objects for EIS data. The EIS_AUX class inherits the HW_AUX
superclass. For a complete description of the contents of the
instance data of the AUX objects, see HW_AUX__DEFINE. The
EIS_AUX class has no self defined parameters other than the
ones inhereted from HW_AUX. All methods are also inhereted,
except the init-method, that fill the instance data with the
EIS specific contents.
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
eis_aux = obj_new('eis_aux'). The init method is
automatically run when the object is declared, and all the
objects parameters are set there.
INPUTS:
None
KEYWORD PARAMETERS:
OUTPUTS:
See HW_AUX__DEFINE for a description of the object's instance
data.
CALLS: ***
EIS_AUX::GETNPARAMS, EIS_AUX::GETPARAMS, EIS_AUX::GETWSCALE, EIS_AUX::INIT
EIS_AUX::SETWSCALE, EIS_AUX::SETXYTITLE
COMMON BLOCKS:
PROCEDURE:
Defines the EIS_AUX object and fille the parameters (instance
data) of the object in the init-method.
RESTRICTIONS:
MODIFICATION HISTORY:
XX-Aug-2001: Viggo Hansteen
01-Oct-2001: Oivind Wikstol. Added documentation.
02-Sep-2002: Oivind Wikstol. Modified structure of menu system
20-APR-2004: Oivind Wikstol - Added funtions to change wavl. scale [pix/Angstr.]
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_bakeout_parameters__DEFINE
Purpose : Generates structure EIS_bakeout_parameters.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_bakeout_parameters. Tags are :
target_temperature : UINT target temperature in ADC units (default 35 degC). Range 0-255.
number_of_duty_cycle_increments : UINT number of 5% increments needed to reach the required final duty cycle. Range 0-19. NB initial duty cycle is 5%.
extra_time_between_increments : UINT extra time between duty cycle increments in seconds (default 0 secs). Range 0-65535. NB this is in addition to the 5 minute minimum time between duty cycle increments.
extra_time_between_decrements : UINT extra time between duty cycle decrements in seconds (default 0 secs). Range 0-65535. NB this is in addition to the 5 minute minimum time between duty cycle increments.
Use : <dummy = {EIS_bakeout_parameters>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 08/09/05
Modified : Version 0.0, 08/09/05, MKC
Version : 0.0, 08/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_bakeout_period__DEFINE
Purpose : Generates structure EIS_bakeout_period.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_bakeout_period. Tags are :
description : STRING description
onboard : INT FLAG indicating whether the bakeout command should be sent from the 'OP' store (1)
or from the 'REAL' time control file (0).
start_time : DOUBLE TAI time of start of bakeout period.
end_time : DOUBLE TAI time to end bakeout period.
Use : <dummy = {EIS_bakeout_period>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 09/05/05
Modified : Version 0.1, 24/06/05, MKC
Changed INT values to UINT.
Version : 0.1, 24/06/05, MKC
[Previous]
[Next]
NAME:
EIS_CAL__DEFINE
PURPOSE:
EIS_CAL__DEFINE defines the class EIS_CAL. Objects of this
class contains calibration data and routines
for the EIS instrument on SOLAR-B. The
EIS_CAL class inherits the superclass EIS_DATA
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
The EIS_CAL__DEFINE procedure is not called directly. An
object of class EIS_CAL is created with the following
statement:
eis_cal = obj_new('eis_cal')
To fill the object with information (see EIS_DATA__DEFINE for
more information about the contents of the object), use the
following statement: eis_cal->seteisdefaults
This method is also called on object instatation.
INPUTS:
KEYWORD PARAMETERS:
Effective area data can be read in by using the keyword genaeff
eis_cal = obj_new('eis_cal',/gen_aff)
OUTPUTS:
Objects of type EIS_CAL
CALLS: ***
EIS_CAL::DC, EIS_CAL::DN_TO_PHOTON, EIS_CAL::ERGS_TO_PHOTON, EIS_CAL::FF
EIS_CAL::GENAEFF, EIS_CAL::GETAEFF, EIS_CAL::GETDISP, EIS_CAL::GETDISPERSION
EIS_CAL::GETDISPSQ, EIS_CAL::GETLAMBDA0, EIS_CAL::GETNPIX, EIS_CAL::INIT
EIS_CAL::LAMB2PIX, EIS_CAL::PHOTON_TO_DN, EIS_CAL::PHOTON_TO_ERGS
EIS_CAL::SETEISDEFAULTS, GET_DELIM, READ_ASCII, string3 [1], string3 [2]
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
March-2004: Oivind Wikstol - Completed version 1.0 of the cal object
26-January-2006: Viggo Hansteen - Fleshed out the definition. Added several
new methods for absolute calibration and wavelength scale
computation.
22-June-2006: Oivind Wikstol - Added dn_to_photon and photon_to_ergs functions.
[Previous]
[Next]
NAME:
EIS_CAL_ABSCAL
PURPOSE:
EIS_CAL_ABSCAL performes absolute intensity calibration of Solar-B EIS data.
Intensity is converted from Data Numbers (DN) to physical units, in:
photons: [ph cm-2 s-1 sr-1] or
cgs : [erg cm-2 s-1 sr-1] or
SI : [J m-2 s-1 sr-1] or
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
CALLS:
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
01-Sep-2005: Oivind Wikstol - Version 1.0
[Previous]
[Next]
NAME:
EIS_CAL_FF
PURPOSE:
EIS_CAL_FF performes flat field correction on Solar-B EIS data.
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
INPUTS:
dobj: Data object of data to be flat field corrected.
KEYWORD PARAMETERS:
ff_file: Flat field name (string), with full directory name.
OUTPUTS:
CALLS:
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
08-Sep-2005: Oivind Wikstol - Version 1.0
[Previous]
[Next]
NAME:
EIS_CAL_MKCALDATA
PURPOSE:
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
eis_cal_mkcaldata
INPUTS:
KEYWORD PARAMETERS:
ccdtemp: If set, the CCD temperature will be written in the IDL saveset.
If not set, it will have a default value of -273 deg C.
dc: set this (,/dc) to indicate dark currrent data
ff: set this (,/ff) to indicate flat field data
Outputs:
An idl saveset with full CCD calibration data (DC or FF) for both CCDs. Stored as idl saveset.
CALLS: ***
GET_DELIM, IS_DIR, LOCAL_NAME
COMMON BLOCKS:
PROCEDURE:
Opens upper frame dataset and lower frame dataset. Stores both i one variable for each
CCD, e.g. ccda[1024, 2048] and ccdb[1024, 2048] and saves as IDL saveset. The user makes the
filename.
RESTRICTIONS:
Datasets to be opened must be stored as an EIS FITS file.
MODIFICATION HISTORY:
22-June-2006: Oivind Wikstol. Version 1.0
[Previous]
[Next]
Project :SolarB EIS
Name :eis_calculate_number od slit-slot changes
Purpose :principally used by eis_mk_study tab
Category :EIS technical planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name :eis_calculate_raster_data_volume
Purpose :principally used by eis_mk_raster tab
Category :EIS technical planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
:nSteps + 1 changed to nSteps September 2005
CALLED BY
eis_import_study_gui, eis_mk_raster_gui__define [1]
eis_mk_raster_gui__define [2]
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_CALCULATE_STUDY_DURATION
PURPOSE
Function to calculate the duration of an eis_study (ms)
CATEGORY
EIS technical planning
CALLED BY:
eis_study_gui [1], eis_study_gui [2]
MODIFICATION HISTORY:
Written, Feb 2005 - Chunkey Lepine, RAL
[Previous]
[Next]
Project :SolarB EIS
Name :eis_calculate_study_volume
Purpose :principally used by eis_mk_raster tab
Category :EIS technical planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
CALLED BY
eis_mk_plan_gui [1], eis_mk_plan_gui [2], eis_mk_study_gui [1]
eis_mk_study_gui [2]
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CAM_readout__DEFINE
Purpose : Generates structure EIS_CAM_readout.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_CAM_readout. Tags are :
On_Chip_Binning : UINT[2] X and Y flags. OCB will not be used so fixed
at [1,1]. NB If OCB used would need appropriate CSG
sequence ID and line list.
CAM_CSG_flush_sequence_ID : UINT Identifies clocking sequence required to perform
flushing.
CAM_CSG_readout_sequence_ID : UINT Identifies clocking sequence required to
perform CCDs read-out.
Readout_nodes : UINT[4] flags that define the CCD readout nodes.
0 : CCDA R R/O chain enable
1 : CCDA L R/O chain enable
2 : CCDB R R/O chain enable
3 : CCDB L R/O chain enable
NB This setting must match the instrument automatic
state set by the CAM command C_SET_AE.
CCD_length : UINT CCD readout register length. Only changes if
OCB used so fixed at 2148.
flush_CCDs : UINT number of times to flush CCDs before each exposure, range 0-255.
addresses : ULONG[4] Camera flare readout sequence window coordinate addresses
for the FM CAM RROM CODE for CSG ID 4. Elements are :-
0 : X start = 0x04002D00
1 : Y start = 0x04000C00
2 : X length = 0x04010700
3 : Y length = 0x04001400
Use : <dummy = {EIS_CAM_readout>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.1, 29/09/04, MKC
Removed CAM_hardware_window.
Version 0.2, 30/11/04, MKC
Added flush_CCDS.
Version 0.3, 24/02/05, MKC
Added ystart and yheight tags.
Version 0.4, 12/04/05, MKC
Reversed order of readout nodes.
Added special readout sequence ID and renamed other normal readout sequence ID.
Changed ystart and yheight tags to addresses tag.
Version 0.5, 24/06/05, MKC
Changed INT values to UINT.
Version : 0.5, 24/06/05, MKC
[Previous]
[Next]
Project : Solar-B/EIS
Name : EIS_CAT
Purpose : widget interface to EIS AS-RUN catalog
Category : operations, widgets
Syntax : IDL> eis_cat
Inputs : None
Outputs : None
Keywords : GROUP = widget ID of any calling widget
TSTART,TEND = start/end times to list (any UT format)
CALLS: ***
ADV_EVENT, ADV_SEARCH_EVENT, ANYTIM2UTC [1], ANYTIM2UTC [2], AREGION_EVENT
CAMPAIGN_EVENT, CW_BGROUP, CW_FIELD, DB_SELECT_EVENT, DEFAULT_EVENT
DISPLAY_BUTTON_EVENT, EIS_CLEANUP, EIS_ELIST, EIS_FITS_URL [1], EIS_FITS_URL [2]
EIS_MLIST, ELIST_EVENT, EXIT_EVENT, FIX_ZDBASE, GET_HANDLER_ID
GET_INT_FROM_TFIELD, GET_NRASTERS_CDS, GET_SEARCH_PARAM, GET_STUDY_PAR, GET_UTC
HELP_EVENT, INIT, IS_BLANK, IS_DIGIT, LOC_FILE [1], LOC_FILE [2], LOC_FILE [3]
MAKE_ELIST_DESC, MAKE_MLIST_DESC, MKLOG, MK_DFONT, MLIST_EVENT, NOT_IMPLEMENTED
PRINT_EVENT, RELIST_EVENT, RESET_EVENT, REVERSE, SEARCH_EVENT, SEC2DHMS, SLR_EVENT
SNAME_EVENT, SOCK_COPY, SOLAR_SRCH_EVENT, SORT_BUTTON_EVENT, STRPAD, TAI2UTC, TRIM
UTC2STR, UTC2TAI, XACK, XCONTROL [1], XCONTROL [2], XKILL, XMANAGER, XMENU [1]
XMENU [2], XREGISTERED, XSHOW, XTEXT, curdir [1], curdir [2]
History : Modified from SOHO/CDS XCAT, Yurow (L-3Com/GSFC), circa 2003
Contact : yurow@cdso8.nascom.nasa.gov
[Previous]
[Next]
NAME: eis_ccsdsInterface__define.pro
PURPOSE: Definition of the EIS ccsds packet structure
CATEGORY: Science
CALLING SEQUENCE: None
INPUTS: None
KEYWORD PARAMETERS: None
OUTPUTS: None
CALLS: None
COMMON BLOCKS:None.
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
23/11/05 mcrw wrote
14/08/06 mcrw added documentation
[Previous]
[Next]
NAME: eis_ccsdsInterface__read.pro
PURPOSE: Definition of the EIS ccsds mission data packet reading
CATEGORY: Science
CALLING SEQUENCE: None
INPUTS: None
KEYWORD PARAMETERS: None
OUTPUTS: None
CALLS: None
COMMON BLOCKS:None.
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
23/11/05 mcrw wrote
14/08/06 mcrw added documentation
[Previous]
[Next]
NAME:
EIS_CHECK_DATABASE
PURPOSE
This function checks that the OFFICIAL and USER databases
are visible.
NOTES
This function is called by eis_mk_raster, eis_mk_study and
eis_mk_plan - if it returns zero (it has failed) - then these
GUIs are not invoked!
INPUTS
None
HISTORY
Written - 25 July 2006 John Rainnie @ RAL
CALLS:
CALLED BY
EIS_MK_PLAN [1], EIS_MK_PLAN [2], EIS_MK_RASTER [1], EIS_MK_RASTER [3]
jarNLTA [1], jarNLTA [3]
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_CHECK_FIVEPC_RULE
PURPOSE
Function to check 5% rule. The block of entries preceding
the cursor time is found - and more importantly its
stop_time. Output is the start_time of the new entry.
CATEGORY
EIS Timeline Planning
INPUTS
all_blocks -
cp_tai - cursor time (in TAI)
tlbID - widget ID of top level base
KEYWORDS
None
MODIFICATION HISTORY
Written by: John Rainnie, RAL - j.rainnie@rl.ac.uk (Dec 2005)
CALLS:
CALLED BY
eis_mk_plan_gui [1], eis_mk_plan_gui [2]
[Previous]
[Next]
Project : SOLAR-B/EIS
Name : EIS_CHECK_POINT
Purpose : Check if EIS raster pointing is within EIS FOV
Category : Planning
Syntax : IDL> valid=eis_check_point(point_stc,index)
Inputs : POINT_STC = EIS pointing structure
INDEX = index of structure (if more than one)
Outputs : VALID = 1/0 if valid/invalid
Keywords : TOLERANCE = tolerance in arcsecs to accept fit [def=0]
CALLS: ***
EXIST, HAVE_TAG, is_number [1], is_number [2], is_struct
History : 18-Sept-2006, Zarro (ADNET/GSFC) - written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_CHECK_SUFFICIENT_TIME
PURPOSE
Function to check that there is sufficient time
CATEGORY
EIS Timeline Planning
INPUTS
all_blocks -
cp_tai - cursor time (in TAI)
tlbID - widget ID of top level base
KEYWORDS
None
MODIFICATION HISTORY
Written by: John Rainnie, RAL - j.rainnie@rl.ac.uk (Dec 2005)
CALLED BY
eis_mk_plan_gui [1], eis_mk_plan_gui [2]
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_coarse_mirror_command__define__DEFINE
Purpose : Generates structure EIS_coarse_mirror_command.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_coarse_mirror_change. Tags are :
description : STRING description
time : DOUBLE TAI time of coarse mirror change.
onboard : UINT FLAG indicating whether the coarse mirror command should be sent from the 'OP' store (1)
or from the 'REAL' time control file (0).
position : UINT the new coarse mirror encoder position.
Use : <dummy = {EIS_coarse_mirror_command>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : ***
EIS_COARSE_MIRROR_COMMAND__DEFINE
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 14/01/05
Modified : Version 0.0, 14/01/05, MKC
Version 0.1, 10/03/05, MKC
Added description tag.
Version 0.2, 22/03/05, MKC
Changed source tag to onboard tag.
Version 0.3, 24/06/05, MKC
Changed INT values to UINT.
Version : 0.3, 24/06/05, MKC
[Previous]
[Next]
NAME:
EIS_CONCAT_DATA
PURPOSE:
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
eis_concat_data, dir = dir
INPUTS:
KEYWORD PARAMETERS:
dir: data directory
OUTPUTS:
CALLS: ***
EIS_MOVIE_PREP [1], EIS_MOVIE_PREP [2], lp_ximovie [1], lp_ximovie [2]
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
Version 1.0, May-2006: Oivind Wikstol and Viggo Hansteen
[Previous]
[Next]
Project :SolarB EIS
Name :eis_control
Purpose :
Category
Author
Version
CALLS:
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_control_details__DEFINE
Purpose : Generates structure EIS_control_details.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_control_details. Tags are :-
XRT_flare_control : structure of type EIS_XRT_flare_control.
EIS_flare_control : structure of type EIS_flare_control.
EIS_event_control : structure of type EIS_event_control.
AEC_control : structure of type EIS_AEC_control.
Use : <dummy = {EIS_control_details>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : Moved out of routine EIS_raster_detail__define.
Written : Martin Carter RAL 28/02/05
Modified : Version 0.0, 28/08/04, MKC
Renamed EIS XRT flare response, EIS flare response, EIS event response structures
to EIS XRT flare control, EIS flare control, EIS event control.
Version 0.1, 24/06/05, MKC
Changed INT values to UINT.
Version 0.2, 13/09/05, MKC
Removed sub ID tag.
Version : 0.2, 13/09/05
[Previous]
[Next]
NAME: eis_convert_hk1_htra_temp.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS: ***
EIS_CONVERT_HK1_TEMP
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
26/Sept/2006 mcrw wrote
[Previous]
[Next]
NAME: eis_convert_hk1_htrb_temp.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS: ***
EIS_CONVERT_HK1_TEMP
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
26/Sept/2006 mcrw wrote
[Previous]
[Next]
NAME: eis_convert_hk1_htrc_temp.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS: ***
EIS_CONVERT_HK1_TEMP
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
26/Sept/2006 mcrw wrote
[Previous]
[Next]
NAME: eis_convert_hk1_icu1_temp.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS: ***
eis_convert_hk1_structure_temp [1], eis_convert_hk1_structure_temp [2]
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
26/Sept/2006 mcrw wrote
[Previous]
[Next]
NAME: eis_convert_hk1_icu2_temp.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS: ***
eis_convert_hk1_structure_temp [1], eis_convert_hk1_structure_temp [2]
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
26/Sept/2006 mcrw wrote
[Previous]
[Next]
NAME: eis_convert_hk1_str1_temp.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS: ***
eis_convert_hk1_structure_temp [1], eis_convert_hk1_structure_temp [2]
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
26/Sept/2006 mcrw wrote
[Previous]
[Next]
NAME: eis_convert_hk1_str2_temp.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS: ***
eis_convert_hk1_structure_temp [1], eis_convert_hk1_structure_temp [2]
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
26/Sept/2006 mcrw wrote
[Previous]
[Next]
NAME: eis_convert_hk1_str3_temp.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS: ***
eis_convert_hk1_structure_temp [1], eis_convert_hk1_structure_temp [2]
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
26/Sept/2006 mcrw wrote
[Previous]
[Next]
NAME: eis_convert_hk1_str4_temp.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS: ***
eis_convert_hk1_structure_temp [1], eis_convert_hk1_structure_temp [2]
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
26/Sept/2006 mcrw wrote
[Previous]
[Next]
NAME: eis_convert_hk1_str5_temp.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS: ***
eis_convert_hk1_structure_temp [1], eis_convert_hk1_structure_temp [2]
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
26/Sept/2006 mcrw wrote
[Previous]
[Next]
NAME: eis_convert_hk1_str6_temp.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS: ***
eis_convert_hk1_structure_temp [1], eis_convert_hk1_structure_temp [2]
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
26/Sept/2006 mcrw wrote
[Previous]
[Next]
NAME: eis_convert_hk1_str7_temp.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS: ***
eis_convert_hk1_structure_temp [1], eis_convert_hk1_structure_temp [2]
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
26/Sept/2006 mcrw wrote
[Previous]
[Next]
NAME: eis_convert_hk1_structure_temp.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS:
CALLED BY:
eis_convert_hk1_icu1_temp [1], eis_convert_hk1_icu1_temp [2]
eis_convert_hk1_icu2_temp [1], eis_convert_hk1_icu2_temp [2]
eis_convert_hk1_str1_temp [1], eis_convert_hk1_str1_temp [2]
eis_convert_hk1_str2_temp [1], eis_convert_hk1_str2_temp [2]
eis_convert_hk1_str3_temp [1], eis_convert_hk1_str3_temp [2]
eis_convert_hk1_str4_temp [1], eis_convert_hk1_str4_temp [2]
eis_convert_hk1_str5_temp [1], eis_convert_hk1_str5_temp [2]
eis_convert_hk1_str6_temp [1], eis_convert_hk1_str6_temp [2]
eis_convert_hk1_str7_temp [1], eis_convert_hk1_str7_temp [2]
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
26/Sept/2006 mcrw wrote
[Previous]
[Next]
NAME: eis_convert_k1_emp.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS: ***
EIS_CONVERT_HK1_TEMP
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
26/Sept/2006 mcrw wrote
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT
Purpose : Generate uploadable files for science plan.
Explanation : If the EIS_CPT processing fails then a simple error message will be returned in !ERR_STRING.
Use : < result = eis_cpt( engineering_parameters, RESET=reset, QUIET=quiet, TIMESTAMP=timestamp) >
Inputs : None.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : RESET : INT FLAG indicating that OBSTBL and OBSTBL map should be reset,
1 : soft reset (only OBSTBL map)
2 : hard reset (OBSTBL also)
QUIET : INT FLAG indicating that no printout to the terminal window should be produced.
MSSL : INT Flag indicating should produce individual ASCII files for each OBSTBL table
0 : no output
1 : outputs new tables
2 : outputs all tables
and line list table in MSSL command mnemonic form.
INTEL : INT Flag indicating should produce individual Intel hex files for each OBSTBL table
and line list table.
0 : no output
1 : outputs new tables
2 : outputs all tables
JSIDE : INT flag indicating that Jside files should be produced.
STAMP : STRING stamp appended to Jside files produced for test purposes.
CONTROL : STRUCTURE of type EIS_control_details.
ENGINEERING : STRUCTURE of type EIS_engineering_parameters
TIME_PERIOD : ARRAY[2] time of start and end of period for processing in
any CDS time format.
UPLOAD : STRUCTURE of type EIS_upload.
STUDIES : STRUCTURE ARRAY of type EIS_study_detail.
SUSPENSIONS : STRUCTURE ARRAY of type EIS_suspend_period.
ABORTS : STRUCTURE ARRAY of type EIS_abort.
BAKEOUTS : STRUCTURE ARRAY of type EIS_bakeout_period.
CONTACT_INFO : STRUCTURE containing contact period info.
MIRROR_COMMANDS : STRUCTURE ARRAY of type EIS_coarse_mirror_command.
REAL_COMMANDS : STRUCTURE ARRAY of type EIS_list_real_detail
Calls : ***
EIS_CPT_CHECK_TIME_PERIOD [1], EIS_CPT_CHECK_TIME_PERIOD [2]
EIS_CPT_CHECK_UPLOAD [1], EIS_CPT_CHECK_UPLOAD [2], EIS_CPT_COMPLETE [1]
EIS_CPT_COMPLETE [2], EIS_CPT_DEBUG [1], EIS_CPT_DEBUG [2]
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2], EIS_CPT_PRELIMINARIES [1]
EIS_CPT_PRELIMINARIES [2], EIS_CPT_PROCESS [1], EIS_CPT_PROCESS [2]
EIS_CPT_VERSION [1], EIS_CPT_VERSION [2]
CALLED BY:
EIS_CPT_TEST [1], EIS_CPT_TEST [2], eis_cpt_gui [1], eis_cpt_gui [2]
Common : None.
Restrictions: None.
Side effects: Returns to calling routine if error.
Resets !ERROR_STATE system variable.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 06/10/04
Modified : Version 0.0, 06/10/04, MKC
Version 0.1, 21/01/05, MKC
Added coarse_mirror_command processing.
Version 0.2, 01/03/05, MKC
Added control_details.
Version 0.3, 18/03/05, MKC
Renamed internal variables.
Renamed keywords.
Added INTEL and JSIDE keywords.
Version 0.4, 03/04/05, MKC
Added TIMESTAMP keyword.
Version 0.5, 22/04/05, MKC
Added extra options to ISACS, MSSL, INTEL flags.
Version 0.6, 27/04/05, MKC
Removed ISACS keyword.
Version 0.7, 09/05/05, MKC
Modified RESET behaviour.
Added bakeout periods.
Version 0.8, 20/07/05, MKC
Added real command sequences.
Version 0.9, 13/09/05, MKC
Added EIS OBSTBL RAM sub ID keyword.
Added UPLOAD_DATE and UPLOAD_PASS_ID keywords.
Changed TIMESTAMP keyword to STAMP.
Version 1.0, 22/09/05, MKC
Added ground contact periods.
Add Data Rate file generation.
Added time period argument to eis cpt process.
Version 1.1, 03/10/05, MKC
Added checks on upload and changed to UPLOAD_TIME keyword.
Version 1.2, 07/10/05, MKC
Removed JSIDE keyword from eis cpt complete.
Version 1.3, 14/06/06, MKC
Changed MK PLAN interface.
Passed interface structures as arguments rather than getting them
through function calls.
Corrected bug where error state variable not reset until after some errors generated.
Moved setup constants to eis cpt preliminaries.
Changed so that requires upload defined even if JSIDE not selected.
Version 1.4, 14/07/06, MKC
Moved check on time period into routine.
Version 1.5, 20/08/06, MKC
Changed logic so that only require upload to be defined if Jside output required.
Moved calculation of upload pass string.
Changed arguments of eis complete and eis cpt check upload.
Took internal copy of upload.
Version 1.6, 03/10/06, MKC
Changed eis cpt complete arguments.
Changed contact periods structure.
Added ABORTS keyword.
Version : 1.6, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_abort_default
Purpose : Generates default structure EIS_abort.
Explanation : Sets up default values for structure EIS_abort.
Use : < s = EIS_CPT_abort_default(time, onboard) >
Inputs : time : DOUBLE TAI time.
onboard : INT FLAG
0 : put in REAL file
1 : put in OP
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_abort.
Opt. Outputs: None.
Keywords : None,
Calls : None.
CALLED BY:
EIS_CPT_LIST_ABORTS [1], EIS_CPT_LIST_ABORTS [2]
EIS_CPT_STRUCTURE_DEFAULTS [1], EIS_CPT_STRUCTURE_DEFAULTS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 04/10/06
Modified : Version 0.0, 04/10/06
Version : 0.0, 04/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_ADD
Purpose : Adds 2nd argument to 1st argument array.
Explanation : Concatenates the second array to the first or equates
the first to the second if the first array has not yet been initialized.
If second array not defined then returns.
Using this routine allows more efficient methods to be implemented in the future
should efficiency become an issue.
Use : < eis_cpt_add, array, new >
Inputs : array : ARR[] existing array
new : ARR[] or SCALAR new data
Opt. Inputs : None.
Outputs : array : ARR[] updated array
Opt. Outputs: None.
Keywords : PRE : add new data at beginning rather than end.
Calls : None.
CALLED BY:
EIS_CPT_ADD_INTEL_HEX_RECORD [1], EIS_CPT_ADD_INTEL_HEX_RECORD [2]
EIS_CPT_COMMAND_STORE_ADD [1], EIS_CPT_COMMAND_STORE_ADD [2]
EIS_CPT_COMMAND_STORE_PROCESS [1], EIS_CPT_COMMAND_STORE_PROCESS [2]
EIS_CPT_C_SET_WINDOW [1], EIS_CPT_C_SET_WINDOW [2], EIS_CPT_DAISY_CHAIN [1]
EIS_CPT_DAISY_CHAIN [2], EIS_CPT_DATARATE_ITEM_OUTPUT
EIS_CPT_DATARATE_OUTPUT [1], EIS_CPT_DATARATE_OUTPUT [2]
EIS_CPT_DATAVOL_ITEM_OUTPUT [1], EIS_CPT_DATAVOL_ITEM_OUTPUT [2]
EIS_CPT_DATA_RATE [1], EIS_CPT_DATA_RATE [2], EIS_CPT_DATA_RATE_PROCESS [1]
EIS_CPT_DATA_RATE_PROCESS [2], EIS_CPT_DECODE_AEC_EXPOSURE_TABLE [1]
EIS_CPT_DECODE_AEC_EXPOSURE_TABLE [2], EIS_CPT_DECODE_AEC_TABLE [1]
EIS_CPT_DECODE_AEC_TABLE [2], EIS_CPT_DECODE_EIS_EVENT_TABLE [1]
EIS_CPT_DECODE_EIS_EVENT_TABLE [2], EIS_CPT_DECODE_EIS_FLARE_TABLE [1]
EIS_CPT_DECODE_EIS_FLARE_TABLE [2], EIS_CPT_DECODE_LINELIST_TABLE [1]
EIS_CPT_DECODE_LINELIST_TABLE [2], EIS_CPT_DECODE_SEQUENCE_TABLE [1]
EIS_CPT_DECODE_SEQUENCE_TABLE [2], EIS_CPT_DECODE_XRT_FLARE_TABLE [1]
EIS_CPT_DECODE_XRT_FLARE_TABLE [2], EIS_CPT_HEX_RASTER [1]
EIS_CPT_HEX_RASTER [2], EIS_CPT_JSIDE_COMMANDS [1]
EIS_CPT_JSIDE_COMMANDS [2], EIS_CPT_JSIDE_SEQUENCE [1]
EIS_CPT_JSIDE_SEQUENCE [2], EIS_CPT_LIST_ABORTS [1], EIS_CPT_LIST_ABORTS [2]
EIS_CPT_LIST_BAKEOUT_PERIODS [1], EIS_CPT_LIST_BAKEOUT_PERIODS [2]
EIS_CPT_LIST_COARSE_MIRROR_COMMANDS [1]
EIS_CPT_LIST_COARSE_MIRROR_COMMANDS [2]
EIS_CPT_LIST_REAL_COMMAND_SEQUENCES [1]
EIS_CPT_LIST_REAL_COMMAND_SEQUENCES [2], EIS_CPT_LIST_STUDY_DETAILS [1]
EIS_CPT_LIST_STUDY_DETAILS [2], EIS_CPT_LIST_SUSPENSION_PERIODS [1]
EIS_CPT_LIST_SUSPENSION_PERIODS [2], EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2]
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [1]
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [2]
EIS_CPT_PROCESS_LINELISTS_FOR_STUDY [1]
EIS_CPT_PROCESS_LINELISTS_FOR_STUDY [2]
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [1]
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [2], EIS_CPT_PROCESS_STUDY [1]
EIS_CPT_PROCESS_STUDY [2], EIS_CPT_READ_TEXT [1], EIS_CPT_READ_TEXT [2]
EIS_CPT_RESPONSE_TIMELINE [1], EIS_CPT_RESPONSE_TIMELINE [2]
EIS_CPT_SEQUENCE_MATCH [1], EIS_CPT_SEQUENCE_MATCH [2]
EIS_CPT_TIMELINE_OUTPUT [1], EIS_CPT_TIMELINE_OUTPUT [2]
EIS_CPT_contacts_default [1], EIS_CPT_contacts_default [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 06/12/04
Modified : Version 0.1, 18/01/05, MKC
Renamed routine from eis cpt add bytes and generalized to any array.
Version 0.2, 22/05/06, MKC
For compatibility with IDL vs 6.2 (keyword_set([0])=1 previously),
removed use of external array=0 to trigger initialization of array.
Version : 0.2, 22/05/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_ADD_INTEL_HEX_RECORD
Purpose : Adds Intel Hex record or header record to record store.
Explanation : Hex-Records are character strings made of several fields which specify the
record type, record length, memory address, data, and checksum. Each byte
of binary data is encoded as a 2-character hexadecimal number: the first
ASCII character representing the high-order 4 bits, and the second the low
order 4 bits of the byte. Each record may be terminated with a CR/LF/NULL.
Accuracy of transmission is ensured by the byte count and checksum fields.
In an hex record :
- The first character (:) indicates the start of a record.
- The next two characters indicate the record length.
- The next four characters give the load address.
- The next two characters indicate the record type (see below).
- Then we have the actual data.
- The last two characters are a checksum (sum of all bytes + checksum = 00).
There are 5 Intel hex record types defined :
- '00' = Data Record
- '01' = End Of File Record
- '02' = Extended Segment Address Record
- '03' = Start Segment Address Record
- '04' = Extended Linear Address Record
- '05' = Start Linear Address Record.
This routine supports data records, end of file records and extended linear
address records. In addition to the Intel hex records the routine also allows
a header record to be included, which starts with a '#' and ends with a ';'.
This routine manipulates the hex records as BYTE arrays rather than strings,
converting any characters required to BYTE values and byte data to two byte
hex values.
Use : < eis_cpt_add_intel_hex_record, load_address, record_data, intel_hex >
Inputs : load_address : UINT load address for the data
Not used if not data record.
record_data : BYTARR[] record data.
Not used if not data record.
intel_hex : BYTARR[] hex records
Opt. Inputs : None.
Outputs : intel_hex : BYTARR[] intel hex format records.
Opt. Outputs: None.
Keywords : ENDOFFILE : FLAG indicating end of file record needed
HEADER : STRING header string for file.
ULBA : UINT extended linear address
NB If ulba is zero then will not get added.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_BYTESTOHEX [1]
EIS_CPT_BYTESTOHEX [2], EIS_CPT_CHECKSUM [1], EIS_CPT_CHECKSUM [2]
EIS_CPT_UINTTOBYTES [1], EIS_CPT_UINTTOBYTES [2]
CALLED BY:
EIS_CPT_COMPOSE_INTEL_HEX_FILE [1], EIS_CPT_COMPOSE_INTEL_HEX_FILE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 25/10/04
Modified : Version 0.1, 02/11/04, MKC
Added HEADER keyword.
Added ULBA keyword.
Version 0.2, 13/01/05, MKC
Used routine eis cpt add.
Version 0.3, 22/05/06, MKC
Changed so that end of file record and ulba record do not use load address.
Version : 0.3, 22/05/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_AEC_control_default
Purpose : Generates default structure EIS_AEC_control.
Explanation : Sets up default values for structure EIS_AEC_control.
Values are based on MSSL?SLB-EIS/SP027.02
Use : <str = EIS_CPT_AEC_control_default()>
Inputs : None.
Opt. Inputs : None.
Outputs : str : STRUCTURE of type EIS_AEC_control
Opt. Outputs: None.
Keywords : None,
Calls : None.
CALLED BY:
EIS_CPT_control_details_default [1], EIS_CPT_control_details_default [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.0, 03/08/04, MKC
Version 0.1, 24/06/05, MKC
Removed the AEC flag.
Changed INT values to UINT.
Corrected low energy pixel count limit to ULONG.
Version 0.2, 08/09/05, MKC
Changed pixelc ount limits.
Version : 0.2, 08/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_AEC_EXPOSURE_TIMES_DEFAULT
Purpose : Returns AEC exposure times.
Explanation : The default exposure times corresponding to the 28 exposure IDs are defined in SP027.02.
These are the only ones allowed at present.
Use : < exposure_times = eis_cpt_AEC_exposure_times_default () >
Inputs : None.
Opt. Inputs : None.
Outputs : expsoure_times : UINTARR(28) exposure times in 10 ms units
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_engineering_parameters_default [1]
EIS_CPT_engineering_parameters_default [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 10/02/05
Modified : Version 0.0, 10/02/05, MKC
Version : Version 0.0, 10/02/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_ASCII_TABLES
Purpose : Outputs OBSTBL tables as ASCII files
Explanation : Writes out OBSTBL tables as ASCII text files in a number of different formats.
Use : < result = eis_cpt_ascii_tables ( table_indexes, MSSL=mssl, INTEL=intel, $
SEQUENCE=sequence, LINELIST=linelist, AEC_EXPOSURE=aec_exposure, AEC_TABLE=aec_table, $
XRT_FLARE=xrt_flare, EIS_FLARE=eis_flare, ) >
Inputs : table_indexes : INTARR() list of sequence tables used.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : MSSL : INT Flag indicating should produce individual ASCII files for each sequence table
and line list table in MSSL command mnemonic form.
INTEL : INT Flag indicating should produce individual Intel hex files for each sequence table
and line list table.
LINELIST : INT FLAG indicating if table is linelist table
SEQUENCE : INT FLAG indicating if table is sequence table
AEC_EXPOSURE : FLAG indicating that processing an AEC exposure table
AEC_TABLE : FLAG indicating that processing an AEC control table
XRT_FLARE : FLAG indicating that processing an XRT flare trigger control table
EIS_FLARE : FLAG indicating that processing an EIS flare trigger control table
EIS_EVENT : FLAG indicating that processing an EIS event trigger control table
Calls : ***
EIS_CPT_FILE_NAME [1], EIS_CPT_FILE_NAME [2], EIS_CPT_OBSTBL [1]
EIS_CPT_OBSTBL [2], EIS_CPT_OBSTBL_INDEX [1], EIS_CPT_OBSTBL_INDEX [2]
EIS_CPT_WRITE_ASCII [1], EIS_CPT_WRITE_ASCII [2]
EIS_CPT_WRITE_INTEL_HEX_FILE [1], EIS_CPT_WRITE_INTEL_HEX_FILE [2], UNIQ [1]
UNIQ [2], UNIQ [3]
CALLED BY:
EIS_CPT_OBSTBL_ASCII [1], EIS_CPT_OBSTBL_ASCII [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 21/01/05
Modified : Version 0.0, 21/01/05, MKC
Version 0.1, 03/02/05, MKC
Removed obstbl argument.
Version 0.2, 24/03/05, MKC
Renamed keywords.
Added INTEL keyword.
Version 0.3, 03/04/05, MKC
Added table_indexes argument.
Added LINELIST and SEQUENCE keywords.
Renamed routine.
Version 0.4, 25/04/05, MKC
Added description to text output.
Do not output invalid tables.
Version 0.5, 27/04/05, MKC
Removed ISACS keyword.
Removed eis cpt convert table.
Version 0.6, 11/05/05, MKC
Used TEXT and CHECK keywords.
Version 0.7, 26/06/05, MKC
Added AEC_EXPOSURE, AEC_TABLE, XRT_FLARE, EIS_FLARE, EIS_EVENT keywords.
Version : 0.7, 26/06/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_bakeout_parameters_default
Purpose : Generates default structure EIS_bakeout_parameters.
Explanation : Sets up default values for structure EIS_bakeout_parameters.
Use : < s = EIS_CPT_bakeout_parameters_default() >
Inputs : None.
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_bakeout_parameters.
Opt. Outputs: None.
Keywords : None,
Calls : None.
CALLED BY:
EIS_CPT_engineering_parameters_default [1]
EIS_CPT_engineering_parameters_default [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 08/09/05
Modified : Version 0.0, 08/09/05, MKC
Version : 0.0, 08/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_bakeout_period_default
Purpose : Generates default structure EIS_bakeout_period.
Explanation : Sets up default values for structure EIS_bakeout_period.
Use : < s = EIS_CPT_bakeout_period_default(start_time, duration, onboard) >
Inputs : start_time : DOUBLE TAI start time or period.
duration : DOUBLE duration in seconds
onboard : INT FLAG
0 : put in REAL file
1 : put in OP
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_bakeout_period.
Opt. Outputs: None.
Keywords : None,
Calls : None.
CALLED BY:
EIS_CPT_LIST_BAKEOUT_PERIODS [1], EIS_CPT_LIST_BAKEOUT_PERIODS [2]
EIS_CPT_STRUCTURE_DEFAULTS [1], EIS_CPT_STRUCTURE_DEFAULTS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 09/05/05
Modified : Version 0.1, 24/06/05, MKC
Changed INT values to UINT.
Version : 0.1, 24/06/05, MKC
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_BYTESTOHEX
Purpose : Converts byte values into hex character values.
Explanation : Output values are coded as two hex characters per byte.
Use : < hex_bytes = eis_cpt_bytestohex(bytes) >
Inputs : bytes : BYTARR[n] byte values
Opt. Inputs : None.
Outputs : hex_bytes : BYTARR[2n] corresponding hex character values.
or STRING preceded by 0x
Opt. Outputs: None.
Keywords : OX : INT flag indicating should output result as a string preceded by 0x
MSSL : INT flag indicatin should output 0x00... as 0.
Calls : None.
CALLED BY:
EIS_CPT_ADD_INTEL_HEX_RECORD [1], EIS_CPT_ADD_INTEL_HEX_RECORD [2]
EIS_CPT_BYTESTOMSSL [1], EIS_CPT_BYTESTOMSSL [2]
EIS_CPT_CHECK_TIME_PERIOD [1], EIS_CPT_CHECK_TIME_PERIOD [2]
EIS_CPT_DECODE_AEC_TABLE [1], EIS_CPT_DECODE_AEC_TABLE [2]
EIS_CPT_DECODE_EIS_EVENT_TABLE [1], EIS_CPT_DECODE_EIS_EVENT_TABLE [2]
EIS_CPT_DECODE_EIS_FLARE_TABLE [1], EIS_CPT_DECODE_EIS_FLARE_TABLE [2]
EIS_CPT_DECODE_LINELIST_TABLE [1], EIS_CPT_DECODE_LINELIST_TABLE [2]
EIS_CPT_DECODE_SEQUENCE_TABLE [1], EIS_CPT_DECODE_SEQUENCE_TABLE [2]
EIS_CPT_DECODE_XRT_FLARE_TABLE [1], EIS_CPT_DECODE_XRT_FLARE_TABLE [2]
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [1]
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [2]
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [1]
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [2], EIS_CPT_PROCESS_STUDIES [1]
EIS_CPT_PROCESS_STUDIES [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/10/04
Modified : Version 0.0, 22/10/04, MKC
Version 0.1, 15/04/05, MKC
Added OX keyword.
Version 0.2, 28/06/05, MKC
Changed so that outputs 0 rather than 0x00.
Version 0.3, 04/10/05, MKC
Added MSSL keyword.
Version : 0.3, 04/10/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_BYTESTOMSSL
Purpose : Converts array of bytes to MSSL format output.
Explanation : Converts array of bytes to MSSL format output.
Use : < str = eis_cpt_bytestomssl(bytes) >
Inputs : bytes : BYTARR[]
Opt. Inputs : None.
Outputs : str : STRING.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_BYTESTOHEX [1], EIS_CPT_BYTESTOHEX [2]
CALLED BY:
EIS_CPT_DECODE_EIS_EVENT_TABLE [1], EIS_CPT_DECODE_EIS_EVENT_TABLE [2]
EIS_CPT_DECODE_EIS_FLARE_TABLE [1], EIS_CPT_DECODE_EIS_FLARE_TABLE [2]
EIS_CPT_DECODE_SEQUENCE_TABLE [1], EIS_CPT_DECODE_SEQUENCE_TABLE [2]
EIS_CPT_DECODE_XRT_FLARE_TABLE [1], EIS_CPT_DECODE_XRT_FLARE_TABLE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 28/06/05
Modified : Version 0.0, 28/06/05, MKC
Version 0.1, 04/10/05, MKC
Added MSSL keyword to bytes to hex.
Version : 0.1, 04/10/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_BYTESTOUINT
Purpose : Converts big endian BYTE array to UINT array.
Explanation : BYTE data values are MSByte first.
If fails then sets error.
Use : < uint_array = eis_cpt_bytestouint(byte_array) >
Inputs : byte_array : BYTARR[2n] byte values.
Opt. Inputs : None.
Outputs : uint_array : UINTARR[n] uint values.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_DECODE_LINELIST_TABLE [1], EIS_CPT_DECODE_LINELIST_TABLE [2]
EIS_CPT_DECODE_SEQUENCE_TABLE [1], EIS_CPT_DECODE_SEQUENCE_TABLE [2]
EIS_CPT_DECODE_XRT_FLARE_TABLE [1], EIS_CPT_DECODE_XRT_FLARE_TABLE [2]
EIS_CPT_PARSE_INTEL_HEX_FILE [1], EIS_CPT_PARSE_INTEL_HEX_FILE [2]
Common : None.
Restrictions: None.
Side effects: Loses any extra dimensions of input array.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 18/10/04
Modified : Version 0.0, 18/10/04, MKC
Version 0.1, 25/04/05, MKC
Removed initial dimension of 1.
Version : Version 0.1, 25/04/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_BYTESTOULONG
Purpose : Converts big endian BYTE array to ULONG array.
Explanation : BYTE data values are MSByte first.
If fails then sets error.
Use : < ulong_array = eis_cpt_bytestoulong(byte_array) >
Inputs : byte_array : BYTARR[4n] byte values.
Opt. Inputs : None.
Outputs : ulong_array : ULONARR[n] ulong values.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_DECODE_AEC_EXPOSURE_TABLE [1]
EIS_CPT_DECODE_AEC_EXPOSURE_TABLE [2]
Common : None.
Restrictions: None.
Side effects: Loses any extra dimensions of input array.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 18/10/04
Modified : Version 0.0, 27/06/05, MKC
Version : Version 0.0, 27/06/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_C_SET_WINDOW
Purpose : Sets up MSSL command.
Explanation : Sets values in the EIS CAM table. Only intended that it should set the ystart value.
BC1 : 0x44
BC2 : Block select
Bit 0 : pattern/program RAM selector
Bit 1 : Unused
Bits 2-7 : block 0-63
BC3 : The RAM page address
Bits 0-2 : used ?
Bits 3-7 : Page base address
BC4 : Address
Bits 0-1 : Unused
Bits 2-7 : Address
BC5 : Byte set-up data
NB memory is divided into 2 RAMs of pattern and program
each RAM is divided into 64 blocks of 2048 bytes for each CSG ID,
each 2048 block is divided into 32 pages of 64 bytes.
The two bytes of the INT12 coords are split between the pattern and program RAMs
but have the same address. The 1st 4 bits of the MSB =yte are an OP code.
NNB the xstart value in memory is one less than required sonce the first pixel is read out
differently.
Use : < bytes = eis_cpt_c_set_window( address, hardware_window) >
Inputs : addresses : ULONG[4] addresses in CAM table for special CSG ID for
0 : x start
1 : x size
2 : y start
3 : y size
hardware_window : INT[4] window coords
0 : x start
1 : x size
2 : y start
3 : y size
Opt. Inputs : None.
Outputs : bytes : BYTARR[20] commands.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_UINTTOBYTES [1]
EIS_CPT_UINTTOBYTES [2], EIS_CPT_ULONGTOBYTES [1], EIS_CPT_ULONGTOBYTES [2]
CALLED BY:
EIS_CPT_HEX_RASTER [1], EIS_CPT_HEX_RASTER [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 12/04/05
Modified : Version 0.0, 12/04/05, MKC
Version, 0.1, 15/04/05, MKC
Changed format of !EIS_CPT_COMMANDS.
Version, 0.2, 27/04/05, MKC
Removed !EIS_CPT_COMMANDS. Put in command directly.
Version : Version 0.2, 27/04/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CALL_SEQ
Purpose : Sets up MSSL command.
Explanation :
Use : < bytes = eis_cpt_call_seq( seq_no ) >
Inputs : seq_no : UINT seq_no 1-nseq
Opt. Inputs : None.
Outputs : bytes : BYTARR[2] command.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [1]
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [2]
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [1]
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 26/11/04
Modified : Version 0.0, 26/11/04, MKC
Version, 0.1, 15/04/05, MKC
Changed format of !EIS_CPT_COMMANDS.
Version, 0.2, 27/04/05, MKC
Removed !EIS_CPT_COMMANDS. Put in command directly.
Version : Version 0.2, 27/04/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CAM_readout_default
Purpose : Generates default structure EIS_CAM_readout.
Explanation : Sets up default values for structure EIS_CAM_readout.
Use : <s = EIS_CPT_CAM_readout_default(node) >
Inputs : nodes : INTARR[4] FLAG indicating readout nodes enabled..
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_CAM_readout
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_engineering_parameters_default [1]
EIS_CPT_engineering_parameters_default [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.1, 29/09/04, MKC
Removed CAM_hardware_window.
Version 0.2, 30/11/04, MKC
Added flush_CCDS.
Version 0.3, 24/02/05, MKC
Added ystart and yheight tags.
Version 0.4, 11/04/05, MKC
Enable just left readout nodes.
Version 0.5, 12/04/05, MKC
Reversed order of readout nodes.
Added special readout sequence ID and renamed other normal readout sequence ID.
Changed ystart and yheight tags to addresses tag.
Version 0.6, 24/06/05, MKC
Changed INT values to UINT.
Version 0.7, 29/06/05, MKC
Added node argument..
Version : 0.7, 29/06/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECK_BAKEOUT_PARAMETERS
Purpose : Checks the EIS bakeout parameters are valid.
Explanation : Checks the EIS bakeout parameters are valid.
Use : < result = eis_cpt_bakeout_parameters ( bakeout_parameters) >
Inputs : bakeout_parameters : STRUCTURE of type EIS_bakeout_parameters.
Opt. Inputs : None.
Outputs : result : status flag
0 : if checks failed.
1 : checks OK.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_CHECK_ENGINEERING_PARAMETERS [1]
EIS_CPT_CHECK_ENGINEERING_PARAMETERS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 12/09/05
Modified : Version 0.0, 12/09/05, MKC
Version : Version 0.0, 12/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECK_CAM_READOUT_PARAMETERS
Purpose : Checks the CAM readout parameters are valid.
Explanation : Checks :
- on chip binnng
- CSG flush ID
- CSG readut IDs
- CCD readout nodes
- CCD length
- flush CCDs
- CSG ID 4 addresses
Use : < result = eis_cpt_check_cam_readout_parameters ( cam_readout_parameters) >
Inputs : cam_readout_parameters : STRUCTURE of type EIS_CAM_readout.
Opt. Inputs : None.
Outputs : result : status flag
0 : if checks failed.
1 : checks OK.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_CHECK_ENGINEERING_PARAMETERS [1]
EIS_CPT_CHECK_ENGINEERING_PARAMETERS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/06/05
Modified : Version 0.0, 22/06/05, MKC
Version : Version 0.0, 22/06/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECK_CONTROL_PARAMETERS
Purpose : Checks various control parameters valid.
Explanation : Checks :
- XRT flare control parameters
- EIS flare control parameters
- EIS event control parameters
- AEC control parameters
NB If this routine is called when no study list is defined then
will not perform any checks. No checks will be performed unless the
corresponding event control table is needed by the current studies time-line.
Use : < result = eis_cpt_check_control_parameters ( control_details, study_details) >
Inputs : control_details : STRUCTURE of type EIS_control_details.
study_details : STRUCTURE ARRAY of type EIS_study_detail.
Opt. Inputs : None.
Outputs : result : status flag
0 : if checks failed.
1 : checks OK.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_CHECK_EVENT_RESPONSE_STUDY [1]
EIS_CPT_CHECK_EVENT_RESPONSE_STUDY [2], EIS_CPT_MESSAGE [1]
EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_PROCESS [1], EIS_CPT_PROCESS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/06/05
Modified : Version 0.0, 22/06/05, MKC
Version 0.1, 08/09/05, MKC
Added check on raster id and AEC pixel count limits.
Version 0.2, 21/09/05, MKC
Added check for multiply defined control studies (study reuse issue).
Version 0.3, 19/06/06, MKC
Moved check on whether study details defined out of this routine.
Changed tag filler sequence identifier.
Added argument to eis cpt check event response study.
Hardcoded study identifiers for response study.
Version : 0.3, 19/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECK_EIS_FLARE_PARAMETERS
Purpose : Checks the EIS flare parameters are valid.
Explanation : Checks the EIS flare parameters are valid.
Use : < result = eis_cpt_eis_flare_parameters ( eis_flare_parameters) >
Inputs : EIS_flare_parameters : STRUCTURE of type EIS_flare_parameters.
Opt. Inputs : None.
Outputs : result : status flag
0 : if checks failed.
1 : checks OK.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_CHECK_ENGINEERING_PARAMETERS [1]
EIS_CPT_CHECK_ENGINEERING_PARAMETERS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/06/05
Modified : Version 0.0, 22/06/05, MKC
Version : Version 0.0, 22/06/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECK_ENGINEERING_PARAMETERS
Purpose : Checks various engineering parameters valid.
Explanation : Checks :
- CAM readout parameters
- XRT flare parameters
- EIS flare parameters
- mechanism direction
- bakeout_parameters
Use : < result = eis_cpt_check_engineering_parameters ( engineering_parameters) >
Inputs : engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
Opt. Inputs : None.
Outputs : result : status flag
0 : if checks failed.
1 : checks OK.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_CHECK_BAKEOUT_PARAMETERS [1], EIS_CPT_CHECK_BAKEOUT_PARAMETERS [2]
EIS_CPT_CHECK_CAM_READOUT_PARAMETERS [1]
EIS_CPT_CHECK_CAM_READOUT_PARAMETERS [2]
EIS_CPT_CHECK_EIS_FLARE_PARAMETERS [1]
EIS_CPT_CHECK_EIS_FLARE_PARAMETERS [2]
EIS_CPT_CHECK_XRT_FLARE_PARAMETERS [1]
EIS_CPT_CHECK_XRT_FLARE_PARAMETERS [2], EIS_CPT_MESSAGE [1]
EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_PROCESS [1], EIS_CPT_PROCESS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 13/04/05
Modified : Version 0.0, 13/04/05, MKC
Version 0.1, 22/06/05, MKC
Added more checks.
Version 0.2, 12/09/05, MKC
Added checks on bakeout parameters.
Version 0.3, 19/06/06, MKC
Added check that engineering parameters are defined..
Version : 0.3, 19/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECK_EVENT_RESPONSE_STUDY
Purpose : Checks the event response study is valid.
Explanation : Checks the event response study is present in the study list.
Checks that if adjust X or adjust Y allowed then the corresponding raster exists.
Checks that if adjust Y allowed then the special hardware window is used.
Use : < result = eis_cpt_check_event_response_study ( event_control, study_details, study_identifier) >
Inputs : event_control : structure of type EIS_XRT_flare_control or EIS_flare_control
or EIS_event_control.
study_details : STRUCTURE ARRAY of type EIS_study_detail.
study_identifier : ULONG identifying event resopnse study (1-4)
Opt. Inputs : None.
Outputs : result : status flag
0 : if checks failed.
1 : checks OK.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2], EIS_GET_STUDY [1], EIS_GET_STUDY [2]
EIS_MULTIPLE_SEQUENCE_TABLES [1], EIS_MULTIPLE_SEQUENCE_TABLES [2]
CALLED BY:
EIS_CPT_CHECK_CONTROL_PARAMETERS [1], EIS_CPT_CHECK_CONTROL_PARAMETERS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 23/06/05
Modified : Version 0.0, 23/06/05, MKC
Version 0.1, 04/07/05, MKC
Added nrasters check..
Added no. of sequences check.
Version 0.2, 08/09/05, MKC
Changed raster number/ number of rasters tag to raster identifier.
Added check for multiply defined control studies (study reuse issue).
Removed restriction that event response study only one sequence table.
Version 0.3, 17/06/06, MKC
Corrected bug in error code.
Version 0.4, 19/06/06, MKC
Changed so that is passed study rather than study details for response study.
Changed tag study identifier.
Added argument study_identifier.
Version : 0.4, 19/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECK_FILE
Purpose : Checks file exists.
Explanation :
Use : < res = eis_cpt_check_file(filename) >
Inputs : filename : STRING name of file, including directory.
Opt. Inputs : None.
Outputs : res : INT FLAG indicating fiel exists
1 : ok
0 : not ok
Opt. Outputs: None.
Keywords : READ : FLAG indicating file for reading.
WRITE : FLAG indicating file for writing.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_OBSTBL_MAP_READ [1], EIS_CPT_OBSTBL_MAP_READ [2]
EIS_CPT_OPEN_FILE [1], EIS_CPT_OPEN_FILE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 15/10/04
Modified : Version 0.0, 15/10/04, MKC
Version : Version 0.0, 15/10/04
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECK_RASTER
Purpose : Checks various raster parameters are in range.
Explanation : Checks :
- coarse mirror encoder position.
- fine mirror position.
- loop counter
- data compression parameter
- number of exposures
- ASRC parameters
- raster repeats
- slit/slot position and direction
- number of data extraction windows
- data extraction windows
- event control flags
Use : < result = eis_cpt_check_raster ( engineering_parameters, raster_detail) >
Inputs : engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
raster_detail : STRUCTURE of type EIS_raster_detail.
Opt. Inputs : None.
Outputs : result : status flag
0 : if checks failed.
1 : checks OK.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_CHECK_WINDOW [1], EIS_CPT_CHECK_WINDOW [2]
EIS_CPT_HARDWARE_WINDOW [1], EIS_CPT_HARDWARE_WINDOW [2]
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_HEX_RASTER [1], EIS_CPT_HEX_RASTER [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 17/12/04
Modified : Version 0.0, 17/12/04, MKC
Version 0.1, 02/03/05, MKC
Modified check on ASRC skip.
Corrected logic.
Version 0.2, 03/04/05, MKC
Added check on number of data extraction windows.
Version 0.3, 11/04/05, MKC
Added check on data extraction windows.
Corrected range for no. of exposures per raster position.
Version 0.4, 22/06/05, MKC
Moved some of the checks to eis cpt check engineering parameters.
Added check for multiple event control flags.
Changed some of the checks since using UINT values.
Removed check on coarse mirror position.
Version 0.5, 28/06/05, MKC
Implemented case of AEC and XRT flare flags.
Version 0.6, 12/09/05, MKC
Added check that raster ID valid.
Version : 0.6, 12/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECK_STUDIES_LIST
Purpose : Checks various things about the studies list.
Explanation : Checks various things about the studies list.
Use : < result = eis_cpt_check_studies_list ( study_details, engineering_parameters) >
Inputs : study_details : STRUCTURE ARRAY of type EIS_study_detail.
engineering_parameters : STRCUTURE of type EIS_engineering_parameters.
Opt. Inputs : None.
Outputs : result : status flag
0 : if checks failed.
1 : checks OK.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_PROCESS_STUDIES [1], EIS_CPT_PROCESS_STUDIES [2]
EIS_CPT_PROCESS_TIMELINE_STUDIES [1], EIS_CPT_PROCESS_TIMELINE_STUDIES [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 08/02/05
Modified : Version 0.0, 08/02/05, MKC
Version 0.1, 12/07/05, MKC
Added engineering parameters to argument list.
Checked if any non time-tagged studies not onboard.
Version 0.2, 21/09/05, MKC
Added check for multiply defined linked studies (study reuse issue).
Version 0.3, 13/06/06, MKC
Corrected typo.
Added check for invalid study identifiers.
Removed duplicate study check - duplicate studies allowed
(NB check did not work anyway)
Version 0.4, 08/09/06, MKC
Moved check of slit/slot changes.
Version 0.5, 12/10/06, MKC
Checked response study is not an engineering study.
Version : 0.5, 12/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECK_STUDY
Purpose : Checks various study parameters valid.
Explanation : Checks various study parameters valid.
Use : < result = eis_cpt_check_study ( study_detail, study) >
study_detail : STRUCTURE of type EIS_study_detail.
study : STRUCTURE ARRAY of type EIS_raster_detail or EIS_engineering_detail.
Opt. Inputs : None.
Outputs : result : status flag
0 : if checks failed.
1 : checks OK.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2], EIS_CPT_STRTRIM [1]
EIS_CPT_STRTRIM [2], EIS_CPT_UNIQUE [1], EIS_CPT_UNIQUE [2]
EIS_MULTIPLE_SEQUENCE_TABLES [1], EIS_MULTIPLE_SEQUENCE_TABLES [2], UNIQ [1]
UNIQ [2], UNIQ [3]
CALLED BY:
EIS_CPT_PROCESS_STUDY [1], EIS_CPT_PROCESS_STUDY [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 17/12/04
Modified : Version 0.0, 17/12/04, MKC
Version 0.1, 05/05/05, MKC
Added check that study is defined.
Version 0.2, 20/06/05, MKC
Added extra check on study repeat number.
Added check that if study uses event control or AEC then corresponding
flag is set in studies list.
Version 0.3, 13/07/05, MKC
Added check that no. of slit/slot changes agrees with study_detail.
Version 0.4, 13/06/06, MKC
Added Study ID to more error messages.
Version 0.5, 12/10/06, MKC
Added check on linelist details for engineering study.
Version : 0.5, 12/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECK_SYSTEM_VARIABLE
Purpose : Checks if a system variable is set.
Explanation : If the system variable is set then returns true else false.
Use : < result = eis_cpt_check_system_variable(name)>
Inputs : name : STRING system variable name
Opt. Inputs : None.
Outputs : result : INT flag
0 : not set
1 : set
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_DEBUG [1], EIS_CPT_DEBUG [2], EIS_CPT_test_sysv [1]
EIS_CPT_test_sysv [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 18/03/05
Modified : Version 0.0, 18/03/05, MKC
Version : Version 0.0, 18/03/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECK_TABLE
Purpose : Checks an individual OBSTBL table is valid.
Explanation : Checks an individual OBSTBL table is valid.
Use : < result = eis_cpt_check_table ( table, index, SEQUENCE=sequence, LINELIST=linelist, $
AEC_EXPOSURE=aec_exposure, AEC_TABLE=aec_table, $
XRT_FLARE=xrt_flare, EIS_FLARE=eis_flare, $
EIS_EVENT=eis_event) >
Inputs : table : BYTARR() individual OBSTBL table
table_index : INT index in OBSTBL
Opt. Inputs : None.
Outputs : result : status flag
0 : if checks failed.
1 : checks OK.
Opt. Outputs: None.
Keywords : SEQUENCE : FLAG indicating that processing a sequence.
LINELIST : FLAG indicating that processing a linelist
AEC_EXPOSURE : FLAG indicating that processing an AEC exposure table
AEC_TABLE : FLAG indicating that processing an AEC control table
XRT_FLARE : FLAG indicating that processing an XRT flare trigger control table
EIS_FLARE : FLAG indicating that processing an EIS flare trigger control table
EIS_EVENT : FLAG indicating that processing an EIS event trigger control table
TEXT : STRARR[] returns decoded table in MSSL command mnemonic form.
RASTERS : INTARR[] indexes of raster commands returned (sequence table only)
Calls : ***
EIS_CPT_CHECKSUM [1], EIS_CPT_CHECKSUM [2]
EIS_CPT_DECODE_AEC_EXPOSURE_TABLE [1]
EIS_CPT_DECODE_AEC_EXPOSURE_TABLE [2], EIS_CPT_DECODE_AEC_TABLE [1]
EIS_CPT_DECODE_AEC_TABLE [2], EIS_CPT_DECODE_EIS_EVENT_TABLE [1]
EIS_CPT_DECODE_EIS_EVENT_TABLE [2], EIS_CPT_DECODE_EIS_FLARE_TABLE [1]
EIS_CPT_DECODE_EIS_FLARE_TABLE [2], EIS_CPT_DECODE_LINELIST_TABLE [1]
EIS_CPT_DECODE_LINELIST_TABLE [2], EIS_CPT_DECODE_SEQUENCE_TABLE [1]
EIS_CPT_DECODE_SEQUENCE_TABLE [2], EIS_CPT_DECODE_XRT_FLARE_TABLE [1]
EIS_CPT_DECODE_XRT_FLARE_TABLE [2], EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
EIS_CPT_OBSTBL_INDEX [1], EIS_CPT_OBSTBL_INDEX [2], EIS_CPT_STRTRIM [1]
EIS_CPT_STRTRIM [2]
CALLED BY:
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 11/05/05
Modified : Version 0.0, 11/05/05, MKC
Version 0.1, 27/06/05, MKC
Dealt with contrl tables.
Version : 0.1, 27/06/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECK_TIME_PERIOD
Purpose : Checks time_period argument for eis_cpt.
Explanation : Checks argument OK.
Use : < tai_time_period = eis_cpt_check_time_period( study_details, suspension_periods, $
abort_times, bakeout_periods, $
coarse_mirror_commands, real_command_sequences, $
time_period ) >
Inputs : study_details : STRUCTURE ARRAY of type EIS_study_detail.
suspension_periods : STRUCTURE ARRAY of type EIS_suspend_period.
abort_times : STRUCTURE ARRAY of type EIS_abort.
bakeout_periods : STRUCTURE ARRAY of type EIS_bakeout_period.
coarse_mirror_commands : STRUCTURE ARRAY of type EIS_coarse_mirror_command.
real_command_sequences : STRUCTURE ARRAY of type EIS_list_real_detail
time_period : ARRAY[2] time of start and end of period for processing in
any CDS time format.
Changed to TAI on exit.
Opt. Inputs : None.
Outputs : time_period : DOUBLE[2] Time period in TAI format.
UNDEFINED if error.
Opt. Outputs: None.
Keywords : None.
Calls : ***
ANYTIM2TAI, EIS_CPT_BYTESTOHEX [1], EIS_CPT_BYTESTOHEX [2]
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2], EIS_CPT_ULONGTOBYTES [1]
EIS_CPT_ULONGTOBYTES [2]
CALLED BY:
EIS_CPT [1], EIS_CPT [2]
Common : None.
Restrictions: None.
Side effects: Resets !ERROR_STATE system variable.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 06/10/04
Modified : Version 0.0, 06/10/04, MKC
Version 0.1, 21/04/05, MKC
Allowed EIS_CPT to be called without a time period defined.
Version 0.2, 27/09/05, MKC
Changed so that alters time period.
Version 0.3, 14/07/06, MKC
Added further arguments and checks.
Version 0.4, 05/10/06, MKC
Added abort_times argument.
Version : 0.4, 05/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECK_UPLOAD
Purpose : Checks upload pass exists.
Explanation : Checks upload pass exists.
Use : < result = eis_cpt_check_upload ( time_period, contact_info, upload, upload_pass) >
Inputs : time_period : DBLARR[2] TAI time to start and finish timeline.
contact_info : STRUCTURE containing contact period info.
upload : STRUCTURE of type EIS_upload
Opt. Inputs : None.
Outputs : result : status flag
0 : if checks failed.
1 : checks OK.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT [1], EIS_CPT [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/10/05
Modified : Version 0.0, 03/10/05, MKC
Version 0.1, 14/06/06, MKC
Renamed from eis cpt check upload pass.
Added check on ram sub id.
Used EIS upload structure.
Version 0.2, 20/08/06, MKC
Removed RAM sub ID check.
Removed upload pass argument.
Version 0.3, 17/09/06, MKC
Changed check on pass ID.
Version 0.4, 03/10/06, MKC
Changed upload structure.
Changed contact periods structure.
Version : 0.4, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECK_WINDOW
Purpose : Checks window parameters are in range.
Explanation : Checks various parameters associated with the definition of a data extraction window are valid.
Use : < result = eis_cpt_check_window ( hardware_window, extraction_window, readout) >
Inputs : hardware_window : UINT[4] coordinates of Camera hardware window
0 : x start
1 : y start
2 : x size
3 : y size
extraction_window : STRUCTURE of type EIS_data_extraction_window.
readout : STRUCTURE of type EIS_CAM_readout
Opt. Inputs : None.
Outputs : result : status flag
0 : if checks failed.
1 : checks OK.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_CHECK_RASTER [1], EIS_CPT_CHECK_RASTER [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 11/04/05
Modified : Version 0.0, 11/04/05, MKC
Version 0.1, 08/06/05, MKC
Corrected check on data extraction window.
Version 0.2, 24/06/05, MKC
Changed checks since input UINT values.
Version 0.3, 29/06/05, MKC
Corrected check on data extraction window..
Version : 0.3, 29/06/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECK_XRT_FLARE_PARAMETERS
Purpose : Checks the XRT flare parameters are valid.
Explanation : Checks the XRT flare parameters are valid.
Use : < result = eis_cpt_xrt_flare_parameters ( xrt_flare_parameters) >
Inputs : xrt_flare_parameters : STRUCTURE of type EIS_XRT_flare_parameters.
Opt. Inputs : None.
Outputs : result : status flag
0 : if checks failed.
1 : checks OK.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_CHECK_ENGINEERING_PARAMETERS [1]
EIS_CPT_CHECK_ENGINEERING_PARAMETERS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/06/05
Modified : Version 0.0, 22/06/05, MKC
Version : Version 0.0, 22/06/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CHECKSUM
Purpose : Calculates checksum for data.
Explanation :
Use : < checksum = eis_cpt_checksum(bytes) >
Inputs : bytes : BYTARR[] data.
Opt. Inputs : None.
Outputs : checksum : BYTE checksum or checksum test (0:not ok, 1:ok)
Opt. Outputs: None.
Keywords : CHECK : INT FLAG indicating should check the checksum adds to zero.
XXOR : INT FLAG indicating should perform XOR checksum
Calls : None.
CALLED BY:
EIS_CPT_ADD_INTEL_HEX_RECORD [1], EIS_CPT_ADD_INTEL_HEX_RECORD [2]
EIS_CPT_CHECK_TABLE [1], EIS_CPT_CHECK_TABLE [2], EIS_CPT_OBSTBL [1]
EIS_CPT_OBSTBL [2], EIS_CPT_PARSE_INTEL_HEX_FILE [1]
EIS_CPT_PARSE_INTEL_HEX_FILE [2], EIS_CPT_SET_LINELIST [1]
EIS_CPT_SET_LINELIST [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/10/04
Modified : Version 0.0, 22/10/04, MKC
Version : Version 0.0, 22/10/04
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_CLOSE_FILE
Purpose : Closes file.
Explanation : If close fails then returns 0 else returns 1.
Use : < result = eis_cpt_close_file(unit) >
Inputs : UNIT : LONG logical unit number of file.
Opt. Inputs : None.
Outputs : result : INT result 1 : ok, 0 : error
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2], EIS_CPT_STRTRIM [1]
EIS_CPT_STRTRIM [2]
CALLED BY:
EIS_CPT_OBSTBL_MAP_WRITE [1], EIS_CPT_OBSTBL_MAP_WRITE [2]
EIS_CPT_READ_ASCII [1], EIS_CPT_READ_ASCII [2]
EIS_CPT_READ_INTEL_HEX_FILE [1], EIS_CPT_READ_INTEL_HEX_FILE [2]
EIS_CPT_WRITE_ASCII [1], EIS_CPT_WRITE_ASCII [2]
EIS_CPT_WRITE_INTEL_HEX_FILE [1], EIS_CPT_WRITE_INTEL_HEX_FILE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 15/10/04
Modified : Version 0.0, 15/10/04, MKC
Version : Version 0.0, 15/10/04
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_coarse_mirror_command_default
Purpose : Generates default structure EIS_coarse_mirror_command.
Explanation : Sets up default values for structure EIS_coarse_mirror_command.
Use : < s = EIS_CPT_coarse_mirror_command_default(start_time, onboard) >
Inputs : start_time : DOUBLE TAI start time or period.
onboard : INT FLAG :
0 : put command in REAL file
1 : put command in OP
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_coarse_mirror_command.
Opt. Outputs: None.
Keywords : None,
Calls : None.
CALLED BY:
EIS_CPT_LIST_COARSE_MIRROR_COMMANDS [1]
EIS_CPT_LIST_COARSE_MIRROR_COMMANDS [2], EIS_CPT_STRUCTURE_DEFAULTS [1]
EIS_CPT_STRUCTURE_DEFAULTS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 14/01/05
Modified : Version 0.0, 14/01/05
Version 0.1, 10/03/05, MKC
Added description tag.
Version 0.2, 21/03/05, MKC
Added start_time to argument list and changed default times.
Added onboard to argument list.
Version 0.3, 24/06/05, MKC
Changed INT values to UINT.
Version : 0.3, 24/06/05, MKC
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_COMMAND_STORE
Purpose : Performs various processing options associated with the command store.
Explanation : The command store contains REAL commands to be sent from the GS and OP commands for the
on-board time-tagged command store.
The commands are stored within EIS_CPT in a structure array of EIS_CPT_COMMAND_STORE.
At the end of processing the plan the OP commands are written out to two ASCII files :
the OP file and the SEQEXEC file. The REAL commands are written out to the REAL file.
The OP file contains the commands, the SEQEXEC file
contains the time of execution for the commands.
Use : < result = eis_cpt_command_store (onboard, time, command, description, parameter, str_parameter, RESET=reset, OUTPUT=output, ADD=add, $
STAMP=stamp, CHECK=check) >
Inputs : onboard : FLAG indicating whether command onboard or from ground.
time : DOUBLE TAI time of execution for command.
command : STRING mnemonic for OP command sequence :
description : STRING description for command
parameter : INT parameter value (if required)
str_parameter : STRING parameter value (if required)
Opt. Inputs :
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : RESET : FLAG indicating should reset OP
OUTPUT : FLAG indicating should output OP
ADD : FLAG indicating should add command to OP store.
STAMP : STRING stamp for file
CHECK : FLAG indicating should check command store.
Calls : ***
EIS_CPT_COMMAND_STORE_ADD [1], EIS_CPT_COMMAND_STORE_ADD [2]
EIS_CPT_COMMAND_STORE_CHECK [1], EIS_CPT_COMMAND_STORE_CHECK [2]
EIS_CPT_COMMAND_STORE_OUTPUT [1], EIS_CPT_COMMAND_STORE_OUTPUT [2]
EIS_CPT_UNDEFINE [1], EIS_CPT_UNDEFINE [2]
CALLED BY:
EIS_CPT_COMMAND_STORE_PROCESS [1], EIS_CPT_COMMAND_STORE_PROCESS [2]
EIS_CPT_COMPLETE [1], EIS_CPT_COMPLETE [2], EIS_CPT_PRELIMINARIES [1]
EIS_CPT_PRELIMINARIES [2], EIS_CPT_PROCESS [1], EIS_CPT_PROCESS [2]
EIS_CPT_PROCESS_ABORT_TIMES [1], EIS_CPT_PROCESS_ABORT_TIMES [2]
EIS_CPT_PROCESS_BAKEOUT_PERIODS [1], EIS_CPT_PROCESS_BAKEOUT_PERIODS [2]
EIS_CPT_PROCESS_COARSE_MIRROR_COMMANDS [1]
EIS_CPT_PROCESS_COARSE_MIRROR_COMMANDS [2]
EIS_CPT_PROCESS_REAL_COMMAND_SEQUENCES [1]
EIS_CPT_PROCESS_REAL_COMMAND_SEQUENCES [2], EIS_CPT_PROCESS_STUDIES [1]
EIS_CPT_PROCESS_STUDIES [2], EIS_CPT_PROCESS_SUSPENSION_PERIODS [1]
EIS_CPT_PROCESS_SUSPENSION_PERIODS [2]
Common : EIS_CPT_command_block
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 01/03/05
Modified : Version 0.0, 01/03/05
Version 0.1, 07/03/05, MKC
Added ADD keyword.
Version 0.2, 24/03/05, MKC
Changed name of COMMON block.
Added onboard parameter to commands.
Changed name of eis cpt add jside command.
Added CHECK keyword.
Used eis cpt command store output.
Adapted from eis cpt op.
Version 0.3, 16/05/05, MKC
Changed type argument to onboard.
Version 0.4, 29/09/05, MKC
Replaced REAL, OP, SEQEXEC files with single ORL file.
Version 0.5, 22/05/06, MKC
Replaced initialization of commands with 0 with undefining commands for
compatability with IDL 6.2.
Version 0.6, 03/10/06, MKC
Changed TIMESTAMP keyword to STAMP.
Added additional string parameter.
Version : 0.6, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_command_store__define
Purpose : Generates structure EIS_CPT_command_store.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case filename.
EIS_CPT_command_store. Tags are :-
time : DOUBLE TAI time of execution for command.
onboard : INT FLAG indicating whether command in OP (1) or GSE (0)
command : STRING mnemonic for OP command sequence :
description : STRING description for command
parameter : INT parameter value (if required)
og_number : UINT OG number for command.
exists : INT flag indicating that OG already set up
Use : <dummy = {EIS_CPT_command_store}>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 08/03/05
Modified : Version 0.0, 08/03/05, MKC
Version 0.1, 24/03/05, MKC
Added onboard tag.
Renamed from eis cpt jside command define.
Version 0.2, 01/10/05, MKC
Added OG number for command and exists tags.
Added additional string parameter.
Version : 0.2, 01/10/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_COMMAND_STORE_ADD
Purpose : Adds a command to EIS CPT command store.
Explanation : The commands are stored within EIS_CPT in a structure array of EIS_CPT_COMMAND_STORE.
Use : < result = eis_cpt_command_store_add (commands, type, time, onboard, command, description,$
parameter, str_parameter) >
Inputs : commands : STRUCTURE ARRAY of EIS_CPT_COMMAND_STORE.
onboard : FLAG indicating whether command onboard or from ground.
time : DOUBLE TAI time of execution for command.
command : STRING mnemonic for command sequence :
description : STRING description for command
parameter : INT parameter value (if required)
str_parameter : STRING parameter value (if required)
Opt. Inputs :
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
ANYTIM2CAL, EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_MESSAGE [1]
EIS_CPT_MESSAGE [2], LAST_ITEM
CALLED BY:
EIS_CPT_COMMAND_STORE [1], EIS_CPT_COMMAND_STORE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 08/03/05
Modified : Version 0.0, 08/03/05
Version 0.1, 24/03/05, MKC
Changed name from eis cpt add jside command.
Added type argument.
Version 0.2, 16/05/05, MKC
Changed type argument to onboard.
Version 0.3, 01/10/05, MKC
Added check if command already present and command number.
Version 0.4, 25/09/06, MKC
Changed set up of new command parameter.
Fixed bug with real sequences taking up og numbers.
Fixed bug with duplicate onboard and real studies.
Added additional string parameter.
Version : 0.4 25/09/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_COMMAND_STORE_CHECK
Purpose : Checks the commands in the command store.
Explanation : The command times should be unique.
Command times should have 1 second resolution.
PAUSE commands should be followed by RESUME command.
Use : < result = eis_cpt_command_store_check (commands) >
Inputs : commands : STRUCTURE ARRAY of EIS_CPT_COMMAND_STORE.
Opt. Inputs :
Outputs : result : INT flag :
1 : processed OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2], TAI2UTC, UNIQ [1], UNIQ [2], UNIQ [3]
UTC2TAI
CALLED BY:
EIS_CPT_COMMAND_STORE [1], EIS_CPT_COMMAND_STORE [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 08/03/05
Modified : Version 0.0, 08/03/05
Version 0.1, 24/03/05, MKC
Rename from eis cpt op check and included GSE commands.
Version 0.2, 21/04/05, MKC
Allowed no commands in command store.
Version : Version 0.2, 21/04/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_COMMAND_STORE_OUTPUT
Purpose : Outputs the commands in the command store to the ASCII ORL file.
Explanation : The OP is the on-board time-tagged command store.
Commands for the OP and GSE are stored within EIS_CPT in a structure array of EIS_CPT_COMMAND_STORE.
Use : < result = eis_cpt_command_store_output (commands, STAMP=stamp) >
Inputs : commands : STRUCTURE ARRAY of EIS_CPT_COMMAND_STORE.
Opt. Inputs :
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : STAMP : STRING stamp for file
Calls : ***
EIS_CPT_COMMAND_STORE_PROCESS [1], EIS_CPT_COMMAND_STORE_PROCESS [2]
EIS_CPT_FILE_NAME [1], EIS_CPT_FILE_NAME [2], EIS_CPT_WRITE_ASCII [1]
EIS_CPT_WRITE_ASCII [2]
CALLED BY:
EIS_CPT_COMMAND_STORE [1], EIS_CPT_COMMAND_STORE [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 08/03/05
Modified : Version 0.0, 08/03/05
Version 0.1, 17/03/05, MKC
Used eis cpt file name.
Version 0.2, 24/03/05, MKC
Changed command store to include GSE commands..
Used eis cpt command store process.
Derived from eis cpt op output.
Added type argument.
Version 0.3, 22/04/05, MKC
Allowed command store to contain no commands.
Version 0.4, 09/05/05, MKC
Produce output even if no commands.
Version 0.5, 29/09/05, MKC
Replaced REAL, OP, SEQEXEC files with single ORL file.
Version 0.6, 17/09/06, MKC
Added printout.
Version 0.7, 25/09/06, MKC
Combined processing of SEQEXEC, REAL, OP and OG commands.
Version 0.9, 03/10/06, MKC
Changed TIMESTAMP keyword to STAMP.
Version : 0.9, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_COMMAND_STORE_PROCESS
Purpose : Processes a command from the command store.
Explanation : The commands are stored within EIS_CPT in a structure array of EIS_CPT_COMMAND_STORE.
The commands are stored in the OP and REAL files as sequences by their sequence name.
Use : < result = eis_cpt_command_store_process (commands, text) >
Inputs : commands : STRUCTURE ARRAY of EIS_CPT_COMMAND_STORE.
text : STRARR[] ASCII output so far
Opt. Inputs :
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
text : STRARR[] containing updated ASCIII output
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_COMMAND_STORE [1]
EIS_CPT_COMMAND_STORE [2], EIS_CPT_JSIDE_PROCESS [1]
EIS_CPT_JSIDE_PROCESS [2], LAST_ITEM
CALLED BY:
EIS_CPT_COMMAND_STORE_OUTPUT [1], EIS_CPT_COMMAND_STORE_OUTPUT [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 08/03/05
Modified : Version 0.0, 08/03/05
Version 0.1, 19/03/05, MKC
Added eis cpt op check.
Version 0.2, 24/03/05, MKC
Changed command store to include GSE commands.
Adapted from eis cpt op process.
Version 0.3, 09/05/05, MKC
Produce output even if no commands.
Corrected bug processing REAL commands.
Added BAKEOUT commands.
Version 0.4, 16/05/05, MKC
Corrected behaviour if no commands for type.
Version 0.5, 20/06/05, MKC
Changed output format of sequence name to decimal.
Version 0.6, 28/06/05, MKC
Added FILE command to command store.
Version 0.7, 12/09/05, MKC
Used eis cpt sib.
Added CCD heater commands.
Changed BAKEOUT treatment.
Version 0.8, 03/10/05, MKC
Added LOAD command.
Version 0.9, 12/07/06, MKC
Prepended 'EIS_' to sequence names in ORL file.
Version 1.0, 20/08/06, MKC
Changed LOAD command parameters.
Version 1.1, 17/09/06, MKC
Removed Select AUTO command from LOAD_OBSTBL command sequence.
Added ';' to ENTRY command.
Removed 'C.' from command description.
Added DUMP OBSTBL command.
Version 1.2, 25/09/06, MKC
Changed ORL sequence name.
Removed type from argument list.
Process SEQEXEC, REAL, OP and OG in parallel.
Used eis cpt jside process.
Version : 1.2, 25/09/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_COMPLETE
Purpose : Outputs data generated by EIS_CPT.
Explanation : Writes output from EIS_CPT to files.
Use : < result = eis_cpt_complete(stamp) >
Inputs : stamp : STRING used for labelling files.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_COMMAND_STORE [1], EIS_CPT_COMMAND_STORE [2], EIS_CPT_DATA_RATE [1]
EIS_CPT_DATA_RATE [2], EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2]
CALLED BY:
EIS_CPT [1], EIS_CPT [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 21/10/04
Modified : Version 0.0, 21/10/04, MKC
Version 0.1, 03/02/05, MKC
Used eis cpt obstbl.
Removed obstbl from common block.
Version 0.2, 01/03/05, MKC
Used EIS CPT op, dv and real
Removed COMMON block.
Added output of timestamped version of OBSTBL.
Changed format of timestamp.
Version 0.3, 23/03/05, MKC
Added TIMESTAMP versions of DV and REAL.
Added command store check.
Used eis cpt command store.
Added JSIDE keyword.
Version 0.4, 03/04/05, MKC
Added TIMESTAMP keyword.
Version 0.5, 16/05/05, MKC
Changed eis cpt command store arguments.
Version 0.6, 13/09/05, MKC
Added PASS keyword.
Changed so that only produces one output version.
Changed TIMESTAMP keyword to STAMP.
Version 0.7, 16/09/05, MKC
Changed behaviour of STAMP keyword.
Added data rate file processing.
Version 0.8, 07/10/05, MKC
Moved command store check.
Removed JSIDE keyword.
Version 0.9, 20/05/06, MKC
Added argument check.
Version 1.0, 20/08/06, MKC
Changed arguments.
Version 1.1, 03/10/06, MKC
Changed upload structure.
Changed arguments.
Changed TIMESTAMP keyword to STAMP.
Changed names of internal obstbl files.
Version : 1.1, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_COMPOSE_INTEL_HEX_FILE
Purpose : Converts data into Intel Hex format.
Explanation : This routine converts the input data into Intel hex format.
The Intel format data is returned as a BYTE array.
The byte data is stored continuously from start_address.
Use : < hex_record = eis_cpt_compose_intel_hex_file(data) >
Inputs : data : BYTARR[] raw data.
Opt. Inputs : None.
Outputs : hex_record : BYTARR[] intel hex format values.
Opt. Outputs: None.
Keywords : HEADER : STRING header string for file.
ULBA : UINT extended linear address : upper 16 bits of 32 bit address.
NB will not get added if zero
START_ADDRESS : UINT start address : lower 16 bits of 32 bit address.
NOENDOFFILE : FLAG indicating not to output end of file record.
Calls : ***
EIS_CPT_ADD_INTEL_HEX_RECORD [1], EIS_CPT_ADD_INTEL_HEX_RECORD [2]
EIS_CPT_GET_INTEL_HEX_RECORD_LENGTH [1]
EIS_CPT_GET_INTEL_HEX_RECORD_LENGTH [2]
CALLED BY:
EIS_CPT_WRITE_INTEL_HEX_FILE [1], EIS_CPT_WRITE_INTEL_HEX_FILE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/10/04
Modified : Version 0.1, 02/11/04, MKC
Added HEADER keyword.
Added ULBA keyword.
Version 0.2, 29/04/05, MKC
Added keyword START_ADDRESS.
Version 0.3, 12/05/05, MKC
Added keyword NOENDOFFILE.
Version 0.4, 05/07/05, MKC
Used eis cpt get intel hex record length.
Version 0.5, 22/05/06, MKC
Removed initialization of dummy.
Version : 0.5, 22/05/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_contacts_default
Purpose : Generates default anonymous structure for EIS contacts.
Explanation : Generates default anonymous structure for EIS contacts.
Use : < s = EIS_CPT_contacts_default(start_time, duration) >
Inputs : start_time : DOUBLE TAI start time or period.
duration : DOUBLE duration in seconds
Opt. Inputs : None.
Outputs : s : STRUCTURE of type anonymous containing contacts info.
Opt. Outputs: None.
Keywords : None,
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2]
CALLED BY:
EIS_CPT_test_parameters [1], EIS_CPT_test_parameters [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/10/06
Modified : Version 0.0, 03/10/06, MKC
Version : 0.0, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_control_details_default
Purpose : Generates default structure EIS_control_details.
Explanation : Sets up default values for structure EIS_control_details.
Use : < s = EIS_CPT_control_details_default(xrtflare_study_id, xrtfiller_study_id, $
eisflare_study_id, eisevent_study_id, adjust_y) >
Inputs : xrtflare_study_id : LONG study identifier
xrtfiller_study_id : LONG study identifier
eisflare_study_id : LONG study identifier
eisevent_study_id : LONG study identifier
adjust_y : INT flag
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_control_detail.
Opt. Outputs: None.
Keywords : None,
Calls : ***
EIS_CPT_AEC_control_default [1], EIS_CPT_AEC_control_default [2]
EIS_CPT_XRT_flare_control_default [1]
EIS_CPT_XRT_flare_control_default [2], EIS_CPT_event_control_default [1]
EIS_CPT_event_control_default [2], EIS_CPT_flare_control_default [1]
EIS_CPT_flare_control_default [2]
CALLED BY:
EIS_CPT_GET_CONTROL [1], EIS_CPT_GET_CONTROL [2]
EIS_CPT_STRUCTURE_DEFAULTS [1], EIS_CPT_STRUCTURE_DEFAULTS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : Moved out of routine EIS_raster_detail__define.
Written : Martin Carter RAL 28/02/05
Modified : Version 0.0, 28/08/04, MKC
Renamed EIS XRT flare response, EIS flare response, EIS event response structures
to EIS XRT flare control, EIS flare control, EIS event control.
Version 0.1, 24/06/05, MKC
Changed INT values to UINT.
Added response_study_id and adjust_y arguments.
Version 0.2, 13/09/05, MKC
Removed sub ID tag.
Version 0.3, 28/09/05, MKC
Added filler study.
Version 0.4, 21/06/06, MKC
Added eis flare and event studies.
Version : 0.4, 21/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_DAISY_CHAIN
Purpose : Gets list of time line studies in daisy_chain.
Explanation : Follows daisy-chain until terminates or interrupted.
Issues a warning if the daisy-chain interrupted.
Ensures that times in timeline are monotonic.
Use : < result = eis_cpt_timeline ( study_details, interrupt_time, link, start_time, timeline) >
Inputs : study_details : STRUCTURE ARRAY of type EIS_study_detail.
interrupt_time : DOUBLE TAI time to finish timeline.
link : INT index into study_details giving the start of the daisy-chain
start_time : DOUBLE TAI start time of first study in daisy-chain
timeline : STRUCTURE ARRAY of type EIS_CPT_timeline so far
NB will be changed on exit
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
timeline : STRUCTURE ARRAY of type EIS_CPT_timeline updated
Opt. Outputs: None.
Keywords : COMPLETE : INT flag indicating should carry on until daisy-chain terminates.
If there is a daisy-chain loop then will terminate after one pass through loop
and set the loop tag.
Calls : ***
ANYTIM2CAL, EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_MESSAGE [1]
EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_RESPONSE_TIMELINE [1], EIS_CPT_RESPONSE_TIMELINE [2]
EIS_CPT_TIMELINE [1], EIS_CPT_TIMELINE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 23/09/05
Modified : Version 0.0, 23/09/05, MKC
Version 0.1, 29/09/05, MKC
Changed behaviour with respect to errors and warnings and daisy-chain loops.
Version 0.2, 15/09/06, MKC
Fixed bug with single looped study if COMPLETE used.
Added check.
Fixed bug with end time calculation.
Version : 0.2, 15/09/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_data_extraction_window_default
Purpose : Generates default structure EIS_data_extraction_window.
Explanation : Sets up default values for structure EIS_data_extraction_window.
Use : <s = EIS_CPT_data_extraction_window_default(xadd, node)>
Inputs : xadd : INT parameter to modify window.
node : UINT indicating readout node.
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_data_extraction_window.
Opt. Outputs: None.
Keywords :
Calls : None.
CALLED BY:
EIS_CPT_raster_detail_default [1], EIS_CPT_raster_detail_default [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/09/04
Modified : Version 0.1, 16/11/04, MKC
Added description tag.
Version 0.2, 03/04/05, MKC
Added xadd argument.
Version 0.3, 24/06/05, MKC
Changed INT values to UINT.
Version 0.4, 28/06/05, MKC
Added NODE argument to switch nodes.
Version : 0.3, 24/06/05, MKC
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_DATA_RATE
Purpose : Produces the data rate file.
Explanation : Produces the data rate file.
Use : < result = eis_cpt_data_rate(engineering_parameters, study_details, contact_info, timeline) >
Inputs : engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
study_details : STRUCTURE ARRAY of type EIS_study_detail.
contact_info : STRUCTURE containing contact period info.
timeline : STRUCTURE ARRAY of type EIS_CPT_timeline updated
time_period : DBLARR[2] TAI time of start and finish
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : RESET : FLAG indicating should reset data rate info
PROCESS : FLAG indicating should process data rate info
OUTPUT : FLAG indicating should output data rate info
STAMP : STRING stamp for file
TIME_PERIOD : CDS TIME[2] defining observation plan time period.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_DATA_RATE_PROCESS [1]
EIS_CPT_DATA_RATE_PROCESS [2], EIS_CPT_FILE_NAME [1], EIS_CPT_FILE_NAME [2]
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2], EIS_CPT_UNDEFINE [1]
EIS_CPT_UNDEFINE [2], EIS_CPT_WRITE_ASCII [1], EIS_CPT_WRITE_ASCII [2]
SEC2DHMS
CALLED BY:
EIS_CPT_COMPLETE [1], EIS_CPT_COMPLETE [2], EIS_CPT_PRELIMINARIES [1]
EIS_CPT_PRELIMINARIES [2], EIS_CPT_PROCESS [1], EIS_CPT_PROCESS [2]
Common : None.
Restrictions: None.
Side effects: Returns to calling routine if error.
Resets !ERROR_STATE system variable.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/09/05
Modified : Version 0.0, 22/09/05, MKC
Version 0.1, 03/10/05, MKC
Removed check on first contact.
Version 0.2, 22/05/06, MKC
Changed initialization of data_rate_text from '' for compatability with IDL 6.2..
Version 0.3, 14/06/06, MKC
Moved check of whether contact periods defined elsewhere.
Removed CHECK keywrod.
Version 0.4, 17/09/06, MKC
Added printout.
Version 0.5, 23/09/06, MKC
Added enegineering paraemeters argument.
Added OBSTBL upload time output.
Version 0.6, 03/10/06, MKC
Changed TIMESTAMP keyword to STAMP.
Changed contact periods structure.
Version : 0.6, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_DATA_RATE_PROCESS
Purpose : Processes the data rate info.
Explanation : Processes the data rate info.
Use : < result = eis_cpt_data_rate_process(study_details, contact_info, timeline, time_period) >
Inputs : study_details : STRUCTURE ARRAY of type EIS_study_detail.
contact_info : STRUCTURE containing contact period info.
timeline : STRUCTURE ARRAY of type EIS_CPT_timeline updated
time_period : DBLARR[2] TAI time of start and finish
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
ANYTIM2CAL, EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_DATARATE_OUTPUT [1]
EIS_CPT_DATARATE_OUTPUT [2], EIS_CPT_TIMELINE_OUTPUT [1]
EIS_CPT_TIMELINE_OUTPUT [2]
CALLED BY:
EIS_CPT_DATA_RATE [1], EIS_CPT_DATA_RATE [2]
Common : None.
Restrictions: None.
Side effects: Returns to calling routine if error.
Resets !ERROR_STATE system variable.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/09/05
Modified : Version 0.0, 22/09/05, MKC
Version 0.1, 20/05/06, MKC
Removed unused timeout keyword check.
Version 0.2, 03/10/06, MKC
Changed contact periods structure.
Version : 0.2, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_DATARATE_ITEM_OUTPUT
Purpose : Outputs a data rate item.
Explanation : Outputs a data rate item.
Use : < eis_cpt_datarate_item_output, text, rat, item >
Inputs : text : STRARR of text
rat : FLOAT data rate in Mbits/s generated between periods
item : STRUCTURE containing contact period info
Opt. Inputs : None.
Outputs : text : STRARR of text
Opt. Outputs: None.
Keywords : FORMAT : INT flag indicating should write the format used.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_TIMEFORMAT [1]
EIS_CPT_TIMEFORMAT [2]
CALLED BY:
EIS_CPT_DATARATE_OUTPUT [1], EIS_CPT_DATARATE_OUTPUT [2]
Common : None.
Restrictions: None.
Side effects: Returns to calling routine if error.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/10/06
Modified : Version 0.0, 03/10/06, MKC
New routine.
Version : 0.0, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_DATARATE_OUTPUT
Purpose : Outputs the datarate info.
Explanation : Outputs the datarate info.
Use : < result = eis_cpt_datarate_output(study_details, contact_info, timeline, time_period) >
Inputs : study_details : STRUCTURE ARRAY of type EIS_study_detail.
contact_info : STRUCTURE containing contact period info.
timeline : STRUCTURE ARRAY of type EIS_CPT_timeline updated
time_period : DBLARR[2] TAI time of start and finish
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
ANYTIM2CAL, EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_DATARATE_ITEM_OUTPUT
EIS_CPT_DATAVOL_ITEM_OUTPUT [1], EIS_CPT_DATAVOL_ITEM_OUTPUT [2]
EIS_CPT_EXTRACT_PERIOD [1], EIS_CPT_EXTRACT_PERIOD [2], EIS_CPT_STRTRIM [1]
EIS_CPT_STRTRIM [2]
CALLED BY:
EIS_CPT_DATA_RATE_PROCESS [1], EIS_CPT_DATA_RATE_PROCESS [2]
Common : None.
Restrictions: None.
Side effects: Returns to calling routine if error.
Resets !ERROR_STATE system variable.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/09/05
Modified : Version 0.0, 22/09/05, MKC
Version 0.1, 03/10/05, MKC
Allowed observation plan to start before first contact.
Version 0.2, 10/10/05, MKC
Usd eis cpt datarate item output.
Version 0.3, 03/10/06, MKC
Changed contact periods structure.
Changed printout to Mbits.
Used routine eis cpt datavol item output.
Version : 0.3, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_DATAVOL_ITEM_OUTPUT
Purpose : Outputs a data rate item.
Explanation : Outputs a data rate item.
Use : < eis_cpt_datavol_item_output, text, vol, dr, eis_vol, item >
Inputs : text : STRARR of text
vol : FLOAT data volume in Mbits generated between contacts
dr : FLOAT cumulative data volume in Mbits
eis_vol : LONG data recorder limit in Mbits.
item : STRUCTURE containing contact period info
Opt. Inputs : None.
Outputs : text : STRARR of text
Opt. Outputs: None.
Keywords : FORMAT : INT flag indicating should write the format used.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_TIMEFORMAT [1]
EIS_CPT_TIMEFORMAT [2]
CALLED BY:
EIS_CPT_DATARATE_OUTPUT [1], EIS_CPT_DATARATE_OUTPUT [2]
Common : None.
Restrictions: None.
Side effects: Returns to calling routine if error.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 10/10/05
Modified : Version 0.0, 10/10/05, MKC
Version 0.1, 17/09/06, MKC
Changed pass ID to 4 characters.
Version 0.2, 03/10/06, MKC
Changed item structure.
Removed AFTER, NOCONTACT, NOPLAN, PERIOD keywords.
Renamed from eis cpt datarate item output.
Version : 0.2, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_DEBUG
Purpose : Checks if the !EIS_CPT_DEBUG system variable is set.
Explanation : If the !EIS_CPT_DEBUG system variable is set then returns true else false.
Use : < result = eis_cpt_debug()>
Inputs : None.
Opt. Inputs : None.
Outputs : result : INT flag
0 : not set
1 : set
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_CHECK_SYSTEM_VARIABLE [1], EIS_CPT_CHECK_SYSTEM_VARIABLE [2]
CALLED BY:
EIS_CPT [1], EIS_CPT [2], EIS_CPT_OBSTBL_REFRESH [1]
EIS_CPT_OBSTBL_REFRESH [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 07/10/04
Modified : Version 0.0, 07/10/04, MKC
Version 0.1, 18/03/05, MKC
Used eis cpt check system variable.
Version : Version 0.1, 18/03/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_DECODE_AEC_EXPOSURE_TABLE
Purpose : Converts OBSTBL table to MSSL format mnemonics
Explanation : Produces individual ASCII file for AEC exposure table in MSSL command mnemonic form.
Use : < result = eis_cpt_decode_aec_exposure_table ( table, text ) >
Inputs : table : BYTARR() table data.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
text : STRARR() ASCII output.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_BYTESTOULONG [1]
EIS_CPT_BYTESTOULONG [2], EIS_CPT_STRTRIM [1], EIS_CPT_STRTRIM [2]
CALLED BY:
EIS_CPT_CHECK_TABLE [1], EIS_CPT_CHECK_TABLE [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 27/06/05
Modified : Version 0.0, 27/06/05, MKC
Version : Version 0.0, 27/06/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_DECODE_AEC_TABLE
Purpose : Converts OBSTBL table to MSSL format mnemonics
Explanation : Produces individual ASCII file for AEC table in MSSL command mnemonic form.
Use : < result = eis_cpt_decode_aec_table ( table, text ) >
Inputs : table : BYTARR() table data.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
text : STRARR() ASCII output.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_BYTESTOHEX [1]
EIS_CPT_BYTESTOHEX [2], EIS_CPT_STRTRIM [1], EIS_CPT_STRTRIM [2]
CALLED BY:
EIS_CPT_CHECK_TABLE [1], EIS_CPT_CHECK_TABLE [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 27/06/05
Modified : Version 0.0, 27/06/05, MKC
Version 0.1, 04/10/05, MKC
Updated mnemonics.
Version : 0.1, 04/10/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_DECODE_EIS_EVENT_TABLE
Purpose : Converts OBSTBL table to MSSL format mnemonics
Explanation : Produces individual ASCII file for EIS event table in MSSL command mnemonic form.
Use : < result = eis_cpt_decode_eis_event_table ( table, text ) >
Inputs : table : BYTARR() table data.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
text : STRARR() ASCII output.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_BYTESTOHEX [1]
EIS_CPT_BYTESTOHEX [2], EIS_CPT_BYTESTOMSSL [1], EIS_CPT_BYTESTOMSSL [2]
EIS_CPT_STRTRIM [1], EIS_CPT_STRTRIM [2]
CALLED BY:
EIS_CPT_CHECK_TABLE [1], EIS_CPT_CHECK_TABLE [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 27/06/05
Modified : Version 0.0, 27/06/05, MKC
Version 0.1, 04/10/05, MKC
Updated mnemonics.
Version : 0.1, 04/10/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_DECODE_EIS_FLARE_TABLE
Purpose : Converts OBSTBL table to MSSL format mnemonics
Explanation : Produces individual ASCII file for EIS flare table in MSSL command mnemonic form.
Use : < result = eis_cpt_decode_eis_flare_table ( table, text ) >
Inputs : table : BYTARR() table data.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
text : STRARR() ASCII output.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_BYTESTOHEX [1]
EIS_CPT_BYTESTOHEX [2], EIS_CPT_BYTESTOMSSL [1], EIS_CPT_BYTESTOMSSL [2]
EIS_CPT_STRTRIM [1], EIS_CPT_STRTRIM [2]
CALLED BY:
EIS_CPT_CHECK_TABLE [1], EIS_CPT_CHECK_TABLE [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 27/06/05
Modified : Version 0.0, 27/06/05, MKC
Version 0.1, 04/10/05, MKC
Updated mnemonics.
Version : 0.1, 04/10/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_DECODE_LINELIST_TABLE
Purpose : Converts OBSTBL table to MSSL format mnemonics
Explanation : Produces individual ASCII files for line list table in MSSL command mnemonic form.
Use : < result = eis_cpt_decode_linelist_table ( index, table, text ) >
Inputs : index : INT table index
table : BYTARR() table data.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
text : STRARR() ASCII output.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_BYTESTOHEX [1]
EIS_CPT_BYTESTOHEX [2], EIS_CPT_BYTESTOUINT [1], EIS_CPT_BYTESTOUINT [2]
EIS_CPT_STRTRIM [1], EIS_CPT_STRTRIM [2], EIS_CPT_UINTTOMSSL [1]
EIS_CPT_UINTTOMSSL [2]
CALLED BY:
EIS_CPT_CHECK_TABLE [1], EIS_CPT_CHECK_TABLE [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 11/04/05
Modified : Version 0.0, 11/04/05, MKC
Version 0.1, 25/04/05, MKC
Removed initialization of text output.
Added check for zero length table.
Corrected format of linelist table.
Removed ISACS format output.
Removed check on table being zero.
Version 0.2, 15/05/05, MKC
Allowed index to be undefined.
Version 0.3, 04/10/05, MKC
Updated mnemonics.
Allowed -1 as table index.
Version : 0.3, 04/10/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_DECODE_SEQUENCE_TABLE
Purpose : Converts OBSTBL table to MSSL format mnemonics
Explanation : Produces individual ASCII files for each sequence table in MSSL command mnemonic form.
Use : < result = eis_cpt_decode_sequence_table ( index, table, text) >
Inputs : index : INT table index (-1 or undefined if not known)
table : BYTARR() table data.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
text : STRARR() ASCII output.
Opt. Outputs: None.
Keywords : RASTERS : INTARR[] indeses of raster commands returned.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_BYTESTOHEX [1]
EIS_CPT_BYTESTOHEX [2], EIS_CPT_BYTESTOMSSL [1], EIS_CPT_BYTESTOMSSL [2]
EIS_CPT_BYTESTOUINT [1], EIS_CPT_BYTESTOUINT [2], EIS_CPT_MESSAGE [1]
EIS_CPT_MESSAGE [2], EIS_CPT_MSSL_COMMANDS [1], EIS_CPT_MSSL_COMMANDS [2]
EIS_CPT_STRTRIM [1], EIS_CPT_STRTRIM [2], EIS_CPT_UINTTOMSSL [1]
EIS_CPT_UINTTOMSSL [2]
CALLED BY:
EIS_CPT_CHECK_TABLE [1], EIS_CPT_CHECK_TABLE [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 11/04/05
Modified : Version 0.0, 11/04/05, MKC
Version 0.1, 25/04/05, MKC
Removed initialization of text output.
Added check for zero length table.
Removed keywords.
Version 0.2, 27/04/05, MKC
Corrected asrc_ctl and added bytes command to output.
Version 0.3, 11/05/05, MKC
Added check on loop back position.
Added check on table index.
Modified check on table length.
Removed check on table being zero.
Version 0.4, 15/05/05, MKC
Allowed index to be undefined.
Version 0.5, 27/06/05, MKC
Removed unnecessary STRING call.
Used eis cpt bytestomssl.
Used eis_cpt_uinttomssl.
Version 0.6, 04/10/05, MKC
Added MSSL keyword to bytes to hex.
Allowed -1 as table index.
Version : 0.6, 04/10/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_DECODE_XRT_FLARE_TABLE
Purpose : Converts OBSTBL table to MSSL format mnemonics
Explanation : Produces individual ASCII file for XRT flare table in MSSL command mnemonic form.
Use : < result = eis_cpt_decode_xrt_flare_table ( table, text ) >
Inputs : table : BYTARR() table data.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
text : STRARR() ASCII output.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_BYTESTOHEX [1]
EIS_CPT_BYTESTOHEX [2], EIS_CPT_BYTESTOMSSL [1], EIS_CPT_BYTESTOMSSL [2]
EIS_CPT_BYTESTOUINT [1], EIS_CPT_BYTESTOUINT [2], EIS_CPT_STRTRIM [1]
EIS_CPT_STRTRIM [2]
CALLED BY:
EIS_CPT_CHECK_TABLE [1], EIS_CPT_CHECK_TABLE [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 27/06/05
Modified : Version 0.0, 27/06/05, MKC
Version 0.1, 04/10/05, MKC
Updated mnemonics.
Version : 0.1, 04/10/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_engineering_detail_default
Purpose : Generates default structure EIS_engineering_detail.
Explanation : Sets up default values for structure EIS_engineering_detail.
Use : < s = EIS_CPT_engineering_detail_default(file, linelists) >
Inputs : file : STRING filename of type 'directory/description.eng_ssss_bbbb'
where
description : is some text describing the purpose of the engineering study;
eng : is the 3 character string 'eng'.
ssss : is the 4 digit duration in seconds;
bbbb : is the 4 digit number of Kbytes of data generated by the engineering study
linelists : STRARR linelist file names or ''
indexes : UINTARR linelist indexes or 0
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_engineering_detail.
Opt. Outputs: None.
Keywords : None
Calls : ***
EIS_CPT_GET_ENGINEERING_DETAIL
CALLED BY:
EIS_CPT_STRUCTURE_DEFAULTS [1], EIS_CPT_STRUCTURE_DEFAULTS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 23/09/04
Modified : Version 0.0, 23/09/04, MKC
Version 0.1, 03/11/04, MKC
Used routine eis_get_engineering_detail to derive default structure from filename.
Version 0.2, 06/05/05, MKC
Changed engineering filename format.
Added linelist.
Added onboard keyword.
Version 0.2, 15/05/05, MKC
Added FILE and LINELIST Keywords.
Removed onboard.
Version 0.3, 23/09/06, MKC
Renamed eis get engineering detail.
Version 0.4 11/10/06, MKC
Added multiple linelist filenames.
Added indexes argument.
Version : 0.4 11/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_engineering_parameters_default
Purpose : Generates default structure EIS_engineering_parameters.
Explanation : Sets up default values for structure EIS_engineering_parameters.
Use : < s = EIS_CPT_engineering_parameters(nodes) >
Inputs : nodes : UINTARR[4] indicating readout nodes enabled.
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_engineering_parameters.
Opt. Outputs: None.
Keywords : None,
Calls : ***
EIS_CPT_AEC_EXPOSURE_TIMES_DEFAULT [1]
EIS_CPT_AEC_EXPOSURE_TIMES_DEFAULT [2], EIS_CPT_CAM_readout_default [1]
EIS_CPT_CAM_readout_default [2], EIS_CPT_XRT_flare_parameters_default [1]
EIS_CPT_XRT_flare_parameters_default [2]
EIS_CPT_bakeout_parameters_default [1]
EIS_CPT_bakeout_parameters_default [2]
EIS_CPT_flare_parameters_default [1], EIS_CPT_flare_parameters_default [2]
EIS_CPT_mechanism_control_default [1]
EIS_CPT_mechanism_control_default [2]
CALLED BY:
EIS_CPT_GET_ENGINEERING [1], EIS_CPT_GET_ENGINEERING [2]
EIS_CPT_STRUCTURE_DEFAULTS [1], EIS_CPT_STRUCTURE_DEFAULTS [2]
eis_get_engineering [1], eis_get_engineering [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 23/09/04
Modified : Version 0.1, 29/09/04, MKC
Adjusted no. of CCD flushes from 2 in line with Seq.00
Version 0.2, 14/10/04, MKC
Added AEC_exposure_time_table.
Version 0.3, 20/10/04, MKC
Added safety_margin_time.
Added EIS OBSTBL RAM sub ID.
Version 0.4, 30/11/04, MKC
Removed flush_CCDS.
Version 0.5, 14/02/05, MKC
Added special and AEC safety margin times.
Used eis cpt default AEC exposure times.
Version 0.6, 23/02/05, MKC
Renamed special safety margin times.
Version 0.7, 28/02/05, MKC
Renamed EIS XRT flare control, EIS flare control
to EIS XRT flare parameters, EIS flare parameters.
Removed EIS event control structure.
Moved OBSTBL RAM sub ID.
Version 0.8, 24/06/05, MKC
Changed INT values to UINT.
Changed saftey margin times to ULONGs.
Version 0.9, 29/06/05, MKC
Added node argument..
Version 1.0, 08/09/05, MKC
Added eis bakeout parameters structure tag.
Version 1.1, 25/09/05, MKC
Added OBSTBL_memory_command_time tag.
Version : 1.1, 25/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_environment
Purpose : Set up and return i/o directories and files used by EIS_CPT.
Explanation : This routine sets up and returns directories and files used by EIS_CPT.
At present the directories and files are defined through environment variables.
Use : < res = eis_cpt_environment() >
Inputs : None.
Opt. Inputs : None.
Outputs : res : Returns STRING containing directory of file name.
Opt. Outputs: None.
Keywords : SETUP : STRUCTURE of type {EIS_CPT_environment}.
OBSTBL : FLAG indicating should return directory for EIS OBSTBL file output
MAP : FLAG indicating should return directory for EIS OBSTBL MAP file output
ORL : FLAG indicating should return directory for EIS ORL file output
RATE : FLAG indicating should return directory for EIS DATA RATE file output
MSSL : FLAG indicating should return directory for MSSL file output
INTEL : FLAG indicating should return directory for INTEL file output
ENG : FLAG indicating should return directory for ENGINEERING file input
REAL : FLAG indicating should return directory for REAL COMMAND SEQUENCE file input
SIB : FLAG indicating should return SIB command table file name.
Calls : None.
CALLED BY:
EIS_CPT_FILE_NAME [1], EIS_CPT_FILE_NAME [2]
EIS_CPT_LIST_REAL_COMMAND_SEQUENCES [1]
EIS_CPT_LIST_REAL_COMMAND_SEQUENCES [2], EIS_CPT_OBSTBL_ASCII [1]
EIS_CPT_OBSTBL_ASCII [2], EIS_CPT_SIB [1], EIS_CPT_SIB [2]
EIS_CPT_environment_wrapper [1], EIS_CPT_environment_wrapper [2]
Common : EIS_CPT_environment_block : local COMMON block storing environment structure
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 06/06/06
Modified :
Version : 0.0, 06/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_environment__DEFINE
Purpose : Generates structure EIS_CPT_environment
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_CPT_environment. Tags are :
OBSTBL_directory : directory containing EIS_OBSTBL.hex files
OBSTBL_map_directory : directory containing OBSTBL.map files
DATA_RATE_directory : directory containing EIS_DATA_RATE.txt files
MSSL_directory : directory containing individual files for each table in MSSL format
INTEL_directory : directory containing individual files for each table in INTEL hex format
engineering_study_directory : directory containing EIS engineering files in INTEL hex format
real_command_sequence_directory : directory containing EIS real command sequence files ín ISACS PLN format
SIB_COMMAND_TABLE : file containing SIB commands ín ISACS PLN format
Use : <dummy = {EIS_CPT_environment>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 06/06/06
Modified :
Version : 0.0, 06/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_environment_wrapper
Purpose : Set up input and output directories and the default directory structure used by EIS_CPT
Explanation : This routine sets up input and output directories and the default directory structure used by EIS_CPT.
The input and output directories are particular to a given machine.
The default directory structure has been constructed so that it is simple to
change for a new machine :-
eis_cpt_output_directory/EIS_OBSTBL_directory
/EIS_ORL_directory
/EIS_DATA_RATE_directory
/EIS_MMSL_directory
/EIS_INTEL_directory
/EIS_OBSTBL_map_directory
eis_cpt_input_directory/EIS_engineering_studies
/EIS_real_command_sequences
Use : < eis_cpt_environment_wrapper, input, output >
Inputs : input : STRING giving input directory.
output : STRING giving output directory.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], EIS_CPT_environment [1]
EIS_CPT_environment [2], concat_dir [4]
CALLED BY:
EIS_CPT_test_environment [1], EIS_CPT_test_environment [2]
eis_mk_plan_gui [1], eis_mk_plan_gui [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 06/10/04
Modified : Version 0.1, 21/10/04
Added EIS_OP_directory, EIS_SEQEXEC_directory, EIS_DV_directory, EIS_linelist_directory
environment variables
Version 0.2, 15/11/04
Changed eis_obstbl_map to directory.
Version 0.3, 02/04/05
Changed environment variables associated with MSSL, ISACS PLN and INTEL outputs.
Version 0.4, 27/04/05
Removed ISACS PLN directory.
Version 0.5, 05/05/05
Added KEYWORDs SOFTWARE and OUTPUT.
Added check that !PATH does not altready include software directory.
Version 0.6, 19/07/05
Changed engineering file environment variable name and added real command sequence direcory.
Added INPUT keyword.
Version 0.7, 12/09/05
Added EIS_SIB_COMMAND_TABLE environment variable..
Changed 'DV' type to 'DATARATE'
Version 0.8, 29/09/05, MKC
Replaced REAL, OP, SEQEXEC files with single ORL file.
Version 0.9, 06/06/06, MKC
Renamed EIS CPT environment to EIS CPT setup environment.
Did away with IDL environment variables.
Did away with adding eis cpt software to IDL path.
Did away with SOFTWARE keyword.
Version 1.0, 14/06/06, MKC
Did away with setting up software directory.
Renamed routine from eis cpt test environment to eis cpt environment wrapper.
Changed input and output from keywords to arguments.
Version 1.1, 15/07/06, MKC
Changed all directories to lower case only.
Version : 1.1, 15/07/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_event_control_default
Purpose : Generates default structure EIS_event_control.
Explanation : Sets up default values for structure EIS_event_control.
Use : < s = EIS_CPT_event_control_default(response_study_id, adjust_y) >
Inputs : response_study_id : LONG response study identifier
adjust_y : INT flag
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_event_control.
Opt. Outputs: None.
Keywords : None,
Calls : None.
CALLED BY:
EIS_CPT_control_details_default [1], EIS_CPT_control_details_default [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 23/09/04
Modified : Version 0.0, 23/09/04, MKC
Version 0.1, 24/02/05, MKC
Moved some parameters from EIS event response.
Version 0.2, 24/06/05, MKC
Changed INT values to UINT.
Added response_study_id and adjust_y arguments.
Changed adjust_x to 0.
Added X_threshold, Y_threshold.
Version 0.3, 04/07/05, MKC
Added number of rasters tag..
Version 0.4, 08/09/05, MKC
Changed raster number/ number of rasters tag to raster identifier.
Version 0.5, 19/06/06, MKC
Changed tag study identifier.
Version : 0.5, 19/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_EXISTS
Purpose : Checks whether item exists in array.
Explanation : Checks whether item exists in array.
Use : < res = eis_cpt_exists(array,item) >
Inputs : array : ARRAY[] any type which can be used with EQ operator
item : ITEM any type which can be used with EQ operator
Opt. Inputs : None.
Outputs : res : INT 0 if not present
1 if present
Opt. Outputs: None.
Keywords : None.
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 11/03/05
Modified : Version 0.0, 11/03/05, MKC
Version : Version 0.0, 11/03/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_EXTRACT_PERIOD
Purpose : Calculates the data volume generated within a specified period.
Explanation : Calculates the data volume generated within a specified period.
Use : < volume = eis_cpt_extract_period(study_details, timeline, start_time, end_time) >
Inputs : study_details : STRUCTURE ARRAY of type EIS_study_detail.
timeline : STRUCTURE ARRAY of type EIS_CPT_timeline updated
start_time : DOUBLE TAI time of start of period.
If not defined then uses from first study.
end_time : DOUBLE TAI time of end of period.
If not defined then uses until last study.
Opt. Inputs : None.
Outputs : volume : FLOAT volume of data generated in Mbits
Opt. Outputs: None.
Keywords : None.
Calls : ***
LAST_ITEM
CALLED BY:
EIS_CPT_DATARATE_OUTPUT [1], EIS_CPT_DATARATE_OUTPUT [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 27/09/05
Modified : Version 0.0, 27/09/05, MKC
Version 0.1, 03/10/06, MKC
Changed output to Mbits.
Version : 0.1, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_FILE_NAME
Purpose : Returns file names for different files produces by eis_cpt.
Explanation : Includes directory from environment variable.
Use : < file = eis_cpt_file_name(filetype,index,STAMP=stamp) >
Inputs : filetype : STRING indicating file
'MSSL' : creating MSSL file output
'INTEL' : creating INTEL hex file output
'ORL' etc
Opt. Inputs : index : INT index
Outputs : file : STRING file name
Opt. Outputs: None.
Keywords : STAMP : STRING stamp for file
SEQUENCE : FLAG indicating that processing a sequence.
LINELIST : FLAG indicating that processing a linelist
AEC_EXPOSURE : FLAG indicating that processing an AEC exposure table
AEC_TABLE : FLAG indicating that processing an AEC control table
XRT_FLARE : FLAG indicating that processing an XRT flare trigger control table
EIS_FLARE : FLAG indicating that processing an EIS flare trigger control table
EIS_EVENT : FLAG indicating that processing an EIS event trigger control table
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], EIS_CPT_UINTTOMSSL [1]
EIS_CPT_UINTTOMSSL [2], EIS_CPT_environment [1], EIS_CPT_environment [2]
concat_dir [4]
CALLED BY:
EIS_CPT_ASCII_TABLES [1], EIS_CPT_ASCII_TABLES [2]
EIS_CPT_COMMAND_STORE_OUTPUT [1], EIS_CPT_COMMAND_STORE_OUTPUT [2]
EIS_CPT_DATA_RATE [1], EIS_CPT_DATA_RATE [2], EIS_CPT_OBSTBL_GET [1]
EIS_CPT_OBSTBL_GET [2], EIS_CPT_OBSTBL_MAP_READ [1]
EIS_CPT_OBSTBL_MAP_READ [2], EIS_CPT_OBSTBL_MAP_WRITE [1]
EIS_CPT_OBSTBL_MAP_WRITE [2], EIS_CPT_OBSTBL_OUTPUT [1]
EIS_CPT_OBSTBL_OUTPUT [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 21/10/04
Modified : Version 0.1, 15/11/04, MKC
Added warning if environment variable not set.
Version 0.2, 11/03/05, MKC
Changed to single routine for all EIS_CPT files.
Put in correct Jside file names.
Version 0.3, 02/04/05, MKC
Added optional index argument and table files.
Added keyword qualifiers.
Version 0.4, 11/05/05, MKC
Added NAME keyword and ENGINEERING filetype.
Version 0.5, 20/06/05, MKC
Changed MSSL and INTEL file names.
Version 0.6, 28/06/05, MKC
Used eis cpt uinttomssl.
Removed ISACS filetype.
Rearranged processing.
Version 0.7, 14/07/05, MKC
Removed ENGINEERING filetype.
Version 0.8, 16/09/05, MKC
Changed filenames.
Removed NAME keyword.
Changed 'DV' type to 'DATARATE'
Version 0.9, 29/09/05, MKC
Replaced REAL, OP, SEQEXEC files with ORL file.
Version 1.0, 08/10/05, MKC
Changed data rate file to '.txt' filetype.
Version 1.1, 06/06/06, MKC
Used eis cpt environment instead of environment variable.
Version 1.2, 03/10/06, MKC
Changed TIMESTAMP keyword to STAMP.
Version : 1.2, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_FIND_STUDY
Purpose : Finds a specific study in a list of studies.
Explanation : EIS_CPT allows studies with the same ID but different links or study repeat number
to be repeated in sequences.
This routine gets the start position of the correct sequence by checking
links and study repeats as well as study identifiers.
Use : < result = eis_cpt_find_study( study_list, study ) >
Inputs : study_list : STRUCTURE of type EIS_study_detail or EIS_CPT_sequence.
study : STRUCTURE of type EIS_study_detail or EIS_CPT_sequence.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_PROCESS_STUDIES [1], EIS_CPT_PROCESS_STUDIES [2]
EIS_CPT_PROCESS_TIMELINE_STUDIES [1], EIS_CPT_PROCESS_TIMELINE_STUDIES [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 20/09/05
Modified : Version 0.0, 20/09/05, MKC
Version : 0.0, 20/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_flare_control_default
Purpose : Generates default structure EIS_flare_control.
Explanation : Sets up default values for structure EIS_flare_control.
Use : < s = EIS_CPT_flare_control_default(response_study_id, adjust_y) >
Inputs : response_study_id : LONG response study identifier
adjust_y : INT flag
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_flare_control
Opt. Outputs: None.
Keywords : None,
Calls : None.
CALLED BY:
EIS_CPT_control_details_default [1], EIS_CPT_control_details_default [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 23/09/04
Modified : Version 0.0, 23/09/04, MKC
Version 0.1, 24/02/05, MKC
Moved parameters from EIS flare response.
Version 0.2, 24/06/05, MKC
Changed INT values to UINT.
Added response_study_id and adjust_y arguments.
Changed adjust_x to 0.
Version 0.3, 04/07/05, MKC
Added number of rasters tag..
Version 0.4, 08/09/05, MKC
Changed raster number/ number of rasters tag to raster identifier.
Version 0.5, 19/06/06, MKC
Changed tag study identifier.
Version : 0.5, 19/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_flare_parameters_default
Purpose : Generates default structure EIS_flare_parameters.
Explanation : Sets up default values for structure EIS_flare_parameters.
Use : < s = EIS_CPT_flare_parameters_default() >
Inputs : None.
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_flare_parameters.
Opt. Outputs: None.
Keywords : None,
Calls : None.
CALLED BY:
EIS_CPT_engineering_parameters_default [1]
EIS_CPT_engineering_parameters_default [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 29/09/04
Modified : Version 0.0, 29/09/04, MKC
Version 0.1, 24/02/05, MKC
Renamed from EIS flare response default.
Moved some parameters from EIS flare control..
Version 0.2, 24/06/05, MKC
Changed INT values to UINT.
Version : 0.2, 24/06/05, MKC
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_GET_CONTROL
Purpose : Dummy version of EIS_MK_PLAN routine for testing EIS_CPT.
Explanation : Gets current settings of EIS control details.
Generates the structure EIS_control_detail.
Use : < control_details = eis_cpt_get_control()>
Inputs : None..
Opt. Inputs : None.
Outputs : control_details : STRUCTURE of type EIS_control_details.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_control_details_default [1], EIS_CPT_control_details_default [2]
EIS_GET_STUDY [1], EIS_GET_STUDY [2]
CALLED BY:
EIS_CPT_test_parameters [1], EIS_CPT_test_parameters [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 28/02/05
Modified : Version 0.0, 28/02/05, MKC
Version 0.1, 26/06/05, MKC
Added response and adjust_y tags.
Version 0.2, 05/07/05, MKC
Added number of rasters tag.
Version 0.3, 20/07/05, MKC
Renamed from eis get control details.
Version 0.4, 12/09/05, MKC
Changed raster number/ number of rasters tag to raster identifier.
Changed response to an index rather than identifier
Version 0.5, 28/09/05, MKC
Added filler study.
Version 0.6, 13/06/06, MKC
Changed so that filler and response = -1 means values not set.
Version 0.7, 19/06/06, MKC
Changed tag study identifier.
Changed response and filler tags.
Version : 0.7, 19/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_GET_ENGINEERING
Purpose : Dummy version of EIS_MK_PLAN routine for use in testing EIS_CPT.
Explanation : Get engineering parameters for EIS_CPT.
Use : < engineering_parameters = eis_cpt_get_engineering() >
Inputs : None.
Opt. Inputs : None.
Outputs : engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_engineering_parameters_default [1]
EIS_CPT_engineering_parameters_default [2]
CALLED BY:
EIS_CPT_test_parameters [1], EIS_CPT_test_parameters [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 06/10/04
Modified : Version 0.0, 06/10/04, MKC
Version 0.1, 29/06/05, MKC
Added node.
Version : Version 0.1, 29/06/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_GET_INTEL_HEX_RECORD_LENGTH
Purpose : Sets up Intel hex record length.
Explanation : This routine allows teh Intel hex record length to be a variable so that
each record contains one OBSTBL table.
Use : < record_length = eis_cpt_get_intel_hex_record_length(load_address) >
Inputs : load_address : UINT address relative to the start of OBSTBL memory.
Opt. Inputs : None.
Outputs : record_length : UINT intel hex record length.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_COMPOSE_INTEL_HEX_FILE [1], EIS_CPT_COMPOSE_INTEL_HEX_FILE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 30/06/05
Modified : Version 0.1, 05/07/05, MKC
Limited size of data to 128 bytes.
Version : Version 0.1, 05/07/05
[Previous]
[Next]
NAME:
eis_cpt_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_HARDWARE_WINDOW
Purpose : Returns hardware window selected.
Explanation : Hardware window used may be either the 'normal' window or the 'special' window.
This is selected by a flag in raster_details.
Use : < window = eis_cpt_hardware_window ( raster_details ) >
Inputs : raster_details : STRUCTURE of type EIS_raster_detail.
Opt. Inputs : None.
Outputs : window : INT[4] coordinates of Camera hardware window
0 : x start
1 : y start
2 : x size
3 : y size
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_CHECK_RASTER [1], EIS_CPT_CHECK_RASTER [2], EIS_CPT_SET_LINELIST [1]
EIS_CPT_SET_LINELIST [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 5/11/04
Modified : Version 0.0, 5/11/04, MKC
Version 0.1, 13/04/05, MKC
Changed to natural order.
Version : Version 0.1, 13/04/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_HEX_RASTER
Purpose : Processes science raster to hex values.
Explanation : This routine processes a raster into Intel Hex format.
It first of all performs some checks on the raster parameters.
If special CAM hardware window required then sets the Y parameters for this.
Then adds the run raster command with its parameters.
Then adds the exposure loop commands.
NB The position of the raster within th esequence is not yet determined
because it may overflow the sequence table and require a new table to be started.
The loop back command takes an absolute position. This will require updating once
the absolute position is determined. The loop back location is the last element of hex.
The value on output is relative to the start of hex.
Use : < hex = eis_cpt_hex_raster ( engineering_parameters, raster_details, $
raster_id, linelist ) >
Inputs : engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
raster_detail : STRUCTURE of type EIS_raster_detail.
raster_id : BYTARR[2] raster ID
linelist : INT linelist table index.
Opt. Inputs : None.
Outputs : hex : BYTARR[] command byte values. NB [0B] is not a valid output
0 : if processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_CHECK_RASTER [1]
EIS_CPT_CHECK_RASTER [2], EIS_CPT_C_SET_WINDOW [1], EIS_CPT_C_SET_WINDOW [2]
EIS_CPT_LOOP_BACK [1], EIS_CPT_LOOP_BACK [2], EIS_CPT_RUN_RASTER [1]
EIS_CPT_RUN_RASTER [2], EIS_CPT_SLIT_SLOT_AUTO [1]
EIS_CPT_SLIT_SLOT_AUTO [2], EIS_CPT_START_EXP [1], EIS_CPT_START_EXP [2]
CALLED BY:
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [1]
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 29/11/04
Modified : Version 0.0, 29/11/04, MKC
Version 0.1, 21/01/05, MKC
Removed coarse mirror command.
Version 0.2, 02/03/05, MKC
Added loop back command and sequence_position argument.
Version 0.3, 12/04/05, MKC
Added special hardware window.
Version 0.4, 12/05/05, MKC
Removed sequence position argument.
Version 0.5, 04/07/05, MKC
Changed raster_number and number of rasters arguments to raster_id.
Added current slit slot argument.
Version : Version 0.5, 04/07/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_HEXTOBYTES
Purpose : Converts hex character values into byte values.
Explanation : Input values are coded as two hex characters per byte
Use : < bytes = eis_cpt_hextobytes(hex_bytes) >
Inputs : hex_bytes : BYTARR[2n] hex character values.
Opt. Inputs : None.
Outputs : bytes : BYTARR[n] corresponding byte values
Opt. Outputs: None.
Keywords : ERR : named variable for reporting error..
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_PARSE_INTEL_HEX_FILE [1], EIS_CPT_PARSE_INTEL_HEX_FILE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/10/04
Modified : Version 0.0, 22/10/04, MKC
Version : Version 0.0, 22/10/04
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_JSIDE_COMMANDS
Purpose : Prepares JSIDE commands.
Explanation : Only a small number of SIB commands will be issued from the OP store :
EIS_MODE_MANU
EIS_MODE_AUTO
EIS_SELECT_SEQ
EIS_PAUSE_SEQ
EIS_RESUME_SEQ
EIS_MOVE_CMIR_AUTO
EIS_SET_CCDT_TARGET
EIS_CHG_CCDH_DUTY+5
EIS_CHG_CCDH_DUTY-5
EIS_DUMP_OBSTBL
The commands are stored within EIS_CPT command store by command mnemonics :
'MANUAL'
'RUNSEQ'
'PAUSE'
'RESUME'
'MIRROR'
'BAKEOUT_START'
'BAKEOUT_INCREMENT'
'BAKEOUT_DECREMENT'
'BAKEOUT_END'
'FILE'
'LOAD'
Use : < result = eis_cpt_jside_commands( command, seq_name, command_text, manual ) >
Inputs : command : STRUCTURE of EIS_CPT_COMMAND_STORE.
Opt. Inputs : None.
Outputs : result : INT 0 or 1 indicating error / no error
seq_name : STRING name of ISACS PLN sequence
command_text : STRARR[] ISACS PLN command mnemonics
manual : INT flag indicating manual mode command needed before sequence
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_READ_ASCII [1]
EIS_CPT_READ_ASCII [2], EIS_CPT_SIB [1], EIS_CPT_SIB [2]
EIS_CPT_UINTTOBYTES [1], EIS_CPT_UINTTOBYTES [2], EIS_CPT_UNDEFINE [1]
EIS_CPT_UNDEFINE [2], EIS_GET_REAL_DETAIL
CALLED BY:
EIS_CPT_JSIDE_PROCESS [1], EIS_CPT_JSIDE_PROCESS [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 30/09/05
Modified : Version 0.0, 26/09/05, MKC
Adapted from eis cpt command store process.
Version 0.1, 04/10/06, MKC
Changed RAM sub ID to a 3 character field in OBSTBL mirroring the version.
Added a string parameter to command store structure.
Used in LOAD and FILE commands.
Version : 0.1, 04/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_JSIDE_PROCESS
Purpose : Prepares JSIDE commands for SEQEXEC, OP, OG, REAL parts of ORL file..
Explanation : Prepares JSIDE commands for SEQEXEC, OP, OG, REAL parts of ORL file..
Use : < result = eis_cpt_jside_process( command, seqexec_text, op_text, og_text, real_text, manual ) >
Inputs : command : STRUCTURE of EIS_CPT_COMMAND_STORE.
Command.description may be modified on output.
Opt. Inputs : None.
Outputs : result : INT 0 or 1 indicating error / no error
seqexec_text : STRARR[] commands for SEQEXEC part of ORL file
op_text : STRARR[] commands for SEQEXEC part of ORL file
og_text : STRARR[] commands for SEQEXEC part of ORL file
real_text : STRARR[] commands for SEQEXEC part of ORL file
manual : INT flag indicating manual mode command needed before sequence
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_JSIDE_COMMANDS [1], EIS_CPT_JSIDE_COMMANDS [2]
EIS_CPT_JSIDE_SEQUENCE [1], EIS_CPT_JSIDE_SEQUENCE [2]
CALLED BY:
EIS_CPT_COMMAND_STORE_PROCESS [1], EIS_CPT_COMMAND_STORE_PROCESS [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 30/09/05
Modified : Version 0.0, 26/09/05, MKC
Adapted from eis cpt command store process.
Version : 0.0, 26/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_JSIDE_SEQUENCE
Purpose : Prepares a JSIDE sequence.
Explanation : Prepares a JSIDE sequence.
Use : < eis_cpt_jside_sequence, command, type, seq_name, command_text, text >
Inputs : command : STRUCTURE of EIS_CPT_COMMAND_STORE.
type : STRING type of command
'REAL'
'SEQEXEC'
'OP'
seq_name : STRING name of ISACS PLN sqeuence
command_text : STRARR[] ISACS PLN command mnemonics
text : STRARR[] ASCII ORL output text
Opt. Inputs :
Outputs : text : STRARR[] containing updated ASCII output
Opt. Outputs: None.
Keywords : MANUAL : FLAG indicating that MODE MANUAL command issued at start of sequence.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_TIMEFORMAT [1]
EIS_CPT_TIMEFORMAT [2]
CALLED BY:
EIS_CPT_JSIDE_PROCESS [1], EIS_CPT_JSIDE_PROCESS [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 30/09/05
Modified : Version 0.0, 30/09/05
Version 0.1, 05/06/06, MKC
SEQEXEC file merged with other ORL files.
Changed SEQEXEC keyword in eis cpt timeformat to ORL.
Version 0.2, 25/09/06, MKC
Rearranged processing.
Added MANUAL keyword.
Version : 0.2, 25/09/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_LIST_ABORTS
Purpose : Dummy version of EIS_MK_PLAN routine for use in testing EIS_CPT.
Explanation : Gets test list of abort times for EIS_CPT.
If no aborts then returns 0.
Use : < aborts = eis_cpt_list_aborts(start_time,stop_time) >
Inputs : start_time : CDS time format of time of start of study period.
stop_time : CDS time format of time of end of study period.
Opt. Inputs : None.
Outputs : aborts : STRUCTURE ARRAY of type EIS_abort.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_abort_default [1]
EIS_CPT_abort_default [2]
CALLED BY:
EIS_CPT_test_parameters [1], EIS_CPT_test_parameters [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 04/10/06
Modified : Version 0.0, 04/10/06, MKC
Version : 0.0, 04/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_LIST_BAKEOUT_PERIODS
Purpose : Dummy version of EIS_MK_PLAN routine for use in testing EIS_CPT.
Explanation : Gets test list of bakeout periods for EIS_CPT.
If no bakeout periods then returns 0.
Use : < bakeout_periods = eis_cpt_list_bakeout_periods(start_time,stop_time) >
Inputs : start_time : CDS time format of time of start of bakeout period.
stop_time : CDS time format of time of end of bakeout period.
Opt. Inputs : None.
Outputs : bakeout_periods : STRUCTURE ARRAY of type EIS_bakeout_period.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_bakeout_period_default [1]
EIS_CPT_bakeout_period_default [2]
CALLED BY:
EIS_CPT_test_parameters [1], EIS_CPT_test_parameters [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 09/05/05
Modified : Version 0.1, 19/07/05, MKC
Renamed from eis get bakeout periods.
Version 0.2, 12/09/05, MKC
Changed bakeout periods.
Version 0.3, 26/09/06, MKC
Added alternatives.
Version : 0.3, 26/09/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_LIST_COARSE_MIRROR_COMMANDS
Purpose : Dummy version of EIS_MK_PLAN routine for use in testing EIS_CPT.
Explanation : Gets test list of coarse mirror commands for EIS_CPT.
If no coarse mirror commands then returns 0.
Use : < coarse_mirror_commands = eis_cpt_list_coarse_mirror_commands(start_time,stop_time) >
Inputs : start_time : CDS time format of time of start of study period.
stop_time : CDS time format of time of end of study period.
Opt. Inputs : None.
Outputs : coarse_mirror_commands : STRUCTURE ARRAY of type EIS_coarse_mirror_command.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_coarse_mirror_command_default [1]
EIS_CPT_coarse_mirror_command_default [2]
CALLED BY:
EIS_CPT_test_parameters [1], EIS_CPT_test_parameters [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 14/01/05
Modified : Version 0.0, 14/01/05, MKC
Version 0.1, 21/03/05, MKC
Added start_time and onboard arguments to eis coarse mirror command default.
Version 0.2, 09/05/05, MKC
Added !EIS_CPT_TEST.
Added another coarse mirror movement.
Version 0.3, 19/07/05, MKC
Renamed from eis get coarse mirror commands.
Version 0.4, 26/09/05, MKC
Added alternatives.
Version : 0.4, 26/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_LIST_REAL_COMMAND_SEQUENCES
Purpose : Dummy version of EIS_MK_PLAN routine for use in testing EIS_CPT.
Explanation : Gets test list of real command sequences for EIS_CPT.
If no real command sequences then returns 0.
Use : < real_command_sequences = eis_cpt_list_real_command_sequences(start_time,stop_time) >
Inputs : start_time : CDS time format of time of start of study period.
stop_time : CDS time format of time of end of study period.
Opt. Inputs : None.
Outputs : real_command_sequences : STRUCTURE ARRAY of type EIS_list_real_detail.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_environment [1]
EIS_CPT_environment [2], EIS_CPT_list_real_detail_default [1]
EIS_CPT_list_real_detail_default [2]
CALLED BY:
EIS_CPT_test_parameters [1], EIS_CPT_test_parameters [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 19/07/05
Modified : Version 0.1, 26/09/06, MKC
Used for all files in REAL directory.
Version : 0.1, 26/09/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_list_real_detail_default
Purpose : Generates default structure EIS_list_real_detail.
Explanation : Sets up default values for structure EIS_list_real_detail.
Use : < s = EIS_CPT_list_real_detail_default(study_time,filename) >
Inputs : study_time : DOUBLE TAI start time.
filename : STRING file name including directory
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_list_real_detail.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_LIST_REAL_COMMAND_SEQUENCES [1]
EIS_CPT_LIST_REAL_COMMAND_SEQUENCES [2], EIS_CPT_STRUCTURE_DEFAULTS [1]
EIS_CPT_STRUCTURE_DEFAULTS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 19/07/05
Modified : Version 0.1, 06/06/06, MKC
Used eis cpt environment instead of environment variable.
Version 0.2, 26/09/06, MKC
Added filename argument.
Version : 0.2, 26/09/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_LIST_STUDY_DETAILS
Purpose : Dummy version of EIS_MK_PLAN routine.
Explanation : Generates an array of EIS_study_detail structures for testing EIS_CPT.
Use : < study_details = eis_cpt_list_study_details(start_time,stop_time)>
Inputs : start_time : CDS time format of time of start of study period.
stop_time : CDS time format of time of end of study period.
Opt. Inputs : None.
Outputs : study_details : STRUCTURE ARRAY of type EIS_study_detail.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_study_detail_default [1]
EIS_CPT_study_detail_default [2], EIS_CPT_study_detail_estimates [1]
EIS_CPT_study_detail_estimates [2], EIS_GET_STUDY [1], EIS_GET_STUDY [2]
CALLED BY:
EIS_CPT_test_parameters [1], EIS_CPT_test_parameters [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 06/10/04
Modified : Version 0.0, 06/10/04, MKC
Version 0.1, 17/03/05, MKC
Added multiple studies.
Added engineering studies.
Renamed eis get study details.
Changed timing of default studies.
Added time argument to eis study detail default.
Added study_id argument to eis study detail default..
Version 0.2, 09/05/05, MKC
Added time_tag and linked study options.
Added engineering studies.
Version 0.3, 16/05/05, MKC
Added gap between studies.
Version 0.4, 27/09/05, MKC
Added nrepeats.
If no time period defined then return no studies.
Version : 0.4, 27/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_LIST_SUSPENSION_PERIODS
Purpose : Dummy version of EIS_MK_PLAN routine for use in testing EIS_CPT.
Explanation : Gets test list of suspension periods for EIS_CPT.
If no suspension periods then returns 0.
Use : < suspension_periods = eis_cpt_list_suspension_periods(start_time,stop_time) >
Inputs : start_time : CDS time format of time of start of study period.
stop_time : CDS time format of time of end of study period.
Opt. Inputs : None.
Outputs : suspension_periods : STRUCTURE ARRAY of type EIS_suspend_period.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_suspend_period_default [1]
EIS_CPT_suspend_period_default [2]
CALLED BY:
EIS_CPT_test_parameters [1], EIS_CPT_test_parameters [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 06/10/04
Modified : Version 0.1, 14/01/05, MKC
Added arguments.
Version 0.2, 21/03/05, MKC
Added start_time and onboard arguments to eis suspend period default.
Added another suspension period.
Version 0.3, 09/05/05, MKC
Added !EIS_CPT_TEST.
Version 0.4, 19/07/05, MKC
Renamed from eis get suspension periods.
Version : Version 0.3, 09/05/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_LOOP_BACK
Purpose : Sets up MSSL loop back command.
Explanation : Sets up MSSL loop back command.
Use : < bytes = eis_cpt_loop_back( position ) >
Inputs : position : BYTE loop back position within sequence 0-127
Opt. Inputs : None.
Outputs : bytes : BYTARR[2] command.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_HEX_RASTER [1], EIS_CPT_HEX_RASTER [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 02/03/05
Modified : Version 0.0, 02/03/05, MKC
Version, 0.1, 15/04/05, MKC
Changed format of !EIS_CPT_COMMANDS.
Version, 0.2, 27/04/05, MKC
Removed !EIS_CPT_COMMANDS. Put in command directly.
Version : Version 0.2, 27/04/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_mechanism_change_default
Purpose : Generates default structure EIS_mechanism_change.
Explanation : Sets up default values for structure EIS_mechanism_change.
NB 0 is valid for both mirror and slit positions.
Use : < s = EIS_CPT_mechanism_change_default() >
Inputs : None.
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_mechanism_change.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_study_detail_default [1], EIS_CPT_study_detail_default [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 09/12/04
Modified : Version 0.0, 09/12/04, MKC
Version : Version 0.0, 09/12/04
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_mechanism_control_default
Purpose : Generates default structure EIS_mechanism_control.
Explanation : Sets up default values for structure EIS_mechanism_control.
Use : < s = EIS_CPT_mechanism_control_default() >
Inputs : None.
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_mechanism_control.
Opt. Outputs: None.
Keywords : None,
Calls : None.
CALLED BY:
EIS_CPT_engineering_parameters_default [1]
EIS_CPT_engineering_parameters_default [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 29/09/04
Modified : Version 0.1, 10/12/04, MKC
Changed definition of slit direction.
Version 0.2, 24/06/05, MKC
Changed INT values to UINT.
Version 0.3, 20/07/05, MKC
Added number of slit changes tag.
Version : 0.3, 20/07/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_MESSAGE
Purpose : Wrapper for IDL MESSAGE routine..
Explanation : Checks if the QUIET flag is set.
Always continues so that error status returned to calling routine.
Uses INFORMATIONAL keyword to determine whether error message reported to
calling routine throught !error_state.
Use : < eis_cpt_message, msg, INFORMATIONAL=informational>
Inputs : msg : STRING message
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : INFORMATIONAL : FLAG passed on to MESSAGE procedure.
Calls : ***
EIS_CPT_QUIET [1], EIS_CPT_QUIET [2]
CALLED BY:
EIS_CPT [1], EIS_CPT [2], EIS_CPT_BYTESTOUINT [1], EIS_CPT_BYTESTOUINT [2]
EIS_CPT_BYTESTOULONG [1], EIS_CPT_BYTESTOULONG [2]
EIS_CPT_CHECK_BAKEOUT_PARAMETERS [1], EIS_CPT_CHECK_BAKEOUT_PARAMETERS [2]
EIS_CPT_CHECK_CAM_READOUT_PARAMETERS [1]
EIS_CPT_CHECK_CAM_READOUT_PARAMETERS [2]
EIS_CPT_CHECK_CONTROL_PARAMETERS [1], EIS_CPT_CHECK_CONTROL_PARAMETERS [2]
EIS_CPT_CHECK_EIS_FLARE_PARAMETERS [1]
EIS_CPT_CHECK_EIS_FLARE_PARAMETERS [2]
EIS_CPT_CHECK_ENGINEERING_PARAMETERS [1]
EIS_CPT_CHECK_ENGINEERING_PARAMETERS [2]
EIS_CPT_CHECK_EVENT_RESPONSE_STUDY [1]
EIS_CPT_CHECK_EVENT_RESPONSE_STUDY [2], EIS_CPT_CHECK_FILE [1]
EIS_CPT_CHECK_FILE [2], EIS_CPT_CHECK_RASTER [1], EIS_CPT_CHECK_RASTER [2]
EIS_CPT_CHECK_STUDIES_LIST [1], EIS_CPT_CHECK_STUDIES_LIST [2]
EIS_CPT_CHECK_STUDY [1], EIS_CPT_CHECK_STUDY [2], EIS_CPT_CHECK_TABLE [1]
EIS_CPT_CHECK_TABLE [2], EIS_CPT_CHECK_TIME_PERIOD [1]
EIS_CPT_CHECK_TIME_PERIOD [2], EIS_CPT_CHECK_UPLOAD [1]
EIS_CPT_CHECK_UPLOAD [2], EIS_CPT_CHECK_WINDOW [1], EIS_CPT_CHECK_WINDOW [2]
EIS_CPT_CHECK_XRT_FLARE_PARAMETERS [1]
EIS_CPT_CHECK_XRT_FLARE_PARAMETERS [2], EIS_CPT_CLOSE_FILE [1]
EIS_CPT_CLOSE_FILE [2], EIS_CPT_COMMAND_STORE_ADD [1]
EIS_CPT_COMMAND_STORE_ADD [2], EIS_CPT_COMMAND_STORE_CHECK [1]
EIS_CPT_COMMAND_STORE_CHECK [2], EIS_CPT_DAISY_CHAIN [1]
EIS_CPT_DAISY_CHAIN [2], EIS_CPT_DECODE_SEQUENCE_TABLE [1]
EIS_CPT_DECODE_SEQUENCE_TABLE [2], EIS_CPT_HEXTOBYTES [1]
EIS_CPT_HEXTOBYTES [2], EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2]
EIS_CPT_OBSTBL_CHECK [1], EIS_CPT_OBSTBL_CHECK [2], EIS_CPT_OBSTBL_INDEX [1]
EIS_CPT_OBSTBL_INDEX [2], EIS_CPT_OBSTBL_MAP_PARSE [1]
EIS_CPT_OBSTBL_MAP_PARSE [2], EIS_CPT_OBSTBL_MAP_READ [1]
EIS_CPT_OBSTBL_MAP_READ [2], EIS_CPT_OPEN_FILE [1], EIS_CPT_OPEN_FILE [2]
EIS_CPT_PARSE_INTEL_HEX_FILE [1], EIS_CPT_PARSE_INTEL_HEX_FILE [2]
EIS_CPT_PROCESS_BAKEOUT_PERIODS [1], EIS_CPT_PROCESS_BAKEOUT_PERIODS [2]
EIS_CPT_PROCESS_COARSE_MIRROR_COMMANDS [1]
EIS_CPT_PROCESS_COARSE_MIRROR_COMMANDS [2]
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [1]
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [2], EIS_CPT_PROCESS_STUDIES [1]
EIS_CPT_PROCESS_STUDIES [2], EIS_CPT_PROCESS_STUDY [1]
EIS_CPT_PROCESS_STUDY [2], EIS_CPT_PROCESS_TIMELINE [1]
EIS_CPT_PROCESS_TIMELINE [2], EIS_CPT_READ_INTEL_HEX_FILE [1]
EIS_CPT_READ_INTEL_HEX_FILE [2], EIS_CPT_READ_TEXT [1]
EIS_CPT_READ_TEXT [2], EIS_CPT_READ_UNFORMATTED_FILE [1]
EIS_CPT_READ_UNFORMATTED_FILE [2], EIS_CPT_SEQUENCE_MATCH [1]
EIS_CPT_SEQUENCE_MATCH [2], EIS_CPT_TABLE_PLACE [1], EIS_CPT_TABLE_PLACE [2]
EIS_CPT_WRITE_TEXT [1], EIS_CPT_WRITE_TEXT [2]
EIS_CPT_WRITE_UNFORMATTED_FILE [1], EIS_CPT_WRITE_UNFORMATTED_FILE [2]
Common : None.
Restrictions: None.
Side effects: Sets !ERROR_STATE message text.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 08/10/04
Modified : Version 0.0, 08/10/04, MKC
Version : Version 0.0, 08/10/04
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_MIR_C_AUTO
Purpose : Sets up MSSL command.
Explanation : Sets up MSSL command.
Use : < bytes = eis_cpt_mir_c_auto( pos ) >
Inputs : pos : UINT encoder position
Opt. Inputs : None.
Outputs : bytes : BYTARR[7] command.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_UINTTOBYTES [1], EIS_CPT_UINTTOBYTES [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 06/12/04
Modified : Version 0.0, 06/12/04, MKC
Version, 0.1, 15/04/05, MKC
Changed format of !EIS_CPT_COMMANDS.
Version, 0.2, 27/04/05, MKC
Removed !EIS_CPT_COMMANDS. Put in command directly.
Version : Version 0.2, 27/04/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_MSSL_COMMANDS
Purpose : Sets up MSSL command values.
Explanation : This provides a translation between MSSL command BC1 hex values and MSSL command mnemonics and
gives the length of each command and any fixed command BC values.
It only includes those commands that may be run from within a sequence table.
It is used for translation of hex sequence tables into MSSL command mnemonics.
The source for the dat aused is the perl EGSE routine seq_translate5.pl.
The MSSL commands are returned as a structure of type MSSL_command with tags :
mnemonic : STRING MSSL command mnemonic
bc1 : BYTE BC1 value
length : INT no. of BC values in command
fixed : STRING any fixed BC2-n values given in ASCII hex
'' if none.
Use : < eis_cpt_mssl_commands, commands>
Inputs : None.
Opt. Inputs : None.
Outputs : commands : STRUCTURE ARRAY of type MSSL commands.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_DECODE_SEQUENCE_TABLE [1], EIS_CPT_DECODE_SEQUENCE_TABLE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 19/04/05
Modified : Version 0.0, 19/04/05, MKC
Version : Version 0.0, 19/04/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_NOW
Purpose : Returns current time.
Explanation : Returns current time in different CDS formats.
Default is string format dd/mmm/yy hh:mm:ss.
Use : < time = eis_cpt_now() >
Inputs : None.
Opt. Inputs : None.
Outputs : time : CDS TIME containing current time.
Opt. Outputs: None.
Keywords : CCSDS : FLAG indicating return time in CCSDS STRING format.
UTC : FLAG indicating return in UTC format
TAI : FLAG indicating return in TAI format
DATE : FLAG indicating return DATE only.
FORM : INT specifies a format for STRING date.
0 dd/mmm/yy hh:mm:ss [default]
1 dd-mmm-yy hh:mm:ss
2 dd/mm/yy hh:mm:ss
3 dd-mm-yy hh:mm:ss
4 mm/dd/yy hh:mm:ss
5 mm-dd-yy hh:mm:ss
6 yy/mm/dd hh:mm:ss
7 yy-mm-dd hh:mm:ss
8 yyyymmddhhmmss
9 dd-mmm-yyyy hh:mm:ss.sss (VMS-like)
10 dd-mmm-yyyy hh:mm:ss.ss (!stime-like)
11 yyyy/mm/dd hh:mm:ss.sss (cpt use)
Calls : ***
ANYTIM2CAL, ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2], GET_UTC
CALLED BY:
EIS_CPT_OBSTBL_REFRESH [1], EIS_CPT_OBSTBL_REFRESH [2]
EIS_CPT_TIMEFORMAT [1], EIS_CPT_TIMEFORMAT [2]
EIS_CPT_TIME_PERIOD_DEFAULT [1], EIS_CPT_TIME_PERIOD_DEFAULT [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 04/11/04
Modified : Version 0.1, 07/02/05, MKC
Added FORM keyword.
Version 0.2, 09/03/05, MKC
Added TIMESTAMP keyword.
Version 0.3, 24/03/05, MKC
Removed TIMESTAMP keyword.
Version : Version 0.3, 24/03/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OBSTBL
Purpose : Performs various processing options with the OBSTBL.
Explanation : Finds best location to put table in OBSTBL and inserts table into OBSTBL.
For SEQUENCE tables allows links between sequences to be inserted and terminate command
parameter to be set. Calculates checksum to complete sequence table.
Use : < result = eis_cpt_obstbl ( table, table_index, time_for_reuse, description, $
SEQUENCE=sequence, LINELIST=linelist, AEC_EXPOSURE=aec_exposure, AEC_TABLE=aec_table, $
XRT_FLARE=xrt_flare, EIS_FLARE=eis_flare, STAMP=stamp, $
EIS_EVENT=eis_event, PLACE=place, EXTRACT=extract, OUTPUT=output, $
MSSL=mssl, INTEL=intel, LINK=link) >
Inputs : None.
Opt. Inputs : table : BYTARR[] for processing
table_index : INT table index. May be undefined on input.
time_for_reuse : DOUBLE TAI time after which linelists may be reused.
description : STRING description of table
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
table_index : INT index table placed at.
Undefined if no place found for table.
Opt. Outputs: None.
Keywords : GET : FLAG indicating should read in OBSTBL or return individual OBSTBL table
REFRESH : FLAG indicating should refresh OBSTBL
EXTRACT : FLAG indicating should extract table from OBSTBL.
CHECK : FLAG indicating should check table.
PLACE : FLAG indicating that should find location for table in OBSTBL
EXACT : FLAG indicating that should check if there is an exact table match in OBSTBL
If defined on input table_index specifies a single table that should be checked.
On output table_index gives the table index if an exact match found else -1.
USED : INT indicating should look in 'inuse = used' tables also.
SET : FLAG indicating that should write table to OBSTBL.
RESPONSE : FLAG indicating that table is used in response study.
TERMINATE : FLAG indicating that table defined by table_index terminates
LINK : INT containing table index which links to this sequence.
FIRST : INT flag indicating sequence table first in study (for use with LINK).
LAST : INT flag indicating sequence table last in study (for use with LINK).
OUTPUT : FLAG indicating should output OBSTBL
SEQUENCE : FLAG indicating that processing a sequence or LONARR[] list of sequences
LINELIST : FLAG indicating that processing a linelist or LONARR[] list of linelists
AEC_EXPOSURE : FLAG indicating that processing an AEC exposure table
AEC_TABLE : FLAG indicating that processing an AEC control table
XRT_FLARE : FLAG indicating that processing an XRT flare trigger control table
EIS_FLARE : FLAG indicating that processing an EIS flare trigger control table
EIS_EVENT : FLAG indicating that processing an EIS event trigger control table
STAMP : STRING stamp indicating should stamp file names.
RESET : FLAG for use with get.
UPLOAD : STRUCTURE of type EIS_upload.
ULBA : UINT extended linear base address for OBSTBL (only used with EXTRACT)
TEXT : STRARR[] returns decoded table in MSSL command mnemonic form.
Used with CHECK.
RASTERS : INTARR[] indexes of raster commands returned
Used with CHECK (sequence table only).
MSSL : INT Flag indicating should produce individual ASCII files for each sequence table
and line list table in MSSL command mnemonic form.
0 : no output
1 : outputs new tables
2 : outputs all tables
INTEL : INT Flag indicating should produce individual Intel hex files for each sequence table
and line list table.
0 : no output
1 : outputs new tables
2 : outputs all tables;
DIFFERENCE : FLAG indicating should calculate difference of OBSTBL with previous OBSTBL.
Calls : ***
ANYTIM2CAL, EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_CHECKSUM [1]
EIS_CPT_CHECKSUM [2], EIS_CPT_CHECK_TABLE [1], EIS_CPT_CHECK_TABLE [2]
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2], EIS_CPT_OBSTBL_ASCII [1]
EIS_CPT_OBSTBL_ASCII [2], EIS_CPT_OBSTBL_EXTRACT [1]
EIS_CPT_OBSTBL_EXTRACT [2], EIS_CPT_OBSTBL_GET [1], EIS_CPT_OBSTBL_GET [2]
EIS_CPT_OBSTBL_INDEX [1], EIS_CPT_OBSTBL_INDEX [2]
EIS_CPT_OBSTBL_OUTPUT [1], EIS_CPT_OBSTBL_OUTPUT [2]
EIS_CPT_OBSTBL_PLACE [1], EIS_CPT_OBSTBL_PLACE [2]
EIS_CPT_OBSTBL_REFRESH [1], EIS_CPT_OBSTBL_REFRESH [2]
EIS_CPT_OBSTBL_SET [1], EIS_CPT_OBSTBL_SET [2], EIS_CPT_STRTRIM [1]
EIS_CPT_STRTRIM [2], EIS_CPT_TABLE_DIFFERENCE [1]
EIS_CPT_TABLE_DIFFERENCE [2]
CALLED BY:
EIS_CPT_ASCII_TABLES [1], EIS_CPT_ASCII_TABLES [2], EIS_CPT_COMPLETE [1]
EIS_CPT_COMPLETE [2], EIS_CPT_DATA_RATE [1], EIS_CPT_DATA_RATE [2]
EIS_CPT_PRELIMINARIES [1], EIS_CPT_PRELIMINARIES [2], EIS_CPT_PROCESS [1]
EIS_CPT_PROCESS [2], EIS_CPT_PROCESS_AEC_TABLE [1]
EIS_CPT_PROCESS_AEC_TABLE [2], EIS_CPT_PROCESS_EIS_EVENT_TABLE [1]
EIS_CPT_PROCESS_EIS_EVENT_TABLE [2], EIS_CPT_PROCESS_EIS_FLARE_TABLE [1]
EIS_CPT_PROCESS_EIS_FLARE_TABLE [2]
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [1]
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [2]
EIS_CPT_PROCESS_LINELISTS_FOR_STUDY [1]
EIS_CPT_PROCESS_LINELISTS_FOR_STUDY [2], EIS_CPT_PROCESS_STUDIES [1]
EIS_CPT_PROCESS_STUDIES [2], EIS_CPT_PROCESS_XRT_FLARE_TABLE [1]
EIS_CPT_PROCESS_XRT_FLARE_TABLE [2], EIS_CPT_SEQUENCE_MATCH [1]
EIS_CPT_SEQUENCE_MATCH [2], EIS_CPT_SEQUENCE_PLACE [1]
EIS_CPT_SEQUENCE_PLACE [2], EIS_CPT_SEQUENCE_RESOLVE_LINKS [1]
EIS_CPT_SEQUENCE_RESOLVE_LINKS [2]
Common : EIS_CPT_obstbl_block
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 01/02/05
Modified : Version 0.1, 07/02/05
Renamed eis cpt get obstbl, eis cpt refresh obstbl, eis cpt output obstbl.
Added AEC exposure table etc.
Version 0.2, 01/03/05, MKC
Renamed the AEC and event tags.
Added PLACE keyword back in.
Changed TIMESTAMP flag to string containing time.
Moved indexes to !EIS_CPT_CONSTANTS.
Version 0.3, 02/04/05, MKC
Added EXTRACT keyword.
Used eis cpt obstbl place.
Version 0.4, 28/04/05, MKC
Added ULBA keyword.
Rearranged order of processing keywords.
Changed use of !EIS_CPT_CONSTANTS.
Version 0.5, 12/05/05, MKC
Rearranged processing order.
Changed INDEX keyword to LINK.
Added CHECK, TEXT, RASTERS keywords.
Changed error message if get fails.
Version 0.6, 14/07/05, MKC
Added INTEL and MSSL and ALL keywords to print out tables as intel hex.
Version 0.7, 16/09/05, MKC
Changed sense of LINK keyword so that refers to previous table rather than following table.
Added EXACT keyword.
Added SET keyword.
Added USED keyword.
Version 0.8, 04/10/05, MKC
Added UPLOAD_TIME keyword.
Changed so that if no place found then sets table_index to -1.
Version 0.9, 14/06/06, MKC
Used EIS_upload structure.
Version 1.0, 16/06/06, MKC
Changed so that if no place found then table_index is undefined.
Changed so that table_index is undefined or valid on input.
Version 1.1, 14/07/06, MKC
Updated OBSTL_MAP link info.
Added FIRST and LAST keywords.
Added TERMINATE keyword.
Version 1.2, 21/08/06, MKC
Changed error message.
Version 1.3, 23/09/06, MKC
Keep copy of previous obstbl in common block.
Added keyword DIFFERENCE.
Removed keyword ALL.
Version 1.4, 03/10/06, MKC
Changed TIMESTAMP keyword to STAMP.
Version : 1.4, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_obstbl__define
Purpose : Generates structure EIS_CPT_obstbl.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
EIS_CPT_obstbl. Tags are :-
map : STRUCTURE of type EIS_CPT_obstbl_map
data : BYTARR[] obstbl byte values.
header : STRING header info
ulba : UINT extended linear address
Use : <dummy = {EIS_CPT_obstbl}>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 26/10/04
Modified : Version 0.0, 26/10/04, MKC
Version 0.1, 04/03/05, MKC
Added OBSTBL size to !EIS_CPT_CONSTANTS.
Removed index tag.
Version : Version 0.1, 04/03/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OBSTBL_ASCII
Purpose : Writes out OBSTBL tables to individual ASCII files.
Explanation : This routine outputs OBSTBL tables either as Intel hex files or MSSL command mnemonic files.
Use : < result = eis_cpt_obstbl_ascii ( MSSL=mssl, INTEL=intel, $
SEQUENCE=sequence, LINELIST=linelist, $
AEC_EXPOSURE=aec_exposure, AEC_TABLE=aec_table, $
XRT_FLARE=xrt_flare, EIS_FLARE=eis_flare, $
EIS_EVENT=eis_event ) >
Inputs : None.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : OK.
0 : failed.
Opt. Outputs: None.
Keywords : MSSL : INT Flag indicating should produce individual ASCII files for each sequence table
and line list table in MSSL command mnemonic form.
0 : no output
1 : outputs new tables
2 : outputs all tables
INTEL : INT Flag indicating should produce individual Intel hex files for each sequence table
and line list table.
0 : no output
1 : outputs new tables
2 : outputs all tables
SEQUENCE : INTARR list of sequence tables to output.
LINELIST : INTARR list of linelist tables to output.
AEC_EXPOSURE : FLAG indicating that processing an AEC exposure table
AEC_TABLE : FLAG indicating that processing an AEC control table
XRT_FLARE : FLAG indicating that processing an XRT flare trigger control table
EIS_FLARE : FLAG indicating that processing an EIS flare trigger control table
EIS_EVENT : FLAG indicating that processing an EIS event trigger control table
Calls : ***
EIS_CPT_ASCII_TABLES [1], EIS_CPT_ASCII_TABLES [2], EIS_CPT_environment [1]
EIS_CPT_environment [2]
CALLED BY:
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : Adapeted from EIS CPT process.
Written : Martin Carter RAL 13/07/05
Modified : Version 0.0, 13/07/05, MKC
Version 0.1, 28/09/05, MKC
Corrected bug if mssl or intel undefined.
Changed logic slightly.
Removed ALL keyword.
Version : 0.1, 28/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OBSTBL_CHECK
Purpose : Checks OBSTBL parameters are in range.
Explanation : Checks various parameters associated with the OBSTBL.
Use : < res = eis_cpt_obstbl_check(start_address,header,ulba,data) >
Inputs : None.
Opt. Inputs : None.
Outputs : res : INT FLAG indicating result
1 : ok
0 : not ok
start_address : UINT 16 least significant bits of start address
header : STRING OBSTBL header string.
ulba : UINT upper linear base address.
data : BYTARR[] OBSTBL data
Opt. Inputs : None.
Outputs : result : status flag
0 : if checks failed.
1 : checks OK.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_OBSTBL_GET [1], EIS_CPT_OBSTBL_GET [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 29/04/05
Modified : Version 0.0, 29/04/05, MKC
Version : Version 0.0, 29/04/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OBSTBL_EXTRACT
Purpose : Gets table from OBSTBL.
Explanation : OBSTBL contains many different tables.
This routine extracts a table of specified type.
Use : < res = eis_cpt_obstbl_extract(obstbl, table_index, table, time_for_reuse, description ) >
Inputs : obstbl : STRUCTURE of type EIS_CPT_obstbl.
table_index : INT index of table.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed OK.
0 : processing failed.
table : BYTARR[] table data
time_for_reuse : DOUBLE TAI time after which table may be reused.
description : STRING description of table
Opt. Outputs: None.
Keywords : SEQUENCE : FLAG indicating that processing a sequence.
LINELIST : FLAG indicating that processing a linelist
AEC_EXPOSURE : FLAG indicating that processing an AEC exposure table
AEC_TABLE : FLAG indicating that processing an AEC control table
XRT_FLARE : FLAG indicating that processing an XRT flare trigger control table
EIS_FLARE : FLAG indicating that processing an EIS flare trigger control table
EIS_EVENT : FLAG indicating that processing an EIS event trigger control table
Calls : ***
EIS_CPT_OBSTBL_INDEX [1], EIS_CPT_OBSTBL_INDEX [2]
CALLED BY:
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 04/03/05
Modified : Version 0.0, 04/03/05, MKC
Version 0.1, 25/04/05, MKC
Removed check that table is used.
Removed fatal check on table length.
Added table check routine.
Version 0.2, 29/04/05, MKC
Changed use of !EIS_CPT_CONSTANTS.
Version 0.3, 11/05/05, MKC
Updated.
Version 0.4, 28/06/05, MKC
Added time_for_reuse and description from control tables.
Version : 0.4, 28/06/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OBSTBL_GET
Purpose : Get current OBSTBL and OBSTBL map from files
Explanation : The current OBSTBL is kept in an INTEL Hex file.
The current OBSTBL map is kept in an ASCII file.
If read fails then returns 0.
Use : < result = eis_cpt_obstbl_get(obstbl) >
Inputs : None.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
obstbl : STRUCTURE of type EIS_CPT_OBSTBL.
Opt. Outputs: None.
Keywords : reset : INT flag indicating should initialize OBSTBL
1 : soft reset (only OBSTBL map)
2 : hard reset (OBSTBL also)
Calls : ***
EIS_CPT_FILE_NAME [1], EIS_CPT_FILE_NAME [2], EIS_CPT_OBSTBL_CHECK [1]
EIS_CPT_OBSTBL_CHECK [2], EIS_CPT_OBSTBL_MAP_READ [1]
EIS_CPT_OBSTBL_MAP_READ [2], EIS_CPT_READ_INTEL_HEX_FILE [1]
EIS_CPT_READ_INTEL_HEX_FILE [2]
CALLED BY:
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 26/10/04
Modified : Version 0.1, 25/11/04, MKC
Added !EIS_CPT_CONSTANTS.
Version 0.2, 07/02/05, MKC
Renamed from eis cpt get obstbl.
Renamed eis cpt read obstbl map.
Renamed eis cpt read obstbl.
Version 0.3, 04/03/05, MKC
Moved OBSTBL indexes to !EIS_CPT_CONSTANTS.
Removed index tags.
Changed call to eis cpt obstbl read.
Version 0.4, 26/04/05, MKC
Changed so that preserves OBSTBL data on RESET.
Added check on ulba.
Added start_address.
Version 0.5, 09/05/05, MKC
Modified RESET behaviour.
Replaced eis cpt obstbl read with direct call to eis cpt read intel hex file.
Changed so that returns OBSTL through argument list.
Version 0.6, 05/07/05, MKC
Changed so that resets resets OBSTBL to 'FF's..
Version 0.7, 20/08/06, MKC
Fixed bug where if reset=1 used and OBSTBL read fails then OBSTBL not initialized to 'FF's.
If no OBSTBL now insists start with reset=2.
Version 0.8, 03/10/06, MKC
Changed names of internal obstbl files.
Version : 0.8, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OBSTBL_INDEX
Purpose : Gets index(es) of table relative to start of OBSTBL, length and number of tables.
Explanation : OBSTBL contains many different tables.
This routine returns index(es) of tables, length and number of tables of specified type
in OBSTBL data array.
Use : < res = eis_cpt_obstbl_address(table_index, index,length,number,SEQUENCE=sequence, LINELIST=linelist, $
AEC_EXPOSURE=aec_exposure, AEC_TABLE=aec_table, $
XRT_FLARE=xrt_flare, EIS_FLARE=eis_flare, $
EIS_EVENT=eis_event, ALL=all ) >
Inputs : table_index : INT index of table.
May be undefined if ALL indexes required.
May be undefined if only length and number of tables needed.
Opt. Inputs : None.
Outputs : index : LONG or []LONG index relative to start of OBSTBL data.
length : INT length of table
number : INT number of tables
Opt. Outputs: None.
Keywords : SEQUENCE : FLAG indicating that processing a sequence.
LINELIST : FLAG indicating that processing a linelist
AEC_EXPOSURE : FLAG indicating that processing an AEC exposure table
AEC_TABLE : FLAG indicating that processing an AEC control table
XRT_FLARE : FLAG indicating that processing an XRT flare trigger control table
EIS_FLARE : FLAG indicating that processing an EIS flare trigger control table
EIS_EVENT : FLAG indicating that processing an EIS event trigger control table
ALL : FLAG indicating should return all indexes for linelists or sequences
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2], EIS_CPT_STRTRIM [1]
EIS_CPT_STRTRIM [2]
CALLED BY:
EIS_CPT_ASCII_TABLES [1], EIS_CPT_ASCII_TABLES [2], EIS_CPT_CHECK_TABLE [1]
EIS_CPT_CHECK_TABLE [2], EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2]
EIS_CPT_OBSTBL_EXTRACT [1], EIS_CPT_OBSTBL_EXTRACT [2]
EIS_CPT_OBSTBL_PLACE [1], EIS_CPT_OBSTBL_PLACE [2], EIS_CPT_OBSTBL_SET [1]
EIS_CPT_OBSTBL_SET [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 29/04/05
Modified : Version 0.0, 29/04/05, MKC
Version 0.1, 11/05/05, MKC
Added number argument.
Allowed undefined table_index.
Version 0.2, 05/10/05, MKC
Allowed table_index = -1.
Version 0.3, 16/06/06, MKC
Disallow table_index = -1.
Version : 0.3, 16/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_obstbl_map__define
Purpose : Generates structure EIS_CPT_obstbl_map.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
EIS_CPT_obstbl_map. Tags are :-
sequences : STRUCTURE ARRAY of type OBSTBL_map_entry for each sequence table.
linelists : STRUCTURE ARRAY of type OBSTBL_map_entry for each linelist table.
xrt_flare : STRUCTURE of type OBSTBL_map_entry for XRT flare control table.
eis_flare : STRUCTURE of type OBSTBL_map_entry for EIS flare control table.
eis_event : STRUCTURE of type OBSTBL_map_entry for EIS event control table.
aec_table : STRUCTURE of type OBSTBL_map_entry for AEC control table.
aec_exposure : STRUCTURE of type OBSTBL map_entry for AEC exposure table.
Use : <dummy = {EIS_CPT_obstbl_map}>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 20/10/04
Modified : Version 0.1, 18/11/04, MKC
Added description tags.
Rearranged tags.
Version 0.2, 23/02/05, MKC
Added event and aec table tags.
Version 0.3, 28/06/05, MKC
Added aec exposure tag.
Version : 0.3, 28/06/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OBSTBL_MAP_DESCRIPTION
Purpose : Updates description and time.
Explanation : Updates description and time.
Use : < eis_cpt_obstbl_map_description, item, description, time) >
Inputs : item : STRUCTURE of EIS_CPT_OBSTBL_MAP_ENTRY
description : STRING new description
time : DOUBLE TAI time
Opt. Inputs : None.
Outputs : time : DOUBLE TAI latst time
description : STRING updated description
Opt. Outputs: None.
Keywords : None.
Calls : ***
STR_SEP
CALLED BY:
EIS_CPT_OBSTBL_SET [1], EIS_CPT_OBSTBL_SET [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 04/10/05
Modified : Version 0.0, 04/10/05, MKC
Version : 0.0, 04/10/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_obstbl_map_entry__define
Purpose : Generates structure EIS_CPT_obstbl_map_entry.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
EIS_CPT_obstbl_map_entry. Tags are :-
time : DOUBLE TAI time each sequence last used.
used : UINT value indicating whether sequence is currently in use.
0 : unused
1 : used
2 : used and not available for re-use
description : STRING mnemonic
Use : <dummy = {EIS_CPT_obstbl_map_entry}>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 18/11/04
Modified : Version 0.1, 14/07/06, MKC
Added first, last and link tags.
Version : 0.1, 14/07/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OBSTBL_MAP_PARSE
Purpose : Interprets OBSTBL map.
Explanation : Fills OBSTBL map even if entry is not used.
Use : < map = eis_cpt_obstbl_map_parse(data,type,ndim) >
Inputs : data : ANONYMOUS STRUCTURE returned from reading map file.
Tags:['table_id','table_entry','table_used','table_time','table_description']
type : STRING indicating entry type, eg 'SEQUENCE'
ndim : UINT number of possible entries
Opt. Inputs : None.
Outputs : map : STRUCTURE ARRAY of type EIS_CPT_obstbl_map_entry.
Opt. Outputs: None.
Keywords : COUNT : Named variable to receive count of number of type encountered.
Calls : ***
ANYTIM2TAI, EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_OBSTBL_MAP_READ [1], EIS_CPT_OBSTBL_MAP_READ [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 18/11/04
Modified : Version 0.1, 24/11/04
Changed so that sets up all entries (not just used ones).
Version 0.2, 07/02/05, MKC
Renamed eis cpt parse obstbl map
Version 0.3, 21/07/05, MKC
Label indexes from 0 in obstbl map file.
Version 0.4, 04/10/05, MKC
Allowed time field to be '----...'.
Version 0.5, 20/07/06, MKC
Set up first, last and used tags.
Version : 0.5, 20/07/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OBSTBL_MAP_READ
Purpose : Reads current OBSTBL map from file.
Explanation : The current OBSTBL map is kept in an ASCII file.
If read fails then returns 0.
Use : < obstbl_map = eis_cpt_obstbl_map_read() >
Inputs : None.
Opt. Inputs : None.
Outputs : obstbl_map : STRUCTURE of type EIS_CPT_obstbl_map listing TAI times that tables
are available for re-use.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_CHECK_FILE [1], EIS_CPT_CHECK_FILE [2], EIS_CPT_FILE_NAME [1]
EIS_CPT_FILE_NAME [2], EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
EIS_CPT_OBSTBL_MAP_PARSE [1], EIS_CPT_OBSTBL_MAP_PARSE [2], READ_ASCII
CALLED BY:
EIS_CPT_OBSTBL_GET [1], EIS_CPT_OBSTBL_GET [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 18/10/04
Modified : Version 0.1, 18/11/04, MKC
Changed to use '|' as column delimter in map file rather than ' ' to allow comments.
Version 0.2, 07/02/05, MKC
Renamed eis cpt read obstbl map
Version 0.3, 23/02/05, MKC
Changed field locations to allow for longer table_id.
Don't believe these are used anyway.
Added event tables and AEC table.
Version 0.4, 17/03/05, MKC
Used eis cpt file name.
Version 0.5, 28/06/05, MKC
Added aec exposure tag.
Version 0.6, 21/07/05, MKC
Label indexes from 0 in obstbl map file.
Version 0.7, 03/10/05, MKC
Switched on /READ keyword.
Version 0.8, 12/07/06, MKC
Changed MAP file format.
Version 0.9, 03/10/06, MKC
Changed names of internal obstbl files.
Version : 0.9, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OBSTBL_MAP_REFRESH
Purpose : Updates OBSTBL_MAP used flag.
Explanation : Check which tables are available for re-use.
Updates used flag.
Use : < new_map = eis_cpt_obstbl_map_refresh (map, time) >
Inputs : map : STRUCTURE ARRAY of type EIS_CPT_OBSTBL_map_entry
time : DOUBLE TAI time
Opt. Inputs : None.
Outputs : map : STRUCTURE ARRAY of type EIS_CPT_OBSTBL_map_entry
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_OBSTBL_REFRESH [1], EIS_CPT_OBSTBL_REFRESH [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/11/04
Modified : Version 0.1, 07/02/05, MKC
Renamed eis cpt refresh obstbl map
Version 0.2, 03/03/05, MKC
Tightened up use of WHERE.
Version 0.3, 05/10/05, MKC
Reset used=2 values.
Version : Version 0.3, 05/10/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OBSTBL_MAP_TEXT
Purpose : Produces text output for one line of OBSTBL map.
Explanation : Produces text output for one line of OBSTBL map.
Use : < res = eis_cpt_obstbl_map_text(type, index, used, time, description) >
Inputs : type : STRING string giving table type. One of :
'SEQUENCE','LINELIST','AECTABLE','AECEXPOS','XRTFLARE','EISFLARE','EISEVENT'
index : INTARR[] giving each table index
used : INTARR[] flag indicating whether each table used
time : DBLARR[] giving when each table free
description : STRARR[] flag giving description of each table
Opt. Inputs : None.
Outputs : res : INT flag indicating result
1 : ok
0 : not ok
Opt. Outputs: None.
Keywords : FORMAT : INT flag indicating should produce format text.
LINK : INT tabel index of linked sequence table
FIRST : INT flag indicating first sequence in study
LAST : INT flag indicating last sequence in study
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2]
CALLED BY:
EIS_CPT_OBSTBL_MAP_WRITE [1], EIS_CPT_OBSTBL_MAP_WRITE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 04/10/05
Modified : Version 0.0, 04/10/05, MKC
Version 0.1, 12/07/06, MKC
Changed MAP file format.
Included follow on sequence and start of study flag.
Added link, first and last keywords.
Version : 0.1, 12/07/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OBSTBL_MAP_WRITE
Purpose : Writes current OBSTBL map to file.
Explanation : If write fails then returns 0.
Use : < res = eis_cpt_obstbl_map_write(obstbl_map) >
Inputs : obstbl_map : STRUCTURE of type EIS_CPT_obstbl_map listing TAI times that line lists and sequences
are available for re-use.
Opt. Inputs : None.
Outputs : res : INT flag indicating result
1 : ok
0 : not ok
Opt. Outputs: None.
Keywords : STAMP : STRING stamp indicating should stamp file names.
Calls : ***
EIS_CPT_CLOSE_FILE [1], EIS_CPT_CLOSE_FILE [2], EIS_CPT_FILE_NAME [1]
EIS_CPT_FILE_NAME [2], EIS_CPT_OBSTBL_MAP_TEXT [1]
EIS_CPT_OBSTBL_MAP_TEXT [2], EIS_CPT_OPEN_FILE [1], EIS_CPT_OPEN_FILE [2]
EIS_CPT_WRITE_TEXT [1], EIS_CPT_WRITE_TEXT [2]
CALLED BY:
EIS_CPT_OBSTBL_OUTPUT [1], EIS_CPT_OBSTBL_OUTPUT [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 21/10/04
Modified : Version 0.1, 04/11/04, MKC
Added TIMESTAMP keyword.
Version 0.2, 07/02/05, MKC
Renamed from eis ct write obstbl map.
Version 0.3, 23/02/05, MKC
Changed IDs to SEQUENCE and LINELIST and added event and AEC IDs.
Version 0.4, 04/03/05, MKC
Changed TIMESTAMP flag to string containing time.
Version 0.5, 09/03/05, MKC
Incorporated TIMESTAMP within file name routine
Version 0.6, 17/03/05, MKC
Used eis cpt file name.
Version 0.7, 28/06/05, MKC
Added exposure tag.
Version 0.8, 21/07/05, MKC
Label indexes from 0 in obstbl map file.
Version 0.9, 04/10/05, MKC
Used eis cpt obstbl map text.
Version 1.0, 12/07/06, MKC
Used eis cpt obstbl map text for header.
Added keywords to eis cpt obstbl map text.
Added tags to obstbl_map.
Version 1.1, 03/10/06, MKC
Changed TIMESTAMP keyword to STAMP.
Version : 1.1, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OBSTBL_OUTPUT
Purpose : Writes current OBSTBL and OBSTBL map to files.
Explanation : The current OBSTBL is kept in an INTEL Hex file.
The current OBSTBL map is kept in an ASCII file.
Use : < res = eis_cpt_obstbl_output(obstbl) >
Inputs : obstbl : STRUCTURE of type EIS_CPT_obstbl.
Opt. Inputs : None.
Outputs : res : INT FLAG indicating result
1 : ok
0 : not ok
Opt. Outputs: None.
Keywords : STAMP : STRING stamp indicating should stamp file names.
Calls : ***
EIS_CPT_FILE_NAME [1], EIS_CPT_FILE_NAME [2], EIS_CPT_OBSTBL_MAP_WRITE [1]
EIS_CPT_OBSTBL_MAP_WRITE [2], EIS_CPT_WRITE_INTEL_HEX_FILE [1]
EIS_CPT_WRITE_INTEL_HEX_FILE [2]
CALLED BY:
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 26/10/04
Modified : Version 0.1, 04/11/04, MKC
Added TIMESTAMP keyword.
Version 0.2, 07/02/05, MKC
Renamed from eis ct output obstbl.
Renamed eis cpt write obstbl map and eis cpt write obstbl.
Version 0.3, 04/03/05, MKC
Changed TIMESTAMP flag to string containing time.
Version 0.4, 11/04/05, MKC
Removed eis cpt obstbl write.
Version 0.5, 17/09/06, MKC
Added printout.
Version 0.6, 03/10/06, MKC
Changed TIMESTAMP keyword to STAMP.
Version : 0.6, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OBSTBL_PLACE
Purpose : Places table in OBSTBL.
Explanation : Finds best location to put table in OBSTBL.
Use : < res = eis_cpt_obstbl_place(obstbl, table, table_index) >
Inputs : obstbl : STRUCTURE of type EIS_CPT_obstbl.
table : BYTARR[] table data
Opt. Inputs : table_index : INT index of table to be checked.
If table_index defined and NE -1 then specifies a single table that should be checked.
On output table_index gives the table index if an exact match found else undefined.
If undefined then does full search of tables.
Outputs : result : INT flag :
1 : processed OK.
0 : processing failed.
table_index : INT index of table found.
Undefined if no place found for table
Opt. Outputs: None.
Keywords : SEQUENCE : FLAG indicating that processing a sequence.
LINELIST : FLAG indicating that processing a linelist
AEC_EXPOSURE : FLAG indicating that processing an AEC exposure table
AEC_TABLE : FLAG indicating that processing an AEC control table
XRT_FLARE : FLAG indicating that processing an XRT flare trigger control table
EIS_FLARE : FLAG indicating that processing an EIS flare trigger control table
EIS_EVENT : FLAG indicating that processing an EIS event trigger control table
EXACT : FLAG indicating should look for exact match when doing full search in unused tables
NB with proviso about last two bytes in sequence table
USED : INT indicating should look in 'inuse = used' tables also.
Calls : ***
EIS_CPT_OBSTBL_INDEX [1], EIS_CPT_OBSTBL_INDEX [2], EIS_CPT_TABLE_PLACE [1]
EIS_CPT_TABLE_PLACE [2]
CALLED BY:
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 04/03/05
Modified : Version 0.0, 04/03/05, MKC
Version 0.1, 29/04/05, MKC
Changed use of !EIS_CPT_CONSTANTS.
Version 0.2, 16/05/05, MKC
Changed processing of linelist map details.
Version 0.3, 25/06/05, MKC
Added map entries for control tables.
Version 0.4, 28/06/05, MKC
Added map entries for aec_exposure table.
Version 0.5, 16/09/05, MKC
Split into two routines : PLACE and SET.
Added EXACT and USED keywords.
Renamed eis cpt place table.
Version 0.6, 04/10/05, MKC
Added control table keywords.
Changed so that if no place found then sets table_index to -1.
Version 0.7, 16/06/06, MKC
Changed so that if no place found then table_index is undefined.
Changed so that table_index is undefined or valid on input.
Version : 0.7, 16/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OBSTBL_REFRESH
Purpose : Updates OBSTBL
Explanation : Check which tables are available for re-use.
Sets up header.
Use : < eis_cpt_obstbl_refresh, obstbl, upload >
Inputs : obstbl : STRUCTURE of type EIS_CPT_obstbl.
upload : STRUCTURE of type EIS_upload.
Opt. Inputs : None.
Outputs : Sets up upload if not defined.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_DEBUG [1], EIS_CPT_DEBUG [2], EIS_CPT_NOW [1], EIS_CPT_NOW [2]
EIS_CPT_OBSTBL_MAP_REFRESH [1], EIS_CPT_OBSTBL_MAP_REFRESH [2]
CALLED BY:
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 05/11/04
Modified : Version 0.1, 03/02/05, MKC
Moved obstbl to argument list.
Passed subID rather than engineering parameters.
Version 0.2, 07/02/05, MKC
Renamed eis cpt refresh obstbl, eis cpt refresh obstbl map
Changed header format.
Version 0.3, 23/02/05, MKC
Added event and aec tables.
Used !EIS_CPT_CONSTANTS.
Version 0.4, 04/10/05, MKC
Made refresh time an argument.
Version 0.5, 14/06/06, MKC
Used EIS_upload structure.
Version 0.6, 17/06/06, MKC
Hardcoded creation date if debugging.
Version 0.7, 20/08/06, MKC
Changed ' 999, dd' to ' ddd, dd' format for sub ID.
Used previous to calculate next version for OBSTBL.
Set up version and RAM sub id in upload structure.
If upload not defined then sets up default.
Version 0.8, 04/10/06, MKC
Changed RAM sub ID to a 3 character field in OBSTBL mirroring the version.
Changed version and RAM sub ID scheme.
Version : 0.8, 04/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OBSTBL_SET
Purpose : Inserts table into OBSTBL.
Explanation : Inserts table into OBSTBL.
Use : < res = eis_cpt_obstbl_set(obstbl, table_index, table, time_for_reuse, description ) >
Inputs : obstbl : STRUCTURE of type EIS_CPT_obstbl.
table_index : INT index of table.
table : BYTARR[] table data
time_for_reuse : DOUBLE TAI time after which table may be reused.
description : STRING description of table
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : SEQUENCE : FLAG indicating that processing a sequence.
LINELIST : FLAG indicating that processing a linelist
AEC_EXPOSURE : FLAG indicating that processing an AEC exposure table
AEC_TABLE : FLAG indicating that processing an AEC control table
XRT_FLARE : FLAG indicating that processing an XRT flare trigger control table
EIS_FLARE : FLAG indicating that processing an EIS flare trigger control table
EIS_EVENT : FLAG indicating that processing an EIS event trigger control table
RESPONSE : FLAG indicating that table is used in response study.
Calls : ***
EIS_CPT_OBSTBL_INDEX [1], EIS_CPT_OBSTBL_INDEX [2]
EIS_CPT_OBSTBL_MAP_DESCRIPTION [1], EIS_CPT_OBSTBL_MAP_DESCRIPTION [2]
CALLED BY:
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 04/03/05
Modified : Version 0.0, 04/03/05, MKC
Version 0.1, 29/04/05, MKC
Changed use of !EIS_CPT_CONSTANTS.
Version 0.2, 16/05/05, MKC
Changed processing of linelist map details.
Version 0.3, 25/06/05, MKC
Added map entries for control tables.
Version 0.4, 28/06/05, MKC
Added map entries for aec_exposure table.
Version 0.5, 16/09/05, MKC
Split into two routines : PLACE and SET.
Changed delimiter between comments to '#'
Added keyword response.
Version 0.6, 04/10/05, MKC
Allowed re-use of control tables..
Version 0.7, 17/06/06, MKC
Changed so that always writes table even if exact match.
Version 0.8, 14/07/06, MKC
Changed so that always writes sequence table even if exact match.
Version : 0.8, 14/07/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_OPEN_FILE
Purpose : Opens file.
Explanation : If open fails then returns 0 else returns logical unit.
NB 0 is not a valid logical unit
Use : < unit = eis_cpt_open_file(filename) >
Inputs : filename : STRING name of file, including directory.
Opt. Inputs : None.
Outputs : unit : LONG logical unit of opened file.
Opt. Outputs: None.
Keywords : READ : FLAG indicating open file for reading.
WRITE : FLAG indicating open file for writing.
Calls : ***
EIS_CPT_CHECK_FILE [1], EIS_CPT_CHECK_FILE [2], EIS_CPT_MESSAGE [1]
EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_OBSTBL_MAP_WRITE [1], EIS_CPT_OBSTBL_MAP_WRITE [2]
EIS_CPT_READ_ASCII [1], EIS_CPT_READ_ASCII [2]
EIS_CPT_READ_INTEL_HEX_FILE [1], EIS_CPT_READ_INTEL_HEX_FILE [2]
EIS_CPT_WRITE_ASCII [1], EIS_CPT_WRITE_ASCII [2]
EIS_CPT_WRITE_INTEL_HEX_FILE [1], EIS_CPT_WRITE_INTEL_HEX_FILE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 15/10/04
Modified : Version 0.0, 15/10/04, MKC
Version : Version 0.0, 15/10/04
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PARSE_INTEL_HEX_FILE
Purpose : Interprets Intel Hex format file.
Explanation : If fails then returns 0.
Allow header delineated by '#' and ';'.
Allow /cr etc so that uses ':' for start of new records and does not
demand that records are contiguous.
However, issues warning if load addresses are not continuous.
Allow spaces between hex values.
Allow no end of file record.
Use : < res = eis_cpt_parse_intel_hex_file(raw_data,start_address,header,ulba,data) >
Inputs : raw_data : BYTARR[] raw data from file in Intel Hex format.
Opt. Outputs: None.
Outputs : res : INT FLAG indicating result
1 : ok
0 : not ok
start_address : UINT 16 least significant bits of start address
header : STRING OBSTBL header string.
ulba : UINT upper linear base address.
data : BYTARR[] OBSTBL data
Keywords : NOENDOFFILE : FLAG indicating allows no end of file record.
Calls : ***
EIS_CPT_BYTESTOUINT [1], EIS_CPT_BYTESTOUINT [2], EIS_CPT_CHECKSUM [1]
EIS_CPT_CHECKSUM [2], EIS_CPT_HEXTOBYTES [1], EIS_CPT_HEXTOBYTES [2]
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2], EIS_CPT_STRTRIM [1]
EIS_CPT_STRTRIM [2], EIS_CPT_UNDEFINE [1], EIS_CPT_UNDEFINE [2]
CALLED BY:
EIS_CPT_READ_INTEL_HEX_FILE [1], EIS_CPT_READ_INTEL_HEX_FILE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 15/10/04
Modified : Version 0.1, 01/11/04, MKC
Added HEADER keyword.
Added ULBA keyword.
Version 0.2, 04/03/05, MKC
Changed so that returns data through arguments and an
error code through function call.
Version 0.3, 29/04/05, MKC
Added start_address argument.
Allow spaces between hex values.
Allow no end of file record.
Added NOENDOFFILE keyword.
Version 0.4, 15/05/05, MKC
Made it an error if no data in file.
Version 0.5, 17/09/06, MKC
Changed so that NOENDOFFILE flag allows no end of file but does not insist on it.
Version 0.6, 12/10/06, MKC
Prevented start address being passed into routine.
Version : 0.6, 12/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PRELIMINARIES
Purpose : Performs preliminary tasks for eis_cpt.
Explanation : Initializes things, reads OBSTBL and OBSTBL map.
Use : < result = eis_cpt_preliminaries(RESET=reset, QUIET=quiet) >
Inputs : None.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : RESET : INT FLAG indicating that OBSTBL and OBSTBL map should be reset,
QUIET : INT FLAG indicating that no printout to the terminal window should be produced.
Calls : ***
EIS_CPT_COMMAND_STORE [1], EIS_CPT_COMMAND_STORE [2], EIS_CPT_DATA_RATE [1]
EIS_CPT_DATA_RATE [2], EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2]
EIS_CPT_QUIET [1], EIS_CPT_QUIET [2], EIS_CPT_SETUP_CONSTANTS [1]
EIS_CPT_SETUP_CONSTANTS [2]
CALLED BY:
EIS_CPT [1], EIS_CPT [2]
Common : None.
Restrictions: None.
Side effects: Returns to calling routine if error.
Resets !ERROR_STATE system variable.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 06/10/04
Modified : Version 0.1, 21/01/05, MKC
Added coarse_mirror_command_list to arguments.
Version 0.2, 03/02/05, MKC
Used eis cpt obstbl.
Moved obstbl to its own common block.
Version 0.3, 01/03/05, MKC
Used EIS CPT op, dv and real
Removed COMMON block.
Added control_details.
Changed so that does not output old version of obstbl as time stamped file.
Version 0.4, 18/03/05, MKC
Renamed arguments.
Used eis cpt command store
Version 0.5, 21/04/05, MKC
Allowed EIS_CPT to be called without a time period defined.
Version 0.6, 09/05/05, MKC
Added bakeout_periods.
Version 0.7, 19/07/05, MKC
Renamed routines eis get suspension periods, eis get bakeout periods and
eis get coarse mirror commands.
Renamed eis get control details.
Added real command sequences argument.
Version 0.8, 22/09/05, MKC
Added ground contact periods.
Added eis cpt data rate.
Added time period processing to TAI.
Version 0.9, 03/10/05, MKC
Removed restriction that control details must be set up /(even if not used).
Version 1.0, 14/06/06, MKC
Removed use of interface routines and associated arguments.
Version 1.1, 14/07/06, MKC
Moved time period check and time period argument argument.
Version : 1.0, 14/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS
Purpose : Processes studies and other time line objects needed for current plan..
Explanation : This routine processes the science plan timeline. producing the necessary entries into
the OBSTBL, REAL command file and OP command file.
Items in the timeline consist of : science studies, engineering studies, real command sequences,
suspension periods, bakeout periods and coarse mirror movements.
Studies are either science or engineering studies.
Use : < result = eis_cpt_process ( engineering_parameters, control_details, study_details, $
suspension_periods, abort_times, bakeout_periods, contact_info, coarse_mirror_commands, $
real_command_sequences, time_period, upload, $
MSSL=mssl, INTEL=intel ) >
Inputs : engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
control_details : STRUCTURE of type EIS_control_details.
study_details : STRUCTURE ARRAY of type EIS_study_detail.
suspension_periods : STRUCTURE ARRAY of type EIS_suspend_period.
abort_Times : STRUCTURE ARRAY of type EIS_abort.
bakeout_periods : STRUCTURE ARRAY of type EIS_bakeout_period.
contact_info : STRUCTURE containing contact period info.
coarse_mirror_commands : STRUCTURE ARRAY of type EIS_coarse_mirror_command.
real_command_sequences : STRUCTURE ARRAY of type EIS_list_real_detail
time_period : DBLARR[2] TAI time to start and finish timeline.
upload : STRUCTURE of type EIS_upload.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
upload : Gets defined if not already defined
Opt. Outputs: None.
Keywords : MSSL : INT Flag indicating should produce individual ASCII files for each sequence table
and line list table in MSSL command mnemonic form.
0 : no output
1 : outputs new tables
2 : outputs all tables
INTEL : INT Flag indicating should produce individual Intel hex files for each sequence table
and line list table.
0 : no output
1 : outputs new tables
2 : outputs all tables
Calls : ***
EIS_CPT_CHECK_CONTROL_PARAMETERS [1], EIS_CPT_CHECK_CONTROL_PARAMETERS [2]
EIS_CPT_CHECK_ENGINEERING_PARAMETERS [1]
EIS_CPT_CHECK_ENGINEERING_PARAMETERS [2], EIS_CPT_COMMAND_STORE [1]
EIS_CPT_COMMAND_STORE [2], EIS_CPT_DATA_RATE [1], EIS_CPT_DATA_RATE [2]
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2], EIS_CPT_PROCESS_ABORT_TIMES [1]
EIS_CPT_PROCESS_ABORT_TIMES [2], EIS_CPT_PROCESS_BAKEOUT_PERIODS [1]
EIS_CPT_PROCESS_BAKEOUT_PERIODS [2]
EIS_CPT_PROCESS_COARSE_MIRROR_COMMANDS [1]
EIS_CPT_PROCESS_COARSE_MIRROR_COMMANDS [2]
EIS_CPT_PROCESS_REAL_COMMAND_SEQUENCES [1]
EIS_CPT_PROCESS_REAL_COMMAND_SEQUENCES [2], EIS_CPT_PROCESS_STUDIES [1]
EIS_CPT_PROCESS_STUDIES [2], EIS_CPT_PROCESS_SUSPENSION_PERIODS [1]
EIS_CPT_PROCESS_SUSPENSION_PERIODS [2], EIS_CPT_PROCESS_TIMELINE [1]
EIS_CPT_PROCESS_TIMELINE [2]
CALLED BY:
EIS_CPT [1], EIS_CPT [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 21/10/04
Modified : Version 0.1, 25/11/04, MKC
Added rearrange studies list.
Version 0.2, 20/01/05, MKC
Changed order of processing studies.
Version 0.3, 21/01/05, MKC
Added coarse_mirror_command_list to arguments.
Moved to processing study links after rocessing studies.
Removed eis cpt arrange studies list.
Added eis cpt resolve study links.
Moved eis cpt refresh obstbl.
Version 0.4, 08/02/05, MKC
Removed re-usable study code.
Version 0.5, 22/02/05, MKC
Added AEC control.
Version 0.6, 01/03/05, MKC
Added ENGINEERING keyword to EIS get study details.
Added EIS CPT process studies.
Added control_details.
Version 0.7, 18/03/05, MKC
Renamed arguments
Renamed keywords.
Added INTEL keyword.
Version 0.8, 13/04/05, MKC
Added check of engineering parameters.
Version 0.9, 21/04/05, MKC
Allowed EIS_CPT to be called without a time period defined.
Version 1.0, 27/04/05, MKC
Removed ISACS keyword.
Version 1.1, 09/05/05, MKC
Added process bakeout periods.
Version 1.2, 24/06/05, MKC
Added sequence_starts to the argument list of eis cpt process studies.
Version 1.3, 27/06/05, MKC
Moved eis cpt [process control tables..
Version 1.4, 19/07/05, MKC
Added real command sequences argument.
Version 1.5, 12/09/05, MKC
Added engineering parameters to process bakeout routine.
Added EIS OBSTBL RAM sub ID argument.
Added contact periods argument.
Added time_period argument.
Version 1.6, 03/10/05, MKC
Added upload time and pass id.
Version 1.7, 07/10/05, MKC
Moved command store check.
Version 1.8, 14/06/06, MKC
Used EIS_upload structure.
Version 1.9, 19/06/06, MKC
Moved check on whether relevant details defined into this routine.
Version 2.0, 20/08/06, MKC
Added engineering parameters to eis cpt data rate arguments.
Version 2.1, 03/10/06, MKC
Changed contact periods structure.
Added abort_times argument.
Added string argument to eis cpt command store.
Version : 2.1, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_ABORT_TIMES
Purpose : Processes aborts.
Explanation : Processes aborts.
Use : < result = eis_cpt_process_abort_times ( abort_times ) >
Inputs : abort_times : STRUCTURE ARRAY of type EIS_abort.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_COMMAND_STORE [1], EIS_CPT_COMMAND_STORE [2]
CALLED BY:
EIS_CPT_PROCESS [1], EIS_CPT_PROCESS [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 05/10/06
Modified : Version 0.0, 05/10/06, MKC
Version : 0.0, 05/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_AEC_TABLE
Purpose : Processes AEC table.
Explanation : Control tables are only processed if required by the current time-line..
Use : < result = eis_cpt_process_aec_table ( control, study_details, engineering_parameters) >
Inputs : control : STRUCTURE of type EIS_event_control.
study_details : STRUCTURE ARRAY of type EIS_study_detail.
engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2], EIS_CPT_SET_AEC_TABLE [1]
EIS_CPT_SET_AEC_TABLE [2], EIS_CPT_STUDY_TIME [1], EIS_CPT_STUDY_TIME [2]
EIS_CPT_ULONGTOBYTES [1], EIS_CPT_ULONGTOBYTES [2], EIS_CPT_UNDEFINE [1]
EIS_CPT_UNDEFINE [2]
CALLED BY:
EIS_CPT_PROCESS_CONTROL_TABLES [1], EIS_CPT_PROCESS_CONTROL_TABLES [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 24/06/05
Modified : Version 0.0, 24/06/05, MKC
Version 0.1, 18/09/05, MKC
Changed PLACE keyword to SET in eis cpt obstbl..
Version 0.2, 04/10/05, MKC
Allowed re-use of control table.
Version 0.3, 16/06/06, MKC
Changed so that table index is undefined if no place found for table.
Version : 0.3, 16/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_BAKEOUT_PERIODS
Purpose : Processes bakeout_periods.
Explanation : Processes bakeout_periods.
Use : < result = eis_cpt_process_bakeout_periods ( bakeout_periods, engineering_parameters ) >
Inputs : bakeout_periods : STRUCTURE ARRAY of type EIS_bakeout_period.
engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_COMMAND_STORE [1], EIS_CPT_COMMAND_STORE [2], EIS_CPT_MESSAGE [1]
EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_PROCESS [1], EIS_CPT_PROCESS [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 09/05/05
Modified : Version 0.1, 12/09/05, MKC
Changed bakeout procedure.
Added engineering parameters argument.
Version 0.2, 19/06/06, MKC
Moved check on whether stduy details defined out of this routine.
Moved printout of ALL OBSTBLs out of this routine.
Version 0.3, 26/09/06, MKC
Changed so that all commanding may be performed from GSE.
Version : 0.3, 26/09/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_COARSE_MIRROR_COMMANDS
Purpose : Processes coarse mirror commands.
Explanation : Processes coarse mirror commands.
Use : < result = eis_cpt_process_coarse_mirror_commands ( coarse_mirror_commands, engineering_parameters ) >
Inputs : coarse_mirror_commands : STRUCTURE ARRAY of type EIS_coarse_mirror_command.
engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_COMMAND_STORE [1], EIS_CPT_COMMAND_STORE [2], EIS_CPT_MESSAGE [1]
EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_PROCESS [1], EIS_CPT_PROCESS [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 26/10/04
Modified : Version 0.0, 26/10/04, MKC
Version 0.1, 09/03/05, MKC
Changed so that processes all coarse mirror commands.
Version 0.2, 22/03/05, MKC
Changed source tag to onboard tag.
Added 'real' commands.
Version 0.3, 24/03/05, MKC
Used eis cpt command store.
Version 0.4, 25/06/05, MKC
Added check on coarse mirror position.
Added engineering parameters to argument list
Version 0.5, 19/06/06, MKC
Moved check on whether coarse_mirror_commands defined out of this routine.
Version : 0.5, 19/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_CONTROL_TABLES
Purpose : Processes control tables.
Explanation : Control tables are only processed if required by the current time-line..
Use : < result = eis_cpt_process_control_tables ( control_details, study_details, $
sequences, engineering_parameters) >
Inputs : control_details : STRUCTURE of type EIS_control_details.
study_details : STRUCTURE ARRAY of type EIS_study_detail.
sequences : STRUCTURE ARRAY of type EIS_CPT_sequence.
engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_PROCESS_AEC_TABLE [1], EIS_CPT_PROCESS_AEC_TABLE [2]
EIS_CPT_PROCESS_EIS_EVENT_TABLE [1], EIS_CPT_PROCESS_EIS_EVENT_TABLE [2]
EIS_CPT_PROCESS_EIS_FLARE_TABLE [1], EIS_CPT_PROCESS_EIS_FLARE_TABLE [2]
EIS_CPT_PROCESS_XRT_FLARE_TABLE [1], EIS_CPT_PROCESS_XRT_FLARE_TABLE [2]
CALLED BY:
EIS_CPT_PROCESS_STUDIES [1], EIS_CPT_PROCESS_STUDIES [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 24/06/05
Modified : Version 0.0, 24/06/05, MKC
Version 0.1, 27/06/05, MKC
Remove check that study details defined.
Added check that control_details defined.
Changed to use sequences argument.
Version : Version 0.1, 27/06/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_EIS_EVENT_TABLE
Purpose : Processes EIS event table.
Explanation : Control tables are only processed if required by the current time-line..
Use : < result = eis_cpt_process_eis_event_table ( control, study_details, $
sequences, engineering_parameters) >
Inputs : control : STRUCTURE of type EIS_event_control.
study_details : STRUCTURE ARRAY of type EIS_study_detail.
sequences : STRUCTURE ARRAY of type EIS_CPT_sequence.
engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2], EIS_CPT_SET_EIS_EVENT_TABLE [1]
EIS_CPT_SET_EIS_EVENT_TABLE [2], EIS_CPT_STUDY_TIME [1]
EIS_CPT_STUDY_TIME [2]
CALLED BY:
EIS_CPT_PROCESS_CONTROL_TABLES [1], EIS_CPT_PROCESS_CONTROL_TABLES [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 24/06/05
Modified : Version 0.0, 24/06/05, MKC
Version 0.1, 18/09/05, MKC
Changed PLACE keyword to SET in eis cpt obstbl..
Changed to use sequences argument.
Version 0.2, 04/10/05, MKC
Allowed re-use of control table.
Version 0.3, 16/06/06, MKC
Changed so that table index is undefined if no place found for table.
Changed tag study identifier.
Hardcoded study identifier for response study.
Version : 0.3, 16/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_EIS_FLARE_TABLE
Purpose : Processes EIS flare table.
Explanation : Control tables are only processed if required by the current time-line..
Use : < result = eis_cpt_process_eis_flare_table ( control, study_details, $
sequences, engineering_parameters) >
Inputs : control : STRUCTURE of type EIS_flare_control.
study_details : STRUCTURE ARRAY of type EIS_study_detail.
sequences : STRUCTURE ARRAY of type EIS_CPT_sequence.
engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2], EIS_CPT_SET_EIS_FLARE_TABLE [1]
EIS_CPT_SET_EIS_FLARE_TABLE [2], EIS_CPT_STUDY_TIME [1]
EIS_CPT_STUDY_TIME [2]
CALLED BY:
EIS_CPT_PROCESS_CONTROL_TABLES [1], EIS_CPT_PROCESS_CONTROL_TABLES [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 24/06/05
Modified : Version 0.0, 24/06/05, MKC
Version 0.1, 18/09/05, MKC
Changed PLACE keyword to SET in eis cpt obstbl..
Changed to use sequences argument.
Version 0.2, 04/10/05, MKC
Allowed re-use of control table.
Version 0.3, 16/06/06, MKC
Changed so that table index is undefined if no place found for table.
Changed tag study identifier.
Hardcoded study identifiers for response study.
Version : 0.3, 16/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_ENGINEERING_SEQUENCES
Purpose : Implements engineering study as OBSTBL sequence tables
Explanation : An engineering study consists of a single Intel Hex file sequence table.
There optimum location is determined.
OBSTBL and OBSTBL_MAP are updated.
The mandatory control sequence is completed
outside of this routine.
Use : < result = eis_cpt_process_engineering_sequences( engineering_parameters, study_detail, engineering_detail, $
time_for_reuse, linelist, seq_start, seq_end, sequences ) >
Inputs : engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
study_detail : STRUCTURE of type EIS_study_detail.
engineering_detail : STRUCTURE ARRAY of type EIS_engineering_detail.
time_for_reuse : DOUBLE TAI time after which sequences may be overwritten.
linelists : INTARR[] gives linelist table index for engineering table.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
sequences : STRUCTURE ARRAY of type EIS_CPT_sequence.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_BYTESTOHEX [1]
EIS_CPT_BYTESTOHEX [2], EIS_CPT_CALL_SEQ [1], EIS_CPT_CALL_SEQ [2]
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2], EIS_CPT_OBSTBL [1]
EIS_CPT_OBSTBL [2], EIS_CPT_READ_INTEL_HEX_FILE [1]
EIS_CPT_READ_INTEL_HEX_FILE [2], EIS_CPT_TERM_SEQ [1], EIS_CPT_TERM_SEQ [2]
EIS_CPT_UINTTOBYTES [1], EIS_CPT_UINTTOBYTES [2]
CALLED BY:
EIS_CPT_PROCESS_STUDY [1], EIS_CPT_PROCESS_STUDY [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 10/05/05
Modified : Version 0.1, 28/06/05, MKC
Added ISACS PLN type engineering files.
Version 0.2, 14/07/05, MKC
Used file name directly.
Renamed engineering study filename tag.
Removed onboard tag from engineering detail.
Added sequence ID to obstbl map description.
Version 0.3, 12/09/05, MKC
Changed so that uses an intermediate structure array of sequences.
Added study repeats.
Version 0.4, 19/07/06, MKC
Added first sequence in study flag.
Version 0.5, 12/10/06, MKC
Added multiple linelisst for engineering studies.
Version : 0.5, 12/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_LINELISTS_FOR_STUDY
Purpose : Processes science linelists.
Explanation : Processes science linelists, checking for match with existing linelist.
Use : < result = eis_cpt_process_linelists_for_study ( engineering_parameters, raster_details, time_for_reuse, $
linelists ) >
Inputs : engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
study : STRUCTURE ARRAY of type EIS_raster_detail or EIS_engineering_detail,.
time_for_reuse : DOUBLE TAI time after which linelists may be reused.
linelists : INTARR[] linelist table list.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
linelists : INTARR[] adds to linelist table list for each raster for science study and for
engineering study if linelist used.
Opt. Outputs: None.
Keywords : ENGINEERING : FLAG indicating engineering study.
RESPONSE_RASTER : ULONG raster identifier indicating response study response raster
NB once detected response_raster is set to zero.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2]
EIS_CPT_READ_INTEL_HEX_FILE [1], EIS_CPT_READ_INTEL_HEX_FILE [2]
EIS_CPT_SET_LINELIST [1], EIS_CPT_SET_LINELIST [2], EIS_CPT_UNDEFINE [1]
EIS_CPT_UNDEFINE [2]
CALLED BY:
EIS_CPT_PROCESS_STUDY [1], EIS_CPT_PROCESS_STUDY [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 26/10/04
Modified : Version 0.1, 23/11/04, MKC
Added description tag.
Version 0.2, 02/12/04, MKC
Added linelists argument.
Version 0.3, 01/02/05, MKC
Added eis cpt obstbl.
Removed obstbl from argumnet list.
Version 0.4, 02/03/05, MKC
Corrected logic bug and added LINELIST keyword to eis cpt obstbl.
Version 0.5, 10/05/05, MKC
Added engineering keyword and engineering study processing.
Version 0.6, 14/07/05, MKC
Used file name directly.
Changed engineering linelist filename tag.
Version 0.7, 18/09/05, MKC
Added SET, USED keywords in eis cpt obstbl.
Added keyword RESPONSE_RASTER.
Version 0.8, 05/10/05, MKC
Changed so that if no place found then sets table_index to -1.
Version 0.9, 16/06/06, MKC
Changed so that table index is undefined if no place found for table.
Version 1.0, 11/10/06, MKC
Added multiple linelist filenames for engineering studies.
Version : 1.0, 11/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_REAL_COMMAND_SEQUENCES
Purpose : Processes the real command sequences.
Explanation : Processes the real command sequences.
Use : < result = eis_cpt_process_real_command_sequences ( real_command_sequences ) >
Inputs : real_command_sequences : STRUCTURE ARRAY of type EIS_list_real_detail.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_COMMAND_STORE [1], EIS_CPT_COMMAND_STORE [2], STRIP_DIRNAME [1]
STRIP_DIRNAME [2]
CALLED BY:
EIS_CPT_PROCESS [1], EIS_CPT_PROCESS [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 20/07/05
Modified : Version 0.0, 20/07/05, MKC
Version 0.1, 05/10/06, MKC
Added string argument to eis cpt command store.
Version : 0.1, 05/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_RESPONSE_STUDIES
Purpose : Processes event response studies.
Explanation : This routine processes the studies used for event response.
Event response studies are specified by their study database ID.
Use : < result = eis_cpt_process_response_studies ( engineering_parameters, control_details,$
expiry_times, list_of_lines, sequences) >
Inputs : engineering_parameters : STRCUTURE of type EIS_engineering_parameters.
study_details : STRUCTURE ARRAY of type EIS_study_detail.
control_details : STRUCTURE of type EIS_control_details.
expiry_times : DBLARR[nstudies] TAI time study expires.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
list_of_lines : INTARR() list of all linelist tables used.
sequences : STRUCTURE ARRAY of type EIS_CPT_sequences
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_PROCESS_STUDY [1], EIS_CPT_PROCESS_STUDY [2], EIS_GET_STUDY [1]
EIS_GET_STUDY [2], LAST_ITEM
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : Adapted from EIS CPT process.
Written : Martin Carter RAL 21/10/04
Modified : Version 0.0, 01/03/05
Version 0.1, 09/03/05, MKC
Added time-tagged studies to OP store.
Version 0.2, 18/03/05, MKC
Renamed eis get study details.
Renamed argument.
Version 0.3, 24/03/05, MKC
Used eis cpt command store.
Allowed studies to be run from GSE.
Renamed keywords.
Added INTEL keyword.
Version 0.4, 03/04/05, MKC
Added ACSII output of lines and sequences.
Version 0.5, 21/04/05, MKC
Allowed EIS_CPT to be called without a time period defined.
Version 0.6, 27/04/05, MKC
Removed ISACS keyword.
Version 0.7, 09/05/05, MKC
Removed Bakeout study processing.
Added in engineering file processing.
Changed to use eis cpt process study.
Version 0.8, 24/06/05, MKC
Added sequence_starts to the argument list.
Version 0.9, 27/06/05, MKC
Changed argument list.
Added eis cpt process control tables.
Version 1.0, 12/07/05, MKC
Added engineering parameters to eis cpt check studies list arguments.
Used eis cpt obstbl to output ASCII files.
Version 1.1, 19/09/05, MKC
Added reuse of sequences.
Added timeline processing.
Added expiry times argument.
Version 1.2, 19/06/06, MKC
Moved check on whether study details defined out of this routine.
Version 1.3, 08/09/06, MKC
Separated from eis cpt process studies.
Version : 1.3, 08/09/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_SCIENCE_SEQUENCES
Purpose : Implements science study as OBSTBL sequence tables
Explanation : A science study consists of a number of rasters. It may span a number of OBSTBL sequence
tables. These are daisy-chained together. This routine runs through the rasters forming the study,
adding them to the current sequence table.
When the sequence table is full a new sequence table.
The mandatory control sequence for the last sequence table forming the study is completed
outside of this routine, as are the links between daisy-chained sequences forming the study.
Use : < result = eis_cpt_process_science_sequences( engineering_parameters, study_detail, raster_details, $
time_for_reuse, linelists, sequences ) >
Inputs : engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
study_detail : STRUCTURE of type EIS_study_detail.
raster_details : STRUCTURE ARRAY of type EIS_raster_detail.
time_for_reuse : DOUBLE TAI time after which sequences may be overwritten.
linelists : INTARR[nrasters] gives linelist table index for each raster.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
sequences : STRUCTURE ARRAY of type EIS_CPT_sequence.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_BYTESTOHEX [1]
EIS_CPT_BYTESTOHEX [2], EIS_CPT_CALL_SEQ [1], EIS_CPT_CALL_SEQ [2]
EIS_CPT_HEX_RASTER [1], EIS_CPT_HEX_RASTER [2], EIS_CPT_SET_RASTER_ID [1]
EIS_CPT_SET_RASTER_ID [2], EIS_CPT_TERM_SEQ [1], EIS_CPT_TERM_SEQ [2]
EIS_CPT_UINTTOBYTES [1], EIS_CPT_UINTTOBYTES [2]
EIS_MULTIPLE_SEQUENCE_TABLES [1], EIS_MULTIPLE_SEQUENCE_TABLES [2]
CALLED BY:
EIS_CPT_PROCESS_STUDY [1], EIS_CPT_PROCESS_STUDY [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 261/10/04
Modified : Version 0.1, 26/01/05, MKC
Changed how sequences constructed
Version 0.2, 01/02/05, MKC
Changed study_index argument to seq_start and seq_end.
Added extra control for re-use of sequence tables.
Moved checksum and following study calculations.
Removed obstbl argument.
Added eis_cpt_obstbl.
Version 0.3, 02/03/05, MKC
Corrected bug in logic.
Added sequence position to eis cpt hex raster.
Corrected seq_start unset.
Version 0.4, 18/03/05, MKC
Moved eis cpt check study.
Version 0.5, 03/04/05, MKC
Added sequences argument.
Version 0.6, 10/05/05, MKC
Renamed from eis cpt process sequences for study.
Changed INDEX keyword to LINK keyword.
Fixed bug with loop back position.
Version 0.7, 05/07/05, MKC
Used eis cpt set raster id.
Implement only set slit/slot once per study and when changes.
Version 0.8, 21/07/05, MKC
Added sequence ID to obstbl map description.
Version 0.9, 12/09/05, MKC
Changed raster number/number of rasters to raster identifier.
Changed sense of LINK keyword so that refers to previous table rather than following table.
Changed so that uses an intermediate structure array of sequences.
Version 1.0, 19/07/06, MKC
Added first sequence in study flag.
Version : 1.0, 19/07/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_STUDIES
Purpose : Processes studies in time line.
Explanation : This routine processes the studies used in the science plan. producing the necessary entries into
the OBSTBL and ORL file.
Studies are either science or engineering studies.
Studies are processed individually and placed in the OBSTBL.
Each study is processed according to whether it is a science or engineering study.
The links between studies are resolved.
The time-tagged studies are added to the OP store.
Use : < result = eis_cpt_process_studies ( engineering_parameters, study_details, control_details,$
expiry_times, MSSL=mssl, INTEL=intel ) >
Inputs : engineering_parameters : STRCUTURE of type EIS_engineering_parameters.
study_details : STRUCTURE ARRAY of type EIS_study_detail.
control_details : STRUCTURE of type EIS_control_details.
expiry_times : DBLARR[nstudies] TAI time study can be safely overwritten.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : MSSL : INT Flag indicating should produce individual ASCII files for each sequence table
and line list table in MSSL command mnemonic form.
0 : no output
1 : outputs new tables
2 : outputs all tables
INTEL : INT Flag indicating should produce individual Intel hex files for each sequence table
and line list table.
0 : no output
1 : outputs new tables
2 : outputs all tables
Calls : ***
EIS_CPT_BYTESTOHEX [1], EIS_CPT_BYTESTOHEX [2]
EIS_CPT_CHECK_STUDIES_LIST [1], EIS_CPT_CHECK_STUDIES_LIST [2]
EIS_CPT_COMMAND_STORE [1], EIS_CPT_COMMAND_STORE [2], EIS_CPT_FIND_STUDY [1]
EIS_CPT_FIND_STUDY [2], EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2], EIS_CPT_PROCESS_CONTROL_TABLES [1]
EIS_CPT_PROCESS_CONTROL_TABLES [2], EIS_CPT_PROCESS_STUDY [1]
EIS_CPT_PROCESS_STUDY [2], EIS_CPT_RESPONSE_RASTER [1]
EIS_CPT_RESPONSE_RASTER [2], EIS_CPT_RESPONSE_STUDY [1]
EIS_CPT_RESPONSE_STUDY [2], EIS_CPT_SEQUENCE_LINK [1]
EIS_CPT_SEQUENCE_LINK [2], EIS_CPT_SEQUENCE_MATCH [1]
EIS_CPT_SEQUENCE_MATCH [2], EIS_CPT_SEQUENCE_PLACE [1]
EIS_CPT_SEQUENCE_PLACE [2], EIS_CPT_SEQUENCE_RESOLVE_LINKS [1]
EIS_CPT_SEQUENCE_RESOLVE_LINKS [2], EIS_CPT_UINTTOBYTES [1]
EIS_CPT_UINTTOBYTES [2], EIS_GET_STUDY [1], EIS_GET_STUDY [2]
CALLED BY:
EIS_CPT_PROCESS [1], EIS_CPT_PROCESS [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : Adapted from EIS CPT process.
Written : Martin Carter RAL 21/10/04
Modified : Version 0.0, 01/03/05
Version 0.1, 09/03/05, MKC
Added time-tagged studies to OP store.
Version 0.2, 18/03/05, MKC
Renamed eis get study details.
Renamed argument.
Version 0.3, 24/03/05, MKC
Used eis cpt command store.
Allowed studies to be run from GSE.
Renamed keywords.
Added INTEL keyword.
Version 0.4, 03/04/05, MKC
Added ACSII output of lines and sequences.
Version 0.5, 21/04/05, MKC
Allowed EIS_CPT to be called without a time period defined.
Version 0.6, 27/04/05, MKC
Removed ISACS keyword.
Version 0.7, 09/05/05, MKC
Removed Bakeout study processing.
Added in engineering file processing.
Changed to use eis cpt process study.
Version 0.8, 24/06/05, MKC
Added sequence_starts to the argument list.
Version 0.9, 27/06/05, MKC
Changed argument list.
Added eis cpt process control tables.
Version 1.0, 12/07/05, MKC
Added engineering parameters to eis cpt check studies list arguments.
Used eis cpt obstbl to output ASCII files.
Version 1.1, 19/09/05, MKC
Added reuse of sequences.
Added timeline processing.
Added expiry times argument.
Version 1.2, 19/06/06, MKC
Moved check on whether study details defined out of this routine.
Version 1.3, 08/09/06, MKC
Added comments.
Version 1.4, 03/10/06, MKC
Removed unnecessary ASCII file printout with /ALL.
Version : 1.4, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_STUDY
Purpose : Processes science or engineering study.
Explanation : Constructs the OBSTBL linelist tables and sequence tables for the science or engineering study.
The sequence tables are stored as an array of {EIS_CPT_sequence}.
The linelist tables are written directly to the OBSTBL.
Use : < result = eis_cpt_process_study ( engineering_parameters, study_detail, study, time_for_reuse, $
list_of_lines, sequences ) >
Inputs : engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
study_detail : STRUCTURE of type EIS_study_detail.
study : STRUCTURE ARRAY of type EIS_raster_detail or EIS_engineering_detail.
time_for_reuse : DOUBLE TAI time after which study can be overwritten.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
list_of_lines : INTARR() list of all linelist tables used.
sequences : STRUCTURE ARRAY of type EIS_CPT_sequences
Opt. Outputs: None.
Keywords : RESPONSE_RASTER : ULONG raster identifier indicating response study response raster
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_CHECK_STUDY [1]
EIS_CPT_CHECK_STUDY [2], EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [1]
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [2]
EIS_CPT_PROCESS_LINELISTS_FOR_STUDY [1]
EIS_CPT_PROCESS_LINELISTS_FOR_STUDY [2]
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [1]
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [2], EIS_CPT_STRTRIM [1]
EIS_CPT_STRTRIM [2]
CALLED BY:
EIS_CPT_PROCESS_RESPONSE_STUDIES [1], EIS_CPT_PROCESS_RESPONSE_STUDIES [2]
EIS_CPT_PROCESS_STUDIES [1], EIS_CPT_PROCESS_STUDIES [2]
EIS_CPT_PROCESS_TIMELINE_STUDIES [1], EIS_CPT_PROCESS_TIMELINE_STUDIES [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 26/10/04
Modified : Version 0.0, 26/10/04, MKC
Version 0.1, 21/01/05, MKC
Added sequence table output in ASCII text file format.
Version 0.2, 01/02/05, MKC
Changed study_index argument to seq_start and seq_end.
Removed obstbl and COMMON block.
Version 0.3, 24/03/05, MKC
Renamed keywords.
Added INTEL keyword.
Version 0.4, 02/04/05, MKC
Added linelists argument to eis cpt ascii linelists for study.
Added sequences and lines to argument list.
Removed ASCII output.
Version 0.5, 10/05/05, MKC
Renamed routine from eis cpt process science studies.
Renamed routine eis cpt process sequences for study.
Version 0.6, 12/09/05, MKC
Changed so that uses an intermediate structure array of sequences.
Added keyword RESPONSE_RASTER.
Added time for reuse to argument list.
Version 0.7, 13/06/06, MKC
Added error messages.
Version : 0.7, 13/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_SUSPENSION_PERIODS
Purpose : Processes suspension_periods.
Explanation : Processes suspension_periods.
Use : < result = eis_cpt_process_suspension_periods ( suspension_periods ) >
Inputs : suspension_periods : STRUCTURE ARRAY of type EIS_suspension_period.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_COMMAND_STORE [1], EIS_CPT_COMMAND_STORE [2]
CALLED BY:
EIS_CPT_PROCESS [1], EIS_CPT_PROCESS [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 26/10/04
Modified : Version 0.0, 26/10/04, MKC
Version 0.1, 09/03/05, MKC
Changed so that processes all suspension periods.
Version 0.2, 18/03/05, MKC
Renamed arguments
Added 'real' commands.
Version 0.3, 24/03/05, MKC
Used eis cpt command store.
Version 0.4, 19/06/06, MKC
Moved check on whether suspension_periods defined out of this routine.
Version : 0.4, 19/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_TIMELINE
Purpose : Processes timeline.
Explanation : Processes timeline.
Use : < result = eis_cpt_process_timeline ( engineering_parameters, study_details, control_details, $
end_time, timeline, expiry_times) >
Inputs : engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
study_details : STRUCTURE ARRAY of type EIS_study_detail.
control_details : STRUCTURE of type EIS_control_details.
time_period : DBLARR[2] TAI time to start and finish timeline.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
timeline : STRUCTURE ARRAY of type EIS_CPT_timeline updated
expiry_times : DBLARR[nstudies] TAI time study expires.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2], EIS_CPT_STRTRIM [1]
EIS_CPT_STRTRIM [2], EIS_CPT_TIMELINE [1], EIS_CPT_TIMELINE [2]
CALLED BY:
EIS_CPT_PROCESS [1], EIS_CPT_PROCESS [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 27/09/05
Modified : Version 0.0, 27/09/05, MKC
Version 0.1, 19/06/06, MKC
Moved check on whether study details defined out of this routine.
Version 0.2, 08/09/06, MKC
Add check of slit slot changes.
Include changes between studies and study repeats.
Version : 0.2, 08/09/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_TIMELINE_STUDIES
Purpose : Processes studies on the timeline.
Explanation : This routine processes the studies used for event response.
Studies are either science or engineering studies.
Use : < result = eis_cpt_process_timeline_studies ( engineering_parameters, study_details, $
expiry_times, list_of_lines, sequences) >
Inputs : engineering_parameters : STRCUTURE of type EIS_engineering_parameters.
study_details : STRUCTURE ARRAY of type EIS_study_detail.
expiry_times : DBLARR[nstudies] TAI time study expires.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
list_of_lines : INTARR() list of all linelist tables used.
sequences : STRUCTURE ARRAY of type EIS_CPT_sequences
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_CHECK_STUDIES_LIST [1], EIS_CPT_CHECK_STUDIES_LIST [2]
EIS_CPT_FIND_STUDY [1], EIS_CPT_FIND_STUDY [2], EIS_CPT_PROCESS_STUDY [1]
EIS_CPT_PROCESS_STUDY [2], EIS_GET_STUDY [1], EIS_GET_STUDY [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : Adapted from EIS CPT process.
Written : Martin Carter RAL 21/10/04
Modified : Version 0.0, 01/03/05
Version 0.1, 09/03/05, MKC
Added time-tagged studies to OP store.
Version 0.2, 18/03/05, MKC
Renamed eis get study details.
Renamed argument.
Version 0.3, 24/03/05, MKC
Used eis cpt command store.
Allowed studies to be run from GSE.
Renamed keywords.
Added INTEL keyword.
Version 0.4, 03/04/05, MKC
Added ACSII output of lines and sequences.
Version 0.5, 21/04/05, MKC
Allowed EIS_CPT to be called without a time period defined.
Version 0.6, 27/04/05, MKC
Removed ISACS keyword.
Version 0.7, 09/05/05, MKC
Removed Bakeout study processing.
Added in engineering file processing.
Changed to use eis cpt process study.
Version 0.8, 24/06/05, MKC
Added sequence_starts to the argument list.
Version 0.9, 27/06/05, MKC
Changed argument list.
Added eis cpt process control tables.
Version 1.0, 12/07/05, MKC
Added engineering parameters to eis cpt check studies list arguments.
Used eis cpt obstbl to output ASCII files.
Version 1.1, 19/09/05, MKC
Added reuse of sequences.
Added timeline processing.
Added expiry times argument.
Version 1.2, 19/06/06, MKC
Moved check on whether study details defined out of this routine.
Version 1.3, 08/09/06, MKC
Separated from eis cpt process studies.
Version : 1.3, 08/09/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_PROCESS_XRT_FLARE_TABLE
Purpose : Processes XRT flare table.
Explanation : Control tables are only processed if required by the current time-line..
Use : < result = eis_cpt_process_xrt_flare_table ( control, study_details, $
sequences, engineering_parameters) >
Inputs : control : STRUCTURE of type EIS_XRT_flare_control.
study_details : STRUCTURE ARRAY of type EIS_study_detail.
sequences : STRUCTURE ARRAY of type EIS_CPT_sequence.
engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2], EIS_CPT_SET_XRT_FLARE_TABLE [1]
EIS_CPT_SET_XRT_FLARE_TABLE [2], EIS_CPT_STUDY_TIME [1]
EIS_CPT_STUDY_TIME [2]
CALLED BY:
EIS_CPT_PROCESS_CONTROL_TABLES [1], EIS_CPT_PROCESS_CONTROL_TABLES [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 24/06/05
Modified : Version 0.0, 24/06/05, MKC
Version 0.1, 18/09/05, MKC
Changed PLACE keyword to SET in eis cpt obstbl.
Changed to use sequences argument.
Version 0.2, 04/10/05, MKC
Allowed re-use of control table.
Version 0.3, 16/06/06, MKC
Changed so that table index is undefined if no place found for table.
Changed tags study identifier and filler sequence identifier.
Hardcoded study identifiers for response studies.
Version : 0.3, 16/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_QUIET
Purpose : Checks if the QUIET flag is set.
Explanation : The QUIET flag is held in a COMMON block internal to this routine.
Use : < result = eis_cpt_quiet()>
Inputs : None.
Opt. Inputs : None.
Outputs : result : INT flag
0 : not set
1 : set
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2], EIS_CPT_PRELIMINARIES [1]
EIS_CPT_PRELIMINARIES [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 08/10/04
Modified : Version 0.0, 08/10/04, MKC
Version : Version 0.0, 08/10/04
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_raster_detail_default
Purpose : Generates default structure EIS_raster_detail.
Explanation : Sets up default values for structure EIS_raster_detail.
Use : < s = EIS_CPT_raster_detail_default(nwindows,xadd,node) >
Inputs : nwindows : INT no of data extraction windows.
xadd : INT parameter to modify data extaction windows.
node : UINT indicating readout node.
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_raster_detail.
Opt. Outputs: None.
Keywords : SPECIAL : FLAG indicating special window should be used.
AEC_TABLE: FLAG if AEC used for raster
XRT_FLARE: FLAG if XRT flare hunting used for raster.
EIS_FLARE: FLAG if EIS flare hunting used for raster.
EIS_EVENT: FLAG if EIS event hunting used for raster.
EXPOSURES: LONARR[] sets up exposure times in ms.
Calls : ***
EIS_CPT_STRTRIM [1], EIS_CPT_STRTRIM [2]
EIS_CPT_data_extraction_window_default [1]
EIS_CPT_data_extraction_window_default [2]
EIS_CPT_raster_detail_estimates [1], EIS_CPT_raster_detail_estimates [2]
CALLED BY:
EIS_CPT_STRUCTURE_DEFAULTS [1], EIS_CPT_STRUCTURE_DEFAULTS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 29/09/04
Modified : Version 0.1, 23/11/04, MKC
Added raster_description and linelist description tags.
Removed raster_title.
Added ASRC_skip.
Version 0.2, 28/02/05, MKC
Removed EIS XRT flare response, EIS flare response, EIS event response and AEC control structures
and replaced them with flags.
Removed flat_field tag and changed no. of exposures range.
Version 0.3, 02/04/05, MKC
Added variable no. of data extraction windows.
Modified data extraction window with xadd.
Version 0.4, 15/04/05, MKC
Modified default exposure times and no. of exposures.
Added SPECIAL keyword and changed special hardware window.
Version 0.5, 24/06/05, MKC
Changed INT values to UINT.
Removed coarse mirror position and insert flag tags.
Added event control flags.
Version 0.6, 29/06/05, MKC
Added node argument..
Version 0.7, 08/09/05, MKC
Added raster identifier.
Added exposures.
Added nmirror.
Changed fine mirror step to UINT.
Changed default fine mirror step to 1.
Version : 0.7, 08/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_raster_detail_estimates
Purpose : Generates simple duration and data volume estimates from structure EIS_raster_detail.
Explanation : In calculating the duration takes into account :
- the possible flat-field exposures before and after the series of raster repeats;
- the raster repeats;
- the number raster mirror positions;
- the total exposure time during each set of exposures at each mirror position.
In calculating the data volume takes into account :
- the possible flat-field exposures before and after the series of raster repeats;
- the raster repeats;
- the number raster mirror positions;
- the number of exposures at each mirror position;
- the sizes of the data extraction windows;
- assumes 2 bytes per pixel.
Use : < EIS_CPT_raster_detail_estimates, s >
Inputs : s : STRUCTURE of type EIS_raster_detail.
Opt. Inputs : None.
Outputs : Fills in duration and data tags.
Opt. Outputs: None.
Keywords : None,
Calls : None.
CALLED BY:
EIS_CPT_raster_detail_default [1], EIS_CPT_raster_detail_default [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 29/09/04
Modified : Version 0.0, 29/09/04, MKC
Version 0.1, 03/03/05, MKC
Removed flat-fields.
Version 0.2, 24/06/05, MKC
Changed INT values to UINT.
Version : 0.2, 24/06/05, MKC
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_READ_ASCII
Purpose : Reads STRARR from ASCII file.
Explanation :
Use : < res = eis_cpt_read_ascii(file,text) >
Inputs : file : STRING file name
Opt. Inputs : None.
Outputs : res : INT flag indicating result
1 : ok
0 : not ok
text : STRARR text data
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_CLOSE_FILE [1], EIS_CPT_CLOSE_FILE [2], EIS_CPT_OPEN_FILE [1]
EIS_CPT_OPEN_FILE [2], EIS_CPT_READ_TEXT [1], EIS_CPT_READ_TEXT [2]
CALLED BY:
EIS_CPT_JSIDE_COMMANDS [1], EIS_CPT_JSIDE_COMMANDS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/10/05
Modified : Version 0.0, 03/10/05, MKC
Version : Version 0.0, 03/10/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_READ_INTEL_HEX_FILE
Purpose : Reads Hex format file.
Explanation : If read fails then returns 0.
Expects data to be continuous in file.
Use : < res = eis_cpt_read_intel_hex_file(filename,start_address,header,ulba,data) >
Inputs : filename : STRING file name.
Opt. Inputs : None.
Outputs : res : INT FLAG indicating result
1 : ok
0 : not ok
start_address : UINT 16 least significant bits of start address
header : STRING OBSTBL header string.
ulba : UINT upper linear base address.
data : BYTARR[] OBSTBL data
Opt. Outputs: None.
Keywords : NOENDOFFILE : FLAG indicating should be no end of file record.
Calls : ***
EIS_CPT_CLOSE_FILE [1], EIS_CPT_CLOSE_FILE [2], EIS_CPT_MESSAGE [1]
EIS_CPT_MESSAGE [2], EIS_CPT_OPEN_FILE [1], EIS_CPT_OPEN_FILE [2]
EIS_CPT_PARSE_INTEL_HEX_FILE [1], EIS_CPT_PARSE_INTEL_HEX_FILE [2]
EIS_CPT_READ_UNFORMATTED_FILE [1], EIS_CPT_READ_UNFORMATTED_FILE [2]
CALLED BY:
EIS_CPT_OBSTBL_GET [1], EIS_CPT_OBSTBL_GET [2]
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [1]
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [2]
EIS_CPT_PROCESS_LINELISTS_FOR_STUDY [1]
EIS_CPT_PROCESS_LINELISTS_FOR_STUDY [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 15/10/04
Modified : Version 0.1, 01/11/04, MKC
Added HEADER keyword.
Version 0.2, 04/03/05, MKC
Changed so that returns data through arguments and an
error code through function call.
Changed calls to eis cpt read unformatted and eis cpt parse intel hex file.
Version 0.3, 29/04/05, MKC
Added start_address argument.
Version 0.4, 12/05/05, MKC
Changed file unit argumnet to file name argument.
Added NOENDOFFILE keyword.
Version 0.5, 17/09/06, MKC
Added errro message.
Version : 0.5, 17/09/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_READ_TEXT
Purpose : Reads STRARR from file specified by logical unit.
Explanation : Reads STRARR from file specified by logical unit.
Use : < res = eis_cpt_read_text(unit,text) >
Inputs : unit : LONG logical unit number
Opt. Inputs : None.
Outputs : res : INT flag indicating result
1 : ok
0 : not ok
text : STRARR text data
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_READ_ASCII [1], EIS_CPT_READ_ASCII [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/10/05
Modified : Version 0.0, 03/10/05, MKC
Version : Version 0.0, 03/10/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_READ_UNFORMATTED_FILE
Purpose : Reads an unformatted file into a byte array.
Explanation : If read fails then returns 0.
NB This routine does not work under VMS since VMS files contain a 2byte record-length descriptor.
NB This routine does not work with compressed files.
Use : < res = eis_cpt_read_unformatted_file(unit,data) >
Inputs : unit : LONG logical unit number for file.
Opt. Inputs : None.
Outputs : res : INT FLAG indicating result
1 : ok
0 : not ok
data : BYTARR[] data values.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_READ_INTEL_HEX_FILE [1], EIS_CPT_READ_INTEL_HEX_FILE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 15/10/04
Modified : Version 0.0, 15/10/04, MKC
Version 0.1, 04/03/05, MKC
Changed so that returns data through arguments and an
error code through function call.
Version : Version 0.1, 04/03/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_real_detail_default
Purpose : Generates default structure EIS_real_detail.
Explanation : Sets up default values for structure EIS_real_detail.
Use : < s = EIS_CPT_real_detail_default(study_filename) >
Inputs : study_filename : STRING filename of type 'description.real_ssss_bbbb'
where
description : is some text describing the purpose of the engineering study;
real : is the 4 character string 'real' indicating that the file is a real command study.
ssss : is the 4 digit duration in seconds;
bbbb : is the 4 digit number of Kbytes of data generated by the engineering study;
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_real_detail.
Opt. Outputs: None.
Keywords : None
Calls : ***
EIS_GET_REAL_DETAIL
CALLED BY:
EIS_CPT_STRUCTURE_DEFAULTS [1], EIS_CPT_STRUCTURE_DEFAULTS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 11/07/05
Modified :
Version : Version 0.0, 11/07/05, MKC
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_RESPONSE_RASTER
Purpose : Returns response raster ID for response study.
Explanation : Returns response raster ID for response study else 0.
Use : < raster_id = eis_cpt_response_raster ( control_details, study_identifier) >
Inputs : control_details : STRUCTURE of type EIS_control_details.
study_identifier : ULONG study identifier from planning tools.
Opt. Inputs : None.
Outputs : raster_id : ULONG raster identifier indicating response study response raster
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_PROCESS_STUDIES [1], EIS_CPT_PROCESS_STUDIES [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 21/09/05
Modified : Version 0.0, 21/09/05, MKC
Version 0.1, 19/06/06, MKC
Changed tag study identifier.
Version : 0.1, 19/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_RESPONSE_STUDY
Purpose : Returns response study ID.
Explanation : Returns response study ID.
Returns 0 if no response study.
Use : < study_id = eis_cpt_response_study ( control_details, study_identifier) >
Inputs : control_details : STRUCTURE of type EIS_control_details.
study_identifier : ULONG study identifier from planning tools.
Opt. Inputs : None.
Outputs : study_id : ULONG study identifier indicating response study
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_PROCESS_STUDIES [1], EIS_CPT_PROCESS_STUDIES [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 21/06/06
Modified : Version 0.0, 21/06/06, MKC
Version : 0.0, 21/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_RESPONSE_TIMELINE
Purpose : Gets timeline list of studies in event response.
Explanation : Gets timeline list of studies in event response.
Use : < result = eis_cpt_response_timeline ( study_details, time_period, hunter_index,
response_study_identifier, type, timeline) >
Inputs : study_details : STRUCTURE ARRAY of type EIS_study_detail.
time_period : DBLARR[2] TAI time to start and finish timeline.
hunter_index : LONG index into timeline of event hunter study
If no hunter study then -1.
response_study_identifier: LONG ID of response study
timeline : STRUCTURE ARRAY of type EIS_CPT_timeline. Updated.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
timeline : STRUCTURE ARRAY of type EIS_CPT_timeline updated
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_DAISY_CHAIN [1]
EIS_CPT_DAISY_CHAIN [2], EIS_CPT_STRTRIM [1], EIS_CPT_STRTRIM [2]
CALLED BY:
EIS_CPT_TIMELINE [1], EIS_CPT_TIMELINE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 23/09/05
Modified : Version 0.0, 23/09/05, MKC
Changed behaviour with respect to errors and warnings and daisy-chain loops.
Version 0.2, 22/06/06, MKC
Removed type argument.
Version : 0.2, 22/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_RUN_RASTER
Purpose : Sets up MSSL command.
Explanation : Sets up raster comand.
Uses no. of raster/raster number for raster ID.
Use : < bytes = eis_cpt_run_raster( engineering_parameters, raster_detail, raster_id, linelist ) >
Inputs : engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
raster_detail : STRUCTURE of type EIS_raster_detail.
raster_id : BYTARR[2] raster ID
linelist : INT linelist table index.
Opt. Inputs : None.
Outputs : bytes : BYTARR[22] command.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_UINTTOBYTES [1], EIS_CPT_UINTTOBYTES [2]
CALLED BY:
EIS_CPT_HEX_RASTER [1], EIS_CPT_HEX_RASTER [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 26/11/04
Modified : Version 0.0, 26/11/04, MKC
Version 0.1, 02/03/05, MKC
Changed event response tags in raster to control flags.
Version 0.2, 11/04/05, MKC
Corrected bits used for R/O nodes and science operations control.
Reversed order of readout nodes.
Added normal or special readout sequence ID.
Version 0.3, 15/04/05, MKC
Changed format of !EIS_CPT_COMMANDS.
Version, 0.2, 27/04/05, MKC
Removed !EIS_CPT_COMMANDS. Put in command directly.
Version, 0.3, 04/07/05, MKC
Corrected Raster ID.
Changed raster_number and number of rasters arguments to raster_id.
Version : Version 0.2, 27/04/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_sequence__define
Purpose : Generates structure EIS_CPT_sequence
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case filename.
Tags are :
study_identifier : ULONG 'unique' study identifier provided by the planning tools
study_repeat_number : UINT number of times to repeat the study (1-255).
linked_study_identifier : ULONG daisy-chained study identifier, 0 if no daisy-chained study.
nrepeats : UINT number of times study repeated
description : STRING study description
first : INT flag indicating that sequence is the first in the study
last : INT flag indicating that sequence is the last in the study
link : INT index of daisy-chained sequence in sequences, -1 if no daisy-chained sequence.
NB 0 is a valid index.
time : DOUBLE TAI time used on timeline
exact : INT flag indicating exact match exists.
index : INT OBSTBL table index
bytes : BYTARR[128] sequence bytes
Use : <dummy = {EIS_CPT_sequence}>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 16/09/05
Modified : Version 0.0, 16/09/05, MKC
Version 0.1, 19/07/06, MKC
Added first tag.
Version : 0.1, 19/07/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_SEQUENCE_LINK
Purpose : Links sequences together converting study identifier link to sequence index.
Explanation : Links sequences together converting study identifier link id to sequence index.
Returns link with :
link = -1 if sequence terminated
link = 0-nsequences-1
Use : < result = eis_cpt_sequence_link( sequences ) >
Inputs : sequences : STRUCTURE ARRAY of type EIS_CPT_sequence.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
sequences : STRUCTURE ARRAY updates .link tag.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_PROCESS_STUDIES [1], EIS_CPT_PROCESS_STUDIES [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 17/09/05
Modified : Version 0.0, 17/09/05, MKC
Version 0.1, 19/07/06, MKC
Changed check on no. of linked sequences to = 1
Version 0.2, 15/09/06, MKC
Rearranged logic.
Corrected bug with daisy-chained studies spanning more than one sequence table.
Version : 0.2, 15/09/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_SEQUENCE_MATCH
Purpose : Finds if sequence tables already loaded into OBSTBL.
Explanation : This routine locates the sequence tables forming each study if they are already in OBSTBL.
NB There is a limitation of the approach taken which occurs if the same study
is used at the start of different daisy-chains. A repeat of one of the daisy-chains may not
find the existing studies loaded since the first occurrance is taken.
Use : < result = eis_cpt_sequence_match( sequences ) >
Inputs : sequences : STRUCTURE ARRAY of type EIS_CPT_sequence.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
sequences : STRUCTURE ARRAY updates .exact tag.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2], EIS_CPT_UNDEFINE [1]
EIS_CPT_UNDEFINE [2]
CALLED BY:
EIS_CPT_PROCESS_STUDIES [1], EIS_CPT_PROCESS_STUDIES [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 17/09/05
Modified : Version 0.0, 17/09/05, MKC
Version 0.1, 05/10/05, MKC
Allowed for obscure case where exact match found lower down in a daisy-chain
but for a different table_index.
Changed so that table_index = -1 if no placement found.
Version 0.2, 16/06/06, MKC
Changed so that table index is undefined if no place found for table.
Version : 0.2, 16/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_SEQUENCE_PLACE
Purpose : Places sequence tables into OBSTBL.
Explanation : This routine puts the sequence tables forming each study into the OBSTBL.
The optimum location for each table is determined.
OBSTBL and OBSTBL_MAP are updated.
The mandatory control sequence is completed outside of this routine.
Use : < result = eis_cpt_sequence_place( sequences ) >
Inputs : sequences : STRUCTURE ARRAY of type EIS_CPT_sequence.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2], EIS_CPT_UNDEFINE [1]
EIS_CPT_UNDEFINE [2]
CALLED BY:
EIS_CPT_PROCESS_STUDIES [1], EIS_CPT_PROCESS_STUDIES [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 261/10/04
Modified : Version 0.1, 26/01/05, MKC
Changed how sequences constructed
Version 0.2, 01/02/05, MKC
Changed study_index argument to seq_start and seq_end.
Added extra control for re-use of sequence tables.
Moved checksum and following study calculations.
Removed obstbl argument.
Added eis cpt obstbl.
Version 0.3, 02/03/05, MKC
Corrected bug in logic.
Added sequence position to eis cpt hex raster.
Corrected seq_start unset.
Version 0.4, 18/03/05, MKC
Moved eis cpt check study.
Version 0.5, 03/04/05, MKC
Added sequences argument.
Version 0.6, 10/05/05, MKC
Renamed from eis cpt process sequences for study.
Changed INDEX keyword to LINK keyword.
Fixed bug with loop back position.
Version 0.7, 05/07/05, MKC
Used eis cpt set raster id.
Implement only set slit/slot once per study and when changes.
Version 0.8, 21/07/05, MKC
Added sequence ID to obstbl map description.
Version 0.9, 12/09/05, MKC
Changed raster number/number of rasters to raster identifier.
Changed sense of LINK keyword so that refers to previous table rather than following table.
Changed so that uses an intermediate structure array of sequences.
Removed sequence starts, sequence ends list of sequenes arguments.
Version 1.0, 14/07/06, MKC
Writes sequence table even if exact match..
Version : 1.0, 14/07/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_SEQUENCE_RESOLVE_LINKS
Purpose : Resolves links betwwen studies and terminates studies.
Explanation : Studies can be time-tagged, daisy-chained or free-standing (neither daisy-
chained nor time-tagged).
The daisy-chain link references the sequence table index of the start of the next study.
This routine adds the appropriate link command to the last sequence table for each study
and calculates the checksum. Where the study terminates without a link, the appropriate
sequence table index is added.
This applies to science or engineering studies.
Use : < result = eis_cpt_sequence_resolve_links(sequences) >
Inputs : sequences : STRUCTURE ARRAY of type EIS_CPT_sequence.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2]
CALLED BY:
EIS_CPT_PROCESS_STUDIES [1], EIS_CPT_PROCESS_STUDIES [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 25/11/04
Modified : Version 0.0, 25/11/04, MKC
Version 0.1, 03/03/05, MKC
Corrected logic.
Version 0.2, 12/05/05, MKC
Changed to use LINK keyword.
Version 0.3, 16/09/05, MKC
Changed sense of LINK keyword so that refers to previous table rather than following table.
Renamed from eis cpt resolve study links.
Changed arguments.
Resolved links even for sequences within a study.
Version 0.4, 20/07/06, MKC
Resolve links even if exact match.
Added terminate, first and last tags.
Version : 0.4, 20/07/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_SET_AEC_TABLE
Purpose : Sets up AEC table parameters.
Explanation : Sets up AEC table parameters.
Use : < table = eis_cpt_set_AEC_table ( control) >
Inputs : control : STRUCTURE of type EIS_AEC_control
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
table : BYTARR[16] AEC table
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_UINTTOBYTES [1], EIS_CPT_UINTTOBYTES [2], EIS_CPT_ULONGTOBYTES [1]
EIS_CPT_ULONGTOBYTES [2]
CALLED BY:
EIS_CPT_PROCESS_AEC_TABLE [1], EIS_CPT_PROCESS_AEC_TABLE [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 24/06/05
Modified : Version 0.0, 24/06/05, MKC
Version : Version 0.0, 24/06/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_SET_EIS_EVENT_TABLE
Purpose : Sets up EIS event table parameters.
Explanation :
Use : < table = eis_cpt_set_EIS_event_table ( control, engineering_parameters, response_index) >
Inputs : control : STRUCTURE of type EIS_flare_control
engineering_parameters : STRUCTURE of type EIS_engineering_parameters
response_index : INT index of sequence table start for event response study
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
table : BYTARR[20] EIS event table
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_SET_RASTER_ID [1], EIS_CPT_SET_RASTER_ID [2]
EIS_CPT_ULONGTOBYTES [1], EIS_CPT_ULONGTOBYTES [2]
CALLED BY:
EIS_CPT_PROCESS_EIS_EVENT_TABLE [1], EIS_CPT_PROCESS_EIS_EVENT_TABLE [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 24/06/05
Modified : Version 0.0, 24/06/05, MKC
Version 0.1, 05/07/05, MKC
Corrected raster_id.
Version 0.2, 08/09/05, MKC
Changed raster number/ number of rasters tag to raster identifier.
Version : 0.2, 08/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_SET_EIS_FLARE_TABLE
Purpose : Sets up EIS flare table parameters.
Explanation :
Use : < table = eis_cpt_set_EIS_flare_table ( control, engineering_parameters, response_index) >
Inputs : control : STRUCTURE of type EIS_flare_control
engineering_parameters : STRUCTURE of type EIS_engineering_parameters
response_index : INT index of sequence table start for event response study
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
table : BYTARR[24] EIS flare table
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_SET_RASTER_ID [1], EIS_CPT_SET_RASTER_ID [2]
EIS_CPT_ULONGTOBYTES [1], EIS_CPT_ULONGTOBYTES [2]
CALLED BY:
EIS_CPT_PROCESS_EIS_FLARE_TABLE [1], EIS_CPT_PROCESS_EIS_FLARE_TABLE [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 24/06/05
Modified : Version 0.0, 24/06/05, MKC
Version 0.1, 05/07/05, MKC
Corrected raster_id.
Version 0.2, 08/09/05, MKC
Changed raster number/ number of rasters tag to raster identifier.
Version : 0.2, 08/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_SET_LINELIST
Purpose : Sets up linelist entry.
Explanation : Sets up linelist entry.
Use : < result = eis_cpt_set_linelist ( engineering_parameters, raster_details ) >
Inputs : engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
raster_detail : STRUCTURE of type EIS_raster_detail.
Opt. Inputs : None.
Outputs : linelist : BYTARR[linelist length] linelist entry
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_CHECKSUM [1], EIS_CPT_CHECKSUM [2], EIS_CPT_HARDWARE_WINDOW [1]
EIS_CPT_HARDWARE_WINDOW [2], EIS_CPT_UINTTOBYTES [1]
EIS_CPT_UINTTOBYTES [2], EIS_CPT_WINDOW_ENTRY [1], EIS_CPT_WINDOW_ENTRY [2]
CALLED BY:
EIS_CPT_PROCESS_LINELISTS_FOR_STUDY [1]
EIS_CPT_PROCESS_LINELISTS_FOR_STUDY [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 9/11/04
Modified : Version 0.1, 15/11/04, MKC
Corrected bugs.
Version 0.2, 13/04/05, MKC
Moved reordering of hardware window.
Version 0.3, 26/04/05, MKC
Corrected linelist format.
Version : Version 0.3, 26/04/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_SET_RASTER_ID
Purpose : Sets up raster ID.
Explanation : Uses the last 16 bits of the raster indentifier.
Use : < raster_id = eis_cpt_set_raster_id (raster_identifier) >
Inputs : raster_identifier : ULONG planning tool raster ID.
Opt. Inputs : None.
Outputs : raster_id : BYTARR[2] raster ID
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [1]
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [2], EIS_CPT_SET_EIS_EVENT_TABLE [1]
EIS_CPT_SET_EIS_EVENT_TABLE [2], EIS_CPT_SET_EIS_FLARE_TABLE [1]
EIS_CPT_SET_EIS_FLARE_TABLE [2], EIS_CPT_SET_XRT_FLARE_TABLE [1]
EIS_CPT_SET_XRT_FLARE_TABLE [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 05/07/05
Modified : Version 0.0, 05/07/05, MKC
Version 0.1, 08/09/05, MKC
Changed raster number/ number of rasters tag to raster identifier.
Version : 0.1, 08/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_SET_XRT_FLARE_TABLE
Purpose : Sets up XRT flare table parameters.
Explanation :
Use : < table = eis_cpt_set_XRT_flare_table ( control, engineering_parameters, response_index, filler_index) >
Inputs : control : STRUCTURE of type EIS_XRT_flare_control
engineering_parameters : STRUCTURE of type EIS_engineering_parameters
response_index : INT index of sequence table start for event response study
filler_index : INT index of sequence table start for filler study
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
table : BYTARR[20] XRT flare table
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_SET_RASTER_ID [1], EIS_CPT_SET_RASTER_ID [2]
EIS_CPT_UINTTOBYTES [1], EIS_CPT_UINTTOBYTES [2], EIS_CPT_ULONGTOBYTES [1]
EIS_CPT_ULONGTOBYTES [2]
CALLED BY:
EIS_CPT_PROCESS_XRT_FLARE_TABLE [1], EIS_CPT_PROCESS_XRT_FLARE_TABLE [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 24/06/05
Modified : Version 0.0, 24/06/05, MKC
Version 0.1, 05/07/05, MKC
Corrected raster_id.
Version 0.2, 08/09/05, MKC
Changed raster number/ number of rasters tag to raster identifier.
Version 0.3, 19/06/06, MKC
Changed tag filelr sequence identifier.
Version : 0.3, 19/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_SETUP_CONSTANTS
Purpose : Sets up EIS CPT constants.
Explanation : These constants are defined externally to EIS_CPT.
Use : < eis_cpt_setup_constants >
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up !EIS_CPT_CONSTANTS
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_PRELIMINARIES [1], EIS_CPT_PRELIMINARIES [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 06/12/04
Modified : Version 0.0, 06/12/04, MKC
Version 0.1, 02/03/05, MKC
Added loop-back command.
Added OBSTBL indexes.
Version, 0.2, 09/03/05, MKC
Removed coarse mirror command.
Version, 0.3, 02/04/05, MKC
Added OBSTBl table sizes..
Version, 0.4, 12/04/05, MKC
Added c_set_window command.
Add coarse mirror command.
Version, 0.5, 15/04/05, MKC
Changed format of !EIS_CPT_COMMANDS.
Version, 0.6, 27/04/05, MKC
Removed !EIS_CPT_COMMANDS. Put in command directly.
Added addresses.
Version : Version 0.6, 27/04/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_SIB
Purpose : Constructs and checks SIB command.
Explanation : Constructs and checks SIB command.
Use : < sibcmd = eis_cpt_sib(command, arguments) >
Inputs : command : STRING SIB command mnemonic
Opt. Inputs : arguments : BYTARR[] optional arguments
Outputs : sibcmd : STRING SIB command
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_environment [1], EIS_CPT_environment [2]
READ_EIS_CMD_FROM_SLBSIB [1], READ_EIS_CMD_FROM_SLBSIB [2]
CALLED BY:
EIS_CPT_JSIDE_COMMANDS [1], EIS_CPT_JSIDE_COMMANDS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 12/09/05
Modified : Version 0.1, 06/06/06, MKC
Used eis cpt environment instead of environment variable.
Version : 0.1, 06/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_SLIT_SLOT_AUTO
Purpose : Sets up MSSL command.
Explanation : Sets the slit/slot position includes direction of rotation to get to the position.
Use : < bytes = eis_cpt_slit_slot_auto( pos, direction ) >
Inputs : pos : UINT slit/slot position
direction : INT direction to move slit/slot
-1 : backwards
1 : forwards
Opt. Inputs : None.
Outputs : bytes : BYTARR[9] command.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_UINTTOBYTES [1], EIS_CPT_UINTTOBYTES [2]
CALLED BY:
EIS_CPT_HEX_RASTER [1], EIS_CPT_HEX_RASTER [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 06/12/04
Modified : Version, 0.0, 06/12/04, MKC
Version, 0.1, 15/04/05, MKC
Changed format of !EIS_CPT_COMMANDS.
Version, 0.2, 27/04/05, MKC
Removed !EIS_CPT_COMMANDS. Put in command directly.
Version : Version 0.2, 27/04/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_START_EXP
Purpose : Sets up MSSL start exposure command.
Explanation : Sets up MSSL start exposure command.
Use : < bytes = eis_cpt_start_exp( exposure_time ) >
Inputs : exposure_time : UINT range is 1-65535 in units of 10 ms.
Opt. Inputs : None.
Outputs : bytes : BYTARR[3] command.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_UINTTOBYTES [1], EIS_CPT_UINTTOBYTES [2]
CALLED BY:
EIS_CPT_HEX_RASTER [1], EIS_CPT_HEX_RASTER [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 17/12/04
Modified : Version 0.0, 17/12/044, MKC
Version, 0.1, 15/04/05, MKC
Changed format of !EIS_CPT_COMMANDS.
Version, 0.2, 27/04/05, MKC
Removed !EIS_CPT_COMMANDS. Put in command directly.
Version : Version 0.2, 27/04/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_STRTRIM
Purpose : Converts to trimmed string.
Explanation : Converts parameter to string and trims off any leading or trailing blanks.
Use : < str = eis_cpt_strtrim(value) >
Inputs : value : ANY
Opt. Inputs : None.
Outputs : str : STRING.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_CHECK_STUDY [1], EIS_CPT_CHECK_STUDY [2], EIS_CPT_CHECK_TABLE [1]
EIS_CPT_CHECK_TABLE [2], EIS_CPT_CLOSE_FILE [1], EIS_CPT_CLOSE_FILE [2]
EIS_CPT_DATARATE_OUTPUT [1], EIS_CPT_DATARATE_OUTPUT [2]
EIS_CPT_DECODE_AEC_EXPOSURE_TABLE [1]
EIS_CPT_DECODE_AEC_EXPOSURE_TABLE [2], EIS_CPT_DECODE_AEC_TABLE [1]
EIS_CPT_DECODE_AEC_TABLE [2], EIS_CPT_DECODE_EIS_EVENT_TABLE [1]
EIS_CPT_DECODE_EIS_EVENT_TABLE [2], EIS_CPT_DECODE_EIS_FLARE_TABLE [1]
EIS_CPT_DECODE_EIS_FLARE_TABLE [2], EIS_CPT_DECODE_LINELIST_TABLE [1]
EIS_CPT_DECODE_LINELIST_TABLE [2], EIS_CPT_DECODE_SEQUENCE_TABLE [1]
EIS_CPT_DECODE_SEQUENCE_TABLE [2], EIS_CPT_DECODE_XRT_FLARE_TABLE [1]
EIS_CPT_DECODE_XRT_FLARE_TABLE [2], EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2]
EIS_CPT_OBSTBL_INDEX [1], EIS_CPT_OBSTBL_INDEX [2]
EIS_CPT_PARSE_INTEL_HEX_FILE [1], EIS_CPT_PARSE_INTEL_HEX_FILE [2]
EIS_CPT_PROCESS_STUDY [1], EIS_CPT_PROCESS_STUDY [2]
EIS_CPT_PROCESS_TIMELINE [1], EIS_CPT_PROCESS_TIMELINE [2]
EIS_CPT_RESPONSE_TIMELINE [1], EIS_CPT_RESPONSE_TIMELINE [2]
EIS_CPT_TIMELINE_ITEM_OUTPUT [1], EIS_CPT_TIMELINE_ITEM_OUTPUT [2]
EIS_CPT_raster_detail_default [1], EIS_CPT_raster_detail_default [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 25/10/04
Modified : Version 0.0, 25/10/04, MKC
Version 0.1, 11/03/05, MKC
Corrected bug.
Version : Version 0.1, 11/03/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_STRUCTURE_DEFAULTS
Purpose : Generates defaults for structures used within EIS_CPT.
Explanation : Structures defaults generated for are :
EIS_study_detail.
EIS_mechanism_change.
EIS_raster_detail.
EIS_flat_field_detail.
EIS_data_extraction_window.
EIS_control_detail.
EIS_XRT_flare_control.
EIS_flare_control.
EIS_event_control.
EIS_AEC_control.
EIS_engineering_detail.
EIS_mechanism_change.
EIS_real_detail.
EIS_list_real_detail.
EIS_engineering_parameters.
EIS_CAM_readout.
EIS_XRT_flare_parameters.
EIS_flare_parameters.
EIS_mechanism_control.
EIS_bakeout_parameters.
EIS_suspend_period.
EIS_abort.
EIS_bakeout_period.
EIS_contact_period.
EIS_coarse_mirror_command.
EIS_upload.
Use : <eis_cpt_structure_defaults>
Inputs : None.
Opt. Inputs : None.
Outputs : study_detail : STRUCTURE of type EIS_study_detail.
raster_detail : STRUCTURE of type EIS_raster_detail.
control_detail : STRUCTURE of type EIS_control_detail.
engineering_detail : STRUCTURE of type EIS_engineering_detail.
engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
suspend_period : STRUCTURE of type EIS_suspend_period.
bakeout_period : STRUCTURE of type EIS_bakeout_period.
contact_period : STRUCTURE of type EIS_contact_period.
coarse_mirror_command : STRUCTURE of type EIS_coarse_mirror_command.
upload : STRUCTURE of type EIS_upload.
Opt. Outputs: None.
Keywords : None,
Calls : ***
EIS_CPT_abort_default [1], EIS_CPT_abort_default [2]
EIS_CPT_bakeout_period_default [1], EIS_CPT_bakeout_period_default [2]
EIS_CPT_coarse_mirror_command_default [1]
EIS_CPT_coarse_mirror_command_default [2]
EIS_CPT_control_details_default [1], EIS_CPT_control_details_default [2]
EIS_CPT_engineering_detail_default [1]
EIS_CPT_engineering_detail_default [2]
EIS_CPT_engineering_parameters_default [1]
EIS_CPT_engineering_parameters_default [2]
EIS_CPT_list_real_detail_default [1], EIS_CPT_list_real_detail_default [2]
EIS_CPT_raster_detail_default [1], EIS_CPT_raster_detail_default [2]
EIS_CPT_real_detail_default [1], EIS_CPT_real_detail_default [2]
EIS_CPT_study_detail_default [1], EIS_CPT_study_detail_default [2]
EIS_CPT_suspend_period_default [1], EIS_CPT_suspend_period_default [2]
EIS_CPT_upload_default [1], EIS_CPT_upload_default [2]
CALLED BY:
EIS_CPT_TEST [1], EIS_CPT_TEST [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/09/04
Modified : Version 0.0, 22/09/04, MKC
Version 0.1, 17/01/05, MKC
Added coarse mirror command structure.
Added EIS_mechanism_change in description.
Version 0.2, 28/02/05, MKC
Renamed response structures to parameters structures.
Added EIS_control_details structure.
Version 0.3, 21/03/05, MKC
Added time arguments to some of the routines.
Added study id argument to eis study detail default.
Added onboard and duration argument to eis suspend period default.
Added onboard argument to eis coarse mirror command default.
Added onboard argument to eis study details default.
Version 0.4, 02/04/05, MKC
Added variable no. of data extraction windows to eis raster detail default
and xadd.
Version 0.5, 09/05/05, MKC
Added time_tagged variable to eis study detail default.
Added file and linelist to EIS engineering detail default.
Version 0.6, 25/06/05, MKC
Added study_id and adjust_y flag to eis cpt control default.
Version 0.7, 29/06/05, MKC
Added node to eis engineering parameters default and eis raster detail default.
Version 0.8, 12/07/05, MKC
Added eis_real_detail structure.
Version 0.9, 20/07/05, MKC
Modified eis_real_detail structure.
Added eis_list_real_detail structure.
Version 1.0, 22/09/05, MKC
Added EIS_bakeout_period and EIS_contact_period.
Added nrepeats to study_details.
Version 1.1, 14/06/06, MKC
Added EIS_upload.
Version 1.2, 20/08/06, MKC
Added version to eis upload defaults arguments.
Version 1.3, 26/09/06, MKC
Added filename argument to eis cpt list real detail default.
Version 1.4, 03/10/06, MKC
Changed upload structure.
Removed eis contact period structure.
Added abort structure.
Added indexes argument to eis cpt engineering detail default.
Version : 1.4, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_STRUCTURES
Purpose : Generates structures used within EIS_CPT.
Explanation : Structures generated (and their sub-structures) are :
EIS_upload.
EIS_study_detail.
EIS_mechanism_change.
EIS_raster_detail.
EIS_flat_field_detail.
EIS_data_extraction_window.
EIS_control_details.
EIS_XRT_flare_control.
EIS_flare_control.
EIS_event_control.
EIS_AEC_control.
EIS_engineering_detail.
EIS_mechanism_change.
EIS_real_detail.
EIS_list_real_detail.
EIS_engineering_parameters.
EIS_CAM_readout.
EIS_XRT_flare_parameters.
EIS_flare_parameters.
EIS_mechanism_control.
EIS_bakeout_parameters.
EIS_suspend_period.
EIS_abort.
EIS_coarse_mirror_command.
EIS_bakeout_period.
Use : <eis_cpt_structures>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definitions.
Opt. Outputs: None.
Keywords : None,
Calls : None.
CALLED BY:
EIS_CPT_TEST [1], EIS_CPT_TEST [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.1, 22/09/04, MKC
Removed EIS_bakeout_detail structure.
Version 0.2, 30/09/04, MKC
Included structure hierarchy and removed unnecessary calls.
Version 0.3, 17/01/05, MKC
Added coarse mirror command structure.
Added EIS_mechanism_change in description.
Version 0.4, 28/02/05, MKC
Renamed response structures to parameters structures.
Added EIS control_detail structure.
Version 0.5, 12/07/05, MKC
Added eis_real_detail structure.
Version 0.6, 20/07/05, MKC
Modified eis_real_detail structure.
Added eis_list_real_detail structure.
Version 0.7, 22/09/05, MKC
Added EIS_bakeout_period and EIS_contact_period.
Version 0.8, 14/06/06, MKC
Added EIS_upload.
Version 0.9, 03/10/06, MKC
Removed eis contact period structure.
Added abort structure.
Version : 0.9, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_study_detail_default
Purpose : Generates default structure EIS_study_detail.
Explanation : Sets up default values for structure EIS_study_detail.
Use : < s = EIS_CPT_study_detail_default(study_id, study_time, onboard, time_tag, nrepeats) >
Inputs : study_id : LONG study identifier (in testing indexes raster array)
study_time : DOUBLE TAI start time or period.
onboard : INT FLAG :
0 : run from ORL file
1 : run from OP
time_tag : INT FLAG indicating if study time-tagged.
nrepeats : INT number of study repeats.
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_study_detail.
Opt. Outputs: None.
Keywords : LINK : FLAG indicating if study linked to previous study.
ENGINEERING : FLAG indicating study is an engineering study
Calls : ***
EIS_CPT_mechanism_change_default [1], EIS_CPT_mechanism_change_default [2]
CALLED BY:
EIS_CPT_LIST_STUDY_DETAILS [1], EIS_CPT_LIST_STUDY_DETAILS [2]
EIS_CPT_STRUCTURE_DEFAULTS [1], EIS_CPT_STRUCTURE_DEFAULTS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 29/09/04
Modified : Version 0.1, 16/11/04, MKC
Added description tag.
Version 0.2, 22/11/04
Changed time of study.
Version 0.3, 24/11/04
Changed duration and data volume estimates.
Version 0.4, 09/12/04, MKC
Added slit_slot and coarse_mirror tags.
Version 0.5, 17/01/05, MKC
Removed coarse_mirror tag.
Version 0.6, 01/03/05, MKC
Add engineering study tag.
Version 0.7, 19/03/05, MKC
Changed start time to dummy value..
Version 0.8, 21/03/05, MKC
Added study_time to argument list and changed default times.
Added study identifier argument.
Added onboard tag and argument.
Version 0.9, 09/05/05, MKC
Added time_tag to argument list.
Added LINK and ENGINEERING keywords.
Version 1.0, 23/06/05, MKC
Added event flags to structure.
Changed INT values to UINT.
Version 1.1, 27/09/05, MKC
Added nrepeats.
Version : 1.1, 27/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_study_detail_estimates
Purpose : Generates simple duration and data volume estimates from structure array EIS_raster_detail.
Explanation : Simply sums the durations and data volumes of the individual rasters and sets up the tags in the
study detail structure. Sets up event flags.
Use : < EIS_CPT_study_detail_estimates, study_detail, study >
Inputs : study_detail : STRUCTURE of type EIS_study_detail.
study : STRUCTURE ARRAY of type EIS_raster_detail.
Opt. Inputs : None.
Outputs : Fills in duration and data tags.
Opt. Outputs: None.
Keywords : None,
Calls : None.
CALLED BY:
EIS_CPT_LIST_STUDY_DETAILS [1], EIS_CPT_LIST_STUDY_DETAILS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 24/11/04
Modified : Version 0.0, 24/11/04, MKC
Version 0.1, 18/03/05, MKC
Renamed arguments
Version 0.2, 23/06/05, MKC
Added event flags.
Changed INT values to UINT.
Version 0.3, 20/07/05, MKC
Added slit slot details.
Version : 0.3, 20/07/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_STUDY_TIME
Purpose : Gives time after which tables forming study can be re-used.
Explanation : Allows margin of error.
Use : < study_time = eis_cpt_study_time(study_detail, safety_margin >
Inputs : study_detail : STRUCTURE of type EIS_study_detail.
safety_time : DOUBLE time in seconds.
Opt. Inputs : None.
Outputs : study_time : DOUBLE TAI time table scan be re-used.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_PROCESS_AEC_TABLE [1], EIS_CPT_PROCESS_AEC_TABLE [2]
EIS_CPT_PROCESS_EIS_EVENT_TABLE [1], EIS_CPT_PROCESS_EIS_EVENT_TABLE [2]
EIS_CPT_PROCESS_EIS_FLARE_TABLE [1], EIS_CPT_PROCESS_EIS_FLARE_TABLE [2]
EIS_CPT_PROCESS_XRT_FLARE_TABLE [1], EIS_CPT_PROCESS_XRT_FLARE_TABLE [2]
Common : None.
Restrictions: None.
Side effects: Loses any extra dimensions of input array.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/02/05
Modified : Version 0.0, 03/02/05, MKC
Version : Version 0.0, 03/02/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_suspend_period_default
Purpose : Generates default structure EIS_suspend_period.
Explanation : Sets up default values for structure EIS_suspend_period.
Use : < s = EIS_CPT_suspend_period_default(start_time, duration, onboard) >
Inputs : start_time : DOUBLE TAI start time or period.
duration : DOUBLE duration in seconds
onboard : INT FLAG
0 : put in REAL file
1 : put in OP
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_suspend_period.
Opt. Outputs: None.
Keywords : None,
Calls : None.
CALLED BY:
EIS_CPT_LIST_SUSPENSION_PERIODS [1], EIS_CPT_LIST_SUSPENSION_PERIODS [2]
EIS_CPT_STRUCTURE_DEFAULTS [1], EIS_CPT_STRUCTURE_DEFAULTS [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 29/09/04
Modified : Version 0.0, 29/09/04
Version 0.1, 10/03/05, MKC
Added description tag.
Version 0.2, 21/03/05, MKC
Added start_time to argument list and changed default times.
Added onboard tag.
Added duration argument.
Version 0.3, 24/06/05, MKC
Changed INT values to UINT.
Version : 0.3, 24/06/05, MKC
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_TABLE_DIFFERENCE
Purpose : Calculates difference measure between two tables.
Explanation : Uses measure of how many commands table difference swould take to upload.
Use : < difference = eis_cpt_table_difference (table0, table1) >
Inputs : table0 : BYTARR[n] table data
table1 : BYTARR[n] table data
Opt. Inputs : None.
Outputs : difference : INT difference.
Opt. Outputs: None.
Keywords : None.
Calls : ***
LAST_ITEM, UNIQ [1], UNIQ [2], UNIQ [3]
CALLED BY:
EIS_CPT_OBSTBL [1], EIS_CPT_OBSTBL [2], EIS_CPT_TABLE_SEARCH [1]
EIS_CPT_TABLE_SEARCH [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 16/09/05
Modified : Version 0.0, 16/09/05, MKC
Version 0.1, 23/09/06, MKC
Changed difference measure from simple count of no of byte differences.
Version : 0.1, 23/09/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_TABLE_PLACE
Purpose : Finds best place to put a table in OBSTBL.
Explanation : Goes through all of the available locations in OBSTBL using the
minimum number of byte differences with the table to be placed as the criterion
for determining the best place to put it.
For sequence tables, it is difficult to determine the TERM_SEQ or CALL_SEQ argument
before the table indexes are known. This argument and the checksum are omitted from
the byte difference comparison. This means that exact matches cannot be verified
for sequence tables.
Ensures that uses used table in preference to unused table if looking for exact match.
If table index defined on entry then checks whether that table gives an exact match.
Use : < result = eis_cpt_table_place (obstbl, indexes, used, table, table_index, SEQUENCE=sequence) >
Inputs : obstbl : BYTARR[] OBSTBL data
indexes : LONARR[n] indexes of tables to be searched in OBSTBL data
inuse : INTARR[n] flag indicating whether table in use
table : BYTARR[] table data
Opt. Inputs : table_index : INT index into indexes of table specifying one table to search
If undefined then does full search of tables.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
table_index : INT index into indexes of table
Not defined if no place found for table
Opt. Outputs: None.
Keywords : SEQUENCE : FLAG indicating table is a sequence table.
LINELIST : FLAG indicating that processing a linelist
AEC_EXPOSURE : FLAG indicating that processing an AEC exposure table
AEC_TABLE : FLAG indicating that processing an AEC control table
XRT_FLARE : FLAG indicating that processing an XRT flare trigger control table
EIS_FLARE : FLAG indicating that processing an EIS flare trigger control table
EIS_EVENT : FLAG indicating that processing an EIS event trigger control table
EXACT : FLAG indicating should look for exact match when doing full search in unused tables
NB with proviso about last two bytes in sequence table
USED : INT indicating should look in 'inuse = used' tables also.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2], EIS_CPT_TABLE_SEARCH [1]
EIS_CPT_TABLE_SEARCH [2], EIS_CPT_UNDEFINE [1], EIS_CPT_UNDEFINE [2]
CALLED BY:
EIS_CPT_OBSTBL_PLACE [1], EIS_CPT_OBSTBL_PLACE [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 11/11/04
Modified : Version 0.1, 15/11/04, MKC
Changed so that can reuse tables.
Version 0.2, 25/01/05, MKC
Added SEQUENCE keyword.
Corrected logic.
Tightened up use of WHERE.
Version 0.3, 22/03/05, MKC
Added table type to error messages.
Version 0.4, 17/09/05
Removed restriction that only looks for exact matches for linelist tables.
Use routine eis cpt table difference.
Added EXACT and USED keywords.
Changed so that returns table index as an argument.
Changed so that if table index defined on input then only
looks at specified table.
Renamed from eis cpt place table
Split into two routines.
Version 0.5, 04/10/05, MKC
Added control table keywords.
Changed so that if no place found then sets table_index to -1.
Allowed table_index = -1 on input.
Version 0.6, 16/06/06, MKC
Changed so that table_index is undefined if no match found.
Simplified behaviour if table index set on entry.
Version : 0.6, 16/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_TABLE_SEARCH
Purpose : Searches list of tables for best match.
Explanation : Searches list of tables for best match.
Use : < table_index = eis_cpt_table_search (obstbl, indexes, list, table, EXACT=exact) >
Inputs : obstbl : BYTARR[] OBSTBL data
indexes : LONARR[n] indexes of tables to be searched in OBSTBL data
list : LONARR[] list of indexes to be searched
table : BYTARR[] table data
Opt. Inputs : None.
Outputs : table_index : INT index into indexes of table
-1 if no match found for table
Opt. Outputs: None.
Keywords : EXACT : FLAG indicating should look for exact match only.
Calls : ***
EIS_CPT_TABLE_DIFFERENCE [1], EIS_CPT_TABLE_DIFFERENCE [2]
CALLED BY:
EIS_CPT_TABLE_PLACE [1], EIS_CPT_TABLE_PLACE [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 11/11/04
Modified : Version 0.1, 15/11/04, MKC
Changed so that can reuse tables.
Version 0.2, 25/01/05, MKC
Added SEQUENCE keyword.
Corrected logic.
Tightened up use of WHERE.
Version 0.3, 22/03/05, MKC
Added table type to error messages.
Version 0.4, 17/09/05
Removed restriction that only looks for exact matches for linelist tables.
Use routine eis cpt table difference.
Added EXACT and USED keywords.
Changed so that returns table index as an argument.
Changed so that if table index defined on input then only
looks at specified table.
Renamed from eis cpt place table
Split into two routines.
Version 0.5, 04/10/05, MKC
Added 50 % criteria else use new table.
Version 0.6, 23/09/05, MKC
Changed measure of table differences to number of commands needed
to upload..
Version : 0.6, 23/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_TERM_SEQ
Purpose : Sets up MSSL command.
Explanation :
Use : < bytes = eis_cpt_term_seq( seq_no ) >
Inputs : seq_no : UINT seq_no 0->nsq-1
Opt. Inputs : None.
Outputs : bytes : BYTARR[2] command.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [1]
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [2]
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [1]
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 26/11/04
Modified : Version 0.0, 26/11/04, MKC
Version, 0.1, 15/04/05, MKC
Changed format of !EIS_CPT_COMMANDS.
Version, 0.2, 27/04/05, MKC
Removed !EIS_CPT_COMMANDS. Put in command directly.
Version : Version 0.2, 27/04/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_TEST
Purpose : Tests EIS_CPT routine.
Explanation : Runs through a fixed set of tests.
Use : < eis_cpt_test >
Inputs : None.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : TEST : STRING indicating which test to apply.
: OUTPUT : STRING override default output directory.
INPUT : STRING override default input directory.
LIST : FLAG indicating just list tests.
Calls : ***
ANYTIM2TAI, EIS_CPT [1], EIS_CPT [2], EIS_CPT_STRUCTURES [1]
EIS_CPT_STRUCTURES [2], EIS_CPT_STRUCTURE_DEFAULTS [1]
EIS_CPT_STRUCTURE_DEFAULTS [2], EIS_CPT_TIMEFORMAT [1]
EIS_CPT_TIMEFORMAT [2], EIS_CPT_TIME_PERIOD_DEFAULT [1]
EIS_CPT_TIME_PERIOD_DEFAULT [2], EIS_CPT_test_environment [1]
EIS_CPT_test_environment [2], EIS_CPT_test_parameters [1]
EIS_CPT_test_parameters [2], EIS_CPT_test_sysv [1], EIS_CPT_test_sysv [2]
EIS_CPT_upload_default [1], EIS_CPT_upload_default [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 01/03/05
Modified : Version 0.0, 01/03/05, MKC
Version 0.1, 22/03/05, MKC
Added eis cpt test sysv.
Added 3.1 and 3.2 tests.
Added 4.1 and 4.2 tests.
Version 0.2, 02/04/05, MKC
Added 3.3 and 5.1 test.
Added TIMESTAMPs.
Version 0.3, 12/04/05, MKC
Added TEST keyword.
Added SPECIAL parameter.
Modified 5.2 test.
Version 0.4, 09/05/05, MKC
Added time_tag, linked and hard reset.
Added 5.3 test.
Added 2.4 test.
Added 2.5 test.
Changed so that bakeouts, cmirror and suspension periods are not defaults.
Version 0.5, 15/05/05, MKC
Added 6 tests.
Version 0.6, 24/06/05, MKC
Added 7 tests.
Changed SPECIAL so that duplicates across studies rather than rasters.
This changes test 5.2. Previously used SPECIAL = [0,1].
Added test 2.5.
Version 0.7, 29/06/05, MKC
Added 3.6 and 3.7.
Version 0.8, 20/07/05, MKC
Added 2.6.
Version 0.9, 13/09/05, MKC
Added RAM sub ID argument to eis cpt.
Added check on pass ID to eis cpt.
Changed TIMESTAMP keyword to STAMP.
Added test 5.5.
Added test 2.7.
Added test 8.
Changed test numbering.
Added test 9.
Added test of study repeats.
Version 1.0, 07/06/06, MKC
Added INPUT and OUTPUT keywords and eis cpt test environment.
Version 1.1, 18/06/06, MKC
Added test 7.3.
Added KEYWORDS to eis_cpt.
Changed response and filler keywords.
Version 1.2, 13/07/06, MKC
Explicitly inserted study IDs in some places.
Version 1.3, 20/08/06, MKC
Changed arguments of eis cpt upload default.
Changed test 2.1.
Version 1.4, 14/09/06, MKC
Added NRASTERS to 8.4 and renamed to 8.4a.
Added test 8.4b.
Added tests 3.10, 3.11 and 3.12.
Added test 4.11.
Added 4th engineering study to 6.1.
Changed pass ID in upload to 4 characters.
Version 1.5, 25/09/06, MKC
Added LIST keyword.
Added extra study to 3.9.
Changed test 2.6.
Added 2.4b, 2.4c, 2.4d, 2.4e, 2.4f.
Added /MSSL to 8.8a.
Changed upload structure.
Changed CONTACTS keyword to CONTACT_INFO.
Added aborts.
Added ABORT to 2.4a and 2.4g.
Added some more studies to 10.2.
Added 12.1.
Added extra study to 6.1.
Version : 1.5, 25/09/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_test__define
Purpose : Generates structure EIS_CPT_test.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
EIS_CPT_test. Tags are :-
nstudies : INT no. of studies
study_id : LONARR[] study identifier for each study
onboard : INTARR[] flag for each study indicating where it should be run from.
time_tag : INTARR[] flag for each study indicating whether it is time-tagged or not.
links : INTARR[] specifies which study each study links to (-1 if no link). .
nrasters : INTARR[] no. of rasters in each study
nwindows : INTARR[,] no of windows for each raster for each study
xadd : INTARR[,] data extraction window modification parameter for each raster for each study
node : INTARR[,] data extraction window readout node for each raster for each study
special : INTARR[,] special hardware window flag for each raster for each study
bakeout : INT Flag indicating should include bakeout periods.
suspension : INT Flag indicating should include suspension periods.
abort : INT Flag indicating should include aborts.
cmirror : INT Flag indicating should include coarse mirror commands.
engineering : INTARR[] flag for each study indicating if engineering study.
aec_table: INTARR[,] AEC flag for each raster for each study
xrt_flare: INTARR[,] XRT flare flag for each raster for each study
eis_flare: INTARR[,] EIS flare flag for each raster for each study
eis_event: INTARR[,] EIS event flag for each raster for each study
xrtflare_response : LONG ID of event response study
xrtfiller_response : LONG ID of event response study
eisflare_response : LONG ID of event response study
eisevent_response : LONG ID of event response study
adjust_y : INT flag allowing Y adjust in event response study
readout_nodes : INTARR[4] flag indicating whether readout node enabled
nocontact: INT flag indicating should not include default contact periods
exposures: LONARR giving exposure times in ms at each mirror position.
nmirror : LONG number of fine mirror positions.
nrepeats : INTARR[] number of study repeats for each study.
Use : <dummy = {EIS_CPT_test}>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 17/03/05
Modified : Version 0.1, 02/04/05, MKC
Added nwindows and xadd tags.
Version 0,2, 15/04/05, MKC
Added special tag.
Version 0,3, 09/05/05, MKC
Added time_tag and linked tags.
Added bakeout, suspension and cmiror tags.
Added engineering tag.
Version 0.4, 24/06/05, MKC
Added control table tags.
Added response and adjust_y tags.
Version 0.5, 29/06/05, MKC
Added readout nodes and node tags.
Version 0.6, 20/07/05, MKC
Added real tag.
Version 0.7, 22/09/05, MKC
Added nocontact tag.
Added exposures tag.
Added nmirror tag.
Added nrepeats tag.
Version 0.8, 28/09/05, MKC
Added filler tag.
Change dlinked tag to links.
Version 0.9, 19/06/06, MKC
Changed response and filler tags.
Version 1.0, 04/10/06, MKC
Added abort tag.
Version : 1.0, 04/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_test_environment
Purpose : Set up test environment used by EIS_CPT
Explanation : This routine sets up test environment used by EIS_CPT.
Use : < eis_cpt_test_environment >
Inputs : None.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : OUTPUT : STRING override default output directory.
INPUT : STRING override default input directory.
Calls : ***
EIS_CPT_environment_wrapper [1], EIS_CPT_environment_wrapper [2]
CALLED BY:
EIS_CPT_TEST [1], EIS_CPT_TEST [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 06/10/04
Modified : Version 0.1, 21/10/04
Added EIS_OP_directory, EIS_SEQEXEC_directory, EIS_DV_directory, EIS_linelist_directory
environment variables
Version 0.2, 15/11/04
Changed eis_obstbl_map to directory.
Version 0.3, 02/04/05
Changed environment variables associated with MSSL, ISACS PLN and INTEL outputs.
Version 0.4, 27/04/05
Removed ISACS PLN directory.
Version 0.5, 05/05/05
Added KEYWORDs SOFTWARE and OUTPUT.
Added check that !PATH does not altready include software directory.
Version 0.6, 19/07/05
Changed engineering file environment variable name and added real command sequence direcory.
Added INPUT keyword.
Version 0.7, 12/09/05
Added EIS_SIB_COMMAND_TABLE environment variable..
Changed 'DV' type to 'DATARATE'
Version 0.8, 29/09/05, MKC
Replaced REAL, OP, SEQEXEC files with single ORL file.
Version 0.9, 06/06/06, MKC
Renamed EIS CPT environment to EIS CPT setup environment.
Did away with IDL environment variables.
Did away with adding eise cpt software to IDL path.
Did away with SOFTWARE keyword.
Version 1.0, 14/06/06, MKC
Split some of setup into wrapper routine..
Version : 1.0, 14/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_test_parameters
Purpose : Set up test parameters used by EIS_CPT
Explanation : This routine sets up test parameters used by EIS_CPT.
Use : < eis_cpt_test_parameters, time_period, engineering_parameters, control_details, study_details, $
suspension_periods, abort_times, bakeout_periods, $
contact_periods, coarse_mirror_commands, real_command_sequences>
Inputs : time_period : DBLARR[2] TAI time to start and finish timeline.
Opt. Inputs : None.
Outputs : engineering_parameters : STRUCTURE of type EIS_engineering_parameters.
control_details : STRUCTURE of type EIS_control_details.
study_details : STRUCTURE ARRAY of type EIS_study_detail.
suspension_periods : STRUCTURE ARRAY of type EIS_suspend_period.
abort_times : STRUCTURE ARRAY of type EIS_abort.
bakeout_periods : STRUCTURE ARRAY of type EIS_bakeout_period.
contact_periods : STRUCTURE ARRAY of type EIS_contact_period.
coarse_mirror_commands : STRUCTURE ARRAY of type EIS_coarse_mirror_command.
real_command_sequences : STRUCTURE ARRAY of type EIS_list_real_detail
Opt. Outputs: None.
Keywords : None.
Calls : ***
ANYTIM2TAI, EIS_CPT_GET_CONTROL [1], EIS_CPT_GET_CONTROL [2]
EIS_CPT_GET_ENGINEERING [1], EIS_CPT_GET_ENGINEERING [2]
EIS_CPT_LIST_ABORTS [1], EIS_CPT_LIST_ABORTS [2]
EIS_CPT_LIST_BAKEOUT_PERIODS [1], EIS_CPT_LIST_BAKEOUT_PERIODS [2]
EIS_CPT_LIST_COARSE_MIRROR_COMMANDS [1]
EIS_CPT_LIST_COARSE_MIRROR_COMMANDS [2]
EIS_CPT_LIST_REAL_COMMAND_SEQUENCES [1]
EIS_CPT_LIST_REAL_COMMAND_SEQUENCES [2], EIS_CPT_LIST_STUDY_DETAILS [1]
EIS_CPT_LIST_STUDY_DETAILS [2], EIS_CPT_LIST_SUSPENSION_PERIODS [1]
EIS_CPT_LIST_SUSPENSION_PERIODS [2], EIS_CPT_contacts_default [1]
EIS_CPT_contacts_default [2]
CALLED BY:
EIS_CPT_TEST [1], EIS_CPT_TEST [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 14/06/06
Modified : Version 0.1, 03/10/06, MKC
Replaced eis cpt list contact periods with eis cpt contacts default.
Added aborts.
Version : 0.1, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_test_sysv
Purpose : Generates system variable EIS_CPT_test.
Explanation : Sets up test system variable structure.
Use : <EIS_CPT_test_sysv, NSTUDIES=nstudies, NRASTERS=nrasters, NWINDOWS=nwindows, $
XADD=xadd, NODE=node, ONBOARD=onboard,
SPECIAL=special, TIME_TAG=time_tag, LINKS=links, $
BAKEOUT=bakeout, SUSPENSION=suspension, CMIRROR=cmirror, $
REAL=real, ENGINEERING=engineering, $
AEC_TABLE=aec_table, XRT_FLARE=xrt_flare, EIS_FLARE=eis_flare, EIS_EVENT=eis_event, $
RESPONSE=response, FILLER=filler, ADJUST_X=adjust_x, $
READOUT_NODES=readout_nodes, IDS=ids, NOCONTACT=nocontact, $
EXPOSURE=exposure, NMIRROR=nmirror, NREPEATS=nrepeats>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up system variable.
Opt. Outputs: None.
Keywords : NSTUDIES : INT no. of studies
NRASTERS : INT or INTARR[] no of rasters for each study
NWINDOWS : INT or INTARR[nstudies,nrasters] no of windows for each raster for each study
XADD : INT or INTARR[nstudies,nrasters] data extraction window modification parameter
for each raster for each study
NODE : INT or INTARR[nstudies,nrasters] data extraction window readout node
for each raster for each study
0 : CCDA R R/O chain enable
1 : CCDA L R/O chain enable
2 : CCDB R R/O chain enable
3 : CCDB L R/O chain enable
ONBOARD : INT or INTARR[] onboard flag for each study
Default is onboard.
SPECIAL : INT or INTARR[nstudies,nrasters] flag if special hardware window used for each raster for each study
Default is normal hardware window.
TIME_TAG : INT or INTARR[] flag indicating whether study time-tagged or not.
Default is time-tagged.
LINKS : INTARR[nstudies] indicating which study each study links to.
BAKEOUT : INT Flag indicating should include bakeout periods.
1 : one OP and one REAL
2 : OP
3 : REAL
SUSPENSION : INT Flag indicating should include suspension periods.
ABORT : INT Flag indicating should include abort times.
CMIRROR : INT Flag indicating should include coarse mirror commands.
1 : one OP and one REAL
2 : OP
3 : REAL
REAL : INT flag indicating should include REAL command sequence.
ENGINEERING : INT or INTARR[] flag for each study indicating if engineering study.
AEC_TABLE: INT or INTARR[nstudies,nrasters] flag if AEC used for each raster for each study
XRT_FLARE: INT or INTARR[nstudies,nrasters] flag if XRT flare hunting used for each raster for each study.
EIS_FLARE: INT or INTARR[nstudies,nrasters] flag if EIS flare hunting used for each raster for each study.
EIS_EVENT: INT or INTARR[nstudies,nrasters] flag if EIS event hunting used for each raster for each study.
XRTFLARE_RESPONSE : LONG giving response study ID
XRTFILLER_RESPONSE : LONG giving response study ID
EISFLARE_RESPONSE : LONG giving response study ID
EISEVENT_RESPONSE : LONG giving response study ID
ADJUST_Y : INT FLAG indicating adjust Y allowed in event response study.
READOUT_NODES : INTARR[4] flag indicating whether each readout node enabled.
IDS : LONARR[nstudies] study identifier for each study.
NOCONTACT : INT flag indicating should not include default contact periods.
EXPOSURES: LONARR[] sets up exposure times in ms.
NMIRROR : LONG number of mirror positions.
NREPEATS : INTARR[nstudies] number of study repeats for each study.
Calls : ***
EIS_CPT_CHECK_SYSTEM_VARIABLE [1], EIS_CPT_CHECK_SYSTEM_VARIABLE [2]
CALLED BY:
EIS_CPT_TEST [1], EIS_CPT_TEST [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/03/05
Modified : Version 0.1, 02/04/05, MKC
Added nwindows and xadd keywords.
Version 0,2, 15/04/05, MKC
Added SPECIAL keyword.
Version 0,3, 09/05/05, MKC
Added TIME_TAG keyword.
Started study_id's from 1.
Added LINKED keyword.
Added bakeout, suspension and cmirror keywords.
Added engineering tag.
Version 0.4, 25/06/05, MKC
Added event control flags.
Added response and adjust_y tags.
Changed SPECIAL so that duplicates across studies rather than rasters.
Version 0.5, 29/06/05, MKC
Added readout node tag.
Version 0.6, 20/07/05, MKC
Added REAL keyword.
Version 0.7, 20/09/05, MKC
Added IDS keyword.
Added NOCONTACT keyword.
Added EXPOSURES keyword.
Added NMIRROR keyword.
Added NREPEATS keyword.
Version 0.8, 28/09/05, MKC
Added FILLER keyword.
Changed LINKED to LINKS
Version 0.9, 13/06/06, MKC
Changed RESPONSE and FILLER keywords.
Version 1.0, 13/07/06, MKC
Changed so that default study IDs start from 5.
Version 1.1, 05/10/06, MKC
Added ABORT keyword.
Version : 1.1, 05/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_TIME_PERIOD_DEFAULT
Purpose : Sets default time_period argument for eis_cpt.
Explanation : Sets time period as tomorrow.
Use : < time_period = eis_cpt_time_period_default(time) >
Inputs : None.
Opt. Inputs : time : CDS TIME overwriting today
Outputs : time_period : DOUBLE[2] Time period in CCSDS time format.
Opt. Outputs: None.
Keywords : None.
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], EIS_CPT_NOW [1], EIS_CPT_NOW [2]
CALLED BY:
EIS_CPT_TEST [1], EIS_CPT_TEST [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 23/10/04
Modified : Version 0.0, 23/10/04, MKC
Version : Version 0.0, 23/10/04
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_TIMEFORMAT
Purpose : Outputs time in formats required by EIS_CPT.
Explanation : The ORL file requires the time in the format :
yyyy/mm/dd.hh:mm:ss
The TIMESTAMP on EIS_CPT output files is in format yyyymmddhhmmss
Use : < timestring = eis_cpt_timeformat (time) >
Inputs : time : CDS time format
Opt. Inputs :
Outputs : timestring : STRING time in SEQEXEC time format
Opt. Outputs: None.
Keywords : ORL : Flag indicating want ORL time format
TIMESTAMP : Flag indicating want TIMESTAMP time format
JSIDE : Flag indicating want JSIDE time format
NOW : Flag indicating want time now
HHMMSS : Flag indicating want time in day in hhmmss format.
Calls : ***
ANYTIM2CAL, ANYTIM2UTC [1], ANYTIM2UTC [2], EIS_CPT_NOW [1], EIS_CPT_NOW [2]
CALLED BY:
EIS_CPT_DATARATE_ITEM_OUTPUT, EIS_CPT_DATAVOL_ITEM_OUTPUT [1]
EIS_CPT_DATAVOL_ITEM_OUTPUT [2], EIS_CPT_JSIDE_SEQUENCE [1]
EIS_CPT_JSIDE_SEQUENCE [2], EIS_CPT_TEST [1], EIS_CPT_TEST [2]
Common : None.
Restrictions: None.
Side effects: May output ASCII files.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 08/03/05
Modified : Version 0.0, 08/03/05
Version 0.1, 24/03/05, MKC
Added JSIDE format.
Added NOW keyword.
Version 0.2, 13/09/05, MKC
Changed Jside time format to YYYYMMDD.
Version 0.3, 05/05/06, MKC
SEQEXEC file merged with other ORL files.
Changed SEQEXEC keyword to ORL.
Time format required in ORL file changed from
yyyy/mm.dd.hh:mm:ss
to
yyyy/mm/dd.hh:mm:ss
Version 0.4, 03/10/06, MKC
Added HHMMSS keyword.
Version : 0.4, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_TIMELINE
Purpose : Gets list of time line studies.
Explanation : Gets list of time line studies.
Use : < result = eis_cpt_timeline ( study_details, control_details, time_period , timeline) >
Inputs : study_details : STRUCTURE ARRAY of type EIS_study_detail.
control_details : STRUCTURE of type EIS_control_details.
time_period : DBLARR[2] TAI time to start and finish timeline.
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
timeline : STRUCTURE ARRAY of type EIS_CPT_timeline updated
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_DAISY_CHAIN [1], EIS_CPT_DAISY_CHAIN [2]
EIS_CPT_RESPONSE_TIMELINE [1], EIS_CPT_RESPONSE_TIMELINE [2]
EIS_CPT_UNDEFINE [1], EIS_CPT_UNDEFINE [2], LAST_ITEM
CALLED BY:
EIS_CPT_PROCESS_TIMELINE [1], EIS_CPT_PROCESS_TIMELINE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 23/09/05
Modified : Version 0.0, 23/09/05, MKC
Version 0.1, 29/09/05, MKC
Changed behaviour with respect to errors and warnings and daisy-chain loops.
Version 0.2, 22/05/06, MKC
Changed initialization of timeline for compatability with IDL 6.2.
Version 0.3, 19/06/06, MKC
Changed tags study identifier and filler sequence identifier.
Hardcoded study identifiers for response study.
Removed type argument from routine eis cpt response timeline.
Version : 0.3, 19/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_timeline__define
Purpose : Generates structure EIS_CPT_timeline
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case filename.
Tags are :
time : DOUBLE TAI time of use
index : INT index into study_details
type : INT timeline type
0 : main plan
1 : XRT flare response
2 : XRT filler
3 : EIS flare
4 : EIS event
slit_slot : structure of type EIS_CPT_mechanism_change.
loop : INT loop back value
Use : <dummy = {EIS_CPT_timeline}>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 16/09/05
Modified : Version 0.0, 16/09/05, MKC
Version 0.1, 29/09/05, MKC
Added loop tag.
Version : 0.1, 29/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_TIMELINE_ITEM_OUTPUT
Purpose : Outputs an item on the timeline.
Explanation : Outputs an item on the timeline.
Use : < line = eis_cpt_timeline_item_output(study_details, item, time_period) >
Inputs : study_details : STRUCTURE ARRAY of type EIS_study_detail.
item : STRUCTURE of type EIS_CPT_timeline
interrupt_time : DOUBLE TAI time of next item on timeline
Opt. Inputs : None.
Outputs : line : STRING of text
Opt. Outputs: None.
Keywords : FORMAT : INT flag indicating should write the format used.
Calls : ***
ANYTIM2CAL, EIS_CPT_STRTRIM [1], EIS_CPT_STRTRIM [2]
CALLED BY:
EIS_CPT_TIMELINE_OUTPUT [1], EIS_CPT_TIMELINE_OUTPUT [2]
Common : None.
Restrictions: None.
Side effects: Returns to calling routine if error.
Resets !ERROR_STATE system variable.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 28/09/05
Modified : Version 0.0, 28/09/05, MKC
Version 0.1, 13/06/06, MKC
Changed LOOP BACK to REPEAT in data volume file.
Added '|' to indicate links to following study.
Version 0.2, 03/10/06, MKC
Changed output to Mbits.
Version : 0.2, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_TIMELINE_OUTPUT
Purpose : Outputs the timeline.
Explanation : Outputs the timeline.
Use : < result = eis_cpt_timeline_output(study_details, timeline, time_period ) >
Inputs : study_details : STRUCTURE ARRAY of type EIS_study_detail.
timeline : STRUCTURE ARRAY of type EIS_CPT_timeline updated
time_period : DBLARR[2] TAI time of start and finish
Opt. Inputs : None.
Outputs : result : INT flag :
1 : processed science plan OK.
0 : processing failed.
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_ADD [1], EIS_CPT_ADD [2], EIS_CPT_TIMELINE_ITEM_OUTPUT [1]
EIS_CPT_TIMELINE_ITEM_OUTPUT [2]
CALLED BY:
EIS_CPT_DATA_RATE_PROCESS [1], EIS_CPT_DATA_RATE_PROCESS [2]
Common : None.
Restrictions: None.
Side effects: Returns to calling routine if error.
Resets !ERROR_STATE system variable.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/09/05
Modified : Version 0.0, 22/09/05, MKC
Version 0.1, 28/09/05, MKC
Added time period argument,
Changed behaviour for daisy-chain loops
Version 0.2, 03/10/06, MKC
Changed output to Mbits.
Version : 0.2, 03/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_UINTTOBYTES
Purpose : Converts UINT array to big endian BYTE array.
Explanation : Arranges BYTE data values MSByte first.
If fails then sets error.
Use : < byte_array = eis_cpt_uinttobytes(unit_array) >
Inputs : uint_array : UINTARR[n] uint values.
Opt. Inputs : None.
Outputs : byte_array : BYTARR[2n] byte values.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_ADD_INTEL_HEX_RECORD [1], EIS_CPT_ADD_INTEL_HEX_RECORD [2]
EIS_CPT_C_SET_WINDOW [1], EIS_CPT_C_SET_WINDOW [2]
EIS_CPT_JSIDE_COMMANDS [1], EIS_CPT_JSIDE_COMMANDS [2]
EIS_CPT_MIR_C_AUTO [1], EIS_CPT_MIR_C_AUTO [2]
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [1]
EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [2]
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [1]
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [2], EIS_CPT_PROCESS_STUDIES [1]
EIS_CPT_PROCESS_STUDIES [2], EIS_CPT_RUN_RASTER [1], EIS_CPT_RUN_RASTER [2]
EIS_CPT_SET_AEC_TABLE [1], EIS_CPT_SET_AEC_TABLE [2]
EIS_CPT_SET_LINELIST [1], EIS_CPT_SET_LINELIST [2]
EIS_CPT_SET_XRT_FLARE_TABLE [1], EIS_CPT_SET_XRT_FLARE_TABLE [2]
EIS_CPT_SLIT_SLOT_AUTO [1], EIS_CPT_SLIT_SLOT_AUTO [2]
EIS_CPT_START_EXP [1], EIS_CPT_START_EXP [2]
Common : None.
Restrictions: None.
Side effects: Loses any extra dimensions of input array.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 18/10/04
Modified : Version 0.0, 18/10/04, MKC
Version : Version 0.0, 18/10/04
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_UINTTOMSSL
Purpose : Converts uint value to MSSL format output.
Explanation : Converts uint value to MSSL format output.
Use : < str = eis_cpt_uinttomssl(value) >
Inputs : value : INT
Opt. Inputs : None.
Outputs : str : STRING.
Opt. Outputs: None.
Keywords : OX : INT flag indicating should output as Hex.
Calls : None.
CALLED BY:
EIS_CPT_DECODE_LINELIST_TABLE [1], EIS_CPT_DECODE_LINELIST_TABLE [2]
EIS_CPT_DECODE_SEQUENCE_TABLE [1], EIS_CPT_DECODE_SEQUENCE_TABLE [2]
EIS_CPT_FILE_NAME [1], EIS_CPT_FILE_NAME [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 28/06/05
Modified : Version 0.0, 28/06/05, MKC
Version 0.1, 04/10/05, MKC
Added explicit UNIT conversion.
Version : 0.1, 04/10/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_ULONGTOBYTES
Purpose : Converts ULONG array to big endian BYTE array.
Explanation : Aarranges BYTE data values MSByte first.
If fails then sets error.
Use : < byte_array = eis_cpt_ulongtobytes(unit_array) >
Inputs : uint_array : ULONGARR[n] ulong values.
Opt. Inputs : None.
Outputs : byte_array : BYTARR[4n] byte values.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_CHECK_TIME_PERIOD [1], EIS_CPT_CHECK_TIME_PERIOD [2]
EIS_CPT_C_SET_WINDOW [1], EIS_CPT_C_SET_WINDOW [2]
EIS_CPT_PROCESS_AEC_TABLE [1], EIS_CPT_PROCESS_AEC_TABLE [2]
EIS_CPT_SET_AEC_TABLE [1], EIS_CPT_SET_AEC_TABLE [2]
EIS_CPT_SET_EIS_EVENT_TABLE [1], EIS_CPT_SET_EIS_EVENT_TABLE [2]
EIS_CPT_SET_EIS_FLARE_TABLE [1], EIS_CPT_SET_EIS_FLARE_TABLE [2]
EIS_CPT_SET_XRT_FLARE_TABLE [1], EIS_CPT_SET_XRT_FLARE_TABLE [2]
Common : None.
Restrictions: None.
Side effects: Loses any extra dimensions of input array.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 18/10/04
Modified : Version 0.0, 18/10/04, MKC
Version : Version 0.0, 18/10/04
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_UNDEFINE
Purpose : Undefines the argument.
Explanation : Undefines the argument.
Use : < eis_cpt_undefine, arg >
Inputs : arg : Any argument
Opt. Inputs : None.
Outputs : arg : UNDEFINED
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_COMMAND_STORE [1], EIS_CPT_COMMAND_STORE [2], EIS_CPT_DATA_RATE [1]
EIS_CPT_DATA_RATE [2], EIS_CPT_JSIDE_COMMANDS [1]
EIS_CPT_JSIDE_COMMANDS [2], EIS_CPT_PARSE_INTEL_HEX_FILE [1]
EIS_CPT_PARSE_INTEL_HEX_FILE [2], EIS_CPT_PROCESS_AEC_TABLE [1]
EIS_CPT_PROCESS_AEC_TABLE [2], EIS_CPT_PROCESS_LINELISTS_FOR_STUDY [1]
EIS_CPT_PROCESS_LINELISTS_FOR_STUDY [2], EIS_CPT_SEQUENCE_MATCH [1]
EIS_CPT_SEQUENCE_MATCH [2], EIS_CPT_SEQUENCE_PLACE [1]
EIS_CPT_SEQUENCE_PLACE [2], EIS_CPT_TABLE_PLACE [1], EIS_CPT_TABLE_PLACE [2]
EIS_CPT_TIMELINE [1], EIS_CPT_TIMELINE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 20/09/05
Modified : Version 0.0, 20/09/05, MKC
Version : 0.0, 20/09/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_UNIQUE
Purpose : Returns unique elements of array in increasing order.
Explanation : Returns unique elements of array in increasing order.
Use : < output = eis_cpt_unique(array) >
Inputs : array : ARRAY[] of values.
Opt. Inputs : None.
Outputs : output : ARRAY[] of unique values.
or
res : 0 elements are not unique
1 elements are unique.
Opt. Outputs: None.
Keywords : CHECK : FLAG indicating should check elemnts are unique.
Calls : ***
UNIQ [1], UNIQ [2], UNIQ [3]
CALLED BY:
EIS_CPT_CHECK_STUDY [1], EIS_CPT_CHECK_STUDY [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 12/10/06
Modified : Version 0.0, 12/10/06, MKC
Version : 0.0, 12/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_upload_default
Purpose : Generates default structure EIS_upload.
Explanation : Sets up default values for structure EIS_upload.
Use : < s = EIS_CPT_upload_default(time, upload_id, version, sub_id) >
Inputs : time : DOUBLE TAI time of day of upload.
upload_id : STRING giving day and four character pass identifier for the upload pass
i.e yyyymmddPassiD = '200612250001'.
This must be set if the /JSIDE option is selected.
version : STRING 3 digit upload version : 820-829 for EIS.
RAM_sub_id : STRING 2 digit RAM sub ID : 00 - 99 for EIS.
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_upload.
Opt. Outputs: None.
Keywords : None
Calls : None.
CALLED BY:
EIS_CPT_STRUCTURE_DEFAULTS [1], EIS_CPT_STRUCTURE_DEFAULTS [2]
EIS_CPT_TEST [1], EIS_CPT_TEST [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 14/06/06
Modified : Version 0.1, 20/08/06, MKC
Added version to arguments and structure.
Version 0.2, 03/10/06, MKC
Changed upload structure.
Version : 0.1, 20/08/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_VERSION
Purpose : Returns string containing version information.
Explanation : Version is based on date of delivery to RAL and version number.
Use : < version = eis_cpt_version() >
Inputs : None.
Opt. Inputs : None.
Outputs : version : STRING version information.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT [1], EIS_CPT [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 12/07/06
Modified : Version 1.0, 12/07/06, MKC
eis cpt version : Added.
eis cpt command store process : Prepended 'EIS_' to sequence names in ORL file.
eis cpt obstbl map write : Used eis cpt obstbl map text for header.
Added keywords to eis cpt obstbl map text.
Added tags to obstbl_map.
eis cpt obstbl map text : Changed MAP file format.
Included follow on sequence and start of study flag.
Added link, first and last keywords.
eis cpt obstbl map read : Changed MAP file format.
eis cpt obstbl map entry define : Added link, first and last tags.
eis cpt preliminaries : Moved time period check and time period argument argument.
eis cpt : Moved check on time period into routine.
eis cpt check time period : Added further arguments and checks.
eis cpt obstbl set : Changed so that always writes sequence table even if exact match.
eis cpt sequence place : Writes sequence table even if exact match.
eis cpt obstbl : Updated OBSTL_MAP link info.
Added FIRST and LAST keywords.
: Added TERMINATE keyword.
eis cpt sequence link : Changed check on no. of linked sequences to = 1
eis cpt sequence define : Added first tag.
eis cpt process science sequences : Added first sequence in study flag.
eis cpt process engineering sequences : Added first sequence in study flag.
eis cpt obstbl map parse : Set up first, last and used tags.
eis cpt sequence resolve links : Resolve links even if exact match.
Added terminate, first and last tags.
Version 1.1, 15/08/06, MKC
eis cpt environment wrapper : Changed all directories to lower case only.
Version 1.2, 20/08/06, MKC
eis cpt obstbl get : Fixed bug where if reset=1 used and OBSTBL read fails then OBSTBL not initialized to 'FF's.
If no OBSTBL now insists start with reset=2.
eis cpt obstbl refresh : Changed ' 999, dd' to ' ddd, dd' format for sub ID.
Used previous to calculate next version for OBSTBL.
Set up version and RAM sub id in upload structure.
If upload not defined then sets up default.
eis upload define : Added upload version to structure.
eis upload default : Added version to arguments and structure.
eis cpt structure defaults : Added version to eis upload defaults arguments.
eis cpt check upload : Removed RAM sub ID check.
Removed upload pass argument.
eis cpt process : Changed arguments for EIS OBSTBL LOAD command.
eis cpt command store process : Changed LOAD command parameters.
eis cpt test : Changed arguments of eis cpt upload default.
eis cpt : Changed logic so that only require upload to be defined if Jside output required.
Moved calculation of upload pass string.
Changed arguments of eis complete and eis cpt check upload.
Took internal copy of upload.
eis cpt complete : Changed arguments.
eis cpt obstbl : Changed error message.
Version 1.3, 08/09/06, MKC
eis cpt test : Added NRASTERS to 8.4 and renamed to 8.4a.
Added test 8.4b.
Added tests 3.10, 3.11 and 3.12.
Added test 4.11.
Added 4th engineering study to 6.1.
Changed pass ID in upload to 4 characters.
eis cpt sequence link : Rearranged logic.
Corrected bug with daisy-chained studies spanning
more than one sequence table.
eis cpt daisy chain : Fixed bug with single looped study if COMPLETE used.
Added check.
Fixed bug with end time calculation. :
Implemented response studies not in studies list.
eis cpt check studies list : Moved check of slit/slot changes.
eis cpt process timeline : Add check of slit slot changes.
Include changes between studies and study repeats.
eis cpt read intel hex file : Added error message.
eis cpt parse intel hex file : Changed so that NOENDOFFILE flag allows no end of file but does not insist on it.
eis cpt data rate : Added printout.
eis cpt command store output : Added printout.
eis cpt obstbl output : Added printout.
eis cpt command store process : Removed Select AUTO command from LOAD_OBSTBL command sequence.
Added ';' to ENTRY command.
Removed 'C.' from command description.
Added DUMP OBSTBL command.
eis cpt list contact periods : Changed pass IDs to 4 character values.
eis cpt check upload : Changed check on pass ID.
eis cpt data rate item output : Changed pass ID to 4 characters.
eis cpt get engineering detail : Renamed to eis cpt get engineering detail.
Allowed non-standard names.
Version 1.4, 23/09/06, MKC
Added estimate of time for OBSTBL upload and used this as a measure of differences for
placing sequence tables :
eis cpt get engineering detail default: Renamed eis get engineering detail.
eis cpt table search : Changed measure of table differences to number of commands needed
to upload.
eis cpt table difference : Changed difference measure from simple count of no of byte differences.
eis cpt obstbl : Keep copy of previous obstbl in common block.
Added keyword DIFFERENCE.
eis cpt data rate : Added engineering parameters argument.
Added OBSTBL upload time output.
eis cpt process : Added engineering parameters to eis cpt data rate arguments.
Used new scheme in ORL file commands in which a time interval is inserted after the manual mode
command :
eis cpt command store add : Changed set up of new command parameter.
Fixed bug with real sequences taking up og numbers.
Fixed bug with duplicate onboard and real studies.
eis cpt command store process : Changed ORL sequence name.
Removed type from argument list.
Process SEQEXEC, REAL, OP and OG in parallel.
Used eis cpt jside process.
eis cpt engineering parameters default: Added OBSTBL_memory_command_time tag.
Added ORL_manual_command_delay tag.
eis engineering parameters define : Added OBSTBL_memory_command_time tag.
eis cpt test : Added LIST keyword.
Added extra study to 3.9.
Changed test 2.6.
Added 2.4b, 2.4c, 2.4d, 2.4e, 2.4f.
Added /MSSL to 8.8a.
eis cpt command store output : Combined processing of SEQEXEC, REAL, OP and OG commands.
eis cpt jside sequence : Rearranged processing.
Added MANUAL keyword.
eis cpt jside commands : Adapted from eis cpt command store process.
eis cpt jside process : Adapted from eis cpt command store process.
eis cpt list real detail default : Added filename argument.
eis cpt list real command sequences : Used all files in REAL directory.
eis cpt list bakeout periods : Added alternatives.
eis cpt list coarse mirror commands : Added alternatives.
eis cpt process bakeout periods : Changed so that all commanding may be performed from GSE.
Add MSSL output directory printout :
eis cpt process studies : Removed unnecessary ASCII file printout with /ALL.
eis cpt obstbl : Removed keyword ALL.
eis cpt obstbl ascii : Removed ALL keyword.
Change upload structure :
eis upload define : Changed upload structure.
eis cpt upload default : Changed upload structure.
eis cpt structure defaults : Changed upload structure.
eis cpt complete : Changed upload structure.
Changed arguments.
Changed TIMESTAMP keyword to STAMP.
eis cpt : Changed eis cpt complete arguments.
eis cpt obstbl : Changed TIMESTAMP keyword to STAMP.
eis cpt obstbl output : Changed TIMESTAMP keyword to STAMP.
eis cpt obtsbl map write : Changed TIMESTAMP keyword to STAMP.
eis cpt file name : Changed TIMESTAMP keyword to STAMP.
eis cpt data rate : Changed TIMESTAMP keyword to STAMP.
eis cpt command store : Changed TIMESTAMP keyword to STAMP.
eis cpt command store output : Changed TIMESTAMP keyword to STAMP.
eis cpt check upload : Changed upload structure.
eis cpt test : Changed upload structure.
Changed name of internal OBSTBL files :
eis cpt complete : Changed names of internal obstbl files.
eis cpt obstbl get : Changed names of internal obstbl files.
eis cpt obstbl map read : Changed names of internal obstbl files.
Change to new contact periods structure :
eis contact period define : Deprecated.
eis cpt contact period default : Deprecated.
eis cpt list contact periods : Deprecated.
eis cpt contacts default : New routine setting up default contacts structure.
eis cpt test parameters : Replaced eis cpt list contact periods with eis cpt contacts default.
eis cpt : Changed contact periods structure.
Changed CONTACTS keyword to CONTACT_INFO.
eis cpt test : Changed CONTACTS keyword to CONTACT_INFO.
eis cpt check upload : Changed contact periods structure.
eis cpt process : Changed contact periods structure.
eis cpt data rate : Changed contact periods structure.
eis cpt data rate process : Changed contact periods structure.
eis cpt datarate output : Changed contact periods structure.
Changed printout to Mbits.
Used routine eis cpt datavol item output.
eis cpt datarate item output : New routine.
eis cpt structures : Removed eis contact period structure.
eis cpt structure defaults : Removed eis contact period structure.
eis cpt timeformat : Added HHMMSS keyword.
eis cpt extract period : Changed output to Mbits.
eis cpt timeline output : Changed output to Mbits.
eis cpt timeline item output : Changed output to Mbits.
eis cpt datavol item output : Changed item structure.
Removed AFTER, NOCONTACT, NOPLAN, PERIOD keywords.
Renamed from eis cpt datarate item output.
Changed RAM sub ID and version scheme (again) :
eis cpt obtsbl refresh : Changed RAM sub ID to a 3 character field in OBSTBL mirroring the version.
Changed version and RAM sub ID scheme.
eis cpt jside commands : Changed RAM sub ID to a 3 character field in OBSTBL mirroring the version.
Added Abort events :
eis abort define : New routine.
eis cpt abort default : New routine.
eis cpt list aborts : New routine.
eis cpt test define : Added abort tag.
eis cpt structures : Added abort structure.
eis cpt structure defaults : Added abort structure.
eis cpt test parameters : Added aborts.
eis cpt test : Added aborts.
Added ABORT to 2.4a and 2.4g.
Added some more studies to 10.2.
eis cpt test sysv : Added ABORT keyword.
eis cpt : Added ABORTS keyword.
eis cpt check time period : Added abort_times argument.
eis cpt process : Added abort_times argument.
eis cpt process abort times : New routine.
eis cpt command store define : Added additional string parameter.
eis cpt command store : Added additional string parameter.
eis cpt command store add : Added additional string parameter.
eis cpt process : Added string argument to eis cpt command store.
eis cpt process real command sequences: Added string argument to eis cpt command store.
eis cpt jside commands : Added string argument to eis cpt command store.
Used in LOAD and FILE commands.
More testing :
eis cpt test : Added 12.1.
Added multiple linelists to engineering studies :
eis engineering detail define : Added multiple linelist filenames.
Added linelist indexes.
eis cpt engineering detail default : Added multiple linelist filenames.
Added indexes argument.
eis cpt get engineering detail : Added multiple linelist filenames.
Added linelist indexes.
Added indexes keyword.
eis cpt structure defaults : Added indexes argument to eis cpt engineering detail default.
eis get study : Added multiple linelist filenames.
Added indexes argument to eis cpt engineering detail default.
Added new engineering file.
eis cpt check studies list : Checked response study is not an engineering study.
eis cpt process linelists for study : Added multiple linelist filenames for engineering studies.
eis cpt check study : Added check on linelist details for engineering study.
eis cpt process engineering studies : Added multiple linelists for engineering studies.
eis cpt parse intel hex file : Prevented start address being passed into routine.
eis cpt test : Added extra study to 6.1.
Version : 1.4, 23/09/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_WINDOW_ENTRY
Purpose : Returns line list table entry for data extraction window.
Explanation :
Use : < entry = eis_cpt_window_entry ( data_extraction_window ) >
Inputs : data_extraction_window : STRUCTURE of type EIS_data_extraction_window.
Opt. Inputs : None.
Outputs : entry : UINTARR[3] linelist table entry for data extraction window
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
EIS_CPT_SET_LINELIST [1], EIS_CPT_SET_LINELIST [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 9/11/04
Modified : Version 0.0, 9/11/04, MKC
Version 0.1, 11/04/05, MKC
Corrected bits used for SW header.
Version : Version 0.1, 11/04/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_WRITE_ASCII
Purpose : Writes STRARR to ASCII file.
Explanation :
Use : < res = eis_cpt_write_ascii(file,text) >
Inputs : file : STRING file name
text : STRARR text data
Opt. Inputs : None.
Outputs : res : INT flag indicating result
1 : ok
0 : not ok
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_CLOSE_FILE [1], EIS_CPT_CLOSE_FILE [2], EIS_CPT_OPEN_FILE [1]
EIS_CPT_OPEN_FILE [2], EIS_CPT_WRITE_TEXT [1], EIS_CPT_WRITE_TEXT [2]
CALLED BY:
EIS_CPT_ASCII_TABLES [1], EIS_CPT_ASCII_TABLES [2]
EIS_CPT_COMMAND_STORE_OUTPUT [1], EIS_CPT_COMMAND_STORE_OUTPUT [2]
EIS_CPT_DATA_RATE [1], EIS_CPT_DATA_RATE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 21/10/04
Modified : Version 0.0, 21/10/04, MKC
Version : Version 0.0, 21/10/04
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_WRITE_INTEL_HEX_FILE
Purpose : Writes data to intel hex file.
Explanation : Writes data to intel hex file.
Use : < res = eis_cpt_write_intel_hex_file(file,data) >
Inputs : file : STRING filename
data : BYTARR[] data values.
Opt. Inputs : None.
Outputs : res : INT FLAG indicating result
1 : ok
0 : not ok
Opt. Outputs: None.
Keywords : HEADER : STRING header string for file.
ULBA : UINT extended linear address
START_ADDRESS : UINT start address : lower 16 bits of 32 bit address.
NOENDOFFILE : FLAG indicating not to output end of file record.
TIMESTAMP : STRING time stamp indicating should time stamp file names.
Calls : ***
EIS_CPT_CLOSE_FILE [1], EIS_CPT_CLOSE_FILE [2]
EIS_CPT_COMPOSE_INTEL_HEX_FILE [1], EIS_CPT_COMPOSE_INTEL_HEX_FILE [2]
EIS_CPT_OPEN_FILE [1], EIS_CPT_OPEN_FILE [2]
EIS_CPT_WRITE_UNFORMATTED_FILE [1], EIS_CPT_WRITE_UNFORMATTED_FILE [2]
CALLED BY:
EIS_CPT_ASCII_TABLES [1], EIS_CPT_ASCII_TABLES [2]
EIS_CPT_OBSTBL_OUTPUT [1], EIS_CPT_OBSTBL_OUTPUT [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/10/04
Modified : Version 0.1, 01/11/04, MKC
Added HEADER keyword.
Added ULBA keyword.
Version 0.2, 04/11/04, MKC
Added TIMESTAMP keyword.
Version 0.3, 07/02/05, MKC
Renamed from eis ct write obstbl.
Version 0.4, 03/03/05, MKC
Changed TIMESTAMP flag to string containing time.
Version 0.5, 09/03/05, MKC
Incorporated TIMESTAMP within file name routine
Version 0.6, 17/03/05, MKC
Used eis cpt file name.
Version 0.7, 11/04/05, MKC
Renamed from eis cpt obstbl write.
Removed timestamp keyword and set up file name outside of routine.
Version 0.8, 13/05/05, MKC
Added keyword START_ADDRESS.
Added keyword NOENDOFFILE.
Version : Version 0.8, 13/05/05
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_WRITE_TEXT
Purpose : Writes STRARR to file specified by logical unit.
Explanation : Writes STRARR to file specified by logical unit.
Use : < res = eis_cpt_write_text(unit,text) >
Inputs : unit : LONG logical unit number
text : STRARR text data
Opt. Inputs : None.
Outputs : res : INT flag indicating result
1 : ok
0 : not ok
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_OBSTBL_MAP_WRITE [1], EIS_CPT_OBSTBL_MAP_WRITE [2]
EIS_CPT_WRITE_ASCII [1], EIS_CPT_WRITE_ASCII [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 21/10/04
Modified : Version 0.0, 21/10/04, MKC
Version : Version 0.0, 21/10/04
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_WRITE_UNFORMATTED_FILE
Purpose : Writes a byte array into an unformatted file.
Explanation : If write fails then returns 0.
Use : < res = eis_cpt_write_unformatted_file(unit,data) >
Inputs : unit : LONG logical unit number for file.
data : BYTARR[] data values
Opt. Inputs : None.
Outputs : Res : INT FLAG
1 : ok
0 : not ok
Opt. Outputs: None.
Keywords : None.
Calls : ***
EIS_CPT_MESSAGE [1], EIS_CPT_MESSAGE [2]
CALLED BY:
EIS_CPT_WRITE_INTEL_HEX_FILE [1], EIS_CPT_WRITE_INTEL_HEX_FILE [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 22/10/04
Modified : Version 0.0, 22/10/04, MKC
Version : Version 0.0, 22/10/04
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_XRT_flare_control_default
Purpose : Generates default structure EIS_XRT_flare_control.
Explanation : Sets up default values for structure EIS_XRT_flare_control.
Use : < s = EIS_CPT_XRT_flare_control_default(response_study_id, filler_study_id, adjust_y) >
Inputs : response_study_id : LONG response study identifier
filler_study_id : LONG filler study identifier
adjust_y : INT flag
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_XRT_flare_control.
Opt. Outputs: None.
Keywords : None,
Calls : None.
CALLED BY:
EIS_CPT_control_details_default [1], EIS_CPT_control_details_default [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 30/09/04
Modified : Version 0.0, 30/09/04, MKC
Version 0.1, 24/02/05, MKC
Moved parameters from EIS XRT flare response.
Version 0.2, 24/06/05, MKC
Changed INT values to UINT.
Added response_study_id and adjust_y arguments.
Changed adjust_x to 0.
Version 0.3, 04/07/05, MKC
Added number of rasters tag..
Version 0.4, 08/09/05, MKC
Changed raster number/ number of rasters tag to raster identifier.
Version 0.3, 28/09/05, MKC
Added filler study.
Version 0.4, 19/06/06, MKC
Changed tag study identifier and filler sequence identifier.
Version : 0.4, 19/06/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_CPT_XRT_flare_parameters_default
Purpose : Generates default structure EIS_XRT_flare_response.
Explanation : Sets up default values for structure EIS_XRT_flare_response.
Use : < s = EIS_CPT_XRT_flare_parameters_default() >
Inputs : None.
Opt. Inputs : None.
Outputs : s : STRUCTURE of type EIS_XRT_flare_parameters.
Opt. Outputs: None.
Keywords : None,
Calls : None.
CALLED BY:
EIS_CPT_engineering_parameters_default [1]
EIS_CPT_engineering_parameters_default [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 30/09/04
Modified : Version 0.0, 30/09/04, MKC
Version 0.1, 24/02/05, MKC
Renamed from EIS XRT flare response default.
Moved some parameters and from EIS_XRT_flare_control.
Version 0.2, 24/06/05, MKC
Changed INT values to UINT.
Set XRT OCB to 8.
Version : 0.2, 24/06/05, MKC
[Previous]
[Next]
NAME:
eis_ct_summary_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
EIS_DATA__DEFINE
PURPOSE:
EIS_DATA__DEFINE defines the class EIS_DATA. Objects of this
class contains data from the EIS instrument on SOLAR-B. The
EIS_DATA class inherits the superclass HW_DATA
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
The EIS_DATA__DEFINE procedure is not called directly. An
object of class EIS_DATA is created with the following
statement:
eis_data = obj_new('eis_data')
To fill the object with information (see HW_DATA__DEFINE for
information about the contents of the object), use the
following statement:
eis_data-> read, filename [, eis_hdr = eis_hdr]
One may also create the object and fill it with information
with one statement:
eis_data = obj_new('eis_data', filename).
In this case the init-procedure of eis_data__define will be
run, this in turn calls EIS_DATA__READ
INPUTS:
file: Name of file (string) containing EIS data (and
headers).
Note: Giving filename as input when declaring the EIS_DATA
object is optional. Filename can also be sent to EIS_DATA__READ.
KEYWORD PARAMETERS:
eis_hdr: Set this keyword to obtain also the header
information in the form of an object of type EIS_HDR.
OUTPUTS:
Objects of type EIS_DATA (and optionally EIS_HDR)
CALLS: ***
EIS_DATA::GETAUX_DATA, EIS_DATA::GETCALSTAT, EIS_DATA::GETCCD_SZ
EIS_DATA::GETDIR, EIS_DATA::GETFILENAME, EIS_DATA::GETFITSLEV
EIS_DATA::GETFITS_REFORMAT, EIS_DATA::GETLAMBDA, EIS_DATA::GETNEXP_PRP
EIS_DATA::GETNSLIT, EIS_DATA::GETOBSMODE, EIS_DATA::GETSIT_AND_STARE
EIS_DATA::GETWD_DEF, EIS_DATA::INIT, EIS_DATA::SAVE, EIS_DATA::SETCALSTAT
EIS_DATA::SETCONT_PX, EIS_DATA::SETFITSLEV, EIS_DATA::SETFITS_REFORMAT
EIS_DATA::SETLINE_PX, EIS_DATA::SETSIT_AND_STARE, EIS_MKFITS [1]
EIS_MKFITS [2], EIS_MODFITS [1], EIS_MODFITS [2]
COMMON BLOCKS:
PROCEDURE:
The procedure opens an object of class EIS_DATA. The EIS_DATA
class inherits the superclass HW_DATA. If filename is given as
input when declaring the object, then EIS_DATA__READ is also
run by the init-procedure below. In that case the parameters
of the object is filled with information.
RESTRICTIONS:
MODIFICATION HISTORY:
28-Mar-2001: Oivind Wikstol.
21-Sep-2001: Oivind Wikstol. Added documentation.
25-Feb-2004: Oivind Wikstol. Added structure array
wd_def[nwin].
06-May-2004: Oivind Wikstol. Added save method
11-May-2004: Oivind Wikstol - Added keyword unit to
init-method
17-Jun-2004: Oivind Wikstol, Added filename string and get
method to eis_data
02-July-2004: Added dir (directory) to es_data (string) and
get method
15-Feb-2005: Added number of exp. pr. raster pos.
08-Mar-2005: Oivind Wikstol - Added sit_and_stare variable object
(0 for raster 1 for sit-and-stare mode)
08-April-2005: Oivind Wikstol: Added obsmode:
e.g. 'sit-and-stare' or 'scanning'
03-Jan-2006: Oivind Wikstol. Added fits_reformat structure and fitslev keyword
14-July-2006: Changd wavelength definitions - moved dispersion to cal object.
[Previous]
[Next]
NAME:
EIS_DATA__READ
PURPOSE:
EIS_DATA__READ reads EIS data files and stores data and other
information in the object fields of an EIS_DATA class object.
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
An object of class EIS_DATA is declared with this statement:
eis_data = obj_new('eis_data')
EIS_DATA__READ reads EIS data files and stores information
into the object, with this statement:
eis_data-> read, filename [, eis_hdr = eis_hdr]
If called from within an eis_data procedure, the
EIS_DATA__READ statement looks like this:
self-> read, file [, eis_hdr = eis_hdr]
INPUTS:
file: Name of file (string) containing EIS data (and headers).
KEYWORD PARAMETERS:
eis_hdr: Set this keyword to obtain also the header
information in the form of an object of type EIS_HDR.
OUTPUTS:
Reads EIS data files and fills the parameters of the EIS_DATA
object with information.
CALLS:
CCSDS_HDR__DEFINE [1], CCSDS_HDR__DEFINE [2], CCSDS_HDR__READ [1]
CCSDS_HDR__READ [2], EIS_HDR__DEFINE [1], EIS_HDR__DEFINE [2], EIS_HDR__READ
CALLED BY:
EIS_GETMOMENTS [1], EIS_GETMOMENTS [2]
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
28-Mar-2001: Oivind Wikstol.
21-Sep-2001: Oivind Wikstol. Added documentation.
[Previous]
[Next]
NAME:
EIS_DATA__READ
PURPOSE:
EIS_HDR__READ reads EIS headers from SOLAR-B EIS packet data
files and stores header info in the instance
data of objects of class 'eis_hdr'
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
An object of class EIS_HDR is declared with this statement:
eis_hdr = obj_new('eis_hdr')
EIS_HDR__READ reads the EIS header part of EIS data files and
stores header information into the header object, with this statement:
eis_hdr-> read, lu (logical unit of EIS data file)
INPUTS:
lu: Logical unit number of EIS data file
KEYWORD PARAMETERS:
OUTPUTS:
Reads EIS header data and fills the parameters of the EIS_HDR
object with information.
CALLS:
MKU24LE, MKUINTLE, MKULONGLE
CALLED BY:
EIS_GETMOMENTS [1], EIS_GETMOMENTS [2]
COMMON BLOCKS:
PROCEDURE:
EIS_HDR__READ first reads 256 byte of data from data
packets. From these 256 bytes, all the various parameters of the
header object is filled with it's correct bits and bytes
according to the definitions of the EIS header. IDL only
has 8, 16 and 32 bit variables, while the different fields of
the EIS header can be any nymber of bits (2, 3, 4, 14, 24
etc..). Thus we store the header parameters with these data types:
Up to 8 bits: Byte variables
9-16 bits: Unsigned integers
17-32 bits: Unsigned long.
The MKUINTLE, MKU24LE and MKULONGLE functions are used to
craete the unsigned integers, 24 bit unsigned longs and 32 bit
unsigned longs from the bit stream. In addition the
bitshifting performed by ishft is used when the header data
have bit lengths other than 16, 24 and 32.
RESTRICTIONS:
MODIFICATION HISTORY:
XX-Jan-2001: Oivind Wikstol.
26-Sep-2001: Oivind Wikstol. Added documentation.
15-Feb-2005: Øivind Wikstøl. Added new hdr parameters.
03-Mar-2005: Øivind Wikstøl. Added new hdr parameters.
31-Aug-2006: Oivind Wikstol . Added compression table parameters
[Previous]
[Next]
NAME:
EIS_DATA__READCCSDS
PURPOSE:
EIS_DATA__READCCSDS reads EIS data files and stores data and other
information in the object fields of an EIS_DATA class object.
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
An object of class EIS_DATA is declared with this statement:
eis_data = obj_new('eis_data')
EIS_DATA__READ reads EIS data files and stores information
into the object, with this statement:
eis_data-> read, filename [, eis_hdr = eis_hdr]
If called from within an eis_data procedure, the
EIS_DATA__READ statement looks like this:
self-> read, file [, eis_hdr = eis_hdr]
INPUTS:
file: Name of file (string) containing EIS data (and headers).
KEYWORD PARAMETERS:
eis_hdr: Set this keyword to obtain also the header
information in the form of an object of type EIS_HDR.
OUTPUTS:
Reads EIS data files and fills the parameters of the EIS_DATA
object with information.
CALLS:
CCSDS_HDR__DEFINE [1], CCSDS_HDR__DEFINE [2], CCSDS_HDR__READ [1]
CCSDS_HDR__READ [2], EIS_HDR__DEFINE [1], EIS_HDR__DEFINE [2], EIS_HDR__READ
LITTLE_ENDIAN [1], LITTLE_ENDIAN [2]
COMMON BLOCKS:
PROCEDURE:
Description on the endian-tests: EIS CCSDS can come in the form of both
little endian and big endian files. Depending on what endianess the
computer that reads the data has, one may have to swap either header or
pixel data or both. The fact that the header and pixel data are written
to a CCSDS file as integers, while the header in EIS_HDR__READ is read
as a byte array while the pixels are read as integers complicate
the situation even more. Here is the "algorithm":
IF Computer is big_endian: Swap both header and pixels if file is
little endian. Swap nothing if file is big endian.
IF computer is little endian: Swap header but not pixels if file is
little endian. Swap pixels but not header if file is big endian.
RESTRICTIONS:
MODIFICATION HISTORY:
28-Mar-2001: Oivind Wikstol.
21-Sep-2001: Oivind Wikstol. Added documentation.
06-May-2004: Oivind Wikstol: self.hdr added
17-Jun-2004: Oivind Wikstol: Added self.filename
15-Feb-2005: Oivind Wikstol. Changed nraster added nexp_prp
26-01-2006: Oivind Wikstol - Fixed endian problem
[Previous]
[Next]
NAME:
EIS_DATA__READFITS
PURPOSE:
EIS_DATA__READFITS reads EIS data files and stores data and other
information in the object fields of an EIS_DATA class object.
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
An object of class EIS_DATA is declared with this statement:
data = obj_new('eis_data')
EIS_DATA__READFITS reads EIS data fits files and stores information
into the object, with this statement:
data-> read, filename, [hdr = hdr]
If called from within an eis_fits_data procedure, the
EIS_DATA__READFITS statement looks like this:
self-> read, file [, hdr = hdr]
INPUTS:
file: Name of fits file (string) containing EIS data (and headers).
KEYWORD PARAMETERS:
hdr: Set this keyword to obtain also the header
information in the form of an object of type EIS_FITS_HDR.
OUTPUTS:
Reads EIS data fits files and fills the parameters of the EIS_DATA
object with information.
CALLS:
FITS_HDR__DEFINE [1], FITS_HDR__DEFINE [2], FITS_HDR__READ [1]
FITS_HDR__READ [2], FITS_HDR__READ [3], FXBOPEN [1], FXBOPEN [2], FXBOPEN [3]
FXBREAD [1], FXBREAD [2], FXBREAD [3], FXBTDIM [1], FXBTDIM [2], FXBTFORM [1]
FXBTFORM [2]
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
14-Jan-2003: Oivind Wikstol.
20-APR-2004: Oivind Wikstol - Cleaned up
17-Jun-2004: Oivind Wikstol: Added self.filename
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_data_extraction_window__DEFINE
Purpose : Generates structure EIS_data_extraction_window.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_data_extraction_window. Tags are :-
description : STRING mnemonic for data extraction window
xstart : UINT window X start in CCD coordinates.
Range 0-2147 (the range limits depend on the readout node).
xsize : UINT window X size in pixels.
Range 1-2148 (the range limits depend on the readout node).
node : UINT readout node :
0 : CCDA(CCD0) right hand side
1 : CCDA(CCD0) left hand side
2 : CCDB(CCD1) right hand side
3 : CCDB(CCD1) left hand side
EIS_AEC_line_flag : UINT flag indicating whether the line is to be used for
AEC (1) or not (0).
EIS_event_line_flag : UINT flag indicating whether the line is to be used for
EIS events (1) or not (0).
EIS_flare_line_flag : UINT flag indicating whether the line is to be used for
EIS flare events (1) or not (0).
Use : <dummy = {EIS_data_extraction_window>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.1, 22/09/04, MKC
Removed readout_sequence_flag tag.
Version 0.2, 16/11/04, MKC
Added description tag.
Version 0.3, 24/06/05, MKC
Changed INT values to UINT.
Version : 0.3, 24/06/05, MKC
[Previous]
[Next]
NAME:
eis_datetime_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
eis_db_save_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_DELETE_TIMELINE_ENTRY
CATEGORY
EIS planning
PURPOSE
Function to update an "as-planned" database entry
INPUTS
WRITTEN
John A Rainnie, RAL
VERSION
V0.0 August 2005
CALLS:
CALLED BY
eis_timeline_container__define [1], eis_timeline_container__define [2]
[Previous]
[Next]
NAME:
eis_dr_obj__DEFINE
PURPOSE:
This procedure defines the data memebers of the
Object "eis_dr_obj".
INPUTS:
ll - an eis_line_list structure
AUTHOR:
John A. Rainnie - RAL (j.a.rainnie@rl.ac.uk)
CALLS:
[Previous]
[Next]
Project : SOLAR-B/EIS
Name : EIS_DROT_FOV
Purpose : Differentially rotate FOV structure
Category : Planning
Syntax : IDL> dfov=eis_drot_fov(fov,interval)
Inputs : FOV = FOV structure
Outputs : Diff rotated FOV structure
Keywords : See ROT_XY
CALLS: ***
ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2], ROT_XY, VALID_TIME, is_number [1]
is_number [2]
CALLED BY:
EIS_IMAGE_TOOL [1], EIS_IMAGE_TOOL [2], EIS_ITOOL_PTOOL [1]
EIS_ITOOL_PTOOL [2]
History : 16-May-2006, Zarro (L-3Com/GSFC) - written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_EISE_CONTROL_TO_PROPS
PURPOSE
Procedure to do something or another!
CATEGORY
EIS Timeline Planning
INPUTS
st - an eis_study structure
eise_control -
KEYWORDS
None
MODIFICATION HISTORY
V0.0 Written by John Rainnie (JAR), RAL, Dec 2005
CALLED BY
eis_mk_study_gui [1], eis_mk_study_gui [2]
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
eis_eise_PROPS_TO_CONTROL
PURPOSE
Procedure to do something or another!
CATEGORY
EIS Timeline Planning
INPUTS
st - an eis_study structure
eise_control -
KEYWORDS
None
MODIFICATION HISTORY
V0.0 Written by John Rainnie (JAR), RAL, Dec 2005
CALLED BY
eis_mk_study_gui [1], eis_mk_study_gui [2]
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_eisf_CONTROL_TO_PROPS
PURPOSE
Procedure to do something or another!
CATEGORY
EIS Timeline Planning
INPUTS
st - an eis_study structure
eisf_control -
KEYWORDS
None
MODIFICATION HISTORY
V0.0 Written by John Rainnie (JAR), RAL, Dec 2005
CALLED BY
eis_mk_study_gui [1], eis_mk_study_gui [2]
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_EISF_PROPS_TO_CONTROL
PURPOSE
Procedure to do something or another!
CATEGORY
EIS Timeline Planning
INPUTS
st - an eis_study structure
eisf_control -
KEYWORDS
None
MODIFICATION HISTORY
V0.0 Written by John Rainnie (JAR), RAL, Dec 2005
CALLED BY
eis_mk_study_gui [1], eis_mk_study_gui [2]
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_engineering_detail__DEFINE
Purpose : Generates structure EIS_engineering_detail.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_engineering_detail. Tags are :
study_filename : STRING filename of type 'directory/description.eng_ssss_bbbb'
where
description : is some text describing the purpose of the engineering study;
eng : is the 3 character string 'eng'.
ssss : is the 4 digit duration in seconds;
bbbb : is the 4 digit number of Kbytes of data generated by the engineering study
description : STRING a description of the engineering study.
duration : DOUBLE indicates the expected duration
in seconds of the engineering sequence table..
data : ULONG the amount of data in bytes expected
from running the engineering sequence table.
slit_slot : structure of type EIS_mechanism_change.
linelist_filenames : STRARR[3] filenames of linelists associated with the engineering study.
If no linelist associated with the engineering study then these
should be blank. NB Only three linelists associated with the engineering
study is supported.
linelist_descriptions : STRARR[3] descriptions of the engineering linelists. Blank if no linelists.
linelist_indexes : UINTARR[3] indexes used to reference the linelists within study.
Use : <dummy = {EIS_engineering_detail>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.1, 13/09/04, MKC
Changed sequence to sequence_table in tags.
Added bakeout_flag and ground_command_flag tags.
Version 0.2, 23/09/04, MKC
Changed engineering study file name.
Fixed sequence_table_number tag.
Version 0.3, 03/11/04, MKC
Added description, duration and data tags to EIS_engineering_detail.
Version 0.4, 16/11/04, MKC
Changed type of some values so cannot be negative.
Version 0.5, 09/12/04, MKC
Added slit_slot and coarse_mirror tags.
Version 0.6, 17/01/05, MKC
Removed coarse_mirror tag.
Version 0.7, 06/05/05, MKC
Removed bakeout_flag, number_of_sequence_tables and sequence_table_number tags.
Renamed ground_command_flag tag to onboard.
Added engineering linelist filename tag.
Added linelist_description tag,
Version 0.8, 11/07/05, MKC
Removed engineering from tag names.
Removed onboard tag.
Version 0.9, 11/10/06, MKC
Added multiple linelist filenames.
Added linelist indexes.
Version : 0.9, 11/10/06
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_engineering_parameters__DEFINE
Purpose : Generates structure EIS_engineering_parameters.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_engineering_parameters. Tags are :
CAM_readout_parameters : Structure of type EIS_CAM_readout.
XRT_flare_parameters : structure of type EIS_XRT_flare_parameters.
EIS_flare_parameters : structure of type EIS_flare_parameters.
mechanism_control : structure of type EIS_mechanism_control
bakeout_parameters : structure of type EIS_bakeout_parameters
AEC_exposure_time_table : ULONG[28] exposure times in 10ms units corresponding to exposure IDs.
safety_margin_time : DOUBLE time in seconds after which can re-use a sequence table or
line list table entry after it is last used.
event_safety_margin_time : DOUBLE time in seconds after which can re-use an event control table
after it is last used.
AEC_safety_margin_time : DOUBLE time in seconds after which can an AEC control table after
it is last used.
OBSTBL_memory_command_time : UINT time in milliseconds to upload a single 14 byte chunk of
OBSTBL memory (150 milliseconds).
Use : < dummy = {EIS_engineering_parameters} >
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.1, 21/09/04, MKC
Removed automatic state version.
Version 0.2, 29/09/04, MKC
Renamed mechanism tag mechanism_control.
Renamed XRT_flare tag XRT_flare_control.
Renamed EIS_flare tag EIS_flare_control.
Renamed EIS_event tag EIS_event_control.
Version 0.3, 14/10/04, MKC
Added AEC_exposure_time_table.
Version 0.4, 20/10/04, MKC
Added safety_margin_time.
Added EIS OBSTBL RAM sub ID.
Version 0.5, 30/11/04, MKC
Moved flush_CCDS to EIS_CAM_READOUT.
Version 0.6, 14/02/05, MKC
Added special and AEC safety margin times.
Version 0.7, 23/02/05, MKC
Renamed special safety margin times.
Version 0.8, 28/02/05, MKC
Renamed EIS XRT flare control, EIS flare control
to EIS XRT flare parameters, EIS flare parameters.
Removed EIS event control structure.
Moved OBSTBL RAM sub ID.
Version 0.9, 24/06/05, MKC
Changed INT values to UINT.
Changed saftey margin times to ULONGs.
Version 1.0, 08/09/05, MKC
Added eis bakeout parameters structure tag.
Version 1.1, 25/09/05, MKC
Added OBSTBL_memory_command_time tag.
Version : 1.1, 25/09/05
[Previous]
[Next]
Project :SolarB EIS
Name :eis_engineering_state
Purpose :Defines the eis_engineering_state data structure
Category :EIS planning
Author :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0, dated February 2005
CALLS:
[Previous]
[Next]
Project : SOLAR-B/EIS
Name : EIS_ENV_INI
Purpose : Extract system parameters for EIS_MK_PLAN from environment variables
in file "setup.eis_env"
Category : planning
Syntax : IDL> eis_env_ini,system_data,status=status
Inputs : SYSTEM_DATA = structure defined by {eis_system_data}
Outputs : SYSTEM_DATA = structure with fields populated from environment variables
Keywords : STATUS = 1/0 if successful or not
CALLS: ***
IS_STRING, LOCAL_NAME, is_struct
History : Written, 30-May-2006, Zarro (L-3Com/GSFC)
Modified, 4-July-2006, Zarro (ADNET/GSFC)
- fixed ANCILLARY definition.
Contact : dzarro@solar.stanford.edu
[Previous]
[Next]
NAME:
EIS_ENVIRONMENT
PURPOSE:
Sets up data sources and directories to search for data for
the XFILES procedure. The user should edit this files in order
to set it up for personal use. Note that the data source
"OTHER" must always be present as the last item on the list
(could also be the only one).
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
@environment (called by XFILES and XDISPLAY)
INPUTS:
None
KEYWORD PARAMETERS:
OUTPUTS:
Objects of class HW_AUX includes the following parameters:
dsource: List of sources of data (e.g. instruments)
that the user want to use the analysis SW
on.
dsource_dir: For each source of data, this variable tells
the analysis SW (XFILES) the default
directory to search for data.
CALLS:
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
01-Sep-2001: Oivind Wikstol
03-Oct-2001: Oivind Wikstol. Added documentation.
11-Apr-2002: Viggo Hansteen. Added scfac variable
28-Oct-2002: Ronald Yurow. Complete Rewrite.
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_event_control__DEFINE
Purpose : Generates structure EIS_event_control.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_event_control. Tags are :
response_identifier : ULONG number uniquely identifying the study
to be run if an EIS event occurs.
0 if no response to an EIS flare event.
raster_identifier : ULONG specifies which raster in the event study the autonomous
repointing is applied to ( if required).
Last 16 bits must not be 0 or 0xFFFF.
adjust_Y : UINT flag indicating whether repointing in the Y
direction by changing the window height and the
camera readout window is allowed (1) or not (0).
adjust_X : UINT flag indicating whether repointing in the X
direction using the fine mirror is allowed (1) or not (0).
X_threshold : UINT threshold used for row sums.
Y_threshold : UINT threshold used for column sums.
X_min_limit : UINT number of consecutive samples above threshold
which are required for a flare trigger, range 1-7.
Y_min_limit : UINT number of consecutive samples above threshold
which are required for a flare trigger, range 1-7.
Use : <dummy = {EIS_event_control}>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.1, 23/09/04, MKC
Changed ystart and yheight tags to ULONG.
Version 0.2, 24/02/05, MKC
Removed ystart and yheight tags.
Moved parameters from EIS event response.
Version 0.3, 24/06/05, MKC
Changed INT values to UINT.
Added X_threshold, Y_threshold.
Version 0.4, 04/07/05, MKC
Added number of rasters tag..
Version 0.5, 08/09/05, MKC
Changed raster number/ number of rasters tag to raster identifier.
Version 0.6, 19/06/06, MKC
Changed tag study identifier.
Version : 0.6, 19/06/06
[Previous]
[Next]
NAME:
eis_event_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
eis_event_ll_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
eis_export_filename_generate
PURPOSE:
Function to return a filename for eis_export_* - and to open
it for writing
CATEGORY:
EIS Technical Planning
INPUTS:
acronym - one of linelist/raster/study
CALLED BY:
eis_mk_raster_gui__define [1], eis_mk_raster_gui__define [2]
eis_mk_study_gui [1], eis_mk_study_gui [2], eis_study_gui [1]
eis_study_gui [2]
MODIFICATION HISTORY:
Written by: John Rainnie, RAL (Jan 2006)
[Previous]
[Next]
NAME:
eis_export_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
eis_export_study
PURPOSE
Procedure
CATEGORY
EIS Technical Planning
INPUTS
st - eis_study structure
MODIFICATION HISTORY
V0.0
Written by: John Rainnie, RAL (March 2006)
CALLS:
CALLED BY
eis_mk_study_gui [1], eis_mk_study_gui [2], eis_study_gui [1]
eis_study_gui [2]
[Previous]
[Next]
NAME:
eis_exposure_times_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
EIS_FITS_CALIB
PURPOSE:
Adds keywords related Calibration and data reduction
to the primary header of the EIS FITS file.
CATEGORY:
EIS Data Processing Software.
CALLING SEQUENCE:
eis_fits_calib, header, md_hdr
INPUTS:
header: The primary header which will have keywords added to it.
md_hdr: EIS Mission Data header object array
calstat: Calibration status structure
KEYWORD PARAMETERS:
OUTPUTS:
The extended primary header
CALLS: ***
FXADDPAR [1], FXADDPAR [2]
CALLED BY:
EIS_MKFITS [1], EIS_MKFITS [2]
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
November 2002: Øivind Wikstøl.
23-nov-2005: Øivind Wikstøl - Added calibration status: calstat
[Previous]
[Next]
NAME:
EIS_FITS_COORD
PURPOSE:
Adds keywords related to coordinates (pointing, SC attitude etc.)
to the primary header of the EIS FITS file.
CATEGORY:
Data Processing Software
CALLING SEQUENCE:
eis_fits_coord, header, md_hdr
INPUTS:
header: The primary header which will have keywords added to it.
md_hdr: EIS Mission Data header object array
plan: EIS planning object
KEYWORD PARAMETERS:
none
OUTPUTS:
The extended primary header
CALLS: ***
FXADDPAR [1], FXADDPAR [2], IS_STRING
CALLED BY:
EIS_MKFITS [1], EIS_MKFITS [2]
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
November 2002: Øivind Wikstøl.
august 2006: Changed pointing from plan to spcd
CRPIX still uncertain where they will come from. Hardcoded to 0!!!
[Previous]
[Next]
NAME:
EIS_FITS_DATAID
PURPOSE:
Adds keywords related to data identification (Data ID)
to the primary header of the EIS FITS file.
CATEGORY:
Data Processing Software
CALLING SEQUENCE:
eis_fits_dataid, header
INPUTS:
header: The primary header which will have keywords added to it.
md_hdr: EIS Mission Data header object array
plan: EIS planning object
KEYWORD PARAMETERS:
none
OUTPUTS:
The extended primary header
CALLS: ***
FXADDPAR [1], FXADDPAR [2], GET_UTC
CALLED BY:
EIS_MKFITS [1], EIS_MKFITS [2]
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
November 2002: Øivind Wikstøl.
[Previous]
[Next]
NAME:
EIS_FITS_OBSTIME
PURPOSE:
Adds keywords related to observation time
to the primary header of the EIS FITS file.
CATEGORY:
Data Processing Software
CALLING SEQUENCE:
eis_fits_obstime, header
INPUTS:
header: The primary header which will have keywords added to it.
md_hdr: EIS Mission Data header object array
plan: EIS plannnig object
KEYWORD PARAMETERS:
none
OUTPUTS:
The extended primary header
CALLS: ***
FXADDPAR [1], FXADDPAR [2]
CALLED BY:
EIS_MKFITS [1], EIS_MKFITS [2]
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
November 2002: Øivind Wikstøl.
August 2006 : Added exptime
NOTE: DATE_OBS AND DATE_END ARE IN WRONG FORMAT. NO TIME
CONVERSION BETWEEN TI AND UTC AVAILABLE!!!
19 september: OW - Removed exptime
[Previous]
[Next]
NAME:
EIS_FITS_SCRIPT
PURPOSE:
Makes FITS files out of telemetry packets for the
EIS instrument on Solar-B from a list of CCSDS files.
CATEGORY:
EIS Data Processing Software
CALLING SEQUENCE:
eis_fits_script, flist (, dir = dir, /keep_name)
INPUTS:
flist: list of CCSDS files
KEYWORD PARAMETERS:
dir: specify where you want your fits files output
keep_name: Keep same name as CCSDS files. If not set, time
information in mission data header will be used
to create file name
OUTPUTS:
A list of FITS files
CALLS: ***
EIS_MKFITS [1], EIS_MKFITS [2], FNAME_EXTRACT, pwd [1], pwd [2]
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
In order for the program to find the input files in flist,
the program must be run from the directory where the flist
files are located, OR the file name sin flist must include
the directory structure
MODIFICATION HISTORY:
2004-10-20: Øivind Wikstøl - First version.
[Previous]
[Next]
Project : Solar-B/EIS >
>
Name : EIS_FITS_URL >
>
Purpose : return URL and path to EIS FITS data file for
specified time
>
Category : sockets >
>
Inputs : DATE = time/date of file (e.g. 01:00 1-May-01)
or filename EIS_010203_0300.fits >
>
Outputs : URL = of file location
Keywords : None
>
CALLS: ***
EIS_SERVER [1], EIS_SERVER [2], FILE2TIME, IS_BLANK, TIME2FID, VALID_TIME
CALLED BY:
EIS_CAT [1], EIS_CAT [2]
History : 1-June-2006, D.M. Zarro (L-3Com/GSFC), Written >
>
Contact : DZARRO@SOLAR.STANFORD.EDU >
function eis_fits_url,date,err=err,_ref_extra=extra
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_flare_control__DEFINE
Purpose : Generates structure EIS_flare_control.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_flare_control. Tags are :
response_identifier : ULONG number uniquely identifying the study
to be run if an EIS flare occurs.
0 if no response to an EIS flare.
raster_identifier : ULONG specifies which raster in the flare study the autonomous
repointing is applied to ( if required).
Last 16 bits must not be 0 or 0xFFFF.
adjust_Y : UINT flag indicating whether repointing in the Y
direction by changing the window height and the
camera readout window is allowed (1) or not (0).
adjust_X : UINT flag indicating whether repointing in the X
direction using the fine mirror is allowed (1) or not (0).
locate_Y : UINT flag indicating whether to use flare peak (0) or
centre (1) for Y flare location.
locate_X : UINT flag indicating whether to use flare peak (0) or
centre (1) for X flare location.
X_threshold : UINT threshold used for row sums.
Y_threshold : UINT threshold used for column sums.
X_min_limit : UINT number of consecutive samples above threshold
which are required for a flare trigger, range 1-255.
Y_min_limit : UINT number of consecutive samples above threshold
which are required for a flare trigger, range 1-255.
Use : <dummy = {EIS_flare_control>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.1, 23/09/04, MKC
Changed ystart and yheight tags to ULONG.
Changed x_threshold and y_threshold to ULONG.
Version 0.2, 24/02/05, MKC
Moved parameters from EIS flare response.
Version 0.3, 24/06/05, MKC
Changed INT values to UINT.
Version 0.4, 04/07/05, MKC
Added number of rasters tag..
Version 0.5, 08/09/05, MKC
Changed raster number/ number of rasters tag to raster identifier.
Version 0.6, 19/06/06, MKC
Changed tag study identifier.
Version : 0.6, 19/06/06
[Previous]
[Next]
NAME:
eis_flare_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_flare_parameters__DEFINE
Purpose : Generates structure EIS_flare_parameters.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_flare_parameters. Tags are :
left_repointing : UINT flag indicating whether to add (1) or subtract (0)
to fine mirror position. Must be set to 0.
right_repointing : UINT flag indicating whether to add (1) or subtract (0)
to fine mirror position. Must be set to 1.
EIS_P_Size : UINT 100* EIS pixel size in arcseconds, range 1-255.
Use : <dummy = {EIS_flare_parameters>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.1, 23/09/04, MKC
Changed ystart and yheight tags to ULONG.
Changed x_threshold and y_threshold to ULONG.
Version 0.2, 24/02/05, MKC
Renamed from EIS flare response define.
Moved some parameters from EIS flare control..
Version 0.3, 24/06/05, MKC
Changed INT values to UINT.
Version : 0.3, 24/06/05, MKC
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_FORMAT_DURATION
PURPOSE
Function to calculate the duration of an eis_study (milliseconds)
CATEGORY
EIS technical planning
CALLS: ***
SEC2DHMS
CALLED BY:
eis_mk_plan_gui [1], eis_mk_plan_gui [2], eis_mk_raster_gui__define [1]
eis_mk_raster_gui__define [2], eis_mk_study_gui [1], eis_mk_study_gui [2]
eis_study_gui [1], eis_study_gui [2]
MODIFICATION HISTORY:
Written, Feb 2005 - Chunkey Lepine, RAL
[Previous]
[Next]
Project : SOLAR-B/EIS
Name : EIS_FOV
Purpose : Return EIS FOV structure
Category : Planning
Syntax : IDL> fov=eis_get_fov()
Inputs : XCEN, YCEN = center coordinates (arcsecs) [def = 0,0]
Outputs : STC = EIS FOV structure
Keywords : DATE_OBS = time [def = current date/time]
CALLS: ***
GET_UTC, VALID_TIME, is_number [1], is_number [2]
CALLED BY:
EIS_IMAGE_TOOL [1], EIS_IMAGE_TOOL [2]
History : 16-Aug-2006, Zarro (ADNET/GSFC) - written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project :SolarB EIS
Name :eis_generate_linelist_title
Purpose :Used for eis_mk_raster interface
Category :EIS technical planning
Input :structure of type eis_line_list
Output :string
Written :John Rainnie
Version :V0 October 2005
CALLED BY
eis_ll_obj__DEFINE [1], eis_ll_obj__DEFINE [2]
[Previous]
[Next]
Project :SolarB EIS
Name :eis_generate_raster_title
Purpose :Used for eis_mk_raster interface
Category :EIS technical planning
Input :structure of type eis_raster
Output :string
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 October 2005
CALLED BY
db_save_raster_entry_create [1], db_save_raster_entry_create [2]
eis_import_study_gui, eis_mk_raster_gui__define [1]
eis_mk_raster_gui__define [2]
[Previous]
[Next]
Project :SolarB EIS
Name :eis_get_aec_exposure_table
Purpose :generates list of AEC exposure times
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
History ;June 2005, updated using JM results
CALLED BY
eis_aec_widgets [1], eis_aec_widgets [2]
[Previous]
[Next]
Project :SolarB EIS
Name :eis_get_as_string_arry
Purpose :overcomes problem with reading strings from database
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name :eis_get_bakeout_periods
Purpose :populate eis_bakout_period structure by querying timeline
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 June 2005
CALLS:
[Previous]
[Next]
NAME:
EIS_GET_CCD_TRANSLATION
PROJECT:
SOLAR-B/EIS
PURPOSE:
Returns the polynomial coefficients required to convert detector
pixel positions into wavelengths.
Polynomials up to n=4 are allowed.
OUTPUT:
A 2-element structure containing the following tags:
a0 - coefficient for p^0
a1 - coefficient for p^1
a2 - coefficient for p^2
a3 - coefficient for p^3
a4 - coefficient for p^4
CALLED BY:
EIS_WAVELENGTH_TO_PIXELS [1], EIS_WAVELENGTH_TO_PIXELS [2]
eis_pixel_to_wavelength [1], eis_pixel_to_wavelength [2]
eis_plot_spectrum [1], eis_plot_spectrum [2]
HISTORY:
Ver.1, 16-May-2006, Peter Young
NOTES:
Coefficients taken from Lang et al. (2006) EIS calibration paper.
Only a 2nd order polynomial fit was used.
[Previous]
[Next]
Project :SolarB EIS
Name :eis_get_coarse_mirror_commands
Purpose :Used for eis_cpt interface
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name :eis_get_contact_periods
Purpose :populate eis_contact_period structure by querying timeline
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 June 2005
CALLS:
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_GET_CONTROL
Purpose : Gets control details for the current list of timeline studies
Inputs : None..
Category : EIS_CPT.
Written : Martin Carter RAL 28/02/05
Modified : Version 0.0, 28/02/05, MKC
Version 0.1, 26/06/05, MKC
Added response and adjust_y tags.
CALLED BY
eis_cpt_gui [1], eis_cpt_gui [2]
[Previous]
[Next]
Project :SolarB EIS
Name :eis_get_current_time
Purpose :
Category :EIS planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 September 2005
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name :eis_get_db_name
Purpose :supplies name of EIS database table given keyword
:serves to keep all table-name definitions in one place
Category :EIS planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 March 2005
CALLED BY
eis_open_db [1], eis_open_db [2]
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
eis_get_engineering
PURPOSE
extract appropriate records and place in
eis_engineering_parameters structure
CATEGORY
EIS timeline planning
MODIFICATION HISTORY
V0.0 Chunkey, February 2005
V0.1 John Rainnie, June 2006
CALLS:
CALLED BY
eis_cpt_gui [1], eis_cpt_gui [2]
[Previous]
[Next]
Project :SolarB EIS
Name :eis_get_engineering_state_list
Purpose :EIS planning
Category :EIS planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name :eis_get_esdb_details
Purpose :Used for primarily for eis_cpt interface
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
CALLS:
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
eis_get_events_filename
PURPOSE:
Function to generate a list of filenames
CATEGORY:
EIS Timeline Planning
INPUTS:
None
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], EIS_CREATE_JSIDE_FILENAMES
concat_dir [4]
MODIFICATION HISTORY:
V0.0 Written by John Rainnie (RAL) 23 Aug 2006
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
eis_get_events_filename
PURPOSE:
Function to generate a list of filenames
CATEGORY:
EIS Timeline Planning
INPUTS:
None
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
DATE_CODE, GET_UTC, concat_dir [4]
MODIFICATION HISTORY:
V0.0 Written by John Rainnie (RAL) 23 Aug 2006
[Previous]
[Next]
Project : EIS
Name : EIS_GET_HDR
Purpose : Read the FITS header keywords from an EIS fits files
Category : FITS I/O
Syntax : IDL> hdr = EIS_GET_HDR (filename, [path], [KEYWORDS])
Inputs : filename = Input file name
path = Path to use to search for FITS file. Defaults to the
current working directory.
Outputs : hdr = An N*2 array of strings containing the Keyword/Value
derived from the fits file header.
Keywords : ERR = Error string written by the function if something fails.
KEY = List of keywords used in the FITS header
VAL = List of values used in the FITS header
LIST = Return header information as an arrary of structures.
Each structure has the following tags :
KEY : "STRING" The keyword from the header.
VAL : "STRING" The corresponding value.
QUIET = Set to true to supress printing messages.
Written : Based on MRD_HEAD, Zarro (EIT/GSFC), 13 Aug 2001
Contact : yurow@cdso8.nascom.nasa.gov
CALLS:
CALLED BY
EIS_ADD_FITS_FILE [1], EIS_ADD_FITS_FILE [2]
[Previous]
[Next]
Project :SolarB EIS
Name :eis_get_science_details
Purpose :Used for eis_cpt interface
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
: study_id keyword added September 2005
CALLS:
CALLED BY
eis_get_science_entry [1], eis_get_science_entry [2]
[Previous]
[Next]
Project :SolarB EIS
Name :eis_get_science_details
Purpose :Used for eis_cpt interface
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
CALLS:
CALLED BY
eis_get_science_entry [1], eis_get_science_entry [2]
[Previous]
[Next]
Project :SolarB EIS
Name :eis_get_science_entry
Purpose :Used for eis_cpt interface
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
:STUDY_ID keyword added September 2005
CALLS:
CALLED BY
EIS_GET_STUDY [1], EIS_GET_STUDY [2], EIS_PLAN__DEFINE [1]
EIS_PLAN__DEFINE [2], EIS_READ_TIMELINE_DATABASE_TABLES [1]
EIS_READ_TIMELINE_DATABASE_TABLES [2]
[Previous]
[Next]
Project :SolarB EIS
Name :eis_get_science_raster_entry
Purpose :Used for eis_cpt interface
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
CALLS:
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
EIS_GET_STUDY
PURPOSE:
Extract appropriate records and place in either eis_raster_detail
or eis_engineering_detail structure
CATEGORY:
EIS timeline planning
EIS CPT
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DB_READ_STUDY_ENTRY
EIS_WAVELENGTH_TO_PIXELS [1], EIS_WAVELENGTH_TO_PIXELS [2], concat_dir [4]
db_read_linelist_entry [1], db_read_linelist_entry [2]
db_read_raster_entry [1], db_read_raster_entry [2]
eis_get_science_entry [1], eis_get_science_entry [2]
eis_raster_angle_to_mirror_step [1], eis_raster_angle_to_mirror_step [2]
eis_wavelength_to_node [1], eis_wavelength_to_node [2]
CALLED BY:
EIS_CPT_CHECK_EVENT_RESPONSE_STUDY [1]
EIS_CPT_CHECK_EVENT_RESPONSE_STUDY [2], EIS_CPT_GET_CONTROL [1]
EIS_CPT_GET_CONTROL [2], EIS_CPT_LIST_STUDY_DETAILS [1]
EIS_CPT_LIST_STUDY_DETAILS [2], EIS_CPT_PROCESS_RESPONSE_STUDIES [1]
EIS_CPT_PROCESS_RESPONSE_STUDIES [2], EIS_CPT_PROCESS_STUDIES [1]
EIS_CPT_PROCESS_STUDIES [2], EIS_CPT_PROCESS_TIMELINE_STUDIES [1]
EIS_CPT_PROCESS_TIMELINE_STUDIES [2]
MODIFICATION HISTORY:
V0 Written by Chunkey Lepine, RAL, February 2005
[Previous]
[Next]
PROJECT
Solar-B EIS
NAME
EIS_GET_STUDY_DESCRIPTIONS_PATH
PURPOSE
Function to return the pathName of a study description file
INPUTS
None
OUPUTS
path
CATEGORY
EIS Technical Planning - eis_mk_study & eis_mk_plan
CALLS: ***
PATH_SEP, eis_get_zdbase [1], eis_get_zdbase [2], str_replace [1]
str_replace [2]
CALLED BY:
db_save_study_entry_create [1], db_save_study_entry_create [2]
db_save_study_entry_create [3], db_save_study_entry_create [4]
eis_view_study_descriptions [1], eis_view_study_descriptions [2]
MODIFICATION HISTORY:
V0.0 Written by: John Rainnie, RAL
j.rainnie@rl.ac.uk (Feb 2006)
V0.1 JAR 16 Aug 2006
Much simplified - using environment variables
[Previous]
[Next]
Project :SolarB EIS
Name :eis_get_study_details
Purpose :Used for eis_cpt interface
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
[Previous]
[Next]
Project :SolarB EIS
Name :eis_get_study_raster_entry
Purpose :Used for eis technical planning and external interface
Category :EIS technical and timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
:June 2005 updated to do DB search and (keyword) return of entry[0]
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name :eis_get_technical_study_rasters
Purpose :Used for eis_cpt interface
Category :EIS technical/timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
CALLS:
[Previous]
[Next]
Project
SolarB EIS
Name
EIS_GET_TIMELINE_DETAILS
Purpose
Function to extract values from the timeline database
Category
EIS timeline planning
Written
Chunkey Lepine, RAL - February 2005
Version
V0 February 2005
V1 John Rainnie
CALLS:
CALLED BY
eis_get_timeline_entries [1], eis_get_timeline_entries [2]
[Previous]
[Next]
Project
SolarB EIS
Name
EIS_GET_TIMELINE_ENTRIES
Purpose
Find entry numbers for records within time range and matching
specific timeline-entry type(s)
Category
EIS timeline planning
Written
Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version
V0.0 February 2005
Changed June 2005, returns timeline details, keyword handling
improved
V0.1 Definition of entry types changed, August 2005
CALLS:
CALLED BY
EIS_READ_TIMELINE_DATABASE_TABLES [1]
EIS_READ_TIMELINE_DATABASE_TABLES [2], eis_get_bakeout_periods [1]
eis_get_bakeout_periods [2], eis_get_coarse_mirror_commands [1]
eis_get_coarse_mirror_commands [2], eis_handle_get_suspension_periods [1]
eis_handle_get_suspension_periods [2], eis_list_real_command_sequences [1]
eis_list_real_command_sequences [2]
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
eis_get_total_raster_width_string
PURPOSE:
Function to create a string label on eis_mk_raster
CATEGORY:
EIS Technical Planning
INPUTS:
ra - an eis_raster structure
OPTIONAL INPUTS:
None
CALLED BY:
eis_mk_raster_gui__define [1], eis_mk_raster_gui__define [2]
MODIFICATION HISTORY:
Written by: John Rainnie, RAL - j.rainnie@rl.ac.uk (Dec 2005)
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
eis_get_xrt_flare_study_details
PURPOSE:
Extract appropriate records and place in either eis_raster_detail
or eis_engineering_detail structure
CATEGORY:
EIS timeline planning
EIS CPT
CALLS: ***
DB_READ_STUDY_ENTRY
CALLED BY:
eis_cpt_gui [1], eis_cpt_gui [2]
MODIFICATION HISTORY:
V0.0 Written by John Rainnie, RAL, June 2006
[Previous]
[Next]
PROJECT
Solar-B EIS
NAME
EIS_GET_ZDBASE
PURPOSE
Function to test whether any windows overlap. This is done for
each CCD separately.
INPUTS
none
OUPUTS
zdbase = 0 / 1 indicating OFFICIAL / USER
CATEGORY
EIS Technical Planning
Database
MODIFICATION HISTORY
V0.0 Written by: John Rainnie, RAL
j.rainnie@rl.ac.uk (Feb 2006)
V0.1 Changed routine to split up ZDBASE into an array of
pathnames. Then see if the environment variable
'EIS_PLAN_DB' is there. If it is, then we know ZDBASE is
pointing to OFFICIAL. JAR 16 Aug 2006
CALLED BY
EIS_CHECK_DATABASE [1], EIS_CHECK_DATABASE [2], db_read_linelist_all [1]
db_read_linelist_all [2], db_read_raster_all [1], db_read_raster_all [2]
db_read_study_all [1], db_read_study_all [2]
eis_get_study_descriptions_path [1], eis_get_study_descriptions_path [2]
eis_linelist_gui [1], eis_linelist_gui [2], eis_mk_plan_gui [1]
eis_mk_plan_gui [2], eis_raster_gui [1], eis_raster_gui [2], eis_study_gui [1]
eis_study_gui [2], eis_view_study_descriptions [1]
eis_view_study_descriptions [2]
[Previous]
[Next]
NAME:
EIS_GETDATA
PURPOSE:
EIS_GETDATA is a script to extract data (one, sevceral or all
line windows) from a (FITS or CCSDS) data file.
CATEGORY:
Hansteen/Wikstol EIS data analysis SW
CALLING SEQUENCE:
eis_getdata, file, wd, (iwin = iwin, /all,hdr = hdr ,/ccsds)
INPUTS:
file: Name of file (string) containing EIS data (and
headers). CCSDS or FITS file. FITS is default.
KEYWORD PARAMETERS:
iwin: The line number indexes (starting with 0, max 24.)
all: Set this to get all line windows.
hdr: set this keyword to get hdr information
ccsds: set this keyword if telemetry file. Standard is fits.
OUTPUTS:
wd: The line window data (wd[lambda, slit, raster])
hdr: The FITS/MD (EIS Missio Data header) - optionally
CALLS:
EIS_DATA__READ and eis_data methods. Optionally also eis_hdr methods.
CALLED BY:
EIS_MOVIE_PREP [1], EIS_MOVIE_PREP [2]
COMMON BLOCKS:
PROCEDURE:
example 1: Get line window 0 and hdr from CCSDS file1= 'file1.dat':
IDL> eis_getdata, file1, wd, hdr=hdr, /ccsds
If e.g 32 pixel wide line window *wavelength,
512 slit pos. and 100 raster pos, the dimension of
wd will now be: wd = uint[32, 512, 100]
example 2: Get line windows 2 and 3 from fitsfile file2='file2.fits':
IDL> eis_getdata, file2, wd, iwin=[2,3]
If same dimensions as above, wd will now be:
wd = uintarr[32, 512, 100, 2], i.e.
wd[nlam, nslit, nraster, nwin]
example 3: Get all 25 line windows and hdr from FITS file 'file2.fits'
IDL>eis_getdata, file2, hdr=hdr, /all
wd is now uintarr[32, 512, 100, 25]
RESTRICTIONS:
MODIFICATION HISTORY:
01-Mar-2004: Oivind Wikstol.
18-Oct-2004: Oivind Wikstol. Added hdr and iwin keywords.
28-Oct-2004: Oivind Wikstol. Added documentation.
[Previous]
[Next]
NAME:
EIS_GETMOMENTS
PURPOSE:
EIS_GETMOMENTS is a script to calculate moments from one,
several or all spectral line windows from a (fits or CCSDS) data file.
CATEGORY:
Hansteen/Wikstol EIS data analysis SW
CALLING SEQUENCE:
eis_getdata, file, iwin, int, vel, wid, (iwin=iwin, all=all,
/gauss, /moment, /line_def, /lamtype, /ccsds)
INPUTS:
file: Name of file (string) containing EIS data (and
headers).
KEYWORD PARAMETERS:
iwin: The line number indexes (starting with 0, max 24.)
all: process all line windows
gauss: set this to use gaussian fits to calculate int, vel, wid.
moment: (Default) Use moments to calculate int, vel, wid
line_def: Use pre-stored pixel definitions for line and
continuum. These are stored in text files, as pixels defining
where on the CCD the spectral line and it's (to be subtracted)
continuum is. If the line ID is 'Line 0' then these pixel
definitions should be stores in a file called
'line_def_0.tmp'. If no line definitions are available, the
user will be presented with a widget where an average line
profile is plotted, and the pixel defintions are set
interactively.
lamptype: Can take two values: lamtype='pix' (DEFAULT) for
pixel wavelength scale or lamtype='wav' for wavelength scale
in Ångstrøm.
ccsds: set this keyword if telemetry file. Standard is fits.
OUTPUTS:
int: intensity (0th order moment). Normally int[x,y, nwin]
vel: velocity (1st order momemt). Normally vel[x,y, nwin]
wid: width (2nd order moment). Normally wid[x,y, nwin]
CALLS:
EIS_DATA__READ [1], EIS_DATA__READ [2], EIS_DATA__READ [3], EIS_DATA__READ [4]
XCFIT (OPTIONAL)
COMMON BLOCKS:
PROCEDURE:
example 1: Calculate int, vel wid, from Line window 0
from CCSDS file1= 'file1.dat'. Use pre-defined
pixel values:
IDL> eis_getmoments, file1, int,vel,wid, /ccsds,$
/line_def
example 2: Get line windows 2 and 3 from fitsfile
file2='file2.fits'. No predined pixel defintions
exist, and use wavelength scale in stead of
pixels. Use gaussian fits:
IDL> eis_getmoments, file2,int,vel, wid,
iwin=[2,3], lamtype='wav', /gauss
RESTRICTIONS:
With the /gauss keyword, the program calls 'XCFIT' which is a
part of the CDS package distributed with solar soft.
MODIFICATION HISTORY:
01-Mar-2004: Oivind Wikstol.
15-Dec-2004: Oivind Wikstol.
[Previous]
[Next]
Project :SolarB EIS
Name :eis_handle_get_suspension_periods
Purpose :Used for eis_cpt interface
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
CALLS:
[Previous]
[Next]
NAME:
EIS_HDR__DEFINE
PURPOSE:
eis_hdr__define defines the class structure 'eis_hdr'.
An object of class 'eis_hdr' contains the header on SOLAR B EIS
data packets sent to the ground. (Only first packets of an
exposureon has the EIS header).)
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
The EIS_HDR__DEFINE procedure is not called directly. An
object of class EIS_HDR is created with the following
statement:
eis_hdr = obj_new('eis_hdr')
To fill the object with information use the following statement:
eis_hdr-> read
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
Objects of type EIS_HDR
CALLS: ***
EIS_HDR::GETACH_VER_NO, EIS_HDR::GETBIT_COMPR_MODE, EIS_HDR::GETB_X
EIS_HDR::GETB_Y, EIS_HDR::GETDATATYPE, EIS_HDR::GETDCH_VER_NO
EIS_HDR::GETEXP_INFO, EIS_HDR::GETHUFFMAN_AC, EIS_HDR::GETHUFFMAN_DC
EIS_HDR::GETIMG_COMPR_MODE, EIS_HDR::GETIMG_TYPE, EIS_HDR::GETLUT_VER_NO
EIS_HDR::GETMAIN_ID, EIS_HDR::GETMAIN_SEQ_COUNT, EIS_HDR::GETMAIN_SEQ_FLAG
EIS_HDR::GETNR_OF_PACKETS, EIS_HDR::GETPACKET_SIZE, EIS_HDR::GETQTAB_VER_NO
EIS_HDR::GETQUANT_TAB, EIS_HDR::GETRAW, EIS_HDR::GETSERIAL_PACKET_NO
EIS_HDR::GETSUB_ID, EIS_HDR::GETSUB_SEQ_COUNT, EIS_HDR::GETSUB_SEQ_FLAG
EIS_HDR::GETVAR, EIS_HDR::GETX_F, EIS_HDR::GETX_P, EIS_HDR::GETY_F
EIS_HDR::GETY_P, EIS_HDR::INIT
CALLED BY:
EIS_DATA__READ [1], EIS_DATA__READ [3], EIS_DATA__READCCSDS [1]
EIS_DATA__READCCSDS [2]
COMMON BLOCKS:
PROCEDURE:
The procedure opens an object of class EIS_HDR. The EIS_HDR
class inherits the superclass HW_HDR, that defines the general
structure of header classes used by the HW data analysis SW.
This procedure also includes various functions (methods of
class 'eis_hdr' whose purpose is to get the different fields of the
header. For example, if you want to know the packet_size:
print, eis_hdr-> getpacket_size()
RESTRICTIONS:
MODIFICATION HISTORY:
01-Feb-2001: Oivind Wikstol.
26-Sep-2001: Oivind Wikstol. Added documentation.
09-Nov-2004: Oivind Wikstol - Updated with new header information.
11-Jan-2005: Øivind Wikstøl - Added HSL keyword
(all of them put together in one
integer)
15-Feb-2005: Øivind Wikstøl - Added new hdr parameters
03-Mar-2005: Øivind Wikstøl - Added new hdr parameters.
31-Aug-2006: Oivind Wikstol - Added compr table ver no parameters
[Previous]
[Next]
NAME:
EIS_HDR__DISPLAY
PURPOSE:
EIS_HDR__DISPLAY is a method of the class EIS_HDR. It is used
to display the contents of an eis_hdr object as text.
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
eis_hdr-> display, textdump. eis_hdr is an object of class
EIS_HDR, textdump is the output.
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
Textdump: A string containing the values of all the parameters
of the header object and a description of it.
CALLS:
COMMON BLOCKS:
PROCEDURE:
EIS_HDR__DISPLAY reads all the instance data of an EIS_HDR
object, and stores it as strings in a string array together
with a description of the data. All strings are then finallly
joined in one long string (textdump) with CR at the rigth
places. The variable 'textdump is the output from the method,
and the header can then be displayed as text by printing
'textdump'.
RESTRICTIONS:
MODIFICATION HISTORY:
XX-Mar-2001: Oivind Wikstol.
01-Oct-2001: Oivind Wikstol. Added documentation.
[Previous]
[Next]
NAME:
EIS_HK__DEFINE
PURPOSE:
The eis_hk object is the general superclass for Solar-B/EIS
House Keeping data (hk)
class objects used by the Hansteen/Wikstøl QL/data analysis
SW. The hk object contains data that is aqcuired from
the House Keeping telemetry stream on Solar-B.
Some of these are used in the main FITS hdr of Solar-B/EIS fits files.
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
hk_obj = obj_new('hk', file = file)
INPUTS:
None
KEYWORD PARAMETERS:
OUTPUTS:
Objects of class EIS_HK includes the following parameters:
CALLS: ***
EIS_HK::GET_TR_MODE, EIS_HK::INIT, EIS_HK::READ
COMMON BLOCKS:
PROCEDURE:
Defines the structure of plan class objects. If no filename
is given as input, the FITS keywords are set to defaults by
the init-procedure. If filename is given (house keeping
telemetry file name), it is read from that file by eis_hk__read.pro
RESTRICTIONS:
MODIFICATION HISTORY:
16-Dec-2005: Oivind Wikstol - Empty object created.
[Previous]
[Next]
PROJECT:
SOLAR-B
NAME:
EIS_IMAGE_TOOL
PURPOSE:
Pointing tool for EIS planning tool
CALLING SEQUENCE:
EIS_IMAGE_TOOL [, fits_file] [, point_stc=point_stc] [, start=start]
[, /reset]
INPUTS:
None required.
OPTIONAL INPUTS:
FITS_FILE -- String scalar or array, list of FITS image files
OUTPUTS:
None.
KEYWORD PARAMETERS:
POINT_STC -- pointing structure
Note that values of POINT_STC structure can be returned to the
caller of IMAGE_TOOL if the MODAL kyeword is set, or it is returned
as a UVALUE of a messenger of a calling widget.
AUTO_PLOT - Keyword used with POINT_STC. When Image Tool (and
Pointing Tool) is running and is called again with
a new
POINT_STC and with AUTO_PLOT set, the
corresponding pointing area(s) will be plotted
automatically.
START -- Start time of a study, in TAI format; defaults to
current date and time. Note: If POINT_STC is passed
in and POINT_STC.DATE_OBS represents a valid TAI,
START will be overwritten by POINT_STC.DATE_OBS.
RESET -- If set, all images saved in image stack will be removed
CALLS: ***
ADD_PSYS, ANYTIM2TAI, ANYTIM2UTC [1], ANYTIM2UTC [2], BLANK, CNVT_COORD [1]
CNVT_COORD [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], COPY_STRUCT [1]
COPY_STRUCT [2], COPY_STRUCT [3], DATATYPE [1], DATATYPE [2], DATATYPE [3]
DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], DPRINT, EIS_DROT_FOV [1]
EIS_DROT_FOV [2], EIS_FOV [1], EIS_FOV [2], EIS_ITOOL_LOAD_IMAGE
EIS_ITOOL_PTOOL [1], EIS_ITOOL_PTOOL [2], EIS_ITOOL_STC [1], EIS_ITOOL_STC [2]
EIS_LIMB_FOV [1], EIS_LIMB_FOV [2], EXIST, EXPTV, FLASH_MSG, GET_TV_SCALE, GET_UTC
HAVE_PROC, HAVE_TAG, ITOOL_ADJ_CTABLE, ITOOL_BUTTON_REFRESH, ITOOL_COPY_TO_PIX
ITOOL_DISPLAY, ITOOL_DISP_PLUS, ITOOL_ICON_PLOT, ITOOL_LIMBFITTER
ITOOL_MARK_ICON, ITOOL_NEW_CSI, ITOOL_NOAA, ITOOL_PLOT_AXES, ITOOL_PLOT_FOV
ITOOL_REFRESH, ITOOL_SOLAR_GRID, ITOOL_UPDATE_ICONBT, MATCH_STRUCT, MK_DFONT
MK_POINT_STC, NINT [1], NINT [2], NUM2STR, OPLOT_NAR [1], OPLOT_NAR [2], ORIENT_MARK
POPUP_MSG, PT_FOV_RESET, SETWINDOW [1], SETWINDOW [2], SINCE_VERSION [1]
SINCE_VERSION [2], STRIP_DIRNAME [1], STRIP_DIRNAME [2], TAI2UTC, TVDEVICE
UPDATE_ROT_BUTTON, UTC2TAI, VALID_TIME, WIDGET_CONTROL2, WIDGET_MBASE, XACK, XKILL
XMANAGER, XREGISTERED2, XSEL_LIST [1], XSEL_LIST [2], concat_dir [4], delvarx [5]
is_number [1], is_number [2], is_struct
CALLED BY:
eis_mk_plan_gui [1], eis_mk_plan_gui [2]
RESTRICTIONS:
Cannot be run two copies simultaneously (guaranteed by the call to
'XREGISTERED')
CATEGORY:
Image processing, science planning
PREVIOUS HISTORY:
Written August 29, 1994, by Liyun Wang, NASA/GSFC
MODIFICATION HISTORY:
12-Jan-2006, Zarro(L-3Com/GSFC) - stripped, reworked, and renamed
CONTACT:
dzarro@solar.stanford.edu
[Previous]
[Next]
PROJECT:
SOLAR-B/EIS
NAME:
EIS_IMAGE_TOOL_EVENT
PURPOSE:
Event handler of image tool
INPUTS:
EVENT - Event structure
CATEGORY: >
Image processing, science planning >
>
PREVIOUS HISTORY: >
Written August 29, 1994, by Liyun Wang, NASA/GSFC >
>
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3]
CNVT_COORD [1], CNVT_COORD [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
CONGRID [1], CONGRID [2], CONGRID [3], DELVARX [1], DELVARX [2], DELVARX [3]
DELVARX [4], DISP_TXT, DROT_MAP, EIS_IMAGE_TOOL_CLEANUP, EIS_ITOOL_LOAD_IMAGE
EIS_ITOOL_STC [1], EIS_ITOOL_STC [2], EIS_ITOOL_ZOOMINOUT [1]
EIS_ITOOL_ZOOMINOUT [2], FLASH_MSG, GET_POINTER, GET_UTC, GREP, HAS_ERROR
HIST_EQUAL, IMAGE_TOOL_HLP, IS_STRING, ITOOL2MAP, ITOOL_ADJ_CTABLE
ITOOL_BUTTON_REFRESH, ITOOL_COMPOSITE, ITOOL_COPY_TO_PIX, ITOOL_CROSS_HAIR
ITOOL_DIFF_ROT, ITOOL_DISPLAY, ITOOL_DISP_PLUS, ITOOL_DISP_ROT, ITOOL_DRAW
ITOOL_IMG_MATCH, ITOOL_INSIDE_LIMB, ITOOL_MARK_ICON, ITOOL_OVERLAYER_EVENT
ITOOL_PICKFILE, ITOOL_PICKFILE_EVENT, ITOOL_REFRESH, ITOOL_RESTORE
ITOOL_RESTORE_PIX, ITOOL_SELECT_IMG, ITOOL_SOLAR_GRID, ITOOL_SWITCHER
ITOOL_UPDATE_ICONBT, ITOOL_WRITE_FITS, ITOOL_XCHG_STACK, ITOOL_XY, LIMBFIT_EVENT
MATCH_STRUCT, MK_HELP_STC, NUM2STR, ORIENT_MARK, PB0R, POPUP_MSG, PS [1], PS [2]
PSCLOSE [1], PSCLOSE [2], PSPLOT [1], PSPLOT [2], PT_FOV_RESET, PT_PTOOL_EVENT
REVERSE, ROT_XY, SAVEIMAGE, SETWINDOW [1], SETWINDOW [2], SET_CURSOR_SIZE
SET_POINTER, SHOW_SYNOP, SIGRANGE [1], SIGRANGE [2], STR2ARR [1], STR2ARR [2]
STRIP_DIRNAME [1], STRIP_DIRNAME [2], TAI2UTC, TVZOOM2, UPDATE_ROT_BUTTON, UTC2TAI
VALID_NUM [1], VALID_NUM [2], VALID_NUM [3], VALID_POINTER, WIDGET_CONTROL2
WIDG_HELP, WIDG_TYPE, X2PS, XACK, XANSWER, XCOLORS [1], XCOLORS [2], XCOLORS [3]
XCOLORS [4], XCOLORS [5], XGET_UTC, XHOUR, XINPUT, XKILL, XPS_SETUP, XREGISTERED
XSET_COLOR, XSET_VALUE, XSHOW_HELP, XSTRUCT, XTEXT, break_file [4], concat_dir [4]
delvarx [5], is_struct
MODIFICATION HISTORY: >
12-Jan-2006, Zarro(L-3Com/GSFC) - stripped, reworked, and renamed >
>
CONTACT: >
dzarro@solar.stanford.edu >
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
eis_import_linelist
PURPOSE:
Procedure
CATEGORY:
EIS Technical Planning
INPUTS:
ll - eis_linelist structure
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], SYSTIM, strsplit
CALLED BY:
eis_mk_raster_gui__define [1], eis_mk_raster_gui__define [2]
MODIFICATION HISTORY:
Written by: John Rainnie, RAL (March 2005)
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
eis_import_raster
PURPOSE:
Procedure
CATEGORY:
EIS Technical Planning
INPUTS:
ra - eis_raster structure
CALLS: ***
EIS_RASTER_DURATION [1], EIS_RASTER_DURATION [2], SYSTIM, strsplit
CALLED BY:
eis_mk_raster_gui__define [1], eis_mk_raster_gui__define [2]
eis_mk_study_gui [1], eis_mk_study_gui [2]
MODIFICATION HISTORY:
Written by: John Rainnie, RAL (March 2005)
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
eis_import_study
PURPOSE:
Procedure
CATEGORY:
EIS Technical Planning
INPUTS:
ra - eis_raster structure
CALLS: ***
EIS_GET_STUDY_DEF_POSITION, EIS_IMPORT_GET_FILENAME, RD_ASCII [1]
RD_ASCII [2], eis_read_linelist_block [1], eis_read_linelist_block [2]
MODIFICATION HISTORY:
Written by: John Rainnie, RAL (March 2005)
[Previous]
[Next]
PROJECT:
Solar-B/EIS
NAME:
EIS_ITOOL_PTOOL
PURPOSE:
Make a widget base for pointing for an appropriate SOHO instrument
EXPLANATION:
This routine creates a widget interface based on a given "parent"
base in IMAGE_TOOL for the pointing purpose. Events genereated from
this widget set is handled by routine PT_PTOOL_EVENT. It requies a
pointing structure be defined (in the common block included in
image_tool_com.pro) for a given instrument. This pointing structure
should include the following tags:
MESSENGER - ID of widget in the caller that triggers a
timer event in the planning tool to signal the
completion of pointing; must be a widget that
does not usually generate any event
INSTRUME - Code specifying the instrument; e.g., 'C' for CDS
SCI_SPEC - Science specification
STD_ID - Study ID
G_LABEL - Generic label for the pointing; e.g., 'RASTER'
X_LABEL - Label for X coordinate of pointing; e.g., 'INS_X'
Y_LABEL - Label for Y coordinate of pointing; e.g., 'INS_Y'
DATE_OBS - Date/time of beginning of observation, in TAI format
DO_POINTING- An integer of value 0 or 1 indicating whether pointing
should be handled at the planning level (i.e., by
IMAGE_TOOL)
N_POINTINGS- Number of pointings to be performed by IMAGE_TOOL
POINTINGS - A structure array (with N_POINTINGS elements) of type
"DETAIL_POINT" to be handled by IMAGE_TOOL. It has the
following tags:
POINT_ID - A string scalar for pointing ID
INS_X - X coordinate of pointing area center in arcs
INS_Y - Y coordinate of pointing area center in arcs
WIDTH - Area width (E/W extent) in arcsec
HEIGHT - Area height (N/S extent) in arcsec
OFF_LIMB - An interger with value 1 or 0 indicating
whether or not the pointing area should
be off limb
N_RASTERS - Number of rasters for each pointing (this is
irrelevant to the SUMER)
RASTERS - A structure array (N_RASTERS-element) of type
"RASTER_POINT" that contains raster size and pointing
information (this is irrelevant to the SUMER). It has
the following tags:
POINTING - Pointing handling code; valis
values are: 1, 0, and -1
INS_X - Together with INS_Y, the pointing to use
when user-supplied values are not
allowed. Only valid when POINTING=0
(absolute) or POINTING=-1 (relative to
1st raster).
INS_Y - ...
WIDTH - Width (E/W extent) of the raster, in arcs
HEIGHT - Height (N/S extent) of the raster, in arcs
CALLED BY:
EIS_IMAGE_TOOL [1], EIS_IMAGE_TOOL [2]
Note: For the case of CDS, pointings.width, pointings.height,
pointings.ins_x, and pointings.ins_y should match the first
raster's rasters.width, rasters.height, rasters.ins_x, and
rasters.ins_y, respectively.
CALLING SEQUENCE:
ITOOL_PTOOL, parent, child [,font=font]
INPUTS:
PARENT - ID of parent widget upon which the pointing widget is built
OPTIONAL INPUTS:
FONT - Font name to be used for labelling
OUTPUTS:
CHILD - ID of the base widget being built and leter on remapped
OPTIONAL OUTPUTS:
None.
KEYWORD PARAMETERS:
None.
CALLS: ***
CNVT_COORD [1], CNVT_COORD [2], DATATYPE [1], DATATYPE [2], DATATYPE [3]
DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], DHELP, DIFF_ROT [1]
DIFF_ROT [2], DPRINT, EIS_DROT_FOV [1], EIS_DROT_FOV [2], EIS_LIMB_FOV [1]
EIS_LIMB_FOV [2], EIS_PLAN_STC [1], EIS_PLAN_STC [2], EIS_VALID_POINT [1]
EIS_VALID_POINT [2], EXIST, FLASH_MSG, FLASH_PLOTS, FXPAR [1], FXPAR [2], HAVE_TAG
ITOOL_COPY_TO_PIX, ITOOL_GETXY_FIELD, ITOOL_PNT_SEND, ITOOL_POINT_PLOT
ITOOL_REFRESH, ITOOL_RESTORE_PIX, ITOOL_SWITCHER, JUSTIFY, MK_DFONT, NUM2STR
PT_BUTTON_UPDATE, PT_FOV_DSHAPE, PT_FOV_RESET, PT_FOV_SHAPE, PT_FOV_UPDATE
PT_PTOOL_EVENT, PT_REFRESH_BASE, PT_ROTATE_POINT, ROT_XY, SETWINDOW [1]
SETWINDOW [2], TAI2UTC, UTC2TAI, WIDGET_CONTROL2, XACK, XANSWER, XSHOW, XSHOW_HELP
delvarx [5], widget_valid
COMMON BLOCKS:
FOR_POINTING - Internal common block used by this routine and
ITOOL_PTOOL
Others - Included in image_tool_com.pro
CATEGORY:
Planning, pointing
PREVIOUS HISTORY:
Written January 23, 1995, Liyun Wang, NASA/GSFC
Separated from the origina code of IMAGE_TOOL
MODIFICATION HISTORY:
Version 2, Liyun Wang, NASA/GSFC, March 8, 1995
Added indicator showing if a selected pointed area is pointed
Added Warnings if there is any pointing area remain unpointed
Version 3, Liyun Wang, NASA/GSFC, March 31, 1995
Added undo feature
Version 4, Liyun Wang, NASA/GSFC, April 27, 1995
Added the FONT keyword
Version 5, November 2, 1995, Liyun Wang, NASA/GSFC
Modified to cope with image icon stacking
Version 6, November 17, 1995, Liyun Wang, NASA/GSFC
Added validity check for CDS
Version 7, December 27, 1995, Liyun Wang, NASA/GSFC
Added pointing for MK_SOHO
Version 8, April 17, 1996, Liyun Wang, NASA/GSFC
Fixed a bug that caused the program crash when switching
studies with different pointing numbers
Version 9, August 19, 1996, Liyun Wang, NASA/GSFC
Corrected an error in plotting rasters with relative pointings
Version 10, December 18, 1996, Liyun Wang, NASA/GSFC
Modified such that the time projection is turned off if
raster is placed off the limb
Version 11, February 12, 1997, Liyun Wang, NASA/GSFC
Fixed a bug causing text widgets remaining inactive when
studies with variable pointings are received
Version 12, February 18, 1997, Liyun Wang, NASA/GSFC
Added fields SCI_SPEC and ID in pointing tool
Version 13, April 1, 1997, Liyun Wang, NASA/GSFC
Fixed a bug occurred during plotting off_limb rasters
Version 14, William Thompson, GSFC, 8 April 1998
Changed !D.N_COLORS to !D.TABLE_SIZE for 24-bit displays
Modified, 12-Jan-2006, Zarro (L-3Com/GSFC) - added /NO_QUIT
keyword
Modified, 14-August-2006, Zarro (ADNET/GSFC) - made EIS-specific
[Previous]
[Next]
PROJECT:
SOLAR-B/EIS
NAME:
EIS_ITOOL_RD_FITS
PURPOSE:
Driver program of FXREAD and CDS_IMAGE to read any FITS file
CALLING SEQUENCE:
eis_itool_rd_fits, data_file, image, header, min=min, max=max, $
image_max=image_max, image_min=image_min $
[,errmsg=errmsg]
INPUTS:
DATA_FILE - name of FITS file
OUTPUTS:
IMAGE - A 2-D image array
HEADER - Header of the image
CSI - Part of CSI structure. It's important to get this structure
KEYWORD PARAMETERS:
IMAGE_MIN - Minimum value of the image array
IMAGE_MAX - Maximum value of the image array
ERRMSG - Error message returned (null string if no error)
STATUS - Flag (0/1) of failure/success
CALLS: ***
IS_STRING, ITOOL_SET_CSI
CALLED BY:
EIS_LOAD_IMAGE [1], EIS_LOAD_IMAGE [2]
MODIFICATION HISTORY:
Written, 1-Jan-06, Zarro (L-3Com/GSFC) - modified from ITOOL_RD_FITS
CONTACT:
dzarro@solar.stanford.edu
[Previous]
[Next]
Project : SOLAR-B/EIS
Name : EIS_ITOOL_STC
Purpose : Convert EIS pointing structure to format
recognized by EIS_IMAGE_TOOL
Category : Planning
Syntax : IDL> stc=eis_itool_stc(eis_stc)
Inputs : EIS_STC = EIS pointing structure
Outputs : STC = EIS_IMAGE_TOOL pointing structure
Keywords : None
CALLS: ***
ANYTIM2TAI, EXIST, HAVE_TAG, MK_POINT_STC, PR_SYNTAX, is_struct, str_replace [1]
str_replace [2]
CALLED BY:
EIS_IMAGE_TOOL [1], EIS_IMAGE_TOOL [2], EIS_IMAGE_TOOL_EVENT [1]
EIS_IMAGE_TOOL_EVENT [2]
History : 16-May-2006, Zarro (L-3Com/GSFC) - written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
EIS_ITOOL_ZOOMINOUT
PURPOSE:
Event handler for zooming in/out
CATEGORY:
image tool
INPUTS:
EVENT - Event structure
CALLS: ***
DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4], ITOOL_DISPLAY, ITOOL_DISP_PLUS
ITOOL_REFRESH, ITOOL_RESTORE, ITOOL_SELECT_IMG, SETWINDOW [1], SETWINDOW [2], XACK
delvarx [5]
CALLED BY:
EIS_IMAGE_TOOL_EVENT [1], EIS_IMAGE_TOOL_EVENT [2]
HISTORY:
Version 1, January 29, 1997, Liyun Wang, NASA/GSFC. Written
Extracted from image_tool.pro
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
NAME:
eis_jar_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
Project : SOLAR-B/EIS
Name : EIS_LIMB_FOV
Purpose : check if solar limb is in EIS FOV
Category : Planning
Syntax : IDL> offlimb=eis_limb_fov(fov)
Inputs : FOV = FOV structure
Outputs : 1/0 if limb falls within FOV
Keywords : OFFLIMB = if FOV center lies off the limb
CALLS: ***
is_struct
CALLED BY:
EIS_IMAGE_TOOL [1], EIS_IMAGE_TOOL [2], EIS_ITOOL_PTOOL [1]
EIS_ITOOL_PTOOL [2]
History : 4-Sep-2006, Zarro (ADNET/GSFC) - written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project :SolarB EIS
Name :eis_line_list
Purpose :Defines data structure EIS_linelist
EIS_line
Atomic name
wavelength (nanometers)
type C (Compulsory), P(project) or U(user-defined)
index used for indexing atomic names(-1 n/a)
EIS_linelist
id line-list id
acronym line-list acronym
title line-list title (computer generated)
nlines number of populated lines
lines array of structures used to define individual lines
Category :Technical planning (linelist)
Author :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0, dated 27 August 2004
:write_locked added May 2005
:eis_line definition separated off, september 2005
CALLS:
[Previous]
[Next]
NAME:
eis_line_name_custom_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
eis_line_name_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
EIS_LINE_VALUES
PROJECT:
SolarB EIS
PURPOSE:
Function to calculate the properties of a line window - defined
by a central wavelength. These include;
p0 - central pixel
p1 - lower pixel node
p2 - upper pixel node
ccd - 1/2 if CCD1 or CCD2
quad -
w1 -
w2 -
CATEGORY:
EIS Technical Planning
INPUTS:
line - an "eis_line" structure
width - window width
CALLS: ***
EIS_WAVELENGTH_TO_PIXELS [1], EIS_WAVELENGTH_TO_PIXELS [2]
eis_pixel_to_wavelength [1], eis_pixel_to_wavelength [2]
CALLED BY:
eis_ll_obj__DEFINE [1], eis_ll_obj__DEFINE [2]
eis_mk_raster_gui__define [1], eis_mk_raster_gui__define [2]
HISTORY:
V0 Written by: John Rainnie, RAL
j.rainnie@rl.ac.uk (Dec 2005)
[Previous]
[Next]
NAME:
eis_linelist_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
eis_lines_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
Project : EIS
Name : EIS_LIST_EXPER
Purpose : List entries in EIS raster catalog. Checks for local
copy of catalog in ZDBASE. If not available, accesses
remote copy via socket call.
Category : utility sockets
Inputs : TSTART, TEND = start/end times for list
or
PROG_NUM = plan program number
Outputs : OBS = main observation structure
N_FOUND = number of elements found
Keywords : SEARCH = search string
SAVE_FILE = save file in which OBS is saved
CALLS: ***
ANYTIM2TAI, BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1]
CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2], DATATYPE [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DELVARX [1], DELVARX [2], DELVARX [3]
DELVARX [4], EIS_SAVE, GET_SID, GET_TEMP_DIR, HAVE_NETWORK, IS_BLANK, IS_STRING
LIST_EXPER, LOC_FILE [1], LOC_FILE [2], LOC_FILE [3], PR_SYNTAX, RPC_SERVER
SOCK_COPY, SOCK_LIST, STR_FORMAT, TEST_DIR, TRIM, VALID_TIME, break_file [4]
concat_dir [4], curdir [1], curdir [2], delvarx [5], is_number [1], is_number [2]
restgen [1], restgen [2], savegen [1], savegen [2]
History : 29-Aug-2002, D.M. Zarro (LAC/GSFC) Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : EIS
Name : EIS_LIST_MAIN
Purpose : List entries in EIS main catalog. Checks for local
copy of catalog in ZDBASE. If not available, accesses
remote copy via socket call.
Category : utility sockets
Inputs : TSTART, TEND = start/end times for list
Outputs : OBS = main observation structure
COUNT = number of elements found
Keywords : SEARCH = search string
SAVE_FILE = save file in which OBS is saved
CALLS: ***
ANYTIM2TAI, BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1]
CONCAT_DIR [2], CONCAT_DIR [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], DELVARX [1]
DELVARX [2], DELVARX [3], DELVARX [4], EIS_SAVE, IS_BLANK, IS_STRING, LIST_MAIN
PR_SYNTAX, SOCK_RPC, STR_FORMAT, TEST_DIR, TRIM, VALID_TIME, break_file [4]
concat_dir [4], curdir [1], curdir [2], delvarx [5], is_struct, savegen [1]
savegen [2]
History : 29-Aug-2002, D.M. Zarro (LAC/GSFC) Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project :SolarB EIS
Name :eis_list_real_command_sequences
Purpose :Used for eis_cpt interface
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 June 2005
CALLS:
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_list_real_detail__DEFINE
Purpose : Generates structure EIS_list_real_detail.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_list_real_detail. Tags are :
start_time : DOUBLE TAI start time of the command
in the GSE to run the real command sequence
filename : STRING filename of type 'description.real_ssss_bbbb'
where
description : is some text describing the purpose of the engineering study;
real : is the 4 character string 'real' indicating that the file is a real command study.
ssss : is the 4 digit duration in seconds;
bbbb : is the 4 digit number of Kbytes of data generated by the engineering study;
Use : <dummy = {EIS_list_real_detail>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 11/07/05
Modified :
Version : Version 0.0, 11/07/05, MKC
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
eis_list_timeline_entries
PURPOSE
extract (ENGINEERING, SCIENCE) timeline records and place in
eis_study_detail structureUsed for eis_cpt interface
CATEGORY
EIS timeline planning
MODIFICATION HISTORY
V0.0 Chunkey, February 2005
V0.1 June 2005, time_tagged and duration fields copied
V0.2 John Rainnie, June 2006
CALLS:
CALLED BY
eis_cpt_gui [1], eis_cpt_gui [2]
[Previous]
[Next]
NAME:
eis_ll_obj__DEFINE
PURPOSE:
This procedure defines the data memebers of the
Object "eis_ll_obj".
INPUTS:
ll - an eis_line_list structure
AUTHOR:
John A. Rainnie - RAL (j.a.rainnie@rl.ac.uk)
CALLS:
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
EIS_LOAD_IMAGE
PURPOSE:
Load in a FITS or GIF file and try to determine the CSI structure
SYNTAX:
eis_itool_load_image, image_file
INPUTS:
IMAGE_FILE -- Name of the image file to be loaded
is returned if no error occurs
STATUS - 0/1, status flag indicating failure/sucess of operation
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], COPY_STRUCT [1], COPY_STRUCT [2]
COPY_STRUCT [3], DELVARX [1], DELVARX [2], DELVARX [3], DELVARX [4]
EIS_ITOOL_LOAD_IMAGE, EIS_ITOOL_RD_FITS [1], EIS_ITOOL_RD_FITS [2]
FILE_EXIST [2], FLASH_MSG, GREP, ITOOL_ADJ_CTABLE, ITOOL_DISPLAY, ITOOL_DISP_PLUS
ITOOL_IMG_SRC, ITOOL_IMG_TYPE, ITOOL_NEW_CSI, ITOOL_REFRESH, SETWINDOW [1]
SETWINDOW [2], STRIP_DIRNAME [1], STRIP_DIRNAME [2], WIDGET_CONTROL2, XACK
delvarx [5], file_exist [1], file_exist [3]
HISTORY:
Written, 1-Jan-2006, Zarro (L-3Com/GSFC) - based on ITOOL_LOAD_IMAGE
CONTACT:
dzarro@solar.stanford.edu
[Previous]
[Next]
NAME: eis_make_status_fits.pro
PURPOSE: To convert solar-B ccsds status packet archives into
level-0 fits format.
Converts ICU/PSU, CAM, MHC and Eis specific parameters of
HK1 status packets.
CATEGORY: Engineering
CALLING SEQUENCE: eis_make_status_fits, 'status_archive' [,output=output]
INPUTS: Filename string of the status archive
KEYWORD PARAMETERS: Set output (string) to an existing directory
where the fits output will be written. Default to '/tmp'.
OUTPUTS: One fits file per status APID in either /tmp or the
directory specified by output.
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], EIS2CAL
EIS_ADD_PRIMARY_HEADER_KEYWORDS, EIS_EXTRACT24BITS, EIS_EXTRACTBITSFROMBYTE
EIS_EXTRACTBITSFROMWORD, EIS_EXTRACTBYTE, EIS_EXTRACTDOUBLEWORD
EIS_EXTRACTLSNIBBLE, EIS_EXTRACTMSNIBBLE, EIS_EXTRACTWORD, EIS_MKCAMFITS
EIS_MKHK1FITS, EIS_MKHK2FITS, EIS_MKHKAOCS1FITS, EIS_MKICUPSUFITS, EIS_MKMHCFITS
EIS_MKSTSFITS, EIS_MK_BINTABLE_EXTENSION, EIS_MK_CCSDS_BINTABLE_EXTENSION
EIS_MK_SUBCOMM_EXTENSION, FXADDPAR [1], FXADDPAR [2], FXBADDCOL [1]
FXBADDCOL [2], FXBCREATE [1], FXBCREATE [2], FXBFINISH [1], FXBFINISH [2]
FXBHMAKE [1], FXBHMAKE [2], FXBWRITE [1], FXBWRITE [2], FXHMAKE [1], FXHMAKE [2]
FXWRITE [1], FXWRITE [2], break_file [4], eis_ti2utc [1], eis_ti2utc [2]
COMMON BLOCKS:None.
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
To do: history keywords and updating
MODIFICATION HISTORY:
17/09/06 mcrw v2.0
New version based on version 1.1
Does not split ccsds header up
Needs altering so that the mhc mechanisms first/last position can be
put in
[Previous]
[Next]
NAME: eis_md_decomp.pro
PURPOSE: Decompress EIS mission data packets.
CATEGORY: Science
CALLING SEQUENCE: eis_mk_decomp, 'md_archive'
INPUTS: Filename string of the mission data archive
KEYWORD PARAMETERS: None
OUTPUTS: One decompressed mission data archive in /tmp
CALLS: ***
EIS_BIT_DECOMP, EIS_PROCESSPACKET, EIS_WRITEDECOMPRESSEDPACKET
CALLED BY:
eis_status_sts1_conversions [1]
COMMON BLOCKS:None.
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
23/11/05 mcrw wrote
14/08/06 mcrw added documentation
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_mechanism_change__DEFINE
Purpose : Generates structure EIS_mechanism_change.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_mechanism_change. Tags are :
number_of_changes : UINT number of changes made to the mechanism position.
initial : UINT start position
final : UINT end position
Use : <dummy = {EIS_mechanism_change>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 07/12/04
Modified : Version 0.0, 07/12/04, MKC
Version : Version 0.0, 07/12/04
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_mechanism_control__DEFINE
Purpose : Generates structure EIS_mechanism_control.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_mechanism_control. Tags are :
slit_direction : INT direction to move the slit mechanism :
-1 : reverse direction i.e 0->3
1 : forward direction i.e 0->1
coarse_mirror_range : [2]UINT +x and -x limits.
Range is 0x4195 to 0xFFFF and 0x0000 to 0x1408.
fine_mirror_range : [2]UINT range 0-2400 corresponding to 0-300"
(was 2927 in previous documentation giving 360").
number_of_slit_changes : UINT number of allowed slit changes per planning period.
Use : <dummy = {EIS_mechanism_control>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.1, 10/12/04, MKC
Changed definition of slit direction.
Version 0.2, 24/06/05, MKC
Changed INT values to UINT.
Version 0.3, 20/07/05, MKC
Added number of slit changes tag.
Version : 0.3, 20/07/05
[Previous]
[Next]
NAME:
EIS_MK_FITSNAME
PURPOSE:
Based on data level (0, 1, 2) and time in UTC (CCSDS format -
YYYY-MM-DDTHH:MM:SS.SSS - see GET_UTC.PRO in SolarSoft),
construct FITS file name in right for EIS on Solar-B.
CATEGORY:
Hansteen/Wikstol data processing software
CALLING SEQUENCE:
filename = eis_mk_fitsname(fitslevel, utc)
INPUTS:
level: Level of data to be written to FITS file (0, 1, 2)
data : EIS data object
hdr: EIS MD hdr object
KEYWORD PARAMETERS:
None
OUTPUTS:
Name of FITS file in the format of 'eis_lx_yyyymmdd_hhmmss.fits'
CALLS: ***
FNAME_EXTRACT, eis_ti2utc [1], eis_ti2utc [2]
CALLED BY:
EIS_MKFITS [1], EIS_MKFITS [2]
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
Version 1: 26-Jan-2005: Oivind Wikstol
August 2006 - Oivind Wikstol: Re-written to fit new FITS naming convention
September 2006 - Oivind Wikstol: Re-written to do time conversion
[Previous]
[Next]
NAME:
EIS_MK_PLAN
PURPOSE:
This procedure invokes the eis_mk_plan GUI
INPUTS:
NONE
AUTHOR:
John Rainnie RAL (j.rainnie@rl.ac.uk)
CALLS: ***
EIS_CHECK_DATABASE [1], EIS_CHECK_DATABASE [2]
MODIFICATION HISTORY:
Dec 2005 - written
May 2006 - modified to include call to "readPlanFromDatabase"
method. Does what it says on the tin.
[Previous]
[Next]
NAME:
eis_mk_plan_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
eis_mk_plan_widgets__define
PURPOSE:
This object
INPUTS:
GROUP -
[Previous]
[Next]
NAME:
EIS_MK_RASTER
PURPOSE:
This procedure invokes the eis_mk_raster GUI
INPUTS:
NONE
AUTHOR:
John Rainnie RAL (j.rainnie@rl.ac.uk)
CALLS: ***
EIS_CHECK_DATABASE [1], EIS_CHECK_DATABASE [2]
MODIFICATION HISTORY:
Dec 2005 - written
[Previous]
[Next]
NAME:
eis_mk_raster
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
eis_mk_raster_gui__define
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
eis_mk_study_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
EIS_MKFITS
PURPOSE:
Makes FITS files out of telemetry packets for the
EIS instrument on Solar-B.
CATEGORY:
Data Processing Software
CALLING SEQUENCE:
eis_mkfits, filename
INPUTS:
data: eis data object
hdr: eis hdr oject array
KEYWORD PARAMETERS:
plan: Input planning tool data object
spcd: Space craft data object
hk: House keeping data object
lev: FITS level, eg 'l0'. set to default ('lev0') if not specified
fitsdir: Input variable. Directory to write fits file in
fitsfile: Input name of fits file (otherwise created automatically
from date)
outfile: Output name of fits file (if not given as input,
this is the way for an outside program to get the
name).
datatype: Type of data (pixel data, moments)
OUTPUTS:
A FITS file
CALLS: ***
EIS_FITS_CALIB [1], EIS_FITS_CALIB [2], EIS_FITS_COORD [1], EIS_FITS_COORD [2]
EIS_FITS_DATAID [1], EIS_FITS_DATAID [2], EIS_FITS_OBSTIME [1]
EIS_FITS_OBSTIME [2], EIS_MK_FITSNAME [1], EIS_MK_FITSNAME [2], FXADDPAR [1]
FXADDPAR [2], FXBADDCOL [1], FXBADDCOL [2], FXBCREATE [1], FXBCREATE [2]
FXBFINISH [1], FXBFINISH [2], FXBHMAKE [1], FXBHMAKE [2], FXBWRITE [1]
FXBWRITE [2], FXHMAKE [1], FXHMAKE [2], FXWRITE [1], FXWRITE [2], GET_UTC
CALLED BY:
EIS_DATA__DEFINE [1], EIS_DATA__DEFINE [2], EIS_FITS_SCRIPT [1]
EIS_FITS_SCRIPT [2], EIS_FITS_SCRIPT [3], XCAL [1], XCAL [2], XCONTROL [1]
XCONTROL [2], XMKFITS [1], XMKFITS [2]
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
November 2002: 1. version by Oivind Wikstol and Viggo Hansteen
2004-04-21: Oivind Wikstol - Added file name functionality
2004-06-25: Øivind Wikstøl - Added keywords calstat and datatype
2005-01-11: Øivind Wikstøl - Added numerous new keywords from mission
data hdr. Both main hdr keywords as well
as new BTE columns and BTE hdr keywords.
2005-11-15: Oivind Wikstol - Added spacecraft data and house keeping data.
Added, removed and changed keywords, according
to list of Solar-B wide keywords list, as
described in document by Shimojo-san.
VERSION: 0.9 !! Remember to update this number in the code when changed!!
[Previous]
[Next]
NAME:
EIS_MODFITS
PURPOSE:
Write FITS data object and FITS header to EIS type FITS file.
Either create new FITS file or modify existing FITS file
with new header or data)
CATEGORY:
Data Processing Software
CALLING SEQUENCE:
eis_modfits, filename, hdr,data
INPUTS:
hdr: FITS header object of type 'fits_hdr'
data: data object of type 'eis_data'
KEYWORD PARAMETERS:
fitsfile: name of FITS file
OUTPUTS:
A FITS file
CALLS: ***
FXBCREATE [1], FXBCREATE [2], FXBFINISH [1], FXBFINISH [2], FXBWRITE [1]
FXBWRITE [2], FXWRITE [1], FXWRITE [2]
CALLED BY:
EIS_DATA__DEFINE [1], EIS_DATA__DEFINE [2], EIS_MOMENT__DEFINE [1]
EIS_MOMENT__DEFINE [3], XCAL [1], XCAL [2], XCONTROL [1], XCONTROL [2]
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
16-Feb-2004: Oivind Wikstol, version 1.0
06-May-2004: Added check on file exist. fitsfile changed to keyword
[Previous]
[Next]
NAME:
EIS_MOMENT__DEFINE
PURPOSE:
EIS_MOMENT__DEFINE defines the class EIS_MOMENT. Objects of this
class contains intensity, velocity and line width data
(0th, 1st and 2nd order intensity moments)
from the EIS instrument on SOLAR-B. The
EIS_MOMENT class inherits the superclass HW_DATA
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
The EIS_MOMENT__DEFINE procedure is not called directly. An
object of class EIS_INT_DATA is created with the following
statement:
eis_int_data = obj_new('eis_int_data', eis_data )
INPUTS:
eis_data: Object of class EIS_DATA, containing the EIS data
from which the intensity data will be calculated and stored in
the instance data of the EIS_INT_DATA object.
KEYWORD PARAMETERS:
OUTPUTS:
Objects of type EIS_MOMENT
CALLS: ***
EIS_FITS_HDR_MOMENT, EIS_MODFITS [1], EIS_MODFITS [2], EIS_MOMENT::CONSTRUCT
EIS_MOMENT::GETLAM_TYPE, EIS_MOMENT::GETLINELIST, EIS_MOMENT::INIT
EIS_MOMENT::READ, EIS_MOMENT::SAVE, EIS_MOMENT::SETLAM_TYPE
COMMON BLOCKS:
PROCEDURE:
The procedure opens an object of class EIS_MOMENT. The
INIT-method of this object is called automatically. In the
INIT method, the method called CONSTRUCT is called. This
method uses the information from the EIS_DATA
object to perform moment calculations
order to calculate intensity for all line window profiles.
The moments are stored in the instance data called 'w'
of EIS_MOMENT.
RESTRICTIONS:
MODIFICATION HISTORY:
04-Feb-2004: Viggo Hansteen.
20-Feb-2004: Oivind Wikstol - Modified.
24-Feb-2004: Oivind Wikstol - Changed call procedure
14-Oct-2004: Oivind Wikstol - Changed data structure to
(nexp, yw, xw) where xw=3
15-Oct-2004: Oivind Wikstol - Added linelist: Pointer to index
list of processed lines. E.g. if total
number of lines are 25, but
moments have been calculated for
2 lines (3, 5), then *linelist
will be intarr(2), with
linelist[0]=3 and linelist[1]=5
[Previous]
[Next]
NAME:
EIS_MOMENT__DEFINE
PURPOSE:
EIS_MOMENT__DEFINE defines the class EIS_MOMENT. Objects of this
class contains intensity, velocity and line width data
(0th, 1st and 2nd order intensity moments)
from the EIS instrument on SOLAR-B. The
EIS_MOMENT class inherits the superclass HW_DATA
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
The EIS_MOMENT__DEFINE procedure is not called directly. An
object of class EIS_INT_DATA is created with the following
statement:
eis_int_data = obj_new('eis_int_data', eis_data )
INPUTS:
eis_data: Object of class EIS_DATA, containing the EIS data
from which the intensity data will be calculated and stored in
the instance data of the EIS_INT_DATA object.
KEYWORD PARAMETERS:
OUTPUTS:
Objects of type EIS_MOMENT
CALLS:
COMMON BLOCKS:
PROCEDURE:
The procedure opens an object of class EIS_MOMENT. The
INIT-method of this object is called automatically. In the
INIT method, the method called CONSTRUCT is called. This
method uses the information from the EIS_DATA
object to perform moment calculations
order to calculate intensity for all line window profiles.
The moments are stored in the instance data called 'w'
of EIS_MOMENT.
RESTRICTIONS:
MODIFICATION HISTORY:
09-Feb-2004: Oivind Wikstol, version 1.0
[Previous]
[Next]
NAME:
EIS_MOMENT__SAVEFITS
PURPOSE:
Makes FITS files out of telemetry packets for the
EIS instrument on Solar-B.
CATEGORY:
Data Processing Software
CALLING SEQUENCE:
eis_moment__savefits, fitsfile=fitsfile
INPUTS:
KEYWORD PARAMETERS:
fitsfile: Input name of fits file (otherwise created automatically
from date)
OUTPUTS:
A FITS file
CALLS:
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
2004-OCT-15: Øivind Wikstøl - First version
[Previous]
[Next]
NAME:
EIS_MOVIE_PREP
PURPOSE:
EIS_MOVIE_PREP takes a list of EIS FITS files as input. It reads the data from each file
and srings it together in an assoc file, together with a small header
describing the data. The prupose og this is to prepare a data set to be
viewed as a movie using XIMOVIE.
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
eis_movie_prep, filelist, iwin
INPUTS:
filelist: List of EIS FITS files whose data should be concatenated and viewed as a movie
iwin : The line window nr (0 - 24)
KEYWORD PARAMETERS:
OUTPUTS:
An assoc file containing the movie data. Opitionally XIMOVIE is launched by EIS_MOVIE_PREP
file name may be returned in the savefile keyword
CALLS: ***
EIS_GETDATA [1], EIS_GETDATA [2], EIS_MAKE_MOVIE_HEADER, string3 [1]
string3 [2]
CALLED BY:
EIS_CONCAT_DATA [1], EIS_CONCAT_DATA [2]
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
Version 1.0, May-2006: Oivind Wikstol and Viggo Hansteen
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_MULTIPLE_SEQUENCE_TABLES
Purpose : Indicates whether study will span more than one OBSTBL sequence tables.
Explanation : Indicates whether study will span more than one OBSTBL sequence tables.
Use : < res = eis_multiple_sequence_tables(raster_details)>
Inputs : raster_details : STRUCTURE ARRAY of type EIS_raster_detail.
Opt. Inputs : None.
Outputs : res : INT flag indicating if study spans multiple sequence tables.
Opt. Outputs: None.
Keywords : None.
Calls : ***
UNIQ [1], UNIQ [2], UNIQ [3]
CALLED BY:
EIS_CPT_CHECK_EVENT_RESPONSE_STUDY [1]
EIS_CPT_CHECK_EVENT_RESPONSE_STUDY [2], EIS_CPT_CHECK_STUDY [1]
EIS_CPT_CHECK_STUDY [2], EIS_CPT_PROCESS_SCIENCE_SEQUENCES [1]
EIS_CPT_PROCESS_SCIENCE_SEQUENCES [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 02/03/05
Modified : Version 0.0, 02/03/05, MKC
Version 0.1, 17/03/05, MKC
Fixed bug when calculating sequence length for multiple rasters.
Version 0.2, 13/04/05, MKC
Added special hardware window commands.
Version 0.3, 05/07/05, MKC
Corrected logic - did not add special hardware window into calculation.
Added slit slot command only if necessary.
Version 0.4, 21/07/05, MKC
Corrected special hardware window to 40 bytes.
Version : 0.4, 21/07/05
[Previous]
[Next]
Project :SolarB EIS
Name :eis_open_db
Purpose :opens database for read only
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
:Updated September 2005 to test that DB file can actually be opened
CALLS:
CALLED BY
eis_get_engineering_state_list [1], eis_get_engineering_state_list [2]
eis_get_esdb_details [1], eis_get_esdb_details [2]
eis_get_science_entry [1], eis_get_science_entry [2]
eis_get_science_raster_entry [1], eis_get_science_raster_entry [2]
eis_get_study_raster_entry [1], eis_get_study_raster_entry [2]
eis_get_technical_study_rasters [1], eis_get_technical_study_rasters [2]
eis_write_time_component_database_table [1]
eis_write_time_component_database_table [2]
[Previous]
[Next]
Project :SolarB EIS
Name :eis_organise_timeline_container_by_time
Purpose :
Category :EIS timeline planning
Written :Chunkey Lepine, RAL
Version :V0 November 2005
CALLS:
[Previous]
[Next]
PROJECT:
Solar-B EIS
NAME:
eis_overlapping_windows
PURPOSE:
Function to test whether any windows overlap. This is done for
each CCD separately.
INPUTS:
ll - an eis_line_list structure
OUPUTS:
ll - an eis_line_list structure
CATEGORY:
EIS Technical Planning - eis_mk_raster
CALLED BY:
eis_ll_obj__DEFINE [1], eis_ll_obj__DEFINE [2]
MODIFICATION HISTORY:
V0. Written by: John Rainnie, RAL
j.rainnie@rl.ac.uk (Feb 2006)
[Previous]
[Next]
Project :SolarB EIS
Name eis_pause_entry__define
Purpose :Defines the eis_pause_caomponent data structure
start_time :Start time (tai) for this timeline entry
duartion :seconds
Category :Timeline planning (handles pause)
Author :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0, dated January 2005
:renamed/revised August 2005
[Previous]
[Next]
NAME:
eis_pixel_to_wavelength
PROJECT:
SolarB EIS
PURPOSE:
Function to calculate the properties of a line window - defined
by a central wavelength. These include;
p0 - central pixel
p1 - lower pixel node
p2 - upper pixel node
ccd - 1/2 if CCD1 or CCD2
quad -
w1 -
w2 -
CATEGORY:
EIS Technical Planning
INPUTS:
line - an "eis_line" structure
width - window width
CALLS: ***
EIS_GET_CCD_TRANSLATION [1], EIS_GET_CCD_TRANSLATION [2]
EIS_GET_CCD_TRANSLATION [3]
CALLED BY:
EIS_LINE_VALUES [1], EIS_LINE_VALUES [2], eis_mk_raster_gui__define [1]
eis_mk_raster_gui__define [2]
HISTORY:
V0 Written by: John Rainnie, RAL
j.rainnie@rl.ac.uk (Dec 2005)
[Previous]
[Next]
NAME:
EIS_PLAN__DEFINE
PURPOSE:
The eis_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 eis_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 EIS_PLAN includes the following parameters:
CALLS: ***
DB_READ_STUDY_ENTRY, EIS_PLAN::DEFAULT, EIS_PLAN::GET_DATATYPE
EIS_PLAN::GET_EIS_SCI, EIS_PLAN::GET_EXPTIME, EIS_PLAN::GET_INSTRUME
EIS_PLAN::GET_JOIN_SB, EIS_PLAN::GET_JOP_ID, EIS_PLAN::GET_LINE_ID
EIS_PLAN::GET_LINE_WVL, EIS_PLAN::GET_LL_ACR, EIS_PLAN::GET_LL_ID
EIS_PLAN::GET_NOAA_NUM, EIS_PLAN::GET_OBSERVER, EIS_PLAN::GET_OBSTITLE
EIS_PLAN::GET_OBS_DEC, EIS_PLAN::GET_OBS_ID, EIS_PLAN::GET_PLANNER
EIS_PLAN::GET_RAST_ACR, EIS_PLAN::GET_RAST_ID, EIS_PLAN::GET_SCI_OBJ
EIS_PLAN::GET_SOLB_SCI, EIS_PLAN::GET_STUDY_ACR, EIS_PLAN::GET_STUDY_AUTH
EIS_PLAN::GET_STUDY_ID, EIS_PLAN::GET_TARGET, EIS_PLAN::GET_TELESCOP
EIS_PLAN::GET_TL_ID, EIS_PLAN::GET_TL_ID_HUNTER, EIS_PLAN::GET_TOHBAN
EIS_PLAN::INIT, EIS_PLAN::READ, db_read_linelist_entry [1]
db_read_linelist_entry [2], db_read_raster_entry [1]
db_read_raster_entry [2], eis_get_science_entry [1]
eis_get_science_entry [2]
COMMON BLOCKS:
PROCEDURE:
Defines the structure of plan class objects. If no filename
is given as input, the FITS keywords are set by
the init-procedure. If filename is given (plan or as-run
file), it is read from that file by eis_plan__read.pro
RESTRICTIONS:
MODIFICATION HISTORY:
28-Nov-2002: Oivind Wikstol. First draft
13-Jan-2003: Oivind Wikstol - Modifications to the init and
read methods. Add line_id to
the data structure
12-Apr-2005: Oivind Wikstol - Added read method.
Changed object definitions and almost
completely re-written because of access
to planning tool data.
August 2006: Oivind Wikstol - Almost completely re-written to work with new planning tool
[Previous]
[Next]
Project :SolarB EIS
Name :eis_plan_control_flags
Purpose :sets overall control flags for plan sequence
used for eis_cpt interface
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 June 2005
History
[Previous]
[Next]
Project : SOLAR-B/EIS
Name : EIS_PLAN_STC
Purpose : Convert EIS image tool structure to format
recognized by eis_mk_plan
Category : Planning
Syntax : IDL> stc=eis_plan_stc(eis_stc)
Inputs : EIS_STC = EIS image tool pointing structure
Outputs : STC = EIS planning tool pointing structure
Keywords : None
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], EIS_POINT_STC [1], EIS_POINT_STC [2], EXIST
HAVE_TAG, PR_SYNTAX
CALLED BY:
EIS_ITOOL_PTOOL [1], EIS_ITOOL_PTOOL [2]
History : 23-Aug-2006, Zarro (ADNET/GSFC) - written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
PROJECT:
Solar-B EIS
NAME:
EIS_PLOT_OBEV
PURPOSE:
Plots any of given resource item on the resource row
CATEGORY:
Planning, Science
EXPLANATION:
This routine plots any of the resource items on the science
plan display. Currently, DSN contact times, commanding times
(throughput RCR), and delayed commanding times
(payload_reserved) should be plotted on the same row; Other
station events should be plotted on the other row.
SYNTAX:
plot_resource, resource, startdis, row
INPUTS:
RESOURCE - Array of {eis_timeline_graphics_resource} structures
that has at least the following tags:
RES_NAME - Resource type (name of resource item)
START_TIME - The beginning times of the resource item, in TAI
stop_time - The end times of the resource item, in TAI
STARTDIS - Start time of the display, in any CDS time format
KEYWORDS:
ROW - row number in which the item is plotted (default: 0)
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], UTC2TAI
CALLED BY:
eis_timeline_plot_gui [1], eis_timeline_plot_gui [2]
RESTRICTIONS:
PLOT_FRAME must be called first.
HISTORY:
V0 August 2005 - John Rainnie, RAL
Based on "/ssw/soho/gen/idl/science/plot_resource.pro"
retained backbone of procedure but changed resouse names etc for EIS
choice of row and subrow, now depends on resource type
V1 26 July 2006 John Rainnie
[Previous]
[Next]
NAME:
eis_plot_spectrum
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
PROJECT:
Solar-B EIS
NAME:
EIS_PLOT_STEV
PURPOSE:
Plots any of given resource item on the resource row
CATEGORY:
Planning, Science
EXPLANATION:
This routine plots any of the resource items on the science
plan display. Currently, DSN contact times, commanding times
(throughput RCR), and delayed commanding times
(payload_reserved) should be plotted on the same row; Other
station events should be plotted on the other row.
SYNTAX:
plot_resource, resource, startdis, row
INPUTS:
RESOURCE - Array of {eis_timeline_graphics_resource} structures
that has at least the following tags:
RES_NAME - Resource type (name of resource item)
START_TIME - The beginning times of the resource item, in TAI
end_time - The end times of the resource item, in TAI
STARTDIS - Start time of the display, in any CDS time format
KEYWORDS:
ROW - row number in which the item is plotted (default: 0)
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], UTC2TAI
CALLED BY:
eis_timeline_plot_gui [1], eis_timeline_plot_gui [2]
RESTRICTIONS:
PLOT_FRAME must be called first.
HISTORY:
V0 August 2005 - John Rainnie, RAL
Based on "/ssw/soho/gen/idl/science/plot_resource.pro"
retained backbone of procedure but changed resouse names etc for EIS
choice of row and subrow, now depends on resource type
V1 26 July 2006 John Rainnie
[Previous]
[Next]
NAME: eis_plotter__define.pro
PURPOSE: An object fro plotting graphs
CATEGORY:
CALLING SEQUENCE: None
INPUTS: None
KEYWORD PARAMETERS: None
OUTPUTS: None
CALLS:
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
03/06/06 mcrw wrote
[Previous]
[Next]
Project : SOLAR-B/EIS
Name : EIS_POINT_STC
Purpose : Create an EIS pointing structure
Category : Planning
Syntax : IDL> stc=eis_point_stc(nrasters)
Inputs : NRASTERS = number of rasters
Outputs : EIS pointing structure with following tag definitions:
(arcsec units assumed)
ID: widget ID to for planning/image tool communication
DATE_OBS: date/time of start of raster (UT)
SCI_OBJ: science objective
SC_X/SC_Y: spacecraft X/Y pointing
FOV_WIDTH = EIS max FOV in X
FOV_HEIGHT = EIS max FOV in Y
XCEN/YCEN = raster center pointing
RAS_WIDTH/RAS_HEIGHT = raster width/height
CALLS: ***
is_number [1], is_number [2]
CALLED BY:
EIS_PLAN_STC [1], EIS_PLAN_STC [2]
History : 12-May-2006, Zarro (L-3Com/GSFC) - written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project
SolarB EIS
Name
EIS_POINTING
Purpose
Defines the eis_pointing data structure
Input
start_time - (tai) for this timeline entry
end_time - (tai)
Category
Timeline planning (handles pause)
Author
John Rainnie
Version
V0, dated January 2005
[Previous]
[Next]
NAME:
eis_prep
PURPOSE:
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS:
datafile: Name of FITS file with EIS data to be calibrated
dobj: If the file is already open a data object can be sent in in steadof a filename.
hdr: header object
savefilename: Name of FITS file where calibrated data with calibrated data.
If not given a default EIS file name ('eis_l1_yyyymmddThhmmss.fits')
will be created.
Outputs:
None
CALLS:
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
22-June-2006: Oivind Wikstol. Version 1.0
[Previous]
[Next]
Project :SolarB EIS
Name :EIS_raster
Purpose :Generates EIS_raster structure
Category :Technical planning (raster)
Author :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version : V0, dated 1 September 2004 - basic structure needed for technical planning
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name :eis_raster_angle_to_mirror_step
Purpose :raster angle to mirror step conversion
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 March 2005
CALLED BY
EIS_GET_STUDY [1], EIS_GET_STUDY [2]
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
eis_raster_compare
PURPOSE:
Function to determine whether 2 rasters are the same
KEYWORDS:
INPUTS:
ra_1 - a raster
ra_2 - another raster
OUTPUTS:
a flag indicating whether the rasters are the same (1) or not (0)
CATEGORY:
EIS Technical Planning
Database
MODIFICATION HISTORY:
V0 Written by: John Rainnie, RAL j.rainnie@rl.ac.uk (Dec 2005)
April 2006 - changed to
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_raster_detail__DEFINE
Purpose : Generates structure EIS_raster_detail.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case filename.
This routine defines the structure :
EIS_raster_detail. Tags are :-
raster_description : STRING mnemonic identifying the raster.
linelist_description : STRING mnemonic identifying the line list.
raster_id : ULONG used by planning tools.
Last 16 bits must not be 0 or 0xFFFF.
linelist_id : ULONG used by planning tools.
duration : ULONG indicates the expected duration
in seconds of the raster and raster repeats.
data : ULONG the amount of data in bytes expected
from running the raster and raster repeats.
slit_slot : UINT the slit slot to be used for the raster.
Range 0-3.
0 : slit width 1"
1 : slot width 250"
2 : slit width 2"
3 : slot width 40"
fine_mirror_position : UINT the initial fine mirror encoder position.
See engineering parameters for range.
fine_mirror_step : UINT the fine mirror encoder step size between
raster positions, Ensure fine mirror
limit not exceeded. See engineering
parameters for range. NB step can only be zero or positive.
number_of_mirror_positions : UINT the number of mirror positions in raster,
range 1-65535.
number_of_exposures_per_raster_position : UINT the number of exposures
at each raster position i.e within the
exposure loop. Range 1-8.
exposure_times : ULONG[8] exposure time for each exposure in
the exposure loop in milliseconds,
range 10-655350 in steps of 10 ms.
number_of_raster_repeats : UINT the number of times to repeat the raster,
range 1-4095.
data_compression_parameter : UINT selects the data compression scheme
to be used, range 0-7 (tbc).
ASRC_step : INT the fine mirror step performed at the
start of each raster in order to compensate
for Anti Solar Rotation Compensation.
If no ASRC then should be 0.
Range -127->+127.
ASRC_skip : UINT defines how often the Anti Solar Rotation
Compensation fine mirror step performed at the
start of each raster is performed during raster
repeats A value of 'n' implies ASRC step performed
every 'n'th raster.
If no ASRC then should be 0.
Range 0-255.
XRT_flare_control_flag : UINT flag indicating whether to respond to an XRT flare event.
EIS_flare_control_flag : UINT flag indicating whether to generate an EIS flare event.
EIS_event_control_flag : UINT flag indicating whether to generate an EIS event
AEC_control_flag : UINT flag indicating whether to use AEC control
special_hardware_window_flag : UINT flag defining whether to use the normal
hardware window (0) or the special hardware window (1).
special_hardware_window : UINT[4] coordinates of special Camera hardware window (CSG ID 4) :
0 : X start (0-2147)
1 : Y start (0-1023)
2 : X length (1-2148)
3 : Y length (1-1024)
normal_hardware_window : UINT[4] coordinates of normal Camera hardware window (CSG ID 3):
0 : X start (0-2147)
1 : Y start (0-1023)
2 : X length (1-2148)
3 : Y length (1-1024)
number_of_data_extraction_windows : UINT the number of data extraction windows. Range 1-25.
data_extraction_windows : Structure array[25] of type EIS_data_extraction_window.
Use : <dummy = {EIS_raster_detail>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.1, 25/08/04, MKC
Renamed tag number_of_raster_positions as
number _of_mirror_positions.
Removed raster_loop_flat_field tag.
Removed insert_slit_slot_command tag.
Version 0.2, 29/09/04, MKC
Renamed eis_event tag as eis_event_response.
Renamed xrt_flare tag as xrt_flare_response.
Renamed eis_flare tag as eis_flare_response.
Renamed AEC tag as AEC_control.
Added normal_hardware_window tag.
Version 0.3, 23/11/04, MKC
Added raster_description and linelist description tags.
Removed raster_title.
Added ASRC_skip.
Version 0.4, 28/02/05, MKC
Removed EIS XRT flare response, EIS flare response, EIS event response and AEC control structures
and replaced them with flags.
Removed flat_field tag and changed no. of exposures range.
Version 0.5, 10/03/05, MKC
Added raster_id and linelist_id tags.
Version 0.6, 24/06/05, MKC
Changed INT values to UINT.
Removed coarse mirror position and insert flag tags.
Version 0.7, 27/09/05, MKC
Changed fine mirror step to UINT.
Version : 0.7, 27/09/05
[Previous]
[Next]
NAME:
eis_raster_details_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
EIS_RASTER_DURATION()
PROJECT
SOLAR-B/EIS
EXPLANATION
Estimates the total duration of an EIS raster.
Note that hardware windows are defined for each CCD half. The
X-limits of these windows are derived by considering the
furthest spaced spectral windows from each CCD half together.
INPUTS
ra - an eis_raster structure
ll - an eis_linelist structure
HISTORY
Beta 1, 28-Apr-2006, Peter Young
numbers obtained from EIS document (unknown author)
Beta 2, 5-May-2006, Peter Young
now works out hardware windows correctly.
Updated
CALLED BY
eis_add_study [1], eis_add_study [2], eis_import_raster [1]
eis_import_raster [2], eis_import_study_gui, eis_mk_plan_gui [1]
eis_mk_plan_gui [2], eis_mk_raster_gui__define [1]
eis_mk_raster_gui__define [2], eis_raster_gui [1], eis_raster_gui [2]
eis_structure_container__define [1], eis_structure_container__define [2]
[Previous]
[Next]
NAME:
eis_raster_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
eis_raster_index_gui
PURPOSE:
This object
INPUTS:
GROUP -
Written
John Rainnie, RAL - a while ago
Modified
V0.1, 15 July 2006
Removed modal keyword and changed string format in line
with eis_mk_study. Also made list double-clickable
CALLS:
[Previous]
[Next]
NAME:
eis_raster_undo__DEFINE
PURPOSE:
This procedure defines the data memebers of the
Object "eis_raster_undo".
INPUTS:
ll - a lineList (eis_line_list) structure
ra - a raster (eis_raster) structure
AUTHOR:
John A. Rainnie - RAL (j.a.rainnie@rl.ac.uk)
CALLS:
[Previous]
[Next]
NAME: eis_rd_sts_fits.pro
PURPOSE: To read solar-B status fits file archives.
CATEGORY:
CALLING SEQUENCE: eis_read_status_fits, 'fits_archive'
INPUTS: Filename string of the status archive
KEYWORD PARAMETERS: None
OUTPUTS: One fits file per status APID
CALLS: ***
EIS_GETSTARTTIME, EIS_PLOT, EIS_PLOTHK1STATUS, EIS_PLOTHK1STRUCTURETEMP
EIS_PLOTHK1SURVIVALTEMP, EIS_PLOTICUCOUNTERS, EIS_PLOTICUCURRENTS
EIS_PLOTICUEXPNUM, EIS_PLOTICUTEMPERATURES, EIS_PLOTICUVOLTAGES
EIS_PLOTMHCCURRENTS, EIS_PLOTMHCTEMPSGP0, EIS_PLOTMHCVOLTAGES, EIS_RD_HK1_FITS
EIS_RD_STS1_FITS, EIS_RD_STS2_FITS, EIS_RD_STS3_FITS, EIS_READ_STATUS_FITS
FXBCLOSE [1], FXBCLOSE [2], FXBOPEN [1], FXBOPEN [2], FXBOPEN [3], FXBREAD [1]
FXBREAD [2], FXBREAD [3], HK1_HEADERS, PRINT_STS1_VOLTAGE_PARAMETERS
READ_FITS_DATA, STS1_HEADERS, STS2_HEADERS, STS3_HEADERS
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
02/02/06 mcrw wrote
17/03/06 -
03/04/06 mcrw modifications during thermal vacuum test
[Previous]
[Next]
NAME: eis_rd_sts_fits.pro
PURPOSE: To read solar-B status fits file archives.
CATEGORY:
CALLING SEQUENCE: eis_read_status_fits, 'fits_archive'
INPUTS: Filename string of the status archive
KEYWORD PARAMETERS: None
OUTPUTS: One fits file per status APID
CALLS:
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
02/02/06 mcrw wrote
17/03/06 -
03/04/06 mcrw modifications during thermal vacuum test
[Previous]
[Next]
NAME: eis_read_fits_data.pro
PURPOSE: To read solar-B status fits file archives.
CATEGORY: Engineering
CALLING SEQUENCE: eis_read_fits_data, 'fits_archive', 'parameter_name', header_number
INPUTS: fits_archive: string of the status archive
parameter_name: string name of the status parameter
header_number: unsigned short of the bintable extension
KEYWORD PARAMETERS: None
OUTPUTS: The status data for the parameter
CALLS: ***
FXBCLOSE [1], FXBCLOSE [2], FXBOPEN [1], FXBOPEN [2], FXBOPEN [3], FXBREAD [1]
FXBREAD [2], FXBREAD [3]
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
02/02/06 mcrw wrote
17/03/06 mcrw
03/04/06 mcrw modifications during thermal vacuum test
10/08/06 mcrw stripped out unwanted code
[Previous]
[Next]
NAME: eis_read_fits_header.pro
PURPOSE: To read solar-B status fits file archives.
CATEGORY: Engineering
CALLING SEQUENCE: eis_read_fits_data, 'fits_archive', header_number
INPUTS: fits_archive: string of the status archive
header_number: unsigned short of the bintable extension
KEYWORD PARAMETERS: None
OUTPUTS: The header data for the bintable extension
CALLS: ***
FXBCLOSE [1], FXBCLOSE [2], FXBOPEN [1], FXBOPEN [2], FXBOPEN [3]
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
02/02/06 mcrw wrote
17/03/06 mcrw
03/04/06 mcrw modifications during thermal vacuum test
10/08/06 mcrw stripped out unwanted code
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
eis_read_linelist_block
PURPOSE:
Procedure
CATEGORY:
EIS Technical Planning
INPUTS:
block - a bunch of lines of text
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], SYSTIM, strsplit
CALLED BY:
eis_import_study [1], eis_import_study [2], eis_import_study_gui
MODIFICATION HISTORY:
Written by: John Rainnie, RAL (March 2005)
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
eis_read_raster_block
PURPOSE:
Procedure
CATEGORY:
EIS Technical Planning
INPUTS:
ra - eis_raster structure
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], SYSTIM, strsplit
CALLED BY:
eis_import_study_gui
MODIFICATION HISTORY:
Written by: John Rainnie, RAL (March 2005)
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
eis_read_study_block
PURPOSE:
Procedure
CATEGORY:
EIS Technical Planning
INPUTS:
ra - eis_raster structure
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], SYSTIM, strsplit
CALLED BY:
eis_import_study_gui
MODIFICATION HISTORY:
Written by: John Rainnie, RAL (March 2005)
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
eis_read_study_lists
PURPOSE:
Read ascii files - "eis_originator_list.lis" ,
"eis_category_list.lis" ,
"eis_target_list.lis"
INPUTS:
- one of "TARGET", "CATEGORY" & "AUTHOR" keywords
CATEGORY:
EIS Technical Planning
Database
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], concat_dir [4]
CALLED BY:
eis_author_gui [1], eis_author_gui [2], eis_db_save_gui [1]
eis_db_save_gui [2], eis_export_gui [1], eis_export_gui [2], eis_sci_obj_gui
MODIFICATION HISTORY:
Written by: John Rainnie, RAL - j.rainnie@rl.ac.uk (Dec 2005)
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
eis_read_studyraster_block
PURPOSE:
Procedure
CATEGORY:
EIS Technical Planning
INPUTS:
ra - eis_raster structure
CALLS: ***
strsplit
CALLED BY:
eis_import_study_gui
MODIFICATION HISTORY:
Written by: John Rainnie, RAL (March 2005)
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
EIS_READ_TIMELINE_DATABASE_TABLES
PURPOSE:
Function to read timeline database tables
CATEGORY:
EIS planning
WRITTEN:
Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
VERSION:
V0 September 2005
V1 May 2005 JAR
CALLS:
CALLED BY
eis_timeline_container__define [1], eis_timeline_container__define [2]
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_real_detail__DEFINE
Purpose : Generates structure EIS_real_detail.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_real_detail. Tags are :
description : STRING a description of the real command study.
duration : DOUBLE indicates the expected duration
in seconds of the real command study.
data : ULONG the amount of data in bytes expected
from running the real command study.
Use : <dummy = {EIS_real_detail>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 11/07/05
Modified :
Version : 0.0, 11/07/05
[Previous]
[Next]
NAME:
eis_repoint_xy_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name
xrt_flare_tlc
Purpose
Category
Author
Version
[Previous]
[Next]
NAME:
eis_response_study_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name eis_science_component__define
Purpose :Defines the eis_science_component data structure
eis_science_2 - (one for each raster in the study) stored in EISscience2DB
ID :sequence ID associated with related eis_science_component
ra_index :position of raster in study sequence
ra_repeats :number of times to repeat this raster
eis_science_component - stored in EISscienceDB
ID :sequence ID associted with this entry
sci_gen :general science description for this entry
sci_eis :eis science description for ths entry
campaign :campaign details for this entry
notes :notes associted with this entry
disturbance :disturbance info associated with this entry
target :target for this entry
targetID :target ID for this entry
studyID :study ID
n_rasters :number of rasters in study
n_repeat :number of times to repeat this study
raster_info :replicated eis_science_2
Category :Timeline planning (timeline)
Author :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0, dated January 2005
History :June 2005 added {eis_raster2} to eis_science_2
:August 2005 replaced eis_science2 with eis_study_raster
:September slit_slot added.
[Previous]
[Next]
Project :SolarB EIS
Name :eis_science_entry
Purpose :Defines the EIS_science_entry data structure
eis_science_2 - (one for each raster in the study) stored in EISscience2DB
ID :sequence ID associated with related eis_science_entry
ra_index :position of raster in study sequence
ra_repeats :number of times to repeat this raster
eis_science_entry - stored in EISscienceDB
ID :sequence ID associted with this entry
sci_gen :general science description for this entry
sci_eis :eis science description for ths entry
campaign :campaign details for this entry
notes :notes associted with this entry
disturbance :disturbance info associated with this entry
target :target for this entry
targetID :target ID for this entry
studyID :study ID
n_rasters :number of rasters in study
n_repeat :number of times to repeat this study
raster_info :replicated eis_science_2
Category :Timeline planning (timeline)
Author :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0, dated January 2005
CALLS: ***
EIS_SCIENCE_ENTRY__DEFINE
History :June 2005 added {eis_raster2} to eis_science_2
:August 2005 replaced eis_science2 with eis_study_raster
:September slit_slot added.
[Previous]
[Next]
Project : Solar-B/EIS >
>
Name : EIS_SERVER >
>
Purpose : return URL and path to EIS FITS data server
>
Category : sockets >
>
Inputs : None >
>
Outputs : SERVER = EIS server name >
Keywords : NETWORK = 1 if network is up
PATH = path to data >
NO_CHECK = return server without checking network status
>
CALLS: ***
HAVE_NETWORK
CALLED BY:
EIS_FITS_URL [1], EIS_FITS_URL [2]
History : 1-June-2006, D.M. Zarro (L-3Com/GSFC), Written >
>
Contact : DZARRO@SOLAR.STANFORD.EDU >
[Previous]
[Next]
Project : HESSI
Name : EIS_SOCK_FIND
Purpose : Find EIS FITS files on a remote Web server
Category : utility system sockets
Inputs : FILE = filename to search for
Outputs : OUT = filename with server path name
Keywords : ERR = error string
COUNT = # of files found [ = 1]
CALLS: ***
HAVE_NETWORK, IS_BLANK, SYNOP_SERVER, TRIM2
History : 7-Jan-2002, D.M. Zarro (EITI/GSFC) Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
NAME:
EIS_SPCD__DEFINE
PURPOSE:
The eis_spcd object is the general superclass for spcd
class objects used by the Hansteen/Wikstøl QL/data analysis
SW. The spcd object contains data that is aqcuired from
the space craft data telemetry stream on Solar-B.
Some of these are used in the main FITS hdr of Solar-B fits files.
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
spcd_obj = obj_new('spcd', file = file)
INPUTS:
None
KEYWORD PARAMETERS:
OUTPUTS:
Objects of class EIS_SPCD includes the following parameters:
CALLS: ***
EIS_SPCD::GETCROTA1, EIS_SPCD::GETCROTA2, EIS_SPCD::GETCRVAL1
EIS_SPCD::GETCRVAL2, EIS_SPCD::GETHLZ, EIS_SPCD::GETINST_ROT, EIS_SPCD::GETSAA
EIS_SPCD::GETSAT_ROT, EIS_SPCD::GETTR_MODE, EIS_SPCD::GETXCEN
EIS_SPCD::GETYCEN, EIS_SPCD::INIT, EIS_SPCD::READ
COMMON BLOCKS:
PROCEDURE:
Defines the structure of plan class objects. If no filename
is given as input, the FITS keywords are set by
the init-procedure. If filename is given (space craft data telemetry
file), it is read from that file by eis_spcd__read.pro
RESTRICTIONS:
MODIFICATION HISTORY:
15-Nov-2005: Oivind Wikstol. First draft
WARNING: saa, hlz, should come from ISACS-PLN files??
August 2006: Added xcen and ycen
[Previous]
[Next]
PROJECT:
Solar-B EIS
NAME:
eis_split_window
PURPOSE:
Function to test whether any windows overlap. This is done for
each CCD separately.
INPUTS:
ll - an eis_line_list structure
OUPUTS:
ll - an eis_line_list structure
CATEGORY:
EIS Technical Planning - eis_mk_raster
CALLED BY:
eis_ll_obj__DEFINE [1], eis_ll_obj__DEFINE [2]
MODIFICATION HISTORY:
V0. Written by: John Rainnie, RAL
j.rainnie@rl.ac.uk (Feb 2006)
[Previous]
[Next]
NAME: eis_status_fits_reader1.pro
PURPOSE: A Solar-B EIS status fits gui
CATEGORY:
CALLING SEQUENCE: @reader1
INPUTS: None
KEYWORD PARAMETERS: None
OUTPUTS: None
CALLS: ***
BUTTON_HANDLER, EIS_READ_STATUS_FITS, EVENT_HANDLER, EXTNAMEHANDLER
EXTPARAHANDLER, FILE_MENU_OPEN, FILE_MENU_QUIT, FXBCLOSE [1], FXBCLOSE [2]
FXBOPEN [1], FXBOPEN [2], FXBOPEN [3], GET_FILE_TYPE, GET_HEADERS
HDR_TEXT_HANDLER, PRINT_BUTTON_HANDLER, SET_EXT_LIST0, SET_EXT_LIST1
SET_EXT_LIST2, SET_EXT_LIST3, UPDATEHK1PARALIST, UPDATEPARALIST
UPDATESTS1PARALIST, UPDATESTS2PARALIST, UPDATESTS3PARALIST, UPDATE_LIST
WRITE_GIF, XMANAGER
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
02/02/06 mcrw wrote
17/03/06 -
03/04/06 mcrw modifications during thermal vacuum test
[Previous]
[Next]
NAME: eis_status_hk1_conversions.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS:
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
03/June/2006 mcrw wrote
[Previous]
[Next]
NAME: eis_status_parameter__define.pro
PURPOSE: To create an object that contains information defining
individual status parameters for EIS.
CATEGORY: Engineering
CALLING SEQUENCE: None
INPUTS: Lun of a file containing parameter descriptions.
KEYWORD PARAMETERS: None
OUTPUTS: None
CALLS: ***
EIS_STATUS_PARAMETER::COMMENT, EIS_STATUS_PARAMETER::DATA
EIS_STATUS_PARAMETER::DESCRIBE, EIS_STATUS_PARAMETER::MAXVAL
EIS_STATUS_PARAMETER::MINVAL, EIS_STATUS_PARAMETER::NAME
EIS_STATUS_PARAMETER::READ, EIS_STATUS_PARAMETER::SETDATA
EIS_STATUS_PARAMETER::UNIT
COMMON BLOCKS:None.
PROCEDURE:
RESTRICTIONS: None
MODIFICATION HISTORY:
23/11/05 mcrw wrote
[Previous]
[Next]
NAME: eis_status_plot.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS:
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
02/02/06 mcrw wrote
17/03/06 -
03/04/06 mcrw modifications during thermal vacuum test
[Previous]
[Next]
NAME: eis_status_sts1_conversions.pro
PURPOSE: To convert EIS status 1 parameters from telemetered values
to engineering values
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS:
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
03/June/2006 mcrw wrote
[Previous]
[Next]
NAME: eis_status_sts2_conversions.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS:
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
03/June/2006 mcrw wrote
[Previous]
[Next]
NAME: eis_status_sts3_conversions.pro
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS: None
OUTPUTS:
CALLS:
COMMON BLOCKS: None
PROCEDURE:
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
03/June/2006 mcrw wrote
21/Sept/2006 mcrw v2.0
[Previous]
[Next]
Project :SolarB EIS
Name :eis_structure_container__define
Purpose :Defines an object wrapper for structures
Category :Timeline planning (timeline)
Author :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0, dated October 2005
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name :eis_study
Purpose :Defines data structure xrt_response_props
Category :Technical planning (study)
Author :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0, dated 6 September 2004
:V0.1, dated 23 November 2004
: write_locked added May 2005.
: concept of study_raster changed completely July 2005
: broke alternative studies into separate stuctures August 2005.
: broke into response props into separate structure definitions.
CALLS:
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_STUDY_DEFINE
PURPOSE
Defines data structure eis_study
Study
id study id
acronym study acronym
target study target - drawn from project list
parameter study parameter ditto.
author study author ditto
description file containing ASCII description
numRasters number of rasters in this study
studyRasters description for each raster
duration study duration - without compression
volume study data volume - without compression
CATEGORY
Technical planning (study)
AUTHOR
Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
VERSION
V0, Chunkey Lepine, 6 September 2004, RAL
V0.1 Changed many of the tags - JAR
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_study_detail__define
Purpose : Generates structure EIS_study_detail.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_study_detail. Tags are :-
study_identifier : ULONG uniquely identifies the study to
the planning databases
description : STRING mnemonic for either science or engineering study
start_time : DOUBLE TAI start time of the command
in the OP store or GSE to run the first EIS
sequence associated with the study or
the expected time that the study will
start if the study is daisy-chained
to another study or the latest time
that the study will be used if neither
of the previous.
time_tagged : UINT flag indicating whether the study is
to be set off from the on-board OP store (1)
or not (0).
duration : ULONG indicates the expected duration in
seconds of a single run through the study.
data : ULONG the amount of data in bytes expected
from running the study.
study_repeat_number : UINT number of times to repeat the study (1-255).
NB An EIS sequence table can be repeated
but if a study spans more than one EIS
sequence it cannot be repeated a fixed
number of times (though can be repeated
indefinitely by daisy-chaining to itself).
linked_study_identifier : ULONG study identifier of the following
daisy-chained study. Should be zero if
no linked study.
slit_slot : structure of type EIS_CPT_mechanism_change.
engineering : UINT flag indicating engineering study (1) or not.
XRT_flare_control_flag : UINT flag indicating whether study contains one or more XRT
flare responsive rasters.
EIS_flare_control_flag : UINT flag indicating whether study contains one or more flare
hunting rasters.
EIS_event_control_flag : UINT flag indicating whether study contains one or more event
hunting rasters.
AEC_control_flag : UINT flag indicating whether the study contains one or more
rasters using AEC.
onboard : UINT flag indicating whether the study is to be kicked
off from the onboard OP store (1) or from the GSE (0).
Use : <dummy = {EIS_study_detail}>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.1, 16/11/04, MKC
Added description tag.
Version 0.2, 09/12/04, MKC
Added slit_slot and coarse_mirror tags.
Version 0.3, 17/01/05, MKC
Removed coarse_mirror tag.
Version 0.4, 01/03/05, MKC
Add engineering study tag.
Version 0.5, 23/03/05, MKC
Add onboard tag.
Version 0.6, 23/06/05, MKC
Add event flags.
Changed INT values to UINT.
Version : 0.6, 23/06/05
[Previous]
[Next]
NAME:
eis_study_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name :eis_study_raster
Purpose :Defines data structure eis_study_raster
Study Raster
id raster id
repeats number of times to repeat each raster
(all parameters below this line are extracted from EISrasterDB)
acronym
title
duration
volume
Category :Technical planning (study)
Author :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0, dated 6 September 2004
:V0.1, dated 23 November 2004
: write_locked added May 2005.
: concept of study_raster changed completely July 2005
; broke alternative studies into separate stuctures August 2005.
: split off eis_study_raster to increase visiblity for eis_mk_plan
CALLS:
[Previous]
[Next]
NAME:
eis_study_undo__DEFINE
PURPOSE:
This procedure defines the data memebers of the
object "eis_study_undo".
INPUTS:
st - a study (eis_study) structure
AUTHOR:
John A. Rainnie - RAL (j.a.rainnie@rl.ac.uk)
CALLS:
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_suspend_period__DEFINE
Purpose : Generates structure EIS_suspend_period.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_suspend_period. Tags are :
description : STRING description
onboard : UINT FLAG indicating whether the suspension command should be sent from the 'OP' store (1)
or from the 'REAL' time control file (0).
pause_time : DOUBLE TAI time of start of suspension of operation
period.
resume_time : DOUBLE TAI time to resume operations.
Use : <dummy = {EIS_suspend_period>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.0, 03/08/04, MKC
Version 0.1, 10/03/05, MKC
Added description tag.
Version 0.2, 22/03/05, MKC
Added onboard tag.
Version 0.3, 24/06/05, MKC
Changed INT values to UINT.
Version : 0.3, 24/06/05, MKC
[Previous]
[Next]
NAME:
EIS_SYNSPEC__DEFINE defines the class EIS_SYNSPEC. Objects of this
class form the interface between the "Chianti" package and the EIS QL
software. The EIS_SYTSNPEC class inherits the superclass HW_DATA
PURPOSE:
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE: EIS_SYNSPEC is created by
eis_synspec = obj_new('eis_synspec',det,region)
INPUTS:
det: detector that synthetic spectra is to be computed for
region: the type of region synthetic spectra is to be computed for
i.e. 'qs','ar','fl',...
KEYWORD PARAMETERS:
OUTPUTS:
CALLS: ***
EIS_SYNSPEC::EISGENERATE, EIS_SYNSPEC::EISLOAD, EIS_SYNSPEC::GETPHOTONS
EIS_SYNSPEC::GETTMAX, EIS_SYNSPEC::INIT, EIS_SYNSPEC::SETEISDEFAULTS
EIS_SYNSPEC__DEFINE, GET_DELIM, INTERPOL
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
06-Jan-2006: Viggo H. Hansteen First version
$Id: eis_synspec__define.pro,v 1.7 2006/08/25 12:59:46 viggoh Exp $
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_SYSTEM_DATA
CATEGORY
PLANNING
PURPOSE
Defines data structure eis_system_data
eis_system_data
dataDirectory directory for most data files
engineeringDirectory specific directory for engineering files
dBdirectory directory for database files
MODIFICATION HISTORY
Written - Chunkey Lepine, 14 October 2004
Modified - JAR 31 May 2005
[Previous]
[Next]
Project :SolarB EIS
Name :EIS_technical_plan_entry
Purpose :Defines the EIS_technical-plan data structure
Category :Technical planning (timeline)
Author :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0, dated January 2005
CALLS:
[Previous]
[Next]
NAME: eis_ti2utc.pro
PURPOSE: Converts spacecraft time to utc
CATEGORY: Science
CALLING SEQUENCE: result = eis_ti2utc(ti, grt)
result = eis_ti2utc('0033D637',' 20050811113116')
INPUTS: ti : (string) onboard spacecraft time
grt : (string) ground received time
KEYWORD PARAMETERS: None
OUTPUTS: If no errors occur in processing the output is a string in
in the approved EIS format (yyyymmddThhmmss). In the event
of an error the grt is returned, which is the EIS time
format without the T.
CALLS: ***
ANYTIM2CAL, doy2ex [1], doy2ex [2]
CALLED BY:
EIS_MK_FITSNAME [1], EIS_MK_FITSNAME [2], eis_make_status_fits [2]
eis_make_status_fits [3]
COMMON BLOCKS: None.
PROCEDURE: 2 auxilliary files are required for the time conversion,
supplied by J-side. One is a CNV_FILE which contains
information about time conversion for a specified range
in every year and the other is a leap seconds file.
RESTRICTIONS: Uses SolarSoft
MODIFICATION HISTORY:
25/08/06 Viggo Hansteen, mcrw wrote
26/08/06 mcrw added documentation
renamed function
used environment variable in spawn
not using strput as gave wrong result
26/09/06 mcrw Tries all CNV files
Requires $EIS_TI_BASE
[Previous]
[Next]
Project :SolarB EIS
Name :eis_time_stamp
Purpose :Defines the eis_time_stamp data structure
comment :comment for this entry - added by planner
Category :Timeline planning (timeline)
Author :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0, dated February 2005
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name :eis_time_stamp
Purpose :Defines the eis_time_stamp data structure
comment :comment for this entry - added by planner
Category :Timeline planning (timeline)
Author :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0, dated February 2005
CALLS:
[Previous]
[Next]
Project
SolarB EIS
Name
eis_timeline_container
Purpose
Function defining the timeline container (tlc)
Category
Timeline planning (timeline)
Author
John Rainnie (JAR) & Chunkey Lepine, RAL.
Version
V0.0 Written by Chunkey, RAL, August 2005
V0.1 JAR May 2006
Updated to include XRTFlare hunter study properties
V0.3 JAR 1 August 2006
Created concept of entry blocks - where a block consists of
a time-tagged study and any chained entries. This has
simplified greatly the logic required to
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name :eis_timeline_entry
Purpose :Defines the eis_time_component structure
Category :Timeline planning (timeline)
Author :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0, dated January 2005
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name :eis_timeline_entry__define
Purpose :Defines the eis_timeline_entry structure
Category :Timeline planning
Author :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0, dated November 2005
CALLED BY
EIS_timeline_plan_entry
[Previous]
[Next]
Project :SolarB EIS
Name eis_timeline_graphics
Purpose :defines eis_timeline_graphics
eis_timeline_graphics (strucuture)
Category :timeline-planning graphics (eis_make_plan)
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 August 2005
[Previous]
[Next]
Project :SolarB EIS
Name :eis_timeline_graphics_axes
Purpose :defines eis_timeline_graphics_axes structure
window_id id of graphics window
x_axis_day_TAI start of x-axis (truncated to days), TAI
x_axis_start start hours - relative to xAxisDayTAI
x_axis_length duration in hours
y_axis_labels string of labels for y axis
Category :timeline-planning graphics (eis_make_plan)
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V1 August 2005
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name :eis_timeline_graphics_axes_default
Purpose :defines eis_timeline_graphics_axes_default values
Category :timeline-planning graphics (eis_make_plan)
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V1 August 2005
CALLS:
CALLED BY
eis_mk_plan_gui [1], eis_mk_plan_gui [2]
[Previous]
[Next]
Project :SolarB EIS
Name :eis_timeline_graphics_marker
Purpose :defines eis_timeline_graphicsmarker structure
Category :Timeline planning (make plan)
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V1 August 2005
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name :eis_timeline_graphics_resource
Purpose :defines eis_timeline_graphics_axes structure
Category :timeline-planning graphics (eis_make_plan)
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V1 August 2005
CALLS:
[Previous]
[Next]
Project :SolarB EIS
Name :EIS_timeline_plan_entry
Purpose :Defines the EIS_timeline-plan data structure
Category :Timeline planning (timeline)
Author :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0, dated January 2005
CALLS:
[Previous]
[Next]
NAME:
eis_timeline_plot_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
eis_title_input_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
PROJECT:
SolarB EIS
NAME:
eis_title_unique
PURPOSE:
Determine whether a lineList title and acronym already exists.
It checks both are unique.
KEYWORDS:
linelist - entry type
raster - " "
study - " "
INPUTS:
title - the new title
acron - the new acronym
OUTPUTS:
a structure containing the tags;
unique_title = 0/1 when title is unique/not
exists_title = (string) ID of (first) ll with this title
unique_acron = 0/1 when acronym is unique/not
exists_acron = (string) ID of (first) ll with this acronym
CATEGORY:
EIS Technical Planning
Database
CALLS: ***
db_read_linelist_all [1], db_read_linelist_all [2], db_read_raster_all [1]
db_read_raster_all [2], db_read_study_all [1], db_read_study_all [2]
CALLED BY:
eis_acronym_input_gui, eis_db_save_gui [1], eis_db_save_gui [2]
eis_import_acronym_gui, eis_import_study_gui, eis_import_title_gui
eis_save_imported_linelist, eis_save_imported_raster, eis_title_input_gui
MODIFICATION HISTORY:
V0 Written by: John Rainnie, RAL j.rainnie@rl.ac.uk (Dec 2005)
April 2006 - changed to check both title & acroynm
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_READ_TIMELINE_DATABASE_TABLES
CATEGORY
EIS planning
PURPOSE
Function to update an "as-planned" database entry
INPUTS
WRITTEN
John A Rainnie, RAL
VERSION
V0.0 August 2005
CALLS:
CALLED BY
eis_write_timeline_database_tables [1]
eis_write_timeline_database_tables [2]
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_UPDATE_TIMELINE_SCIENCE_ENTRY
CATEGORY
EIS planning
PURPOSE
Function to update an "as-planned" database entry
INPUTS
WRITTEN
John A Rainnie, RAL
VERSION
V0.0 August 2005
CALLS:
CALLED BY
eis_write_timeline_database_tables [1]
eis_write_timeline_database_tables [2]
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_upload__DEFINE
Purpose : Generates structure EIS_upload.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_upload. Tags are :-
time : DOUBLE TAI time of day of upload.
upload_id : STRING giving day and four character pass identifier for the upload pass
i.e yyyymmddPassiD = '200612250001'.
This must be set if the /JSIDE option is selected.
version : STRING 3 digit upload version : 820-829 for EIS.
RAM_sub_id : STRING 2 digit RAM sub ID : 00 - 99 for EIS.
Use : <dummy = {EIS_upload>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : Moved out of routine EIS_raster_detail__define.
Written : Martin Carter RAL 14/06/06
Modified : Version 0.0, 14/06/06, MKC
Version 0.1, 20/08/06, MKC
Added upload version to structure.
Version 0.2, 03/10/06, MKC
Changed upload structure.
Version : 0.1, 20/08/06
[Previous]
[Next]
Project : SOLAR-B/EIS
Name : EIS_VALID_POINT
Purpose : Check if EIS raster pointing is within EIS FOV
Category : Planning
Syntax : IDL> valid=eis_valid_point(x,y,point_stc,index)
Inputs : X,Y = pointing coordinates (arcsecs) to check
POINT_STC = EIS pointing structure (EIS_MK_PLAN &
EIS_IMAGE_TOOL formats are supported).
EIS_FOV = EIS fov structure
Outputs : VALID = 1/0 if valid/invalid
Keywords : INDEX = index of raster (if more than one raster)
CALLS: ***
HAVE_TAG, is_number [1], is_number [2], is_struct
CALLED BY:
EIS_ITOOL_PTOOL [1], EIS_ITOOL_PTOOL [2]
History : 16-Aug-2006, Zarro (ADNET/GSFC) - written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
PROJECT
Solar-B EIS
NAME
EIS_VIEW_STUDY_DESCRIPTIONS
PURPOSE
Procedure to display a study description file using IDL's
XDisplayFile routine. This is editable if using a study
description from the USER database. Otherwise not.
INPUTS
st_id - a study ID
tlbID - the widget ID of the parent widget
OUPUTS
None
CATEGORY
EIS Technical Planning - eis_mk_study & eis_mk_plan
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], XDISPLAYFILE [1]
XDISPLAYFILE [2], concat_dir [4], eis_get_study_descriptions_path [1]
eis_get_study_descriptions_path [2], eis_get_zdbase [1], eis_get_zdbase [2]
CALLED BY:
eis_mk_plan_gui [1], eis_mk_plan_gui [2], eis_mk_study_gui [1]
eis_mk_study_gui [2], eis_study_gui [1], eis_study_gui [2]
MODIFICATION HISTORY:
V0.0 Written by: John Rainnie, RAL
j.rainnie@rl.ac.uk (Feb 2006)
V0.1 JAR 16 Aug 2006
[Previous]
[Next]
Project :SolarB EIS
Name :eis_wavelength_to_node
Purpose :wavelength to node conversions
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 February 2005
CALLED BY:
EIS_GET_STUDY [1], EIS_GET_STUDY [2]
History :Updated June 2005 using JM results
[Previous]
[Next]
NAME:
EIS_WAVELENGTH_TO_PIXELS()
PROJECT
SOLAR-B/EIS
EXPLANATION
Converts a wavelength to a pixel location.
INPUT
WAVE The wavelength specified in pico-metres. (This format is required
by the EIS planning software.) WAVE must be specified as a scalar.
OUTPUT
The pixel location corresponding to wavelength WAVE. Fractional pixel
values are not given.
EXAMPLE
IDL> print,eis_wavelength_to_pixels(19512)
1291
CALLS
EIS_GET_CCD_TRANSLATION()
HISTORY
Ver.1, 16-May-2006, Peter Young
CALLS:
CALLED BY
EIS_GET_STUDY [1], EIS_GET_STUDY [2], EIS_LINE_VALUES [1], EIS_LINE_VALUES [2]
eis_mk_raster_gui__define [1], eis_mk_raster_gui__define [2]
[Previous]
[Next]
Project :SolarB EIS
Name :eis_write_science_component_database_table
Purpose :Function to write engineering component database table
Category :EIS timeline planning
Written :Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version :V0 November 2005
CALLS:
CALLED BY
eis_write_timeline_database_tables [1]
eis_write_timeline_database_tables [2]
[Previous]
[Next]
Project
SolarB EIS
Name
EIS_WRITE_TIMELINE_COMPONENT_DATABASE_TABLE
Purpose
Function to write timeline component database table
Category
EIS timeline planning
Written
Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515
Version
V0 November 2005
CALLS:
CALLED BY
eis_write_timeline_database_tables [1]
eis_write_timeline_database_tables [2]
[Previous]
[Next]
Project
SolarB EIS
Name
EIS_READ_TIMELINE_DATABASE_TABLES
Purpose
Function to save/write timeline entries to the "as-planned"
database.
The concept is to check whether a tlc entry object has
already been saved. After inserting a new timeline entry,
encapsulating it into a timeline_entry object, it is
initialized with SEQUENCE_ID = 0.
When this entry is saved to the database, a unique
SEQUENCE_ID value is allocated.
Category
EIS planning
Written
John A. Rainnie
Version
V0.0 originally written by Chunkey- September 2005
V0.1 Completely re-designed JAR
CALLS:
CALLED BY
eis_timeline_container__define [1], eis_timeline_container__define [2]
[Previous]
[Next]
NAME: eis_xlinelist
PURPOSE: This procedure
INPUTS: NONE
CALLED BY
eis_mk_raster_gui__define [1], eis_mk_raster_gui__define [2]
[Previous]
[Next]
NAME: eis_xraster
PURPOSE: This procedure
INPUTS: NONE
CALLED BY
eis_mk_raster_gui__define [1], eis_mk_raster_gui__define [2]
eis_mk_study_gui [1], eis_mk_study_gui [2]
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_XRT_flare_control__DEFINE
Purpose : Generates structure EIS_XRT_flare_control.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_XRT_flare_control. Tags are :
response_identifier : ULONG number uniquely identifying
the study to be run if an XRT flare
occurs. 0 if no response to an
XRT flare.
raster_identifier : ULONG specifies which raster in the flare study the autonomous
repointing is applied to ( if required).
Last 16 bits must not be 0 or 0xFFFF.
filler_identifier : ULONG number uniquely identifying the
study to be run if get an XRT flare end
event. 0 if no follow-on study.
adjust_Y : UINT flag indicating whether repointing in the Y
direction by changing the window height and the
camera readout window is allowed (1) or not (0).
adjust_X : UINT flag indicating whether repointing in the X
direction using the fine mirror is allowed (1) or not (0).
Use : <dummy = {EIS_XRT_flare_control>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.0, 03/08/04, MKC
Version 0.1, 24/02/05, MKC
Moved parameters from EIS XRT flare response.
Version 0.2, 24/06/05, MKC
Changed INT values to UINT.
Version 0.3, 04/07/05, MKC
Added number of rasters tag..
Version 0.4, 08/09/05, MKC
Changed raster number/ number of rasters tag to raster identifier.
Version 0.5, 19/06/06, MKC
Changed tag study identifier and filler sequence identifier.
Version : 0.5, 19/06/06
[Previous]
[Next]
NAME:
eis_xrt_flare_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
Project : SOLAR-B - EIS
Name : EIS_XRT_flare_parameters__DEFINE
Purpose : Generates structure EIS_XRT_flare_parameters.
Explanation : When IDL encounters structure 'STRname', if structure not already defined
it looks for routine strname__define and compiles and calls routine to define
structure. NB under unix it looks for lower case flename.
This routine defines the structure :
EIS_XRT_flare_parameters. Tags are :
verify_FOV : UINT flag indicating whether to check whether the flare
is within the EIS FOV (1) or not (0).
X0 : INT signed value giving EIS-XRT X alignment error.
Range -4095 to +4095.
Y0 : INT signed value giving EIS-XRT Y alignment error
Range -4095 to +4095.
X_conversion : UINT EIS-XRT optical orientation. This should be set
to 1 as EIS-XRT images are inverted in the X
direction.
Y_conversion : UINT EIS-XRT optical orientation. This should be set
to 0 as EIS-XRT images have the same orientation in
the Y direction.
angle : LONG signed value giving EIS-XRT angular alignment
error. Range -65535 to +65535.
OCB : UINT XRT on chip binning factor. Range 1-15. Default is 8.
XRT_pixel_size : UINT XRT pixel size in arcsec/100. Range is 1-255.
EIS_FOV_flag : UINT this parameter is connected to acquiring the
EIS FOV centre and must be set to 1 in FM.
Use : <dummy = {EIS_XRT_flare_parameters>
Inputs : None.
Opt. Inputs : None.
Outputs : Sets up structure definition.
Opt. Outputs: None.
Keywords : None,
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category : EIS_CPT.
Prev. Hist. : None.
Written : Martin Carter RAL 03/08/04
Modified : Version 0.0, 03/08/04, MKC
Version 0.1, 24/02/05, MKC
Renamed from EIS XRT flare response define.
Moved some parameters from EIS_XRT_flare_control..
Version 0.2, 24/06/05, MKC
Changed INT values to UINT.
Version : 0.2, 24/06/05, MKC
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_XRTF_PROPS_TO_CONTROL
PURPOSE
Procedure to do something or another!
CATEGORY
EIS Timeline Planning
INPUTS
st - an eis_study structure
xrtf_control -
KEYWORDS
None
MODIFICATION HISTORY
V0.0 Written by John Rainnie (JAR), RAL, Dec 2005
CALLED BY
eis_mk_plan_gui [1], eis_mk_plan_gui [2], eis_mk_study_gui [1]
eis_mk_study_gui [2]
[Previous]
[Next]
PROJECT
SolarB EIS
NAME
EIS_XRTF_PROPS_TO_CONTROL
PURPOSE
Procedure to do something or another!
CATEGORY
EIS Timeline Planning
INPUTS
s - the new entry's EIS_SCIENCE_COMPONENT structure
xrtf_control -
KEYWORDS
None
MODIFICATION HISTORY
V0.0 Written by John Rainnie (JAR), RAL, Dec 2005
CALLED BY
eis_add_study [1], eis_add_study [2], eis_mk_study_gui [1]
eis_mk_study_gui [2], eis_timeline_container__define [1]
eis_timeline_container__define [2]
[Previous]
[Next]
NAME:
eis_xy_flare_pos_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
eis_xy_min_limit_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
eis_xy_threshold_gui
PURPOSE:
This object
INPUTS:
GROUP -
CALLS:
[Previous]
[Next]
NAME:
ENVIRONMENT
PURPOSE:
Sets up default directories to search locally for Solar-B EIS data. Used ; by the EIS QL front end: XFILES. It searches for environment valiables,
which should be set up in the users system startup file (e.g. a .cshrc
file, .bashrc file etc. on unix systems). If these environment varables
have not been defined, a default of HOME/solarb/eis/data/ is assumed,
where HOME is the users home directory.
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
@environment (called by XFILES)
INPUTS:
None
KEYWORD PARAMETERS:
OUTPUTS:
No output, but these variables are set in the procedure:
dsource_dir: For each source of data (e.g. 'CCSDS', 'FITS', 'HK'),
this variable tells the analysis SW (XFILES) the default
directory to search for data.
scfac: Screen size factor. Used by the QL to set default sizes
of display windows. Currently set default
to 60% of screen size.
CALLS:
GETENV, GET_DELIM, IS_DIR, LOCAL_NAME
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
01-Sep-2001: Oivind Wikstol
03-Oct-2001: Oivind Wikstol. Added documentation.
11-Apr-2002: Viggo Hansteen. Added scfac variable
10-May-2005: Oivind Wikstol. Re-written according to Ron Yurows
suggestion. Documented.
[Previous]
[Next]
NAME:
ENVIRONMENT
PURPOSE:
Sets up data sources and directories to search for data for
the XFILES procedure. The user should edit this files in order
to set it up for personal use. Note that the data source
"OTHER" must always be present as the last item on the list
(could also be the only one).
CATEGORY:
Hansteen/Wikstol Data analysis SW
CALLING SEQUENCE:
@environment (called by XFILES and XDISPLAY)
INPUTS:
None
KEYWORD PARAMETERS:
OUTPUTS:
Objects of class HW_AUX includes the following parameters:
dsource: List of sources of data (e.g. instruments)
that the user want to use the analysis SW
on.
dsource_dir: For each source of data, this variable tells
the analysis SW (XFILES) the default
directory to search for data.
CALLS:
COMMON BLOCKS:
PROCEDURE:
RESTRICTIONS:
MODIFICATION HISTORY:
01-Sep-2001: Oivind Wikstol
03-Oct-2001: Oivind Wikstol. Added documentation.
11-Apr-2002: Viggo Hansteen. Added scfac variable