EIS_abort__DEFINE [1] $SSW/hinode/eis/idl/planning/eis_cpt/mk_plan_interface/eis_abort__define.pro
[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


EIS_ADD_FITS_FILE [1] $SSW/hinode/eis/idl/catalog/eis_add_fits_file.pro
[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)
      


eis_add_study [1] $SSW/hinode/eis/idl/planning/timeline/eis_add_study.pro
[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]


EIS_AEC_control__DEFINE [1] $SSW/hinode/eis/idl/planning/eis_cpt/mk_plan_interface/eis_aec_control__define.pro
[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


eis_aec_event_gui [1] $SSW/hinode/eis/idl/planning/widgets/eis_aec_event_gui__define.pro
[Previous] [Next]
 NAME: 
		     eis_aec_event_gui
 PURPOSE:
		     This object
 INPUTS:
		     GROUP -  
 CALLS:


eis_aec_widgets [1] $SSW/hinode/eis/idl/planning/widgets/eis_aec_widgets__define.pro
[Previous] [Next]
 NAME: 
		     eis_aec_widgets
 PURPOSE:
		     This object
 INPUTS:
		     GROUP -  
 CALLS:


eis_aece_control_to_props [1] $SSW/hinode/eis/idl/planning/utilities/eis_aece_control_to_props.pro
[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]


eis_aece_props_to_control [1] $SSW/hinode/eis/idl/planning/utilities/eis_aece_props_to_control.pro
[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]


eis_author_gui [1] $SSW/hinode/eis/idl/planning/objects/eis_author_gui__define.pro
[Previous] [Next]
 NAME: 
		     eis_author_gui
 PURPOSE:
		     This object
 INPUTS:
		     GROUP -  
 CALLS:


EIS_AUX__DEFINE [1] $SSW/hinode/eis/idl/objects/eis_aux__define.pro
[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.]
       17-Nov-2006: Viggo Hansteen - Added filename parameter to init method.


EIS_bakeout_parameters__DEFINE [1] $SSW/hinode/eis/idl/planning/eis_cpt/mk_plan_interface/eis_bakeout_parameters__define.pro
[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


EIS_bakeout_period__DEFINE [1] $SSW/hinode/eis/idl/planning/eis_cpt/mk_plan_interface/eis_bakeout_period__define.pro
[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


EIS_CAL__DEFINE [1] $SSW/hinode/eis/idl/objects/eis_cal__define.pro
[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:
   xx-Mar-2004: Oivind Wikstol - Completed version 1.0 of the cal object
   26-Jan-2006: Viggo Hansteen - Fleshed out the definition. Added several 
                                 new methods for absolute calibration and wavelength scale
                                 computation.
	22-Jun-2006: Oivind Wikstol - Added dn_to_photon and photon_to_ergs functions.
   23-Nov-2006: Viggo Hansteen - Changed method seteisdefaults so that it first applies hard 
                                 coded defaults, then looks in file 'calresp.txt' in 
                                 self.respdir=getenv('EIS_RESPONSE') for updates 


EIS_CAL_ABSCAL [1] $SSW/hinode/eis/idl/calibration/eis_cal_abscal.pro
[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


EIS_CAL_FF [1] $SSW/hinode/eis/idl/calibration/eis_cal_ff.pro
[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


EIS_CAL_MKCALDATA [1] $SSW/hinode/eis/idl/calibration/eis_cal_mkcaldata.pro
[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


eis_calculate_number od slitslot changes [1] $SSW/hinode/eis/idl/planning/utilities/eis_calculate_study_slit_slot.pro
[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:


eis_calculate_raster_data_volume [1] $SSW/hinode/eis/idl/planning/utilities/eis_calculate_raster_data_volume.pro
[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]


eis_calculate_study_duration [1] $SSW/hinode/eis/idl/planning/utilities/eis_calculate_study_duration.pro
[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
       


eis_calculate_study_volume [1] $SSW/hinode/eis/idl/planning/utilities/eis_calculate_study_volume.pro
[Previous] [Next]
Project    SolarB EIS

Name       EIS_CALCULATE_STUDY_VOLUME

Purpose    
           Calculate study duration - to be improved

Category   EIS technical planning

Written    Chunkey Lepine, RAL, d.r.lepine@rl.ac.uk, 0044-1235-44-6515

Version    V0.0 Feb 2005
           v0.1 Aug 2006
                Included UNITS parameter
 CALLED BY
	eis_mk_plan_gui [1], eis_mk_plan_gui [2], eis_mk_study_gui [1]
	eis_mk_study_gui [2]


EIS_CAM_readout__DEFINE [1] $SSW/hinode/eis/idl/planning/eis_cpt/mk_plan_interface/eis_cam_readout__define.pro
[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


EIS_CAT [1] $SSW/hinode/eis/idl/catalog/eis_cat.pro
[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


eis_ccsds_interface__define $SSW/hinode/eis/idl/spacecraft/decompression/eis_ccsds_interface__define.pro
[Previous] [Next]
 NAME: eis_ccsds_interface__define.pro

 PURPOSE: Definition of the EIS ccsds packet structure
      
 CATEGORY: Science

 CALLING SEQUENCE: None

 INPUTS: None

 KEYWORD PARAMETERS: None

 OUTPUTS: None

 CALLS: ***
	EIS_CCSDS_INTERFACE::CLOSE_INPUT, EIS_CCSDS_INTERFACE::CLOSE_OUTPUT
	EIS_CCSDS_INTERFACE::FILE_NAME, EIS_CCSDS_INTERFACE::FIRST_CCSDS_HEADER
	EIS_CCSDS_INTERFACE::GET_COMPRESSION_METHOD
	EIS_CCSDS_INTERFACE::GET_MD_SEQUENCE_FLAGS
	EIS_CCSDS_INTERFACE::GET_USER_DATA_LENGTH
	EIS_CCSDS_INTERFACE::IS_COMPRESSED
	EIS_CCSDS_INTERFACE::IS_END_PACKET_OF_SEQUENCE
	EIS_CCSDS_INTERFACE::MAIN_SEQUENCE_FLAG, EIS_CCSDS_INTERFACE::MD_HEADER
	EIS_CCSDS_INTERFACE::OPEN_FOR_READING
	EIS_CCSDS_INTERFACE::PRINT_CCSDS_HEADER
	EIS_CCSDS_INTERFACE::PRINT_MD_HEADER
	EIS_CCSDS_INTERFACE::READ_CCSDS_HEADER
	EIS_CCSDS_INTERFACE::READ_MD_HEADER_PACKET
	EIS_CCSDS_INTERFACE::READ_USER_DATA
	EIS_CCSDS_INTERFACE::SUB_SEQUENCE_FLAG
 COMMON BLOCKS:None.

 PROCEDURE:

 RESTRICTIONS: Uses SolarSoft

 MODIFICATION HISTORY:
	23/11/05 mcrw	wrote
       14/08/06 mcrw	added documentation


eis_ccsdsInterface__define [1] $SSW/hinode/eis/idl/spacecraft/decompression/eis_ccsdsInterface__define.pro
[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


eis_ccsdsInterface__read [1] $SSW/hinode/eis/idl/spacecraft/decompression/eis_ccsdsInterface__read.pro
[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


EIS_CHECK_DATABASE [1] $SSW/hinode/eis/idl/planning/utilities/eis_check_database.pro
[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]


eis_check_fivepc_rule [1] $SSW/hinode/eis/idl/planning/timeline/eis_check_fivepc_rule.pro
[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]


EIS_CHECK_POINT [1] $SSW/hinode/eis/idl/image_tool/eis_check_point.pro
[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


eis_check_sufficient_time [1] $SSW/hinode/eis/idl/planning/timeline/eis_check_sufficient_time.pro
[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]


EIS_coarse_mirror_command__define__DEFINE [1] $SSW/hinode/eis/idl/planning/eis_cpt/mk_plan_interface/eis_coarse_mirror_command__define.pro
[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


EIS_CONCAT_DATA [1] $SSW/hinode/eis/idl/util/eis_concat_data.pro
[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


eis_control [1] $SSW/hinode/eis/idl/planning/structure_definitions/eis_line__define.pro
[Previous] [Next]
Project    :SolarB EIS

Name     :eis_control

Purpose    :


Category   

Author     

Version    
 CALLS:


EIS_control_details__DEFINE [1] $SSW/hinode/eis/idl/planning/eis_cpt/mk_plan_interface/eis_control_details__define.pro
[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


eis_convert_hk1_htra_temp [1] $SSW/hinode/eis/idl/spacecraft/housekeeping/fits/reading/eis_convert_hk1_htra_temp.pro
[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


eis_convert_hk1_htrb_temp [1] $SSW/hinode/eis/idl/spacecraft/housekeeping/fits/reading/eis_convert_hk1_htrb_temp.pro
[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


eis_convert_hk1_htrc_temp [1] $SSW/hinode/eis/idl/spacecraft/housekeeping/fits/reading/eis_convert_hk1_htrc_temp.pro
[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


eis_convert_hk1_icu1_temp [1] $SSW/hinode/eis/idl/spacecraft/housekeeping/fits/reading/eis_convert_hk1_icu1_temp.pro
[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


eis_convert_hk1_icu2_temp [1] $SSW/hinode/eis/idl/spacecraft/housekeeping/fits/reading/eis_convert_hk1_icu2_temp.pro
[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


eis_convert_hk1_str1_temp [1] $SSW/hinode/eis/idl/spacecraft/housekeeping/fits/reading/eis_convert_hk1_str1_temp.pro
[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


eis_convert_hk1_str2_temp [1] $SSW/hinode/eis/idl/spacecraft/housekeeping/fits/reading/eis_convert_hk1_str2_temp.pro
[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


eis_convert_hk1_str3_temp [1] $SSW/hinode/eis/idl/spacecraft/housekeeping/fits/reading/eis_convert_hk1_str3_temp.pro
[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


eis_convert_hk1_str4_temp [1] $SSW/hinode/eis/idl/spacecraft/housekeeping/fits/reading/eis_convert_hk1_str4_temp.pro
[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


eis_convert_hk1_str5_temp [1] $SSW/hinode/eis/idl/spacecraft/housekeeping/fits/reading/eis_convert_hk1_str5_temp.pro
[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


eis_convert_hk1_str6_temp [1] $SSW/hinode/eis/idl/spacecraft/housekeeping/fits/reading/eis_convert_hk1_str6_temp.pro
[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


eis_convert_hk1_str7_temp [1] $SSW/hinode/eis/idl/spacecraft/housekeeping/fits/reading/eis_convert_hk1_str7_temp.pro
[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


eis_convert_hk1_structure_temp [1] $SSW/hinode/eis/idl/spacecraft/housekeeping/fits/reading/eis_convert_hk1_structure_temp.pro
[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


eis_convert_k1_emp [1] $SSW/hinode/eis/idl/spacecraft/housekeeping/fits/reading/eis_convert_hk1_temp.pro
[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


EIS_CPT [1] $SSW/hinode/eis/idl/planning/eis_cpt/main/eis_cpt.pro
[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


EIS_CPT_abort_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_abort_default.pro
[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


EIS_CPT_ADD [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_add.pro
[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


EIS_CPT_ADD_INTEL_HEX_RECORD [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_add_intel_hex_record.pro
[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


EIS_CPT_AEC_control_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_aec_control_default.pro
[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


EIS_CPT_AEC_EXPOSURE_TIMES_DEFAULT [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_aec_exposure_times_default.pro
[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


EIS_CPT_ASCII_TABLES [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_ascii_tables.pro
[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


EIS_CPT_bakeout_parameters_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_bakeout_parameters_default.pro
[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


EIS_CPT_bakeout_period_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_bakeout_period_default.pro
[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


EIS_CPT_BYTESTOHEX [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_bytestohex.pro
[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


EIS_CPT_BYTESTOMSSL [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_bytestomssl.pro
[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


EIS_CPT_BYTESTOUINT [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_bytestouint.pro
[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


EIS_CPT_BYTESTOULONG [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_bytestoulong.pro
[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


EIS_CPT_C_SET_WINDOW [1] $SSW/hinode/eis/idl/planning/eis_cpt/command/eis_cpt_c_set_window.pro
[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


EIS_CPT_CALL_SEQ [1] $SSW/hinode/eis/idl/planning/eis_cpt/command/eis_cpt_call_seq.pro
[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


EIS_CPT_CAM_readout_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_cam_readout_default.pro
[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


EIS_CPT_CHECK_BAKEOUT_PARAMETERS [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_check_bakeout_parameters.pro
[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


EIS_CPT_CHECK_CAM_READOUT_PARAMETERS [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_check_cam_readout_parameters.pro
[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


EIS_CPT_CHECK_CONTROL_PARAMETERS [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_check_control_parameters.pro
[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


EIS_CPT_CHECK_EIS_FLARE_PARAMETERS [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_check_eis_flare_parameters.pro
[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


EIS_CPT_CHECK_ENGINEERING_PARAMETERS [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_check_engineering_parameters.pro
[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


EIS_CPT_CHECK_EVENT_RESPONSE_STUDY [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_check_event_response_study.pro
[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


EIS_CPT_CHECK_FILE [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_check_file.pro
[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


EIS_CPT_CHECK_RASTER [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_check_raster.pro
[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


EIS_CPT_CHECK_STUDIES_LIST [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_check_studies_list.pro
[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


EIS_CPT_CHECK_STUDY [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_check_study.pro
[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


EIS_CPT_CHECK_SYSTEM_VARIABLE [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_check_system_variable.pro
[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


EIS_CPT_CHECK_TABLE [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_check_table.pro
[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


EIS_CPT_CHECK_TIME_PERIOD [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_check_time_period.pro
[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


EIS_CPT_CHECK_UPLOAD [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_check_upload.pro
[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


EIS_CPT_CHECK_WINDOW [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_check_window.pro
[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


EIS_CPT_CHECK_XRT_FLARE_PARAMETERS [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_check_xrt_flare_parameters.pro
[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


EIS_CPT_CHECKSUM [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_checksum.pro
[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


EIS_CPT_CLOSE_FILE [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_close_file.pro
[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


EIS_CPT_coarse_mirror_command_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_coarse_mirror_command_default.pro
[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


EIS_CPT_COMMAND_STORE [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_command_store.pro
[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


EIS_CPT_command_store__define [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_command_store__define.pro
[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


EIS_CPT_COMMAND_STORE_ADD [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_command_store_add.pro
[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


EIS_CPT_COMMAND_STORE_CHECK [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_command_store_check.pro
[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


EIS_CPT_COMMAND_STORE_OUTPUT [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_command_store_output.pro
[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


EIS_CPT_COMMAND_STORE_PROCESS [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_command_store_process.pro
[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.3, 01/11/06, MKC
                 Changed so that manual only set for OP commands.

 Version     : 1.3, 01/11/06


EIS_CPT_COMPLETE [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_complete.pro
[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


EIS_CPT_COMPOSE_INTEL_HEX_FILE [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_compose_intel_hex_file.pro
[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


EIS_CPT_contacts_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_contacts_default.pro
[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.1, 02/11/06, MKC
                 Removed time average tags.

 Version     : 0.1, 02/11/06


EIS_CPT_control_details_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_control_details_default.pro
[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


EIS_CPT_DAISY_CHAIN [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_daisy_chain.pro
[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


EIS_CPT_data_extraction_window_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_data_extraction_window_default.pro
[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


EIS_CPT_DATA_RATE [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_data_rate.pro
[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


EIS_CPT_DATA_RATE_PROCESS [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_data_rate_process.pro
[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


EIS_CPT_DATARATE_OUTPUT [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_datarate_output.pro
[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.4, 02/11/06, MKC
                 Removed data rate outputs.

 Version     : 0.4, 02/11/06


EIS_CPT_DATAVOL_ITEM_OUTPUT [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_datavol_item_output.pro
[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


EIS_CPT_DEBUG [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_debug.pro
[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


EIS_CPT_DECODE_AEC_EXPOSURE_TABLE [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_decode_aec_exposure_table.pro
[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


EIS_CPT_DECODE_AEC_TABLE [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_decode_aec_table.pro
[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


EIS_CPT_DECODE_EIS_EVENT_TABLE [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_decode_eis_event_table.pro
[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


EIS_CPT_DECODE_EIS_FLARE_TABLE [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_decode_eis_flare_table.pro
[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


EIS_CPT_DECODE_LINELIST_TABLE [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_decode_linelist_table.pro
[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


EIS_CPT_DECODE_SEQUENCE_TABLE [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_decode_sequence_table.pro
[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


EIS_CPT_DECODE_XRT_FLARE_TABLE [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_decode_xrt_flare_table.pro
[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


EIS_CPT_engineering_detail_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_engineering_detail_default.pro
[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


EIS_CPT_engineering_parameters_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_engineering_parameters_default.pro
[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


EIS_CPT_environment [1] $SSW/hinode/eis/idl/planning/eis_cpt/mk_plan_interface/eis_cpt_environment.pro
[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


EIS_CPT_environment__DEFINE [1] $SSW/hinode/eis/idl/planning/eis_cpt/mk_plan_interface/eis_cpt_environment__define.pro
[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


EIS_CPT_environment_wrapper [1] $SSW/hinode/eis/idl/planning/eis_cpt/mk_plan_interface/eis_cpt_environment_wrapper.pro
[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


EIS_CPT_event_control_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_event_control_default.pro
[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


EIS_CPT_EXISTS [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_exists.pro
[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


EIS_CPT_EXTRACT_PERIOD [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_extract_period.pro
[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


EIS_CPT_FILE_NAME [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_file_name.pro
[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


EIS_CPT_FIND_STUDY [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_find_study.pro
[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


EIS_CPT_flare_control_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_flare_control_default.pro
[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


EIS_CPT_flare_parameters_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_flare_parameters_default.pro
[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


EIS_CPT_GET_CONTROL [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_get_control.pro
[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


EIS_CPT_GET_ENGINEERING [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_get_engineering.pro
[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


EIS_CPT_GET_INTEL_HEX_RECORD_LENGTH [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_get_intel_hex_record_length.pro
[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


eis_cpt_gui [1] $SSW/hinode/eis/idl/planning/timeline/eis_cpt_gui__define.pro
[Previous] [Next]
 NAME: 
		     eis_cpt_gui
 PURPOSE:
		     This object
 INPUTS:
		     GROUP -  
 CALLS:


EIS_CPT_HARDWARE_WINDOW [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_hardware_window.pro
[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


EIS_CPT_HEX_RASTER [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_hex_raster.pro
[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


EIS_CPT_HEXTOBYTES [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_hextobytes.pro
[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


EIS_CPT_JSIDE_COMMANDS [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_jside_commands.pro
[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.2, 01/11/06, MKC
                 Changed so that only set manual mode for onboard commands else write command explcitly.

 Version     : 0.2, 01/11/06


EIS_CPT_JSIDE_PROCESS [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_jside_process.pro
[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.1, 01/11/06, MKC
                 Changed so that INTERVAL command inserted into OP rather than SEQEXEC part of ORL file.

 Version     : 0.1, 01/11/06


EIS_CPT_JSIDE_SEQUENCE [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_jside_sequence.pro
[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.3, 01/11/06, MKC
                 Changed so that INTERVAL inserted in OP rather than SEQEXEC part of ORL file.
                 Added ':' following INTERVAL command.

 Version     : 0.3, 01/11/06


EIS_CPT_LIST_ABORTS [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_list_aborts.pro
[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


EIS_CPT_LIST_BAKEOUT_PERIODS [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_list_bakeout_periods.pro
[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


EIS_CPT_LIST_COARSE_MIRROR_COMMANDS [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_list_coarse_mirror_commands.pro
[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


EIS_CPT_LIST_REAL_COMMAND_SEQUENCES [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_list_real_command_sequences.pro
[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


EIS_CPT_list_real_detail_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_list_real_detail_default.pro
[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


EIS_CPT_LIST_STUDY_DETAILS [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_list_study_details.pro
[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


EIS_CPT_LIST_SUSPENSION_PERIODS [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_list_suspension_periods.pro
[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


EIS_CPT_LOOP_BACK [1] $SSW/hinode/eis/idl/planning/eis_cpt/command/eis_cpt_loop_back.pro
[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


EIS_CPT_mechanism_change_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_mechanism_change_default.pro
[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


EIS_CPT_mechanism_control_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_mechanism_control_default.pro
[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


EIS_CPT_MESSAGE [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_message.pro
[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


EIS_CPT_MIR_C_AUTO [1] $SSW/hinode/eis/idl/planning/eis_cpt/command/eis_cpt_mir_c_auto.pro
[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


EIS_CPT_MSSL_COMMANDS [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_mssl_commands.pro
[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


EIS_CPT_NOW [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_now.pro
[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


EIS_CPT_OBSTBL [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl.pro
[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


EIS_CPT_obstbl__define [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl__define.pro
[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


EIS_CPT_OBSTBL_ASCII [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_ascii.pro
[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


EIS_CPT_OBSTBL_CHECK [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_check.pro
[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


EIS_CPT_OBSTBL_EXTRACT [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_extract.pro
[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


EIS_CPT_OBSTBL_GET [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_get.pro
[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


EIS_CPT_OBSTBL_INDEX [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_index.pro
[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


EIS_CPT_obstbl_map__define [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_map__define.pro
[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


EIS_CPT_OBSTBL_MAP_DESCRIPTION [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_map_description.pro
[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


EIS_CPT_obstbl_map_entry__define [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_map_entry__define.pro
[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


EIS_CPT_OBSTBL_MAP_PARSE [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_map_parse.pro
[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


EIS_CPT_OBSTBL_MAP_READ [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_map_read.pro
[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


EIS_CPT_OBSTBL_MAP_REFRESH [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_map_refresh.pro
[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


EIS_CPT_OBSTBL_MAP_TEXT [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_map_text.pro
[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


EIS_CPT_OBSTBL_MAP_WRITE [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_map_write.pro
[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


EIS_CPT_OBSTBL_OUTPUT [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_output.pro
[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


EIS_CPT_OBSTBL_PLACE [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_place.pro
[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


EIS_CPT_OBSTBL_REFRESH [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_refresh.pro
[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


EIS_CPT_OBSTBL_SET [1] $SSW/hinode/eis/idl/planning/eis_cpt/shared/eis_cpt_obstbl_set.pro
[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


EIS_CPT_OPEN_FILE [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_open_file.pro
[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


EIS_CPT_PARSE_INTEL_HEX_FILE [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_parse_intel_hex_file.pro
[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


EIS_CPT_PRELIMINARIES [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_preliminaries.pro
[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


EIS_CPT_PROCESS [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process.pro
[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


EIS_CPT_PROCESS_ABORT_TIMES [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_abort_times.pro
[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


EIS_CPT_PROCESS_AEC_TABLE [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_aec_table.pro
[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


EIS_CPT_PROCESS_BAKEOUT_PERIODS [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_bakeout_periods.pro
[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


EIS_CPT_PROCESS_COARSE_MIRROR_COMMANDS [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_coarse_mirror_commands.pro
[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


EIS_CPT_PROCESS_CONTROL_TABLES [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_control_tables.pro
[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


EIS_CPT_PROCESS_EIS_EVENT_TABLE [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_eis_event_table.pro
[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


EIS_CPT_PROCESS_EIS_FLARE_TABLE [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_eis_flare_table.pro
[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


EIS_CPT_PROCESS_ENGINEERING_SEQUENCES [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_engineering_sequences.pro
[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


EIS_CPT_PROCESS_LINELISTS_FOR_STUDY [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_linelists_for_study.pro
[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


EIS_CPT_PROCESS_REAL_COMMAND_SEQUENCES [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_real_command_sequences.pro
[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


EIS_CPT_PROCESS_RESPONSE_STUDIES [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_response_studies.pro
[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


EIS_CPT_PROCESS_SCIENCE_SEQUENCES [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_science_sequences.pro
[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


EIS_CPT_PROCESS_STUDIES [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_studies.pro
[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


EIS_CPT_PROCESS_STUDY [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_study.pro
[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


EIS_CPT_PROCESS_SUSPENSION_PERIODS [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_suspension_periods.pro
[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


EIS_CPT_PROCESS_TIMELINE [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_timeline.pro
[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


EIS_CPT_PROCESS_TIMELINE_STUDIES [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_timeline_studies.pro
[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


EIS_CPT_PROCESS_XRT_FLARE_TABLE [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_process_xrt_flare_table.pro
[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


EIS_CPT_QUIET [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_quiet.pro
[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


EIS_CPT_raster_detail_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_raster_detail_default.pro
[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


EIS_CPT_raster_detail_estimates [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_raster_detail_estimates.pro
[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


EIS_CPT_READ_ASCII [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_read_ascii.pro
[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


EIS_CPT_READ_INTEL_HEX_FILE [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_read_intel_hex_file.pro
[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


EIS_CPT_READ_TEXT [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_read_text.pro
[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


EIS_CPT_READ_UNFORMATTED_FILE [1] $SSW/hinode/eis/idl/planning/eis_cpt/lowlevel/eis_cpt_read_unformatted_file.pro
[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


EIS_CPT_real_detail_default [1] $SSW/hinode/eis/idl/planning/eis_cpt/test/eis_cpt_real_detail_default.pro
[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


EIS_CPT_RESPONSE_RASTER [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_response_raster.pro
[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


EIS_CPT_RESPONSE_STUDY [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_response_study.pro
[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


EIS_CPT_RESPONSE_TIMELINE [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_response_timeline.pro
[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


EIS_CPT_RUN_RASTER [1] $SSW/hinode/eis/idl/planning/eis_cpt/command/eis_cpt_run_raster.pro
[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


EIS_CPT_sequence__define [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_sequence__define.pro
[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


EIS_CPT_SEQUENCE_LINK [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_sequence_link.pro
[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


EIS_CPT_SEQUENCE_MATCH [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_sequence_match.pro
[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


EIS_CPT_SEQUENCE_PLACE [1] $SSW/hinode/eis/idl/planning/eis_cpt/internal/eis_cpt_sequence_place.pro
[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