[Next]
There are several "main" programs that may be useful to calculate the
mass or electron density (columnar) in CMEs. The mass of a CME is
computed from the excess brightness after having subtracted off the
pre-event brightness. The technique is to recognize that a single
electron at a certain point in the atmosphere will scatter a known
amount of the solar disk intensity. Then by knowing the observed
intensity, and by assuming that all of the mass is in a single
volume element, we can compute the number of electrons. Then
assuming charge neutrality, the mass can be computed.
The various procedures that can be used to compute electron density
or mass are:
C3_CME:
A function to calibrate C3 images and calculate the mass of a CME
given the base and cme image.
C3_CME_FRONT:
A function to calibrate C3 images and to calculate the mass of the
CME front.
C3_MASSIMG:
A function to calibrate C3 images and calculates the mass of a CME.
The output is a file that is a mass (or electron density image).
CME_MASSIMG2TOTAL:
This function allows you to specify the area of features for which
to calculate the mass of a CME from mass images.
rah 3/26/99
[Previous]
[Next]
NAME:
ABBRV_FILPOL
PURPOSE:
This function returns an abbreviated code for the filter
and polarizer/sector wheels.
CATEGORY:
UTIL
CALLING SEQUENCE:
Result = ABBRV_FILPOL(Filter)
INPUTS:
Filter = String giving the filter or polarizer/sector value
OPTIONAL INPUTS:
None
OUTPUTS:
The function result is a string containing the code for the filter
wheel or the polarizer wheel. Each wheel posisiton is a two
character string.
CALLED BY:
COMB_FULL_EQ, GETBKGIMG, MK_DAILY_C1_MED, MK_DAILY_MED, MK_DAILY_MIN
PROCEDURE:
The wheel position is decoded and converted to a 2 character string.
EXAMPLE:
MODIFICATION HISTORY:
Written, RA Howard, NRL, 7 October 1996
15 Oct 96 RAH Added removing whitespace from filter
Corrected filter/polarizer/sector cases
@(#)abbrv_filpol.pro 1.3 10/15/96 LASCO IDL LIBRARY
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
ACIMGC()
PURPOSE:
returns accumulative image counter
CATEGORY:
EXPLANATION:
SYNTAX:
Result = acimgc()
EXAMPLES:
INPUTS:
header - BYTARR(92) of Image Header
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 7, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_ALT()
Purpose : Adds a CDS alternate science plan record to the database
Explanation : This procedure takes a CDS alternate science plan entry and
adds it to the database "sci_alt". This database contains a
series of such entries, making a historical list.
Use : Result = ADD_ALT( DEF )
IF NOT ADD_ALT( DEF ) THEN ...
Inputs : DEF = This is an anonymous structure containing the following
tags:
PROG_ID = Program ID, linking one or more studies
together
STUDY_ID = Number defining the study
STUDYVAR = Number giving the study variation ID
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
CMP_NO = Campaign number
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
START_TIME = Date/time of beginning of alternate plan,
in TAI format
END_TIME = Date/time of end of alternate plan, in
TAI format
ORIG_DUR = Original duration of the observation, in
seconds, before being truncated by
following time-tagged observations.
N_RASTERS1 = Variable number of rasters parameter
TRACKING = True (1) if feature tracking to be used,
or false (0) otherwise
N_POINTINGS= Number of pointings to use with study
N_REPEAT_S = Number of times to repeat study
GSET_ID = GSET ID number
GET_RAW = True if raw data should be collected.
If N_POINTINGS is greater than 0, then there will be the
additional tag POINTINGS. This is an array of pointing
positions. It itself is a structure, of type
PLAN_PNT_STRUC, with the following tags:
INS_X = Pointing in X relative to sun center
INS_Y = Pointing in Y relative to sun center
ZONE_ID = Pointing zone ID
DEF is also allowed to be an array of such structures.
In such a case, the substructure POINTINGS will be
dimensioned based on the largest value of N_POINTINGS.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_ALT( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], GET_CAMPAIGN
GET_F_RASTER, GET_GSET, GET_OBJECT, GET_PROGRAM, GET_STUDY, TAI2UTC, TRIM, UNIQ [1]
UNIQ [2], UNIQ [3]
CALLED BY:
MOD_ALT
Common : None.
Restrictions: Only this routine or DEL_ALT can be used to add or delete
alternate plan descriptions to or from the database. Modifying
the database by hand could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: The dates in the structure are rounded off to millisecond
accuracy.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 9 May 1995
Modified : Version 1, William Thompson, GSFC, 9 May 1995
Version 2, William Thompson, GSFC, 29 June 1995
Changed so that times in structure are rounded off to
millisecond accuracy.
Version 3, William Thompson, GSFC, 31 August 1995
Allow DEF to be an array
Version 4, William Thompson, GSFC, 28 September 1995
Added tags ORIG_DUR, GSET_ID, GET_RAW
Version 5, William Thompson, GSFC, 11 December 1995
Check validity of GSET_ID when using GIS.
Version : Version 5, 11 December 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_ANOMALY()
Purpose : Adds a SOHO anomaly to the database
Explanation :
Syntax : Result = ADD_ANOMALY( DEF )
IF NOT ADD_ANOMALY( DEF ) THEN ...
Inputs : DEF = This is an anonymous structure containing
tags defined by DEF_ANOMALY
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_ANOMALY( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3], DBCLOSE [1], DBCLOSE [2]
DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2]
DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], DBUPDATE [1], DBUPDATE [2]
DBUPDATE [3], DBUPDATE [4], DB_INFO [1], DB_INFO [2], DB_INFO [3], GET_ANOMALY
GET_SOHO_INST, MATCH_STRUCT, TEST_OPEN, concat_dir [4]
CALLED BY:
WRITE_ANOMALY, XREPORT_EDIT
Common : None.
Restrictions: !PRIV must be 2 or greater to use this routine.
Side effects: If input ANOMALY ID is already in DB, then input
anomaly will replace current entry, otherwise it
will be added with a new ID.
Category : Planning, Databases.
Prev. Hist. : None.
Written : Dominic Zarro, ARC/GSFC, 20 January 1996
Version : Version 1
[Previous]
[Next]
PROJECT:
SOHO - CDS
NAME:
ADD_CAMPAIGN()
PURPOSE:
Adds a CDS campaign record to the database
CATEGORY:
Planning, Databases
EXPLANATION:
This procedure takes a CDS campaign entry and adds it to the
database table CAMPAIGN. This database contains a series of such
entries, making a historical list.
SYNTAX:
Result = add_campaign(DEF)
INPUTS:
DEF = This is an anonymous structure containing the following tags:
CMP_NO = Unique identifier number. If no matches
are found, then a simpler structure is
returned with this set to -1.
CMP_NAME = Name of the campaign.
CMP_TYPE = Campaign type, e.g. JOP, Intercal, etc.
CMP_DESC = Up to five lines of text (400 characters)
describing the campaign.
DATE_OBS = Starting date for the observing campaign
DATE_END = Ending data for the campaign
OBSERVER = Observer in overall charge of the campaign
COMMENT = A comment associated with the campaign
INSTITUTES = Structure containing information about the
institutes involved, with the following tags:
INSTITUT = The name of the institute.
OBSERVER = The name of the observer at that institute
OPTIONAL INPUTS:
None.
OUTPUTS:
The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_CAMPAIGN( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], TRIM
TRIM_CAMPAIGN
CALLED BY:
UPDATE_CAMPAIGN
COMMON:
None.
RESTRICTIONS:
Only this routine and MOD_CAMPAIGN can be used to add or update
SOHO campaigns to or from the database.
Modifying the database by hand could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database.
SIDE EFFECTS:
The dates in the structure are rounded off to millisecond
accuracy.
HISTORY:
Version 1, 10-Sep-1996, William Thompson, GSFC
Converted from SUMER version by Liyun Wang
Version 2, 23-Sep-1996, William Thompson, GSFC
Added campaign type, changed string lengths.
Version 3, 22-Nov-1996, Zarro, GSFC
Added call to TRIM_CAMPAIGN
CONTACT:
WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_CDS_POINT
Purpose : Adds a pointing calibration curve to database
Category : CDS, Calibration, Class3
Explanation : This routine adds a functional expression representing the CDS
pointing as a function of OPS position to the database.
Syntax : ADD_CDS_POINT, DATE_EFF, EQ_NUM, COEFF
Examples : ADD_CDS_POINT, '1995/12/02', 'N2', [4.81,-0.0068]
Inputs : DATE_EFF = The date, and optionally time, that the curve
becomes effective. In other words, the calibration
curve should be applied to all science data taken on
or after that date. Can be in any CDS time format.
The current date is also stored along with the data.
When the database is read in, the most current
version for a given date is used.
For example, if there were two values of DATE_EFF in
the database,
DATE_EFF = 1995/12/02
DATE_EFF = 1996/09/16
then the first would be used for all data taken
between 1995/12/02 and 1996/09/16, and the second
would be used for all data from 1996/09/16 on. If
there was more than one entry in the database with
an effective date of 1996/09/16, then the most
recent one would be used.
There is one thing to watch out for in maintaining
the database. Taking the above example, if one
added a calibration with an effective date of
1996/05/01, then it would be applied to data between
that date and the next date in the database,
i.e. 1996/09/16. If one wanted the new calibration
to apply to all data after 1996/05/01, then one
would have to also add a new entry for 1996/09/16.
EQ_NUM = An identification number for the equation format
being used. See the documention for GET_CDS_POINT
for a discussion of what the various possible
equations are.
COEFF = The coefficients of a function giving the pointing
calibration curve, expressed as a function of OPS
positions. Can have up to 10 elements.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
ANYTIM2TAI, DBBUILD [1], DBBUILD [2], DBBUILD [3], DBCLOSE [1], DBCLOSE [2]
DBCLOSE [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], GET_UTC, PRIV_ZDBASE, UTC2TAI
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 25-Sep-1996, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_DATAWIN()
Purpose : Adds a data window list definition to the database
Explanation : This procedure takes a data extraction window list definition
and adds it to the data window list databases "datawin" and
"datawin2". The ID number for the data window list is
assigned.
Use : Result = ADD_DATAWIN( DEF )
IF NOT ADD_DATAWIN( DEF ) THEN ...
Inputs : DEF = This is an anonymous structure containing the following
tags:
DW_ID = Data window list ID number. Initially, this
is zero. It is updated by this routine to
reflect the ID number in the database.
DETECTOR = Either "G" for GIS or "N" for NIS.
DW_DESC = A short description of the data window list
beyond what is given in the associated line
list description, e.g. "Full slit, 10 pixels
wide". Can be up to 65 characters.
W_WIDTH = Width in pixels used to generate the
windows.
W_HEIGHT = The height in pixels used to generate the
windows. VDS only, for GIS this is set to
unity.
VDS_BACK = Either 0 for off, or 1 for on,
representing whether or not VDS background
windows are being used. For GIS window
lists this must be 0. If VDS_BACK is 1,
then at least one of the window names must
start with the characters "BACK" (case
insensitive).
LL_ID = The line list ID number for the line list
that this window list was derived from. An
appropriate entry must exist in the line
list database. Alternatively, this can be
set to zero to signal that the data window
list is not connected to a line list.
WINS = An array containing the window definitions.
The window definitions themselves are structures, of type
"cds_windows", with the following tags:
WIN_NAME = Window name, derived from the line name in
the line list database. Can be up to 40
characters.
WIN_DEF = The window definition. This is four
numbers, although GIS window definitions
only use two of them.
WIN_FLAG = Whether or not the window can be used to
generate a flag. Either 0 (false) or 1
(true).
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
The tag DW_ID in the input structure is updated to reflect
the ID number assigned in the database.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_DATAWIN( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
DW_ID = If the definition matches one that is already in the
database, then this keyword returns the ID of the
matching data window list. Otherwise, a -1 is returned.
CHECK_ONLY= If this keyword is set, then the routine only checks to see
if the proposed entry is valid, but does not attempt to
place it in the database.
Calls : ***
CHK_DATAWIN, DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2]
DBBUILD [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBDELETE [1], DBDELETE [2]
DBDELETE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2]
DBFIND [3], DBMATCH [1], DBMATCH [2], DBMATCH [3], DBOPEN [1], DBOPEN [2]
DBOPEN [3], DB_INFO [1], DB_INFO [2], DB_INFO [3], GET_LINELIST, NUM2STR
CALLED BY:
IMPORT_PLAN, IMPORT_STUDY, TP_WRT_DWIN
Common : None.
Restrictions: Only this routine can be used to add window list definitions to
the database. Modifying the database by hand could corrupt its
integrity.
The data types and sizes of the structure elements must match
the definitions in the database. The string lengths must not
exceed the lengths defined in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: Once a window list definition has been added to the database,
it must never be removed.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 31 March 1994
Modified : Version 1, William Thompson, GSFC, 1 August 1994
Version 2, Liyun Wang, GSFC/ARC, September 21, 1994
Added the ERRMSG keyword
Version 3, William Thompson, GSFC, 24 October 1994
Changed W_HEIGHT to 1 for GIS data.
Version 4, Liyun Wang, GSFC/ARC, November 4, 1994
CHK_DATAWIN is called to check the existence of the
given data window
Version 5, William Thompson, GSFC, 8 November 1994
Added keyword DW_ID
Version 6, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 7, William Thompson, GSFC, 2 March 1995
Enforce uniqueness for DW_DESC.
Added keyword CHECK_ONLY.
Version 8, William Thompson, GSFC, 14 March 1995
Changed DBFIND to DBMATCH for DW_DESC
Version 9, William Thompson, GSFC, 15 March 1995
Changed so that DW_DESC only needs to be unique for a
given detector.
Version 10, William Thompson, GSFC, 20 June 1995
Added tag WIN_FLAG.
Version 11, Stein Vidar Haugan, UiO, 25 September 1995
Fixed bug with DBEXT always returning arrays.
Version 12, William Thompson, GSFC, 16 May 1997
Allow for possibility of CHK_DATAWIN returning an
array.
Version : Version 12, 16 May 1997
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_DETAIL()
Purpose : Adds a CDS detailed science plan record to the database
Explanation : This procedure takes a CDS detailed science plan entry and
adds it to the database "sci_details". This database contains
a series of such entries, making a historical list.
Use : Result = ADD_DETAIL( DEF )
IF NOT ADD_DETAIL( DEF ) THEN ...
Inputs : DEF = This is an anonymous structure containing the following
tags:
PROG_ID = Program ID, linking one or more studies
together
STUDY_ID = Number defining the study
STUDYVAR = Number giving the study variation ID
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
CMP_NO = Campaign number
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
DATE_OBS = Date/time of beginning of observation,
in TAI format
DATE_END = Date/time of end of observation, in TAI
format
ORIG_DUR = Original duration of the observation, in
seconds, before being truncated by
following time-tagged observations.
N_RASTERS1 = Variable number of rasters parameter
TIME_TAGGED= True (1) if the start of the study is to
be a time-tagged event. Otherwise, the
study will begin immediately after the
previous study.
TRACKING = True (1) if feature tracking to be used,
or false (0) otherwise
N_POINTINGS= Number of pointings to use with study.
N_REPEAT_S = Number of times to repeat study.
FLAG_MASTER= If 0, then CDS is not flag master. If a
positive integer, then CDS is flag master,
and the number represents the scheme used
to generate the flag. Negative numbers
mean the same as positive numbers, but the
flag is local.
GSET_ID = GSET ID number
GET_RAW = True if raw data should be collected.
PROG_NUM = Study counter number (negative is
predicted). This parameter is optional.
If omitted, then 0 is assumed.
If N_POINTINGS is greater than 0, then there will be the
additional tag POINTINGS. This is an array of pointing
positions. It itself is a structure, of type
PLAN_PNT_STRUC, with the following tags:
INS_X = Pointing in X relative to sun center
INS_Y = Pointing in Y relative to sun center
ZONE_ID = Pointing zone ID
DEF is also allowed to be an array of such structures.
In such a case, the substructure POINTINGS will be
dimensioned based on the largest value of N_POINTINGS.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_DETAIL( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
NOCHECK_DB = if set, inhibit integrity checking of input plan
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], GET_CAMPAIGN
GET_F_RASTER, GET_GSET, GET_OBJECT, GET_PROGRAM, GET_STUDY, TAG_EXIST [1]
TAG_EXIST [2], TAI2UTC, TRIM, UNIQ [1], UNIQ [2], UNIQ [3]
CALLED BY:
IMPORT_PLAN, MOD_DETAIL
Common : None.
Restrictions: Only this routine or DEL_DETAIL can be used to add or delete
science details descriptions to or from the database.
Modifying the database by hand could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: The dates in the structure are rounded off to millisecond
accuracy.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 25 July 1994
Modified : Version 1, William Thompson, GSFC, 3 August 1994
Version 2, Liyun Wang, GSFC/ARC, September 21, 1994
Added the ERRMSG keyword
Version 3, William Thompson, GSFC, 8 November 1994
Changed how GET_OBJECT is called
Version 4, William Thompson, GSFC, 21 November 1994
Added item N_REPEAT_S
Version 5, William Thompson, GSFC, 13 December 1994
Modified to write times out to millisecond accuracy.
Version 6, William Thompson, GSFC, 20 December 1994
Changed OBJECT to three characters
Version 7, William Thompson, GSFC, 13 February 1995
Changed the way pointing is handled
Version 8, William Thompson, GSFC, 28 March 1995
Added tag ZONE_ID
Version 9, William Thompson, GSFC, 8 May 1995
Modified to pay attention to DELETED field in database
Version 10, William Thompson, GSFC, 20 June 1995
Added tag FLAG_MASTER
Version 11, William Thompson, GSFC, 29 June 1995
Changed to round off times to millisecond accuracy in
the structure.
Version 12, William Thompson, GSFC, 5 July 1995
Allow FLAG_MASTER to be any positive or negative
integer number.
Version 13, William Thompson, GSFC, 30 August 1995
Allow DEF to be an array
Version 14, William Thompson, GSFC, 28 September 1995
Added tags ORIG_DUR, GSET_ID, GET_RAW
Version 15, William Thompson, GSFC, 11 December 1995
Check validity of GSET_ID when using GIS.
Version 16, Zarro, GSFC, 10 December 1996
Added NOCHECK_DB keyword to turbocharge database
updates -- should only be used if integrity checks are
have been applied already.
Version 17, Zarro, GSFC, 16 January 1997
Inhibited GET_CAMPAIGN error message for CMP_NO=1
since this value is being used by EIT.
Version 18, 03-Jun-1997, William Thompson, GSFC
Include PROG_NUM in database writes.
Version 19, Zarro, GSFC, 7 June 1997
Inhibited GET_CAMPAIGN error message for any
invalid campaign #. Prevents an entire set of
plans from being rejected when CMP_NO is invalid
in a single entry.
Version : Version 19
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_EFF_AREA
Purpose : Adds an effective area curve to database
Category : CDS, Calibration, Class3
Explanation : This routine adds an effective area curve as a function of
mirror position for one of the CDS spectral ranges to the
database.
Syntax : ADD_EFF_AREA, DATE_EFF, SPECTRUM, EFF_AREA
Examples : ADD_EFF_AREA, '1995/12/02', 'N2', 0.00040
Inputs : DATE_EFF = The date, and optionally time, that the value
becomes effective. In other words, the calibration
value should be applied to all science data taken on
or after that date. Can be in any CDS time format.
The current date is also stored along with the data.
When the database is read in, the most current
version for a given date is used.
For example, if there were two values of DATE_EFF in
the database,
DATE_EFF = 1995/12/02
DATE_EFF = 1996/09/16
then the first would be used for all data taken
between 1995/12/02 and 1996/09/16, and the second
would be used for all data from 1996/09/16 on. If
there was more than one entry in the database with
an effective date of 1996/09/16, then the most
recent one would be used.
There is one thing to watch out for in maintaining
the database. Taking the above example, if one
added a calibration with an effective date of
1996/05/01, then it would be applied to data between
that date and the next date in the database,
i.e. 1996/09/16. If one wanted the new calibration
to apply to all data after 1996/05/01, then one
would have to also add a new entry for 1996/09/16.
SPECTRUM = A character string representing the spectrum,
e.g. "N1" or "NIS1".
EFF_AREA = The effective area as a function of mirror position,
given as an array of 256 values. Although larger
than the number of actual mirror positions, storing
the data in this way makes it easier to extract out
the data for a given mirror position. E.g., for
mirror position 76, the effective area would be
EFF_AREA(76).
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
ANYTIM2TAI, DBBUILD [1], DBBUILD [2], DBBUILD [3], DBCLOSE [1], DBCLOSE [2]
DBCLOSE [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], GET_UTC, PRIV_ZDBASE, UTC2TAI
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 16-Sep-1996, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_EFFICIENCY
Purpose : Adds an overall efficiency value to database
Category : CDS, Calibration, Class3
Explanation : This routine adds an overall efficiency value for one of the
CDS spectral ranges to the database.
Syntax : ADD_EFFICIENCY, DATE_EFF, SPECTRUM, EFFICIENCY
Examples : ADD_EFFICIENCY, '1995/12/02', 'N2', 0.00040
Inputs : DATE_EFF = The date, and optionally time, that the value
becomes effective. In other words, the calibration
value should be applied to all science data taken on
or after that date. Can be in any CDS time format.
The current date is also stored along with the data.
When the database is read in, the most current
version for a given date is used.
For example, if there were two values of DATE_EFF in
the database,
DATE_EFF = 1995/12/02
DATE_EFF = 1996/09/16
then the first would be used for all data taken
between 1995/12/02 and 1996/09/16, and the second
would be used for all data from 1996/09/16 on. If
there was more than one entry in the database with
an effective date of 1996/09/16, then the most
recent one would be used.
There is one thing to watch out for in maintaining
the database. Taking the above example, if one
added a calibration with an effective date of
1996/05/01, then it would be applied to data between
that date and the next date in the database,
i.e. 1996/09/16. If one wanted the new calibration
to apply to all data after 1996/05/01, then one
would have to also add a new entry for 1996/09/16.
SPECTRUM = A character string representing the spectrum,
e.g. "N1" or "NIS1".
EFFICIENCY = The overall efficiency value.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
ANYTIM2TAI, DBBUILD [1], DBBUILD [2], DBBUILD [3], DBCLOSE [1], DBCLOSE [2]
DBCLOSE [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], GET_UTC, PRIV_ZDBASE, UTC2TAI
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 16-Sep-1996, William Thompson, GSFC
Version 2, 21-May-2002, William Thompson, GSFC
Allow N4 for NIS-2 second order.
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_EXP_COMM()
Purpose : Adds a CDS experiment comment entry to the as-run database
Explanation : This procedure takes a comment pertaining to the CDS
raster-level (experiment) as-run entry and adds it to the
database "exper_comment". This database contains a series of
such entries, making a historical list.
Use : Result = ADD_EXP_COMM( COMM )
IF NOT ADD_EXP_COMM( COMM ) THEN ...
Inputs : COMM = This is an anonymous structure containing the following
tags:
SEQ_NUM = Experiment sequence number. This serves
as a link to the experiment database.
COMM_NO = Comment ID number. Initially, this is -1.
It is updated by this routine to reflect
the ID number in the database.
COMMENT = A comment.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_EXP_COMM( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DB_INFO [1], DB_INFO [2], DB_INFO [3], GET_EXPER
GET_UTC, LOCK_DATABASE, MOD_EXPER, TRIM, UNLOCK_DATABASE, UTC2TAI
Common : None.
Restrictions: Only this routine can be used to add entries to the
EXPER_COMMENT database. Modifying the database by hand could
corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: Once an entry has been added to the database, it must never be
removed.
The dates in the structure are rounded off to millisecond
accuracy.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 7 March 1996
Modified : Version 1, William Thompson, GSFC, 7 March 1996
Version 2, William Thompson, GSFC, 11 April 1996
Call LOCK_DATABASE and UNLOCK_DATABASE
Version : Version 2, 11 April 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_EXPER()
Purpose : Adds a CDS experiment entry to the as-run database
Explanation : This procedure takes a CDS raster-level (experiment) as-run
entry and adds it to the database "experiment". This database
contains a series of such entries, making a historical list.
Use : Result = ADD_EXPER( OBS )
IF NOT ADD_EXPER( OBS ) THEN ...
Inputs : OBS = This is an anonymous structure containing the following
tags:
PROG_NUM = Study counter number.
SEQ_NUM = Unique sequence number. This serves as
the primary key to the database. Note
that SEQ_NUM is *not* assigned by this
routine.
OBS_SEQ = A character string derived from the raster
number and the variation number,
e.g. "R4V3".
COUNT = The number of repeated observations making
up this experiment. Normally 1.
SEQ_IND = The raster counter
RAS_ID = The raster ID number
RAS_VAR = The raster variation index
EXPTIME = The exposure time, in seconds
OBS_MODE = The observing mode.
DW_ID = The data window ID number
DATE_OBS = Date/time of beginning of observation,
in TAI format
DATE_END = Date/time of end of observation, in TAI
format
OBT_TIME = Onboard date/time of beginning of
observation, in TAI format
OBT_END = Onboard date/time of end of observation,
in TAI format
XCEN = Center of instrument field-of-view in
solar X
YCEN = Center of instrument field-of-view in
solar Y
ANGLE = Angle of instrument relative to solar
north
IXWIDTH = Width of field-of-view in instrument X
IYWIDTH = Width of field-of-view in instrument Y
INS_X0 = The instrument origin pointing in X
INS_Y0 = The instrument origin pointing in Y
INS_ROLL = The instrument roll angle
SC_X0 = The spacecraft pointing in X
SC_Y0 = The spacecraft pointing in Y
SC_ROLL = The spacecraft roll
WAVEMIN = The minimum wavelength of observation, in
Angstroms.
WAVEMAX = The maximum wavelength, in Angstroms
TRACKING = True if tracking is on
SER_ID = The series ID number
OPSLBITS = The OPS-L status bits at the start of the
observation.
OPSRBITS = The OPS-R status bits at the start of the
observation.
SLIT_POS = The slit position at the start of the
observation.
MIR_POS = The mirror position at the start of the
observation.
EV_ENAB = True if event recognition enabled
COMP_ERR = True if a compression error was
encountered.
VDS_PMCP = The VDS MCP programmable voltage setting
VDS_MODE = The VDS readout mode.
VDS_ORI = True if the VDS telemetry data is oriented
by columns
VDS_ACC = True if VDS is operated in accumulate mode
GSET_ID = GIS Setup ID
DETECTOR = Either N or G for NIS/GIS.
ZONE_ID = Pointing zone ID
SLIT_NUM = Slit number
FILENAME = FITS file name
SEQVALID = True for valid science data
DATASRC = Data source, either Q(uicklook) or F(inal
distribution).
It can also be an array of such structures.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_EXPER( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
CDS_MESSAGE, DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2]
DBBUILD [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBDELETE [1], DBDELETE [2]
DBDELETE [3], DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3]
DB_INFO [1], DB_INFO [2], DB_INFO [3], GET_DATAWIN, GET_EXPER, GET_RASTER, GET_UTC
LOCK_DATABASE, TRIM, UNLOCK_DATABASE, UTC2TAI
Common : None.
Restrictions: Only this routine can be used to add entries to the EXPERIMENT
database. Modifying the database by hand could corrupt its
integrity.
The data types and sizes of the structure elements must match
the definitions in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: Once an entry has been added to the database, it must never be
removed.
The dates in the structure are rounded off to millisecond
accuracy.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 30 June 1995
Modified : Version 1, William Thompson, GSFC, 30 June 1995
Version 2, William Thompson, GSFC, 4 August 1995
Changed so that SEQ_NUM is not assigned by this
routine.
Version 3, William Thompson, GSFC, 21 February 1996
Modified to be more robust. It will complain about not
finding IDs in the databases, but will insert the
catalog entry anyway.
Version 4, William Thompson, GSFC, 23 February 1996
Modified for version 2 of the experiment databases.
Version 5, William Thompson, GSFC, 1 April 1996
Added database locking capability.
Version 6, William Thompson, GSFC, 1 April 1996
Added parameter DATASRC
Version 7, William Thompson, GSFC, 9 April 1996
Split off locking mechanism to separate routines
LOCK_DATABASE, UNLOCK_DATABASE
Version 8, William Thompson, GSFC, 25 March 1997
Added check to make sure entry didn't appear while the
routine was running.
Version : Version 8, 25 March 1997
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_F_RASTER()
Purpose : Adds a fundamental raster definition to the database
Explanation : This procedure takes the fundamental parameters of a raster
definition and adds them to the database "raster". The ID
number for the raster is assigned.
Use : Result = ADD_F_RASTER( DEF )
IF NOT ADD_F_RASTER( DEF ) THEN ...
Inputs : DEF = This is a structure of type "cds_f_raster" containing the
following tags:
RAS_ID = Raster ID number. Initially, this is
zero. It is updated by this routine to
reflect the ID number in the database.
DETECTOR = Either "G" for GIS or "N" for NIS.
RAS_DESC = A short description of the raster, giving
its purpose.
SLIT_NUM = The ID number for the slit to be used.
XSTEP = The step size in the X direction, in arcsec.
YSTEP = The step size in the Y direction, in arcsec.
NX = The number of exposure positions in X.
NY = The number of exposure positions in Y.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
The tag RAS_ID in the input structure is updated to reflect
the ID number assigned in the database.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_F_RASTER( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
RAS_ID = If the definition matches one that is already in the
database, then this keyword returns the ID of the
matching fundamental raster. Otherwise, a -1 is returned.
CHECK_ONLY= If this keyword is set, then the routine only checks to see
if the proposed entry is valid, but does not attempt to
place it in the database.
Calls : ***
CHK_F_RASTER, DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2]
DBBUILD [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3]
DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3], DBMATCH [1], DBMATCH [2], DBMATCH [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DB_INFO [1], DB_INFO [2], DB_INFO [3], NUM2STR
CALLED BY:
IMPORT_PLAN, IMPORT_STUDY, TP_WRT_FRAST
Common : None.
Restrictions: Only this routine can be used to add fundamental raster
definitions to the database. Modifying the database by hand
could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database. The string lengths must not
exceed the lengths defined in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: Once a raster definition has been added to the database, it
must never be removed.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 4 April 1994
Modified : Version 1.0, William Thompson, GSFC, 4 May 1994
Version 2, Liyun Wang, GSFC/ARC, September 21, 1994
Added the keyword ERRMSG.
Version 3, Liyun Wang, GSFC/ARC, November 4, 1994
CHK_F_RASTER is called to check the existence of the
given fundamental raster
Version 4, William Thompson, GSFC, 8 November 1994
Added keyword RAS_ID
Version 5, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 6, William Thompson, GSFC, 2 March 1995
Enforce uniqueness for RAS_DESC.
Added keyword CHECK_ONLY.
Version 7, William Thompson, GSFC, 14 March 1995
Changed DBFIND to DBMATCH for RAS_DESC
Version : Version 7, 14 March 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_F_STUDY()
Purpose : Adds a fundamental study definition to the database
Explanation : This procedure takes the fundamental parameters of a study
definition and adds them to the databases "study",
"study_title", and "study2". The ID numbers for the study and
title are assigned.
Use : Result = ADD_F_STUDY( DEF )
IF NOT ADD_F_STUDY( DEF ) THEN ...
Inputs : DEF = This is an anonymous structure containing the following
tags:
STUDY_ID = Study ID number. Initially, this is -1.
It is updated by this routine to reflect
the ID number in the database.
TITLE_ID = Study title ID number. Initially, this
is -1. It is updated by this routine to
reflect the ID number in the database.
OBS_PROG = Name of the study
TITLE = A descriptive title for the study
CATEGORY = The study category, either "T"est,
"S"cience or "C"alibration.
N_RASTER_DEF= The number of rasters in the definition.
RASTERS = A array listing the rasters to be used
during the study.
The raster descriptions themselves are structures, of
type "cds_f_st_ras", with the following tags:
RAS_ID = Raster ID number, pointing to the
definition of the raster.
POINTING = How to handle the pointing. Valid
entries are:
1 = No pointing, supply in plan
0 = Absolute pointing
-1 = Offset value from first raster
INS_X = Together with INS_Y, the pointing to use
when user-supplied values are not
allowed. Only valid when POINTING=0
(absolute) or POINTING=-1 (relative to
1st raster).
INS_Y = ...
If N_RASTER_DEF is 0, then the RASTERS tag can be
omitted. However, in that case, an additional tag must
be added,
VAR_POINT = Either Y or N depending on whether the
study has variable pointing or fixed
pointing.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
The tags STUDY_ID and TITLE_ID in the input structure are
updated to reflect the ID numbers assigned in the database.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_F_STUDY( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
STUDY_ID = If the definition matches one that is already in the
database, then this keyword returns the ID of the
matching study. Otherwise, a -1 is returned.
CHECK_ONLY= If this keyword is set, then the routine only checks to see
if the proposed entry is valid, but does not attempt to
place it in the database.
Calls : ***
CHK_F_STUDY, CHK_T_STUDY, DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1]
DBBUILD [2], DBBUILD [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBDELETE [1]
DBDELETE [2], DBDELETE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1]
DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], DB_INFO [1], DB_INFO [2]
DB_INFO [3], NUM2STR
CALLED BY:
IMPORT_PLAN, IMPORT_STUDY, MK_STUDY
Common : None.
Restrictions: Only this routine can be used to add fundamental study
definitions to the database. Modifying the database by hand
could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database. The string lengths must not
exceed the lengths defined in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: Once a study definition has been added to the database, it
must never be removed.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 28 April 1994
Modified : Version 1, William Thompson, GSFC, 3 August 1994
Version 2, Liyun Wang, GSFC/ARC, September 21, 1994
Added the keyword ERRMSG.
Version 3, Liyun Wang, GSFC/ARC, November 4, 1994
CHK_F_STUDY is called to check the existence of the
given fundamental study
Version 3.1, Zarro GSFC/ARC, November 7, 1994
Added DBSTUDY_ID
Version 4, William Thompson, GSFC/ARC, 8 November 1994
Renamed DBSTUDY_ID keyword to STUDY_ID.
Changed how it is determined.
Fixed bug with duplicate name check.
Version 5, William Thompson, GSFC, 21 November 1994
Removed item N_RASTERS0
Added item N_RASTER_DEF
Version 6, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 7, William Thompson, GSFC, 10 February 1995
Changed N_POINTINGS to VAR_POINT.
Changed definition of POINTING.
Removed VAR_RASTERS.
Version 8, William Thompson, GSFC, 2 March 1995
Enforce uniqueness for TITLE.
Added keyword CHECK_ONLY.
Version 9, William Thompson, GSFC, 14 March 1995
Used DBMATCH instead of DBFIND for TITLE.
Version 10, William Thompson, GSFC, 12 May 1995
Modified to split off separate study_title database
Version 11, William Thompson, GSFC, 6 October 1995
Modified to allow for cases with N_RASTER_DEF=0.
Version : Version 11, 6 October 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_FLAG()
Purpose : Adds a CDS flag receiver science plan record to the database
Explanation : This procedure takes a CDS flag receiver science plan entry and
adds it to the database "sci_flag". This database contains a
series of such entries, making a historical list.
Use : Result = ADD_FLAG( DEF )
IF NOT ADD_FLAG( DEF ) THEN ...
Inputs : DEF = This is an anonymous structure containing the following
tags:
PROG_ID = Program ID, linking one or more studies
together
STUDY_ID = Number defining the study
STUDYVAR = Number giving the study variation ID
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
CMP_NO = Campaign number
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
RCVR_START = Date/time of beginning of receiver status,
in TAI format
RCVR_STOP = Date/time of end of receiver status, in
TAI format
ORIG_DUR = Original duration of the observation, in
seconds, before being truncated by
following time-tagged observations.
N_RASTERS1 = Variable number of rasters parameter
TRACKING = True (1) if feature tracking to be used,
or false (0) otherwise
N_POINTINGS= Number of pointings to use with study.
Can be either 0 or 1.
REPOINT = Either 1 to allow repoints or 0 to
disallow.
GSET_ID = GSET ID number
If N_POINTINGS is greater than 0, then there will be the
additional tag POINTINGS. This is an array of pointing
positions. It itself is a structure, of type
PLAN_PNT_STRUC, with the following tags:
INS_X = Pointing in X relative to sun center
INS_Y = Pointing in Y relative to sun center
ZONE_ID = Pointing zone ID
DEF is also allowed to be an array of such structures.
In such a case, the substructure POINTINGS will be
dimensioned based on the largest value of N_POINTINGS.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_FLAG( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], GET_CAMPAIGN
GET_F_RASTER, GET_GSET, GET_OBJECT, GET_PROGRAM, GET_STUDY, TAI2UTC, TRIM, UNIQ [1]
UNIQ [2], UNIQ [3]
CALLED BY:
MOD_FLAG
Common : None.
Restrictions: Only this routine or DEL_FLAG can be used to add or delete
flag descriptions to or from the database. Modifying the
database by hand could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: The dates in the structure are rounded off to millisecond
accuracy.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 25 July 1994
Modified : Version 1, William Thompson, GSFC, 3 August 1994
Version 2, Liyun Wang, GSFC/ARC, September 21, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 8 November 1994
Modified how GET_OBJECT was called
Version 4, William Thompson, GSFC, 21 November 1994
Added item N_REPEAT_S
Version 5, William Thompson, GSFC, 13 December 1994
Modified to write times out to millisecond accuracy.
Version 6, William Thompson, GSFC, 20 December 1994
Changed OBJECT to three characters
Version 7, William Thompson, GSFC, 13 February 1995
Changed the way pointing is handled
Version 8, William Thompson, GSFC, 28 March 1995
Added tag ZONE_ID
Version 9, William Thompson, GSFC, 8 May 1995
Modified to pay attention to DELETED field in database
Version 10, William Thompson, GSFC, 29 June 1995
Modified to change times in structure to millisecond
accuracy.
Version 11, William Thompson, GSFC, 5 July 1995
Added tag REPOINT.
Version 12, William Thompson, GSFC, 31 August 1995
Allow DEF to be an array
Version 13, William Thompson, GSFC, 6 October 1995
Added tags ORIG_DUR, GSET_ID
Removed tag N_REPEAT_S
Force N_POINTINGS to be either 0 or 1
Version 14, William Thompson, GSFC, 11 December 1995
Check validity of GSET_ID when using GIS.
Version : Version 14, 11 December 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_GSET()
Purpose : Adds an entry to the GIS setup database.
Explanation : This procedure adds an entry to the GIS setup description
catalog. The ID number for the GIS setup description is
assigned.
Use : Result = ADD_GSET( DEF )
IF NOT ADD_GSET( DEF ) THEN ...
Inputs : DEF = This is an anonymous structure containing the following
tags:
GSET_ID = GIS setup ID number. Initially, this
is zero. It is updated by this routine to
reflect the ID number in the database.
HVOLT = High voltages (4)
LLD = Low level discriminators (4)
LUT_CHKSUM = LUT checksum in hexidecimal notation (4)
LUT_PAR = LUT parameters (4,11)
RAW_ID = RAW GIS science data file ID (4)
SLIT_NUM = Slit number
ZONE_ID = Zone ID number
FIL_ID = Filament ID number, or 0 for science data
FFB = Front face bias, either -1 or +1
DET_USED = Whether or not detector is used, either 0
or 1 (4)
GSET_DESC = Free format descriptions (4)
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
The tag GSET_ID in the input structure is updated to reflect
the ID number assigned in the database.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_GSET( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DB_INFO [1], DB_INFO [2], DB_INFO [3]
SAME_DATA [1], SAME_DATA [2]
CALLED BY:
mk_gset
Common : None.
Restrictions: Only this routine can be used to add GSET setup entries to
the database. Modifying the database by hand could corrupt its
integrity.
The data types and sizes of the structure elements must match
the definitions in the database. The string lengths must not
exceed the lengths defined in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: Once a GIS setup definition has been added to the database,
it must never be removed.
There is currently no safeguard to prevent the same data being
added to the database twice.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 7 September 1995
Modified : Version 1, William Thompson, GSFC, 7 September 1995
Version 2, William Thompson, GSFC, 14 September 1995
Replace FIL_CUR with FFB
Version 3, William Thompson, GSFC, 28 September 1995
Make LUT_CHKSUM an array.
Make LUT_PAR floating point.
Version 4, C D Pike, RAL, 2-October-95
Fix checking of LUT checksum string lengths.
Version 5, William Thompson, GSFC, 4 October 1995
Correct bug with LUT_CHKSUM and GSET_DESC not being
written correctly.
Version 6, William Thompson, GSFC, 25 January 1996
Modified definition of LUT_PAR and added DET_USED.
Version : Version 6, 25 January 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_INST_DLYD()
Purpose : Adds an entry to the instrument delayed command database.
Explanation : This procedure adds an entry for a given instrument for delayed
command upload time to the "inst_delayed_cmd" database.
Use : Result = ADD_INST_DLYD( RES )
IF ADD_INST_DLYD( RES ) EQ 0 THEN ...
Inputs : RES = A structure variable containing the following tags:
INSTRUME = Single letter code specifying the
instrument.
EARLIEST = The start time of the reserved time
LATEST = The end time of the reserved time.
NUM_CMDS = The expected average number of OBDH block
commands per minute between the start time
and end time.
It can also be an array of such structures.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_INST_DLYD( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBOPEN [1], DBOPEN [2], DBOPEN [3]
GET_INSTRUMENT
CALLED BY:
READ_KAP
Common : None.
Restrictions: Only this routine or CLR_INST_DLYD can be used to add or delete
delayed command time entries to the database. Modifying the
database by hand could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 6 March 1996
Modified : Version 1, William Thompson, GSFC, 6 March 1996
Version : Version 1, 6 March 1996
[Previous]
[Next]
NAME:
ADD_LASCO_LOGO
PURPOSE:
This function inserts the LASCO logo into the corner of an image
CATEGORY:
LASCO_SYNOPTIC
CALLING SEQUENCE:
Result = ADD_LASCO_LOGO(Img)
INPUTS:
Img: Input image
KEYWORDS:
LEFT When set, puts logo on lower left corner
OUTPUTS:
Result: Output image with same type and dimenstion as input
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], FILEPATH
CALLED BY:
MAKE_DAILY_IMAGE, MKMOVIE, MKMOVIE0 obsolete version of mkmoviepro, MK_IMG
WRUNMOVIE [2]
COMMON:
ADD_LASCO_LOGO_COMMON, w_logo
Temporary storage for the logo
PROCEDURE:
Checks to see if the logo array has been read in, and restores it
if not. Then inserts the logo into the lower, right hand corner.
MODIFICATION HISTORY:
Written by: Scott Paswaters, NRL, Dec 1997
99/07/14 N Rich Add LEFT keyword
@(#)add_lasco_logo.pro 1.3 07/14/99 LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_LINELIST()
Purpose : Adds a line list definition to the database
Explanation : This procedure takes a line list definition and adds it to line
list databases "linelist" and "linelist2". The ID number for
the linelist is assigned.
Use : Result = ADD_LINELIST( DEF )
IF NOT ADD_LINELIST( DEF ) THEN ...
Inputs : DEF = This is an anonymous structure containing the following
tags:
LL_ID = Line list ID number. Initially, this is
zero. It is updated by this routine to
reflect the ID number in the database.
DETECTOR = Either "G" for GIS or "N" for NIS.
LL_DESC = A description of the line list, e.g.
"Temperature sensitive line pairs". Can be
up to 65 characters.
LINES = An array containing the line definitions.
The line definitions themselves are structures, of type
"cds_lines", with the following tags:
LINENAME = Line name, e.g. "He II 304". Can be up to
12 characters.
WAVELNTH = The wavelength of the line, in Angstroms.
GR_ORDER = The grating order
CEN_PIX = The central detector pixel.
WAVEBAND = The wavelength band, 1 or 2 for NIS, 1-4 for
GIS.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
The tag LL_ID in the input structure is updated to reflect
the ID number assigned in the database.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_LINELIST( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
LL_ID = If the definition matches one that is already in the
database, then this keyword returns the ID of the
matching linelist. Otherwise, a -1 is returned.
CHECK_ONLY= If this keyword is set, then the routine only checks to see
if the proposed entry is valid, but does not attempt to
place it in the database.
Calls : ***
CHK_LINELIST, DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2]
DBBUILD [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBDELETE [1], DBDELETE [2]
DBDELETE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2]
DBFIND [3], DBMATCH [1], DBMATCH [2], DBMATCH [3], DBOPEN [1], DBOPEN [2]
DBOPEN [3], DB_INFO [1], DB_INFO [2], DB_INFO [3], NUM2STR
CALLED BY:
IMPORT_PLAN, IMPORT_STUDY, TP_WRT_LLIST
Common : None.
Restrictions: Only this routine can be used to add line list definitions to
the database. Modifying the database by hand could corrupt its
integrity.
The data types and sizes of the structure elements must match
the definitions in the database. The string lengths must not
exceed the lengths defined in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: Once a line list definition has been added to the database, it
must never be removed.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 30 March 1994
Modified : Version 1.0, William Thompson, GSFC, 2 June 1994
Version 2, Liyun Wang, GSFC/ARC, September 21, 1994
Added the keyword ERRMSG.
Version 3, Liyun Wang, GSFC/ARC, November 4, 1994
CHK_LINELIST is called to check the existence of the
given line list
Version 4, William Thompson, GSFC, 8 November 1994
Added keyword LL_ID
Version 5, William Thompson, GSFC, 2 March 1995
Enforce uniqueness for LL_DESC.
Added keyword CHECK_ONLY.
Version 6, William Thompson, GSFC, 14 March 1995
Changed DBFIND to DBMATCH for LL_DESC.
Version 7, William Thompson, GSFC, 15 March 1995
Removed LL_TITLE. Changed so that LL_DESC only needs
to be unique for a given detector.
Version 8, William Thompson, GSFC, 16 May 1997
Allow for possibility of CHK_LINELIST returning an
array.
Version : Version 8, 16 May 1997
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_MAIN()
Purpose : Adds a CDS main entry to the as-run database
Explanation : This procedure takes a CDS study-level (main) as-run entry and
adds it to the database "main". This database contains
a series of such entries, making a historical list.
Use : Result = ADD_MAIN( OBS )
IF NOT ADD_MAIN( OBS ) THEN ...
Inputs : OBS = This is an anonymous structure containing the following
tags:
PROG_NUM = Study counter number. This forms the
primary key for this database.
PROG_ID = Program ID, linking one or more studies
together
PROG_IND = An index, reflecting one's position within
a repeated sequence of studies via the
N_REPEAT_S mechanism.
STUDY_ID = Number defining the study
STUDYVAR = Number giving the study variation ID
OBS_PROG = Name of the study
DETECTOR = Detector, "N", "G", or "B"(oth).
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
CMP_NO = Campaign number
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
DATE_OBS = Date/time of beginning of observation,
in TAI format
DATE_END = Date/time of end of observation, in TAI
format
OBT_TIME = Onboard date/time of beginning of
observation, in TAI format
OBT_END = Onboard date/time of end of observation,
in TAI format
XCEN = Center of instrument field-of-view in
solar X
YCEN = Center of instrument field-of-view in
solar Y
ANGLE = Angle of instrument relative to solar
north
IXWIDTH = Width of field-of-view in instrument X
IYWIDTH = Width of field-of-view in instrument Y
SEQ_FROM = Start of range of observing sequence
numbers.
SEQ_TO = End of range of observing sequence
numbers.
It can also be an array of such structures.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_MAIN( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
CDS_MESSAGE, DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2]
DBBUILD [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBOPEN [1], DBOPEN [2]
DBOPEN [3], GET_CAMPAIGN, GET_MAIN, GET_OBJECT, GET_PROGRAM, GET_STUDY, GET_UTC
LOCK_DATABASE, TRIM, UNLOCK_DATABASE, UTC2TAI
Common : None.
Restrictions: Only this routine can be used to add entries to the MAIN
database. Modifying the database by hand could corrupt its
integrity.
The data types and sizes of the structure elements must match
the definitions in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: Once an entry has been added to the database, it must never be
removed.
The dates in the structure are rounded off to millisecond
accuracy.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 30 June 1995
Modified : Version 1, William Thompson, GSFC, 30 June 1995
Version 2, William Thompson, GSFC, 21 February 1996
Modified to be more robust. It will complain about not
finding IDs in the databases, but will insert the
catalog entry anyway.
Version 3, William Thompson, GSFC, 2 April 1996
Modified for version 3 of the catalog.
Version 4, William Thompson, GSFC, 9 April 1996
Added calls to LOCK_DATABASE, UNLOCK_DATABASE
Version 5, William Thompson, GSFC, 25 March 1997
Added check to make sure that the entry didn't appear
while the routine was running.
Version : Version 5, 25 March 1997
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_MIRSHIFT()
Purpose : Register NIS mirror shift calibrations in the database.
Category : Calibration, NIS, Coordinates
Explanation : Adds an NIS mirror shift calibration to the database. The
calibration is marked with the current date/time.
Syntax : Result = ADD_MIRSHIFT( DATE_EFF, SPECTRUM, COEFF )
Examples : IF NOT ADD_MIRSHIFT('1995-12-2',1,COEFF) THEN ...
Inputs : DATE_EFF = The date, and optionally time, that the value
becomes effective. In other words, the calibration
value should be applied to all science data taken on
or after that date. Can be in any CDS time format.
The current date is also stored along with the data.
When the database is read in, the most current
version for a given date is used.
For example, if there were two values of DATE_EFF in
the database,
DATE_EFF = 1995/12/02
DATE_EFF = 1996/09/16
then the first would be used for all data taken
between 1995/12/02 and 1996/09/16, and the second
would be used for all data from 1996/09/16 on. If
there was more than one entry in the database with
an effective date of 1996/09/16, then the most
recent one would be used.
There is one thing to watch out for in maintaining
the database. Taking the above example, if one
added a calibration with an effective date of
1996/05/01, then it would be applied to data between
that date and the next date in the database,
i.e. 1996/09/16. If one wanted the new calibration
to apply to all data after 1996/05/01, then one
would have to also add a new entry for 1996/09/16.
SPECTRUM = Either 1 or 2
COEFF = The NIS mirror shift calibration coefficients. The
polynomial
SHIFT = POLY(MIR_POS - 128, COEFF)
returns the shift as a function of mirror position.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords : ERRMSG = If defined and passed, then any error messages will
be returned to the user in this parameter rather
than depending on the MESSAGE routine in IDL. If no
errors are encountered, then a null string is
returned. In order to use this feature, ERRMSG must
be defined first, e.g.
ERRMSG = ''
Result = ADD_MIRSHIFT( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2TAI, DBBUILD [1], DBBUILD [2], DBBUILD [3], DBCLOSE [1], DBCLOSE [2]
DBCLOSE [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], GET_UTC, PRIV_ZDBASE, UTC2TAI
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 22-Jan-1999, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
NAME:
ADD_MISSING_BLOCKS
PURPOSE:
Masks blocks in the input image which are identified in the MISSLIST
keyword.
CATEGORY:
LASCO Level 1 post-processing
CALLING SEQUENCE:
Result = add_missing_blocks(image, header)
INPUTS:
image LASCO image with filled-in missing blocks (if any)
header LASCO header structure
KEYWORD PARAMETERS:
OUTPUTS:
image with missing blocks masked
CALLS: ***
C2_WARP, C3_WARP, DATATYPE [1], DATATYPE [2], DATATYPE [3], LASCO_FITSHDR2STRUCT
STR_SEP
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
Obtain coordinates of missing blocks from MISSLIST keyword; create
a mask of the blocks; warp the mask; multiply image by the mask
MODIFICATION HISTORY:
Written by: Nathan Rich, 8/29/02.
@(#)add_missing_blocks.pro 1.1 10/01/02 LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_NRT_RES()
Purpose : Adds an entry to the NRT reserved database.
Explanation : This procedure adds an entry for a given instrument for NRT
reserved time to the "nrt_reserved" database.
Use : Result = ADD_NRT_RES( RES )
IF ADD_NRT_RES( RES ) EQ 0 THEN ...
Inputs : RES = A structure variable containing the following tags:
INSTRUME = Single letter code specifying the
instrument.
START_TIME = The start time of the reserved time
END_TIME = The end time of the reserved time.
CMD_RATE = The expected average number of OBDH block
commands per minute between the start time
and end time.
STATUS = The acceptance status for this activity.
Possible values are REQUESTED, CONFIRMED,
or DENIED. Only the first character is
stored in the database.
It can also be an array of such structures.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_NRT_RES( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBOPEN [1], DBOPEN [2], DBOPEN [3]
GET_INSTRUMENT
CALLED BY:
READ_KAP
Common : None.
Restrictions: Only this routine or CLR_NRT_RES can be used to add or delete
NRT reserved entries to the database. Modifying the database
by hand could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 3 April 1995
Modified : Version 1, William Thompson, GSFC, 3 April 1995
Version 2, William Thompson, GSFC, 22 May 1995
Modified to allow array inputs.
Version : Version 2, 22 May 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_OTHER_OBS()
Purpose : Adds a plan entry for another observatory to database
Explanation : This procedure takes an "Other_Obs" science plan entry from the
KAP and adds it to the database "other_obs". This database
contains a series of such entries, making a historical list.
Use : Result = ADD_OTHER_OBS( DEF )
IF NOT ADD_OTHER_OBS( DEF ) THEN ...
Inputs : DEF = This is an anonymous structure containing the following
tags:
TELESCOP = The name of the telescope.
MNEMONIC = The mnemonic for the telescope.
SCI_OBJ = Science objective
SCI_SPEC = Specific science objective
NOTES = Further notes about the observation
START_TIME = Date/time of beginning of observation,
in TAI format
END_TIME = Date/time of end of observation, in TAI
format
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
CMP_NO = Campaign number
It can also be an array of such structures.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_OTHER_OBS( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBOPEN [1], DBOPEN [2], DBOPEN [3]
GET_CAMPAIGN, GET_OBJECT
CALLED BY:
READ_KAP
Common : None.
Restrictions: Only this routine or DEL_PLAN can be used to add or delete
science plan descriptions to or from the database.
Modifying the database by hand could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 12 April 1995
Modified : Version 1, William Thompson, GSFC, 12 April 1995
Version : Version 1, 12 April 1995
[Previous]
[Next]
PROJECT:
SOHO - CDS
NAME:
ADD_PATH
PURPOSE:
Add directory (and optionally all its subdirs) into IDL path
EXPLANATION:
CALLING SEQUENCE:
ADD_PATH, path_name [,/append] [,index=index]
INPUTS:
path_name -- A string scalar of a valid directory name.
OPTIONAL INPUTS:
INDEX -- Position in the !path where the directory name is inserted;
ignored if the keyword APPEND is set.
OUTPUTS:
None, but !path is changed.
OPTIONAL OUTPUTS:
None.
KEYWORD PARAMETERS:
APPEND -- By default, the given directory name is added in the
beginning of !path. Set this keyword will add the directory
name in the end of !path.
EXPAND -- Set this keyword if the PATH_NAME needs to be expanded.
CALLS: ***
ARR2STR [1], Arr2Str [2], CHK_DIR [1], CHK_DIR [2], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], DATATYPE [1], DATATYPE [2], DATATYPE [3], STR_SEP, concat_dir [4]
CALLED BY:
DO_EIT_SCALING, EIT__DEFINE, GET_GEV, GET_NAR, HSI_LIGHTCURVE_TEST, HXRS__DEFINE
ITOOL_RD_FITS, LOAD_EIT_COLOR, LOAD_PATH, READ_EIT_FILE, SPECPLOT__DEFINE
hessi_version
COMMON BLOCKS:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
CATEGORY:
Utilities, OS
PREVIOUS HISTORY:
Written October 8, 1994, by Liyun Wang, GSFC/ARC
MODIFICATION HISTORY:
Version 2, Liyun Wang, GSFC/ARC, October 17, 1994
Added EXPAND keyword
VERSION:
Version 2, October 17, 1994
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_PLAN()
Purpose : Adds a SoHO/CDS science plan record to the database
Explanation : This procedure takes a SoHO/CDS science plan entry and
adds it to the database "sci_plan". This database contains
a series of such entries, making a historical list.
Use : Result = ADD_PLAN( DEF )
IF NOT ADD_PLAN( DEF ) THEN ...
Inputs : DEF = This is an anonymous structure containing the following
tags:
SCI_OBJ = Science objective from the daily science
meeting
SCI_SPEC = Specific science objective from meeting
NOTES = Further notes about the observation
START_TIME = Date/time of beginning of observation,
in TAI format
END_TIME = Date/time of end of observation, in TAI
format
OBJECT = Code for object planned to be observed
OBJ_ID = Object identification
PROG_ID = Program ID, linking one or more studies
together
XCEN = Center(s) of instrument FOV along X
axis, given as a character string.
YCEN = Center(s) of instrument FOV along Y
axis, given as a character string.
CMP_NO = Campaign number
DISTURBANCES = Description of any disturbances
It can also be an array of such structures.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords : INSTRUMENT = Instrument to add plan entry for. Can be passed
either as the instrument name or as a single
character code value. Normally, this routine is
used for adding CDS records. However, the use of
the INSTRUMENT keyword allows it to be used with
the SOC planning tool.
ERRMSG = If defined and passed, then any error messages
will be returned to the user in this parameter
rather than depending on the MESSAGE routine in
IDL. If no errors are encountered, then a null
string is returned. In order to use this feature,
ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_PLAN( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], GET_CAMPAIGN
GET_INSTRUMENT, GET_OBJECT, GET_PROGRAM, TAI2UTC, TRIM, UNIQ [1], UNIQ [2], UNIQ [3]
CALLED BY:
IMPORT_PLAN
Common : None.
Restrictions: The INSTRUMENT keyword must *only* be used with the SOC
planning tool. Its use disables some CDS-specific checks.
Only this routine or DEL_PLAN can be used to add or delete
science plan descriptions to or from the database.
Modifying the database by hand could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: The dates in the structure are rounded off to millisecond
accuracy.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 26 July 1994
Modified : Version 1, William Thompson, GSFC, 2 August 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 8 November 1994
Modified how GET_OBJECT is called.
Version 4, William Thompson, GSFC, 13 December 1994
Modified to write times out to millisecond accuracy.
Version 5, William Thompson, GSFC, 20 December 1994
Changed OBJECT to three characters
Version 6, William Thompson, GSFC, 8 May 1995
Modified to pay attention to DELETED field in database
Version 7, William Thompson, GSFC, 16 May 1995
Added keyword INSTRUMENT
Version 8, William Thompson, GSFC, 22 May 1995
Made INS variable a named structure.
Version 9, William Thompson, GSFC, 29 June 1995
Changed so that time in structure is rounded off to
millisecond accuracy.
Version 10, William Thompson, GSFC, 30 August 1995
Added tags XCEN, YCEN
Allow input to be an array
Version 11, Zarro, GSFC, 14 January 1997
Made CMP_NO = 1 a valid ID to allow adding
EIT plans
Version : Version 11
[Previous]
[Next]
Name: add_pro
Purpose: perform rudimentary checks on input idl module(s) and place it
online if everything copecetic
Input Parameters
module - name of module(s) (including path) or directory containing
multiple modules to check
Calling Sequence:
add_pro, module [,/doc]
CALLS:
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_PROGRAM()
Purpose : Adds a CDS program definition to the database
Explanation : This procedure takes a CDS multi-observation program definition
and adds it to the database "program".
Use : Result = ADD_PROGRAM( DEF )
IF NOT ADD_PROGRAM( DEF ) THEN ...
Inputs : DEF = This is an anonymous structure containing the following
tags:
PROGNAME = Name of the program.
PROG_ID = Unique identifier number. Initially this is
zero. It is updated by this routine to
reflect the ID number in the database.
PROGDESC = Up to five lines of text describing the
program.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_PROGRAM( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DB_INFO [1], DB_INFO [2], DB_INFO [3]
CALLED BY:
XPROGRAM_ADD
Common : None.
Restrictions: Only this routine can be used to add program descriptions to
the database. Modifying the database by hand could corrupt its
integrity.
The data types and sizes of the structure elements must match
the definitions in the database. The string lengths must not
exceed the lengths defined in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: Once a program description has been added to the database, it
must never be removed.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 21 July 1994
Modified : Version 1.0, William Thompson, GSFC, 21 July 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version : Version 2, September 22, 1994
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_RAW()
Purpose : Adds an entry to the GIS raw data file catalog.
Explanation : This procedure adds an entry to the GIS raw data file catalog.
The ID number for the raw data file is assigned.
Use : Result = ADD_RAW( DEF )
IF NOT ADD_RAW( DEF ) THEN ...
Inputs : DEF = This is an anonymous structure containing the following
tags:
RAW_ID = Raw data file ID number. Initially, this
is zero. It is updated by this routine to
reflect the ID number in the database.
RAW_DESC = Free format description
START_TIME = Start time of data taking, in TAI format.
DET_NUM = GIS detector number: 1-4
SLIT_NUM = Slit number
HVOLT = High voltage value
LLD = Low level discriminator value
CNT_RATE = Count rate range (min, max)
RAW_FILE = Raw data file name
FFB = Front face bias
FIL_ID = Filament ID number
FIL_CUR = Filament current
ZONE_ID = Zone ID number
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
The tag RAW_ID in the input structure is updated to reflect
the ID number assigned in the database.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_RAW( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBOPEN [1], DBOPEN [2], DBOPEN [3], DB_INFO [1], DB_INFO [2], DB_INFO [3]
CALLED BY:
CAT_RAW
Common : None.
Restrictions: Only this routine can be used to add raw data file entries to
the database. Modifying the database by hand could corrupt its
integrity.
The data types and sizes of the structure elements must match
the definitions in the database. The string lengths must not
exceed the lengths defined in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: Once a raw data file definition has been added to the database,
it must never be removed.
The date in the structure is rounded off to millisecond
accuracy.
There is currently no safeguard to prevent the same data being
added to the database twice.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 7 September 1995
Modified : Version 1, William Thompson, GSFC, 7 September 1995
Version 2, William Thompson, GSFC, 14 September 1995
Added RAW_DESC, rename FF_BIAS to FFB to match GSET
database.
Version : Version 2, 14 September 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_RES_TYPE()
Purpose : Adds a resource type name to the database
Explanation : This procedure adds a resource type name such as "DSN_CONTACT"
to the "resource_type" database. The ID number for the
resource type is assigned.
Use : Result = ADD_RES_TYPE( TYPE )
IF ADD_RES_TYPE( TYPE ) EQ 0 THEN ...
Inputs : TYPE = A string parameter containing the name of the resource
type. Can be up to 30 characters long.
Opt. Inputs : None.
Outputs : The result of the function is the ID number assigned to the
resource type. If not successful, then 0 is returned instead.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_RES_TYPE( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
CHECK_ONLY= If this keyword is set, then the routine only checks to see
if the proposed entry is valid, but does not attempt to
place it in the database.
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBMATCH [1], DBMATCH [2], DBMATCH [3], DBOPEN [1], DBOPEN [2], DBOPEN [3]
DB_INFO [1], DB_INFO [2], DB_INFO [3]
Common : None.
Restrictions: Only this routine can be used to add resource types to the
database. Modifying the database by hand could corrupt its
integrity.
!PRIV must be 2 or greater to use this routine.
Side effects: Once a reference type has been added to the database, it must
never be removed.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 31 March 1995
Modified : Version 1, William Thompson, GSFC, 3 April 1995
Version : Version 1, 3 April 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_RESOURCE()
Purpose : Adds an entry to the general resource database.
Explanation : This procedure adds an entry for a general resource at a given
time to the "resource" database.
Use : Result = ADD_RESOURCE( RES )
IF ADD_RESOURCE( RES ) EQ 0 THEN ...
Inputs : RES = A structure variable containing the following tags:
RES_TYPE = The resource type, such as "DSN_CONTACT".
START_TIME = The start time of the resource.
END_TIME = The end time of the resource, if any. For
some resources this parameter is ignored.
It can also be an array of such structures.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_RESOURCE( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBOPEN [1], DBOPEN [2], DBOPEN [3]
LIST_RES_TYPE
CALLED BY:
READ_KAP
Common : None.
Restrictions: Only this routine or CLR_RESOURCE can be used to add or delete
resource descriptions to the database. Modifying the database
by hand could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database.
The resource type must be listed in the resource_type database.
!PRIV must be 2 or greater to use this routine.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 31 March 1995
Modified : Version 1, William Thompson, GSFC, 3 April 1995
Version 2, William Thompson, GSFC, 22 May 1995
Modified to allow array inputs.
Version 3, William Thompson, GSFC, 14 August 1995
Modified to call LIST_RES_TYPE. Together with changes
to that routine, this routine is speeded up.
Version : Version 3, 14 August 1995.
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_T_STUDY()
Purpose : Adds a fundamental study definition to the title database
Explanation : This procedure takes the name, title, and category parts of the
fundamental parameters of a study definition and adds them to
the database "study_title"., and "study2". The ID
number for the study title is assigned.
Use : Result = ADD_T_STUDY( DEF )
IF NOT ADD_T_STUDY( DEF ) THEN ...
Inputs : DEF = This is an anonymous structure containing the following
tags:
STUDY_ID = Study ID number. Must match an entry in
the fundamental study database.
TITLE_ID = Study title ID number. Initially, this
is -1. It is updated by this routine to
reflect the ID number in the database.
OBS_PROG = Name of the study
TITLE = A descriptive title for the study
CATEGORY = The study category, either "T"est,
"S"cience or "C"alibration.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
The tag TITLE_ID in the input structure is updated to reflect
the ID number assigned in the database.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_T_STUDY( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
TITLE_ID = If the name and title matches one that is already in the
database for the given study ID, then this keyword returns
the title ID of the matching study. Otherwise, a -1 is
returned.
CHECK_ONLY= If this keyword is set, then the routine only checks to see
if the proposed entry is valid, but does not attempt to
place it in the database.
Calls : ***
CHK_T_STUDY, DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2]
DBBUILD [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3]
DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3]
DB_INFO [1], DB_INFO [2], DB_INFO [3], NUM2STR
CALLED BY:
IMPORT_PLAN, IMPORT_STUDY
Common : None.
Restrictions: Only this routine and ADD_F_STUDY can be used to add
fundamental study names and titles to the database. Modifying
the database by hand could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database. The string lengths must not
exceed the lengths defined in the database.
This routine must not be called for studies where
N_RASTER_DEF=0.
!PRIV must be 2 or greater to use this routine.
Side effects: Once a study title has been added to the database, it must
never be removed.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 12 May 1995
Modified : Version 1, William Thompson, GSFC, 12 May 1995
Version 2, William Thompson, GSFC, 2 June 1995
Changed way that error messages are handled.
Version : Version 2, 2 June 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_TEL_MODE()
Purpose : Adds an entry to the telemetry mode database.
Explanation : This procedure adds an entry for a telemetry mode change at a
given time to the "telem_mode" database.
Use : Result = ADD_TEL_MODE( TM )
IF ADD_TEL_MODE( TM ) EQ 0 THEN ...
Inputs : TM = A structure variable containing the following tags:
MODE = The telemetry mode being changed to. Can
have one of the following values:
Mnemonic Stored as
LR 1
MR 2
HR 3
IDLE 4
The mnemonics are converted to numbers
before being stored in the database.
START_TIME = The start time of the telemetry mode
change
It can also be an array of such structures.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_TEL_MODE( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBOPEN [1], DBOPEN [2], DBOPEN [3]
CALLED BY:
READ_KAP
Common : None.
Restrictions: Only this routine or CLR_TEL_MODE can be used to add or delete
telemetry modes to the database. Modifying the database
by hand could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 3 April 1995
Modified : Version 1, William Thompson, GSFC, 3 April 1995
Version 2, William Thompson, GSFC, 22 May 1995
Modified to allow array inputs.
Version : Version 2, 22 May 1995
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_TEL_SUBMODE()
Purpose : Adds an entry to the telemetry submode database.
Explanation : This procedure adds an entry for a telemetry submode change at
a given time to the "telem_submode" database.
Use : Result = ADD_TEL_SUBMODE( TM )
IF ADD_TEL_SUBMODE( TM ) EQ 0 THEN ...
Inputs : TM = A structure variable containing the following tags:
SUBMODE = The telemetry submode being changed to.
Can be 1, 2, 3, 4, 5, or 6.
START_TIME = The start time of the telemetry submode
change
It can also be an array of such structures.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_TEL_SUBMODE( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2], DBBUILD [3]
DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBOPEN [1], DBOPEN [2], DBOPEN [3]
CALLED BY:
READ_KAP
Common : None.
Restrictions: Only this routine or CLR_TEL_SUBMODE can be used to add or
delete telemetry submodes to the database. Modifying the
database by hand could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 3 April 1995
Modified : Version 1, William Thompson, GSFC, 3 April 1995
Version 2, William Thompson, GSFC, 22 May 1995
Modified to allow array inputs.
Version 3, William Thompson, GSFC, 24 November 1997
Allow SUBMODE to be up to 6
Version : Version 3, 24 November 1997
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_TILTCAL()
Purpose : Register NIS tilt calibrations in the database.
Category : Calibration, NIS, Coordinates
Explanation : Adds an NIS tilt calibration to the database. The calibration
is marked with the current date/time.
Syntax : Result = ADD_TILTCAL( DATE_EFF, SPECTRUM, COEFF )
Examples : IF NOT ADD_TILTCAL('1995-12-2',1,COEFF) THEN ...
Inputs : DATE_EFF = The date, and optionally time, that the value
becomes effective. In other words, the calibration
value should be applied to all science data taken on
or after that date. Can be in any CDS time format.
The current date is also stored along with the data.
When the database is read in, the most current
version for a given date is used.
For example, if there were two values of DATE_EFF in
the database,
DATE_EFF = 1995/12/02
DATE_EFF = 1996/09/16
then the first would be used for all data taken
between 1995/12/02 and 1996/09/16, and the second
would be used for all data from 1996/09/16 on. If
there was more than one entry in the database with
an effective date of 1996/09/16, then the most
recent one would be used.
There is one thing to watch out for in maintaining
the database. Taking the above example, if one
added a calibration with an effective date of
1996/05/01, then it would be applied to data between
that date and the next date in the database,
i.e. 1996/09/16. If one wanted the new calibration
to apply to all data after 1996/05/01, then one
would have to also add a new entry for 1996/09/16.
SPECTRUM = Either 1 or 2
COEFF = The NIS tilt calibration coefficients. The
polynomial
TILT = POLY(PIXEL, COEFF)
returns the tilt as a function of pixel position.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords : ERRMSG = If defined and passed, then any error messages will
be returned to the user in this parameter rather
than depending on the MESSAGE routine in IDL. If no
errors are encountered, then a null string is
returned. In order to use this feature, ERRMSG must
be defined first, e.g.
ERRMSG = ''
Result = ADD_TILTCAL( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2TAI, DBBUILD [1], DBBUILD [2], DBBUILD [3], DBCLOSE [1], DBCLOSE [2]
DBCLOSE [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], GET_UTC, PRIV_ZDBASE, UTC2TAI
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 13-Jan-1998, William Thompson, GSFC
Contact : WTHOMPSON
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
ADD_UDP_HEAD
PURPOSE:
Add document header to a given SCL file
CATEGORY:
ST_SUMER
SYNTAX:
add_udp_head, scl_code, doc_stc [,scl_file=scl_file]
INPUTS:
SCL_CODE - String array containing the whole SCL code
DOC_STC - A structure of doc containging tags such as NAME,
TITLE, and PURPOSE
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
ERROR - Named variable containing error message. If no error
occurs, the null string is returned
SCL_FILE - Full name of SCL file to be output. If SCL_FILE is missing,
the input SCL_CODE is modified.
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], GREP, WRITE_ASCII
CALLED BY:
ST_SUMER
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
SCL_CODE gets modified if SCL_FILE is not present
HISTORY:
Version 1, October 31, 1996, Liyun Wang, NASA/GSFC. Written
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_V_RASTER()
Purpose : Adds a raster variation definition to the database
Explanation : This procedure takes the parameters that define a raster
variation and adds them to the database "raster_var". The
raster variation index number is assigned.
Use : Result = ADD_V_RASTER( DEF )
IF NOT ADD_V_RASTER( DEF ) THEN ...
Inputs : DEF = This is a structure of type "cds_v_raster" containing the
following tags:
RAS_ID = Raster ID number. Must match an entry in
the fundamental raster database.
RAS_VAR = Raster variation index. Initially, this
is zero. It is updated by this routine to
reflect the index in the database.
RV_DESC = A short description of the raster
variation beyond what is given in the
associated fundamental raster description.
EXPTIME = Exposure time in seconds, to millisecond
accuracy.
LL_ID = Line list ID. Must match an entry in the
line list database. Must also be
consistent with the corresponding DETECTOR
parameter in the fundamental raster
database. Alternatively, this can be set
to zero to signal that the raster is not
connected to a line list.
COMP_ID = Compression method ID.
COMP_OPT = Compression option parameter.
DW_ID = Data extraction window list ID. Must
match an entry in the data window list
table. Must also be consistent with the
LL_ID parameter, and with the DETECTOR
parameter from the fundamental raster
definition.
IEF_ID = Inter-instrument event flag ID.
VDS_ORIENT = VDS orientation, either 0 (row) or 1
(column).
VDS_MAP = VDS mapping mode: 2=Normal, 3=Accumulate.
TEL_RATE = Estimated required telemetry rate, as a
character representing Low/Medium/High
DURATION = Estimated duration of the raster, in
seconds.
USABLE = Either "Y" or "N" to signal whether or not
the raster is usable. Normally "Y".
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
The tag RAS_VAR in the input structure is updated to reflect
the index number assigned in the database.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_V_RASTER( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
RASTER = If the definition matches one already in the database,
then this keyword returns a vector containing the RAS_ID
and RAS_VAR of the match. Otherwise, it returns the
single value -1.
CHECK_ONLY= If this keyword is set, then the routine only checks to see
if the proposed entry is valid, but does not attempt to
place it in the database.
Calls : ***
CHK_V_RASTER, DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2]
DBBUILD [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBEXT [1], DBEXT [2], DBEXT [3]
DBEXT [4], DBFIND [1], DBFIND [2], DBFIND [3], DBMATCH [1], DBMATCH [2], DBMATCH [3]
DBOPEN [1], DBOPEN [2], DBOPEN [3], NUM2STR
CALLED BY:
IMPORT_PLAN, IMPORT_STUDY, TP_WRT_VRAST
Common : None.
Restrictions: Only this routine can be used to add raster variation
definitions to the database. Modifying the database by hand
could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database. The string lengths must not
exceed the lengths defined in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: Once a raster definition has been added to the database, it
must never be removed.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 4 April 1994
Modified : Version 1.0, William Thompson, GSFC, 21 July 1994
Version 1.1, William Thompson, GSFC, 22 August 1994
Changed definition of VDS_MAP.
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, William Thompson, GSFC, 24 October 1994
Change VDS_MAP to be zero for GIS data
Version 4, Liyun Wang, GSFC/ARC, November 4, 1994
CHK_V_RASTER is called to check the existence of the
given raster variation
Version 5, William Thompson, GSFC, 8 November 1994
Added keyword RASTER
Version 6, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 7, William Thompson, GSFC, 27 February 1995
Added check for valid COMP_ID.
Version 8, William Thompson, GSFC, 2 March 1995
Enforce uniqueness for RV_DESC.
Added keyword CHECK_ONLY.
Version 9, William Thompson, GSFC, 14 March 1995
Changed to use DBMATCH instead of DBFIND for RV_DESC.
Version 10, William Thompson, GSFC, 15 March 1995
Changed TEL_RATE to character
Version 11, Stein Vidar Haugan, UiO, 25 September 1995
Fixed bug with DBEXT always returning arrays.
Version 12, William Thompson, GSFC, 27 October 1995
Added item IEF_ID.
Version 13, William Thompson, GSFC, 11 December 1997
Removed TEL_RATE value check, to allow for additional
values besides L/M/H.
Version : Version 13, 11 December 1997
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_V_STUDY()
Purpose : Adds a study variation definition to the database
Explanation : This procedure takes the parameters that define a study
variation, and adds them to the databases "study_var" and
"study_var2". The study variation index number is assigned.
Use : Result = ADD_V_STUDY( DEF )
IF NOT ADD_V_STUDY( DEF ) THEN ...
Inputs : DEF = This is an anonymous structure containing the following
tags:
STUDY_ID = Study ID number. Must match an entry in
the fundamental study database.
TITLE_ID = Study title ID number. Must match an
entry in the study title database.
STUDYVAR = Study variation index. Initially, this
is zero. It is updated by this routine
to reflect the index in the database.
SV_DESC = A short description of the study
variation beyond what is given in the
associated fundamental study description.
Must be no more than 65 characters.
N_RASTERS0 = Fixed part of the number of rasters in
the study.
DURATION0 = Fixed part of the study duration, in
seconds.
DURATION1 = Number of seconds/raster for the variable
part of the study duration.
ZONE_ID = Pointing zone ID.
USABLE = Either "Y" or "N" to signal whether or
not the study is usable. Normally "Y".
RASTERS = A array listing the raster variations to
be used during the study.
The raster descriptions themselves are structures, of
type "cds_v_st_ras", with the following tags:
RAS_VAR = The raster variation index to be used
during the study. The index refers to
the corresponding raster ID in the
"study2" table.
N_REPEAT_R = Number of times to repeat this raster.
If N_RASTER_DEF in the corresponding fundamental study is
0, then the RASTERS tag can be omitted.
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
The tag STUDYVAR in the input structure is updated to reflect
the ID number assigned in the database.
Opt. Outputs: None.
Keywords :
ERRMSG = If defined and passed, then any error messages will be
returned to the user in this parameter rather than
depending on the MESSAGE routine in IDL. If no errors are
encountered, then a null string is returned. In order to
use this feature, ERRMSG must be defined first, e.g.
ERRMSG = ''
Result = ADD_V_STUDY( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
STUDY = If the definition matches one already in the database,
then this keyword returns a vector containing the STUDY_ID
and STUDYVAR of the match. Otherwise, it returns the
single value -1.
CHECK_ONLY= If this keyword is set, then the routine only checks to see
if the proposed entry is valid, but does not attempt to
place it in the database.
Calls : ***
CHK_V_STUDY, DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2]
DBBUILD [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBDELETE [1], DBDELETE [2]
DBDELETE [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4], DBFIND [1], DBFIND [2]
DBFIND [3], DBMATCH [1], DBMATCH [2], DBMATCH [3], DBOPEN [1], DBOPEN [2]
DBOPEN [3], DB_INFO [1], DB_INFO [2], DB_INFO [3], NUM2STR
CALLED BY:
IMPORT_PLAN, IMPORT_STUDY, MK_STUDY
Common : None.
Restrictions: Only this routine can be used to add study variation
definitions to the database. Modifying the database by hand
could corrupt its integrity.
The data types and sizes of the structure elements must match
the definitions in the database. The string lengths must not
exceed the lengths defined in the database.
!PRIV must be 2 or greater to use this routine.
Side effects: Once a study variation definition has been added to the
database, it must never be removed.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 29 April 1994
Modified : Version 1, William Thompson, GSFC, 3 May 1994
Version 2, Liyun Wang, GSFC/ARC, September 22, 1994
Added the keyword ERRMSG.
Version 3, Liyun Wang, GSFC/ARC, November 4, 1994
CHK_V_STUDY is called to check the existence of the
given study variation
Version 4, William Thompson, GSFC, 8 November 1994
Added keyword STUDY
Version 5, William Thompson, GSFC, 21 November 1994
Added items N_RASTERS0 and N_REPEAT_R
Changed RAS_VAR into a structure containing RAS_VAR and
N_REPEAT_R.
Version 6, William Thompson, GSFC, 29 December 1994
Fixed bug when inputs are bytes.
Version 7, William Thompson, GSFC, 2 March 1995
Enforce uniqueness for SV_DESC.
Added keyword CHECK_ONLY.
Version 8, William Thompson, GSFC, 14 March 1995
Use DBMATCH instead of DBFIND for SV_DESC
Check values of DURATION0 and DURATION1.
Version 9, William Thompson, GSFC, 29 March 1995
Added tag ZONE_ID
Version 10, William Thompson, GSFC, 12 May 1995
Modified to split off separate study_title database
Version 11, William Thompson, GSFC, 20 June 1995
Determines FLAGABLE parameter
Version 11, William Thompson, GSFC, 6 October 1995
Modified to allow for cases with N_RASTER_DEF=0.
Version 12, William Thompson, GSFC, 27 October 1995.
Removed tag flagable. Any study can produce a flag if
given an IEF_ID.
Version 13, William Thompson, GSFC, 26 February 1996
Removed requirements that DURATION0 and DURATION1 must
be positive. Negative values indicate that the
durations have been impirically determined.
Version : Version 13, 26 February 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_WAVE_EFF
Purpose : Adds an efficiency versus wavelength curve to database
Category : CDS, Calibration, Class3
Explanation : This routine adds an polynomial expression representing
efficiency as a function of wavelength to the database.
Syntax : ADD_WAVE_EFF, DATE_EFF, SPECTRUM, COEFF
Examples : ADD_WAVE_EFF, '1995/12/02', 'N2', [4.81,-0.0068]
Inputs : DATE_EFF = The date, and optionally time, that the curve
becomes effective. In other words, the calibration
curve should be applied to all science data taken on
or after that date. Can be in any CDS time format.
The current date is also stored along with the data.
When the database is read in, the most current
version for a given date is used.
For example, if there were two values of DATE_EFF in
the database,
DATE_EFF = 1995/12/02
DATE_EFF = 1996/09/16
then the first would be used for all data taken
between 1995/12/02 and 1996/09/16, and the second
would be used for all data from 1996/09/16 on. If
there was more than one entry in the database with
an effective date of 1996/09/16, then the most
recent one would be used.
There is one thing to watch out for in maintaining
the database. Taking the above example, if one
added a calibration with an effective date of
1996/05/01, then it would be applied to data between
that date and the next date in the database,
i.e. 1996/09/16. If one wanted the new calibration
to apply to all data after 1996/05/01, then one
would have to also add a new entry for 1996/09/16.
SPECTRUM = A character string representing the spectrum,
e.g. "N1" or "NIS1".
COEFF = The coefficients of a polynomial giving the relative
efficiency curve, expressed as a function of
wavelength. Can have up to 10 elements.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
ANYTIM2TAI, DBBUILD [1], DBBUILD [2], DBBUILD [3], DBCLOSE [1], DBCLOSE [2]
DBCLOSE [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], GET_UTC, PRIV_ZDBASE, UTC2TAI
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 16-Sep-1996, William Thompson, GSFC
Version 2, 21-May-2002, William Thompson, GSFC
Allow N4 for NIS-2 second order.
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : ADD_WAVECAL()
Purpose : Register wavelength calibrations in the database.
Category : Calibration, GIS, NIS, Wavelength
Explanation : Adds a wavelength calibration to the database. The calibration
is marked with the current date/time.
Syntax : Result = ADD_WAVECAL( DATE_EFF, DETECTOR, COEFF $
[, GSET_ID=GSET_ID ] )
CALLED BY:
MK_WAVECAL, mk_gset
Examples : IF NOT ADD_WAVECAL('1995-12-2','N',COEFF) THEN ...
Inputs : DATE_EFF = The date, and optionally time, that the value
becomes effective. In other words, the calibration
value should be applied to all science data taken on
or after that date. Can be in any CDS time format.
The current date is also stored along with the data.
When the database is read in, the most current
version for a given date is used.
For example, if there were two values of DATE_EFF in
the database,
DATE_EFF = 1995/12/02
DATE_EFF = 1996/09/16
then the first would be used for all data taken
between 1995/12/02 and 1996/09/16, and the second
would be used for all data from 1996/09/16 on. If
there was more than one entry in the database with
an effective date of 1996/09/16, then the most
recent one would be used.
There is one thing to watch out for in maintaining
the database. Taking the above example, if one
added a calibration with an effective date of
1996/05/01, then it would be applied to data between
that date and the next date in the database,
i.e. 1996/09/16. If one wanted the new calibration
to apply to all data after 1996/05/01, then one
would have to also add a new entry for 1996/09/16.
DETECTOR = Either "NIS" or "GIS" (can be abbreviated).
COEFF = The wavelength calibration coefficients. The
dimensions depend on the spectrometer used.
For the NIS spectrometer, the dimensions are (2,2,2)
with the following meanings:
Dim1 = NIS1 (0) or NIS2 (1)
Dim2 = Linear or quadratic coefficients
Dim3 = Coefficients are for wave->pix (0) or
for pix->wave (1)
For the GIS spectrometer, the dimensions are (4,3,2)
with the following meanings:
Dim1 = Detector number (0-3)
Dim2 = Quadratic coefficients
Dim3 = Coefficients are for wave->pix (0) or
for pix->wave (1)
Opt. Inputs : None.
Outputs : The result of the function is a logical value representing
whether or not the operation was successful, where 1 is
successful and 0 is unsuccessful.
Opt. Outputs: None.
Keywords : GSET_ID = The GIS Setup ID that the wavelength calibration
refers to. This is a required keyword for adding
GIS wavelength calibrations.
FILENAME = The name of the file that the calibration is based
on. If not passed, then the null string is used.
ERRMSG = If defined and passed, then any error messages will
be returned to the user in this parameter rather
than depending on the MESSAGE routine in IDL. If no
errors are encountered, then a null string is
returned. In order to use this feature, ERRMSG must
be defined first, e.g.
ERRMSG = ''
Result = ADD_WAVECAL( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2TAI, DATATYPE [1], DATATYPE [2], DATATYPE [3], DBBUILD [1], DBBUILD [2]
DBBUILD [3], DBCLOSE [1], DBCLOSE [2], DBCLOSE [3], DBOPEN [1], DBOPEN [2]
DBOPEN [3], GET_GSET, GET_UTC, PRIV_ZDBASE, TRIM, UTC2TAI
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 05-March-1996, William Thompson, GSFC
Version 2, 15-March-1996, CDP, RAL
Allow gset_id=0 input as a special case not
requiring corresponding entry in GSET database.
Version 3, 05-Jul-1996, William Thompson, GSFC
Change NIS coefficients to second order.
Version 4, 18-Apr-1997, William Thompson, GSFC
Added DATE_EFF parameter.
Corrected call to PRIV_ZDBASE.
Contact : WTHOMPSON
[Previous]
[Next]
Name:
ADDTIME
Purpose:
If optional keyword delta_min is supplied, then add a offset in
decimal minutes to an external time (H,M,S,MS,D,M,Y).
If optional keyword difference is supplied, return the difference
as Value = [A] - [B], where Value will be minutes (floating).
Inputs:
A = Base time, any format.
Calling Sequence:
Result = addtime(A,delta_min=delta_min) ; Result is [h,m,s,ms,d,m,y]
Result = addtime(A,difference=B) ; Result is minutes (float)
Outputs:
Function returns New time time, if delta_min keyword is provided.
Function returns difference of A-B, if B keyword is provied.
OPTIONAL INPUT KEYWORDS:
delta_min Decimal minutes (positive or negative) to add to A.
B 2nd time to subtract from A in any format.
CALLS: ***
Ex2Int [1], Ex2Int [2], Int2Ex [1], Int2Ex [2], anytim2ex [1], anytim2ex [2]
CALLED BY:
ACOPY [1], ANAL_BCS_PHA, ANAL_STIMS, BCS_SPMOVIE [1], BCS_SPMOVIE [2]
COVER_PAGE [1], COVER_PAGE [2], DR, DSN_DMP_FINDER, DSN_FINAL, FIND_CAL [1]
FIND_CAL [2], GET_TRANGE, MK_HXI_MAP, MK_ORB_WEEK, OBS_EVENT, OBS_PLOT
OP_ADD_SPECIAL, PLOT_HXT, SXT_POWL, Sxt_goes_teem, TRACE_SSWHERE [1]
UPDATE_SXT_CO_INDEX, WOBS_PLOT, XMOVIE_SFM, any_decay_time, any_fsp, anyrts
auto_bck_find, bck_interp, choose_interval, contact_sum, contacts [1]
contacts [2], copy_visible, diskbench, dsn_input, fidrange [1], fidrange [2]
fmt_pass, fmt_rasm, get_dn_rate [1], get_dn_rate [2], getm1ans
go_lasdisk golaserdisk, go_lasdisk2 golaserdisk, go_nvs5, goes_plot [1]
goes_plot [2], goes_plot [3], goes_plot [4], goes_plot [5], hxt_images2ps
hxt_utplot, interp_arr [1], interp_arr [2], interp_arr [3], last_lc, launch [1]
launch [2], make_32 [1], make_32 [2], mk_orbit_files, mk_orbit_sum, mult_th_fsp
op_bdr_opt, op_edit [1], op_edit [2], op_get_event [1], op_get_event [2]
op_pass_sheets [1], op_pass_sheets [2], op_saa_med [1], op_saa_med [2]
op_same_time [1], op_same_time [2], op_term_score, op_terminator [1]
op_terminator [2], op_time_sort, op_times, pass_sheets, plot_ar_pfi, plot_fov [1]
plot_nar [1], plot_nar [2], plot_ssw_fov, pr_maxmin_hk, rdtbl, run_dsnfil
save_event [1], save_event [2], sft_files, sgt_time, sxt_anycomp, sxt_dn_int
sxt_mwave, sxt_resp_inp, sxt_t6_resp0, tim2tfss, tim_bin, time_interp
trace_sswhere [2], trace_sswhere [3], trace_sswhere [4], valid_pass, valid_pass2
valid_pass3, valid_pass4 [1], valid_pass4 [2], ycopy, ydump
Procedure:
Calls ex2int and int2ex to do the calculations.
MODIFICATION HISTORY:
15-oct-91, Written, JRL
26-oct-91, Update, JRL - To handle hrs > 24 case
22-jun-92, Update, JRL - eliminate the 24:00 hour case
11-sep-92, Update, JRL - Call anytim2ex to convert input to external.
[Previous]
[Next]
NAME:
ADJHDR
PURPOSE:
Adjust size of a FITS header, if required.
CATEGORY:
File IO. FITS. Low Level.
CALLING SEQUENCE:
ADJHDR,HEADER,ROWNO
INPUTS:
HEADER, a FITS header.
ROWNO, current output row number.
KEYWORD PARAMETERS:
OUTPUTS:
HEADER, may have size increased or reduced by one FITS block.
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
Jul. 1992 I. Zayer LPARL, extended for flexibility in both directions
Oct. 1990 P. Milford Stanford University.
[Previous]
[Next]
NAME:
ADJUST_DATE_OBS
PURPOSE:
This function returns a structure of two string elements containing the
adjusted date-obs and time-obs for a given C1, C2, or C3 image header.
c2_time_offsets.dat file is used to get the time offset using first
value extend, interpolation, or last value extend. It then calculates
the corrected date-obs and time-obs and returns them.
CATEGORY:
LASCO DATA_ANAL
CALLING SEQUENCE:
adj = adjust_date_obs(hdr)
INPUTS:
hdr: A C1, C2, or C3 image header
OPTIONAL INPUTS:
verbose: print diagnostic messages.
adj = adjust_date_obs(hdr,/verbose)
OUTPUTS:
A two element structure of DATE and TIME containing the adjusted
DATE_OBS and TIME_OBS.
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], GET_OFFSET, LASCO_FITSHDR2STRUCT
STR2UTC [1], STR2UTC [2], STR2UTC [3], UTC2STR
Example:
hdr.DATE_OBS = '1998/01/01'
hdr.TIME_OBS = '00:10:11.181'
adj = adjust_date_obs(hdr)
adj.DATE = '1998/01/01'
adj.TIME = '00:13:06.590'
MODIFICATION HISTORY:
Written by: Ed Esfandiari, Feb 1999
7/24/00, nbr - Add SCCS version, reduce_history commmon block
11. 6.01, nbr - Use OPENR instead of OPENU
11.30.01, nbr - Change fnm for windows SSW compatibility
7. 5.02, nbr - Fix SCCS version syntax
09/22/05 Ed Esfandiari - Check hhdr and if time_obs='' assume level-1
file and do not adjust date_time (already adjusted).
@(#)adjust_date_obs.pro 1.8, 09/22/05 - NRL LASCO IDL LIBRARY
[Previous]
[Next]
Name:
ADJUST_HDR_TCR
Purpose:
To return an IDL structure containing corrected date-obs, sun-center, and roll-angle
for a input level 0.5 image header. These can then be used to adjust the level-1 image
headers in the level-1 processing.
Input Parameters:
HDR - A C1, C2, C3, or C4 (EIT) header. For C1 and C4, only the returned
date-obs is valid (roll is set to zero and center is not changed).
Output:
None
RETURN VALUE: - This function returns an IDL structure containing the following tags:
DATE: adjusted date-obs (string)
TIME: adjusted time-obs (string)
ERR : delta-erros from the time_correction routine (string)
XPOS: adjusted x-center (float)
YPOS: adjusted y-center (float)
ROLL: roll angle (float) degrees
Keywords:
VERBOSE - If set, print out information from various steps of the processing.
Calling Sequence:
adj = ADJUST_HDR_TCR(hdr,/verbose)
CALLS: ***
ADJUST_ALL_DATE_OBS, ANYTIM2UTC [1], ANYTIM2UTC [2], DATATYPE [1], DATATYPE [2]
DATATYPE [3], FILEPATH, FXADDPAR [1], FXADDPAR [2], LASCO_FITSHDR2STRUCT
LINEAR_INTERP, TAI2UTC, UTC2TAI
CALLED BY:
REDUCE_LEVEL_1
History:
2003 March 11 - Ed Esfandiari (first version).
2003 March 11, nbr - Add version info to header; change path derivation of data files
2004 April 1 , nbr - Adjust HISTORY kewyords for header
2004 July 17, nbr - good thru March 31, 2004
2004 Oct 4, nbr - good thru Aug 15, 2004
2004 Nov 24, AEE - read in last day from a .sav file instead of hard coded date.
2005 Jan 25, AEE - changed linterp call linear_interp.
version= '@(#)adjust_hdr_tcr.pro 1.6, 11/24/04 using: ' ; LASCO IDL Library (NRL)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
ADMIN()
PURPOSE:
returns administration counter
CATEGORY:
EXPLANATION:
SYNTAX:
Result = admin()
EXAMPLES:
INPUTS:
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 7, 1996, Dietmar Germerott, MAPE Lindau. Written
CONTACT:
Dietmar Germerott, MAPE Lindau (germerott@linax1.mpae.gwdg.de)
[Previous]
[Next]
NAME:
air2vac
PURPOSE:
Convert air wavelength to vacuum wavelength
CALLING SEQUENCE:
air2vac
INPUTS:
wa - air wavelength (Angstroms)
OPTIONAL INPUTS:
none
KEYWORD PARAMETERS:
none
OUTPUTS:
The value returned is the vacuum wavelength (in Angstroms)
corresponding to the input air wavelength.
OPTIONAL OUTPUTS
none
CALLS: ***
W_AIR2VAC
COMMON BLOCKS:
None
SIDE EFFECTS:
None
RESTRICTIONS:
Results are valid only between 2960 and 13000 Angstroms
PROCEDURE:
This procedure is the same algorithm used by Kurucz, et. al.
"Solar Flux Atlas From 296 to 1300 nm", National Solar
Observatory Atlas No. 1, June 1984.
MODIFICATION HISTORY:
Adapted from a FORTRAN program provided by R. Kurucz via
private communication. Adapted by Paul Reiser July 22, 1997.
[Previous]
[Next]
Project : SOHO - CDS
Name : Alice Breeveld
Purpose : Program to find out how long a raw file should be
to give statistics on a weak line, to a certain
level of accuracy.
Explanation : Assumes Poisson statistics
Use : For GIS raw data collection
Inputs : Count rate in weak line, Count rate in detector
Accuracy required
Opt. Inputs : 140 c/s maximum raw data rate
Outputs : Length of file in numbers of events or time
Opt. Outputs:
Keywords :
Calls :
Restrictions: None
Side effects: None
Category :
Prev. Hist. : None
Written : 26th September 1995
Modified : changed data rate collection time on 17/11/95
Version : 2
[Previous]
[Next]
NAME:
ALIGN1.PRO
PURPOSE:
Takes two images of EO frange, corrects it from the dark and
sums both, loading the result into X_display
CATEGORY:
??
CALLING SEQUENCE:
ALIGN1, nom_image1,nom_image2,nom_dark,imas,itest
INPUTS:
nom_image1 one of frange images
nom_image2 frange image in oposite side
nom_dark dark image name
itest 'V' or 'H' horizontal or vert alignement
KEYWORD PARAMETERS:
None
OUTPUTS:
imas resulting composite image
CALLS: ***
visu_cal
CALLED BY:
BUILD_FRAOE, REPLACIMA, STAT_CURSOR, WRITIMA, diafrai, dvpt_fra, gener_mask, ipolarfra
COMMON BLOCKS:
None.
SIDE EFFECTS:
None
RESTRICTIONS:
PROCEDURE:
Straightforward.
MODIFICATION HISTORY:
Written by A.LL v.1.0 LAS 08/25/93
[Previous]
[Next]
NAME:
ALL_NONOP_TEMPS
PURPOSE:
Reads in the SVM HK files, saved by DACS, and plots the non-
operational (S/C monitored) temperatures for LASCO, UVCS, MDI, CELIAS
CATEGORY:
PACKETS
CALLING SEQUENCE:
ALL_NONOP_TEMPS,Td
INPUTS:
Td: Date string in form YYMMDD
KEYWORD PARAMETERS:
LASCO: If present then the LASCO temperatures will be plotted
UVCS: If present then the UVCS temperatures will be plotted
MDI: If present then the MDI temperatures will be plotted
CELIAS: If present then the CELIAS temperatures will be plotted
ALL: If present then all 4 instrument temperatures will be plotted
PRINT: If present then the plot is sent to the printer
CALLS: ***
PLOT_CELIAS_NONOP, PLOT_MDI_NONOP, PLOT_NONOP, PLOT_UVCS_NONOP, READALLSV2
READALLSV4, ps_setup
MODIFICATION HISTORY:
Written by: RAH, NRL, Dec 1994
@(#)all_nonop_temps.pro 1.2 03/08/97 LASCO IDL LIBRARY
[Previous]
[Next]
Name: alphagen
Purpose: return array ['A', 'B', 'C'...] (sindgen with alpha)
Calling Sequence:
alpha=alphagen(10 [,/lower])
CALLED BY
where_title [1], where_title [2]
[Previous]
[Next]
Project : SOHO - CDS
Name : AN_NIMCP
Purpose : Analyze data from runs of NIMCP.
Category : Class3, CDS, Analysis, Calibration
Explanation : Reads in data from runs of NIMCP, and plots up a display
comparing the average profiles. The user can then zoom in on a
portion of the display and then fit gaussians to the data to
determine the amount of loss of sensitivity.
Includes associated routines AN_NIMCP_FUNCT and AN_NIMCP_FIT.
Syntax : AN_NIMCP, STUDY, RESULT
Examples : AN_NIMCP, 2775, RESULT
Inputs : STUDY = The study counter number for the run of NIMCP
Opt. Inputs : RESULT = The structure returned from an earlier run of this
routine.
Outputs : RESULT = Structure containing the average traces.
The parameters from the fits are also stored in a text file
with a name formed from the current study number,
e.g. "s2775_fits.txt".
Opt. Outputs: None.
Keywords : NOREAD = If set, then the FITS files are not read. In this
case, then RESULT must already be defined.
Calls : ***
AN_NIMCP_FIT, AN_NIMCP_FUNCT, AVERAGE, CURVEFIT, DATATYPE [1], DATATYPE [2]
DATATYPE [3], DETDATA, INTERPOL, NTRIM, PIX2WAVE, POLY_FIT, PS [1], PS [2], PSPLOT [1]
PSPLOT [2], READCDSFITS, SETVIEW [1], SETVIEW [2], TRIM, VDS_CALIB, VDS_DEBIAS
WAVE2PIX
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 21-May-1996, William Thompson, GSFC
Version 2, 09-Sep-1996, William Thompson, GSFC
Added printing and output options
Version 3, 25-Feb-1997, William Thompson, GSFC
Add /NOBURNIN to VDS_CALIB call
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : AN_NIMCP_1_2
Purpose : Analyze data from runs of NIMCP_1 and NIMCP_2
Category : Class3, CDS, Analysis, Calibration
Explanation : Reads in data from runs of NIMCP_1 and NIMCP_2, and plots up a
display comparing the average profiles. The user can then zoom
in on a portion of the display and then fit gaussians to the
data to determine the amount of loss of sensitivity.
This routine uses a cruder approach than that of AN_NIMCP, and
it's results are less accurate. In particular, it seems to
overestimate the amount of throughput loss.
Note that this routine is used for the older definitions of
NIMCP_1 and NIMCP_2 which were run as separate studies. The
modified NIMCP study should be analyzed with AN_NIMCP or
AN_NIMCP_AVG.
Syntax : AN_NIMCP_1_2, STUDY1, STUDY2, RESULT
Examples : AN_NIMCP_1_2, 122, 123, RESULT
Inputs : STUDY1 = The study counter number for the run of NIMCP_1. If
passed as an array, then the data from the specified
studies are averaged together.
STUDY2 = The study counter number for the run of NIMCP_2. If
passed as an array, then the data from the specified
studies are averaged together.
Opt. Inputs : RESULT = The structure returned from an earlier run of this
routine.
Outputs : RESULT = Structure containing the average traces.
Opt. Outputs: None.
Keywords : NOREAD = If set, then the FITS files are not read. In this
case, then RESULT must already be defined.
Calls : ***
AVERAGE, DETDATA, GAUSSFIT [1], GAUSSFIT [2], GAUSSFIT [3], GAUSSFIT [4]
GAUSSFIT [5], NTRIM, PIX2WAVE, PS [1], PS [2], PSPLOT [1], PSPLOT [2], READCDSFITS
SETVIEW [1], SETVIEW [2], TAI2UTC, TRIM, UTC2TAI, VDS_DEBIAS, WAVE2PIX
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 02-May-1996, William Thompson, GSFC
Version 2, 22-May-1996, William Thompson, GSFC
Added capability of averaging together several studies.
Incorporate gaussian fitting, as in AN_NIMCP_AVG.
Version 3, 12-Sep-1996, William Thompson, GSFC
Added printing and output options, better scaling
Don't call VDS_CALIB
Contact : WTHOMPSON
[Previous]
[Next]
Project : SOHO - CDS
Name : AN_NIMCP_AVG
Purpose : Analyze data from runs of NIMCP.
Category : Class3, CDS, Analysis, Calibration
Explanation : Reads in data from runs of NIMCP, and plots up a display
comparing the average profiles. The user can then zoom in on a
portion of the display and then fit gaussians to the data to
determine the amount of loss of sensitivity.
This routine uses a cruder approach than that of AN_NIMCP, and
it's results are less accurate. In particular, it seems to
overestimate the amount of throughput loss. However, it is
less dependent on the analyzed lines being isolated.
Syntax : AN_NIMCP_AVG, STUDY, RESULT
Examples : AN_NIMCP_AVG, 2775, RESULT
Inputs : STUDY = The study counter number for the run of NIMCP
Opt. Inputs : RESULT = The structure returned from an earlier run of this
routine.
Outputs : RESULT = Structure containing the average traces.
The parameters from the fits are also stored in a text file
with a name formed from the current study number,
e.g. "s2775_fits.txt".
Opt. Outputs: None.
Keywords : NOREAD = If set, then the FITS files are not read. In this
case, then RESULT must already be defined.
Calls : ***
AVERAGE, DATATYPE [1], DATATYPE [2], DATATYPE [3], DETDATA, GAUSSFIT [1]
GAUSSFIT [2], GAUSSFIT [3], GAUSSFIT [4], GAUSSFIT [5], NTRIM, PIX2WAVE, PS [1]
PS [2], PSPLOT [1], PSPLOT [2], READCDSFITS, SETVIEW [1], SETVIEW [2], TRIM, VDS_CALIB
VDS_DEBIAS, WAVE2PIX
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 22-May-1996, William Thompson, GSFC
Version 2, 09-Sep-1996, William Thompson, GSFC
Added printing and output options, better scaling
Version 3, 25-Feb-1997, William Thompson, GSFC
Add /NOBURNIN to VDS_CALIB call
Contact : WTHOMPSON
[Previous]
[Next]
NAME:
ANALYZE_IMG
PURPOSE:
This procedure reads the headers of raw *.img files and looks
for summing buffer usage and header only files. It will match the
headers and summing buffer files and write the fixed headers to
a specified directory
CATEGORY:
Reduction
CALLING SEQUENCE:
ANALYZE_IMG, Root_dir,Outdir,Udates,Error_flag
INPUTS:
Root_dir: Directory to search for input *.img files
Outdir: Directory to put output *.img files
KEYWORD PARAMETERS:
NOWRITE - Analyze only
OUTPUTS:
Udates: String array with Unique dates
Error_flag: Integer array with value for each datei
0 = OK 1 = possible error 2 = serious error
CALLS: ***
READ_EXT_HDR, READ_IP, UNIQ [1], UNIQ [2], UNIQ [3], sumbuffix
RESTRICTIONS:
PROCEDURE:
Read all the *.img files and analyze them to find the files from the
summing buffers and headers for summing buffer files. Match the
first header with the first file etc. for each summing buffer.
This works so long as the directory contains complete sets of
headers and files. The procedure also checks that the OS_NUM
aka CAMPAIGN_ID is the same header and file for each set. Normal
files (e.g. not from a summing buffer) should be ignored.
EXAMPLE:
ANALYZE_IMG,'/ql/raw','/ql/fixed',error_flag
MODIFICATION HISTORY:
Written by: Dennis Wang - 27 Jun 2000
14 Jul 2000 DW - Changed OS_num ranges, Read 200 bytes for header
08 Aug 2000 DW - Reduced error level of OS_NUM mismatch to possible
error rather than serious error
17 Oct 2000 DW - Added NOWRITE keyword and multiple date warning
17 Oct 2000 DW - Added day by day analysis
17 Dec 2001 NR - Moved 'CD, old_dir' out of FOR loop to end
@(#)analyze_img.pro 1.6, 12/17/01 - NRL LASCO IDL LIBRARY
[Previous]
[Next]
Project : SOHO - CDS
Name : ANYNAME2STD()
Purpose : Converts user format of line name to CDS standard.
Explanation : Spectral lines in the CDS software have an associated 'name'.
This name is also allocated to the data extraction window
derived from the line. For ease of use the internal format
used is of the form N_5_1234_5 ie the element, the ionization
level and the wavelength separated by underscores. (Note the
decimal point is replaced by an underscore also). Since users
may prefer to refer to the line by a name using another format
this routine is provided to try and translate between the two.
Use : IDL> std = anyname2std(element [, ion, wave, errmsg=errmsg])
Inputs : element - the two-letter element ID eg He, N, Ne
ion - the ionization stage (can be roman or arabic)
wave - the wavelength in Angstroms (will be truncated to
nearest 0.01A)
Note that various combinations of the above are possible.
If 3 parameters are supplied they will be interpreted as above.
If only 2 are given, the first will be assumed to contain
both the element and the ion, separated by spaces or under-
scores.
eg IDL> std = anyname2std('He II',301.1)
If only one (string) parameter is given, it will be assumed to
contain all three pieces of information.
eg IDL> std = anyname2std('He II 301.1')
If only one parameter is given but it is a 3-element array
this will be treated as if it were 3 separate parameters
(for compatibility with cds_sline)
Opt. Inputs : As above
Outputs : Function returns standard version of name or null string
if an error is detected.
Opt. Outputs: None
Keywords : errmsg - if this variable is defined on entry, any error
messages will be returned in it.
eg IDL> errmsg = ''
IDL> std = anyname2std('He II', errmsg=errmsg)
IDL> if errmsg ne '' then print,errmsg
----> 'Missing wavelength'
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], REM_MULT_CHAR, REPCHAR, STR_SEP
VALID_NUM [1], VALID_NUM [2], VALID_NUM [3]
CALLED BY:
TP_GWIN_LOGIC, TP_VWIN_LOGIC
Common : None
Restrictions: None
Side effects: None
Category : Util, string
Prev. Hist. : None
Written : C D Pike, RAL, 6-Mar-95
Modified : Add 3-element array input. CDP, 7-Mar-95
Rework wavelength format. CDP, 16-Mar-95
Version : Version 3, 16-Mar-95
[Previous]
[Next]
Name: anystr2tim
Purpose: convert various time strings to Yohkoh internal or External Format
History:
11-Mar-1994 (SLF) - vectorization of timstr2ex
CALLS: ***
TIMSTR2TIM, anytim2ints [1], anytim2ints [2], gt_day [1], gt_day [2], strsplit
Restrictions: proto for testing
[Previous]
[Next]
NAME:
anytim
PURPOSE:
Given a time in the form of a (1) structure, (2) 7-element time
representation, or (3) a string representation, or (4) an array
2xN where the first dimension holds (MSOD, DS79), or
(5) a double or float array of seconds from 1-jan-79
convert to any of the 5 representations including both varieties
of strings, dd-mon-yr or yy/mm/dd.
CALLING SEQUENCE:
xx = anytim(roadmap, out_styl='ints')
xx = anytim("12:33 5-Nov-91", out_sty='ex')
xx = anytim([0, 4000], out_style= 'sec')
INPUT:
item - The input time
Form can be (1) structure with a .time and .day
field, (2) the standard 7-element external representation
or (3) a string of the format "hh:mm dd-mmm-yy"
or (4) 2xN where the first dimension holds (MSOD, DS79), or
or (5) a double or float array of seconds from 1-jan-79
CALLS: ***
ATIME [1], ATIME [2], CHECKVAR [1], DATATYPE [1], DATATYPE [2], DATATYPE [3]
Int2Ex [1], Int2Ex [2], UTIME [1], UTIME [2], Utime2str [1], Utime2str [2]
anytim2ints [1], anytim2ints [2], checkvar [2], gt_day [1], gt_day [2]
gt_time [1], gt_time [2], int2sec [1], int2sec [2], timstr2ex [1], timstr2ex [2]
CALLED BY:
ALIGN1BIGGRAM, ANYTIM_REPORT, BATSE_FLARES_WEEK, BATSE_ON, BATSE_SPEC_GAIN_FDB
BATSE_TIME_INPUT, BCS, Build_Schedule, CALC_LOI_ROLL, CALIBRATE [1], CARR2DATE
CARR2EX, CH2KVT, CH2KVT_GAIN, CHECK_FOR_30S, CHECK_OVERFLOW, CHECK_SFC_PNT, CHKPOINT
CLEAN_GOES, CONT_EDGES, CONT_READ, CP_CATREAD, CP_CATRESET, CP_CATTIME
CREATE_GIF_HTML, CREATE_HTML, CRYSTAL_RES, Create_update_tar, DATETIME OBJECT
DATPLOT, DISCSP_BANDS, DISCSP_EDGES, DISCSP_READ, DISPLOI_MON5K, DO_EVENTLISTS
DO_QLARCHIVE, DROT_NAR, ECI2GEOGRAPHIC, ECL_FRAC, EIT_COPY, EUTPLOT, FDBREAD
FILT_EVENTS, FIND_DBFILE, FIND_GOOD_OCCS, FIND_PACKET
FITS WRITER CLASS FOR ANY RHESSI DATA TYPES, FITS_TIME, FLIST, FLISTOC
FORMAT_INTERVALS, FSOC, FSPLOT, FS_ACC_CONT, FS_ACC_DISCSP, FS_GEN_ARR, FS_GRAPH
FS_OPEN [1], FS_READ_DD, Fits_spectra [1], Fits_spectra [2], GAP_FILE, GAP_FINDER
GEOGRAPHIC2ECI, GETGPSaVG [1], GETGPSaVG [2], GETSATaVG, GET_BATSE_POINTING
GET_DISCSP511, GET_DROT_DUR, GET_FITS_TIME, GET_LAD_GAIN, GET_NAR, GET_OCCS
GET_OCC_ONDAY, GET_SLLD, GET_SPEC_CAL, GET_SPEC_GAIN, GFITS_R, GFITS_W
GOES_CHIANTI_TEM, GOES_FITS_FILES, GOES_MEWE_TEM, GOES_TEM, GOES_TF, GOES_TF_COEFF
GOES_TRANSFER, GOES__DEFINE, GRS_EXTRACT, GRWCH_ST, HESSI
HESSI CALIBRATED EVENTLIST CLASS DEFINITION [3]
HESSI FASTRATE CLASS DEFINITION, HESSI IMAGE FILE CLASS DEFINITION [1]
HESSI IMAGE RAW CLASS DEFINITION [2]
HESSI IMAGE STRATEGY CLASS DEFINITION
HESSI MONITOR RATE CLASS DEFINITION
HESSI MULTI IMAGE CLASS DEFINITION [2]
HESSI MULTI IMAGE CLASS DEFINITION [3], HESSI PACKET FILE ABSTRACT CLASS
HESSI ROLL_DB CLASS DEFINITION, HESSI SIMULATION CLASS DEFINITION
HESSI SOHDATA CLASS DEFINITION, HESSI Search Lookup Table Index
HESSI_REF_TIME, HSI_ANY2SCTIME, HSI_ANY_SOHDATA, HSI_ASPECT_SIM
HSI_BUILD_OBS_TIME, HSI_CLKDELTAFILETIME_2_UT, HSI_CLK_DELTA_WRITE
HSI_CLOCK_DRIFT, HSI_DO_QLOOK_PLOTS, HSI_EVENTLIST_TEST, HSI_FITS2MAP [1]
HSI_GET_CLOCK_SYNCH, HSI_GET_TIMEBIN, HSI_IMAGE_TEST [2]
HSI_IMAGE_TEST__define, HSI_LOCATE_FLARE [2], HSI_LOCATE_FLARE [4]
HSI_MAP_EVALUATOR [1], HSI_MODEL_TO_SCORE, HSI_NOSAAN, HSI_NPAK_HISTOGRAM
HSI_ORBFILETIME_2_UT, HSI_PACKET2FITS, HSI_PAK2FILETIMES, HSI_QLOOK_ASPECT
HSI_QLOOK_SUMMARY_PAGE__DEFINE, HSI_RD_FITS_SPECTRUM, HSI_REF_TIME
HSI_SCORE2FILE, HSI_SCTIME2ANY, HSI_SEQ_CNT_CHECK, HSI_SET_FILE_TIME
HSI_SMEXHDR_RCVD_TIME, HSI_SPECTROGRAMCHAN_OVERLAP_FIX
HSI_SPECTROGRAM_DECIM_CORRECT, HSI_SPECTROGRAM_DECIM_TABLE
HSI_SPECTRUM__DEFINE, HSI_SRM__DEFINE, HSI_SSR_FILL_PER_ORBIT [2]
HSI_TIME_N_ORBITS, HSI_TOHBAN_FLARE_COUNTER, HSI_UT_2_CLKDELTAFILETIME
HSI_VCFILE_PACKET_RATE, HSI_VCFILE_TIMES, HSI_WRITE_LEVEL0, HSI_tplot2any
HXARCHIVE, HXFITS, HXR2FILE, HXRBS, HXRBS_ESC, HXRFITS_ARCHIVE, HXRFITS_HEAD
HXRS__DEFINE, HXT_CAL_FIX [1], HXT_CAL_FIX [2], Hessi_obs_summary
Hsi_contact2fits [1], Hsi_contact2fits [2], Hsi_daily_catalog [1]
Hsi_daily_catalog [2], Hsi_monitor_rate_read, LAY1GKM, LONLAT2XY, Load_sher
MAKE_SOLCALTRAJ, MDI__DEFINE, MERGE_DISCSP_HKG_OCC, MJD2ANY, MK_MER_CONT
NAR2COORD, NEAREST_GEV, NEAR_CONJ, NORH_F2EVF [1], NORH_F2EVF [2], NORH_FIXINDEX
NORH_IMG2IDX [1], NORH_IMG2IDX [2], NORH_JST2UT [1], NORH_JST2UT [2], NORH_MKSZ
NORH_PR_EVX [1], NORH_PR_EVX [2], NORH_PR_INFO [1], NORH_PR_INFO [2]
NORH_RD_TCX [1], NORH_RD_TCX [2], NORH_RD_TSX [1], NORH_RD_TSX [2]
NORH_SEL_DIFF [1], NORH_SEL_DIFF [2], NORH_SYNTH_BYF [1], NORH_SYNTH_BYF [2]
NORH_TCX2IDX [1], NORH_TCX2IDX [2], NORH_TIM2F [1], NORH_TIM2F [2]
NORH_TRANS_BYF [1], NORH_TRANS_BYF [2], NORH_UT2JST [1], NORH_UT2JST [2]
NORP_CLB_INTEG, NORP_CLB_SN, NORP_GT_NDATA, NORP_NCLB_TIME, NORP_RDT2DATA_17G
NORP_RDT2DATA_1G, NORP_RDT2DATA_2G, NORP_RDT2DATA_35G, NORP_RDT2DATA_4G
NORP_RDT2DATA_80G, NORP_RDT2DATA_9G, NORP_RDT2TIMEJ [1], NORP_RDT2TIMEJ [2]
NORP_RD_AVG [1], NORP_RD_AVG [2], NORP_RD_DAILY [1], NORP_RD_DAILY [2]
NORP_RD_DAT, NORP_RD_RDT, OCC_DBASE, ORBIT_DN, ORBIT_INPUT_TIME, PARSE_ATIME [1]
PARSE_GROSSC_ATTITUDE, PLOTBATSE, PLOTBATSE_QL, PLOT_HSI, PLOT_MAP, PLOT_OCCS
PLOT_OCC_ONDAY, PROFILES2, PR_PATROLS, PURGE_KAPS, Pointing_Change, QL_DAY_PLOT
QL_ORBIT_PLOT, QL_PLOTTER, QL_READBDB, RD_GOES, RD_GOES_SDAC, RD_NEAR_PIN [1]
RD_NEAR_PIN [2], READCOL [3], READQUAL, READ_CONT, READ_DISCLA, READ_HXRS_FITS [1]
READ_HXRS_FITS [2], READ_HXRS_FITS [3], READ_MINICAT, READ_MONTH_CAT
READ_OCC_DISCSP, RESTORE_QLOOK, ROLL_PLOT, Radio Spectrogram FITS File reader
Radiospectrogram FITS File reader [1]
Radiospectrogram FITS File reader [2], SET_UTAXIS, SITE__DEFINE
SOLB_PLOT_POINTING [1], SOLB_PLOT_POINTING [2], SOLB_READ_REPOINT [1]
SOLB_READ_REPOINT [2], SOLB_SPACECRAFT_POINTING [1]
SOLB_SPACECRAFT_POINTING [2], SOLEPHUT, SPARTAN_PLANNER, SPECPLOT__DEFINE
SPECTRA2FITS, SPECTROGRAM CLASS DEFINITION, SPECTRUM CLASS DEFINITION
SPEX_COMMONS [2], SPEX_COMMONS [4], SPEX_DATA_GENX [1], SPEX_DATA_GENX [2]
SPEX_DRM__DEFINE, SPEX_FITINT__DEFINE, SPEX_GEN__DEFINE, SPEX_PROC [1]
SPEX_PROC [2], SPEX_SAVE [1], SPEX_SAVE [2], SPEX__DEFINE, STEREO_SIMUL
SXT_BAKEOUT_IN, SXT_COVERAGE, SXT_ECLIPSE, SXT_EXPOSURE_MAP, Shers_load [1]
TEMP_BCK_TIME_INTV, TEST_CAL, TIM2CARR, TIMESTAMP, TIME_AXIS__DEFINE, TIME_F_NAME
TJD2YMD, TOK_RD_DAILY, TRACE_ALIGN_CUBE, TRACE_COPY, TRACE_CUBE_POINTING
TRACE_GBO, TRACE_MDI_ALIGN, TRACE_SSWHERE [1], TV_SYNOP, TWIDGET, TYKW_RDT2TIMEJ
TYKW_RD_DAILY, TYKW_RD_DAT, UNFORMAT_INTERVALS, UPDATE_HTML, UTIME [1], UTIME [2]
UTPLOT_IMAGE, UTPLOT__DEFINE, UT_2_YYDOY [1], VIEW_TRACE_MOSAIC, WRITE_MONTH_CAT
XSM_VALID, XYPLOT__DEFINE, YMD2TJD, YOHKOH_TERM_PREDICT, ZDEROTATE, ZHDRUNIT
accum_counts [1], accum_counts [2], anahead2struct, anytim2weekinfo
auto_bck_find0, avsig_1 [1], avsig_1 [4], avsig_1 [6], avsig_temp
batse_create_html, batse_sea_html, check_cals, cp_catwidget, cw_ut_range
data2files, days_til_next_solar_max, db_gbo, decode_gev, default_rate_header
difference_movie, disp_sci160k [1], disp_sci160k [2], doytim2ints
drm_4_spex [1], drm_4_spex [2], eit_fulldisk, eit_proton_summary, evt_grid
find_uvexp, fix_decon_pits, fixinate_trace, flare_hist, get_acedata
get_epoch_sfcs [1], get_epoch_sfcs [2], get_gevloc_data, get_goes_defsat [1]
get_goes_defsat [2], get_infox, get_solar_indices, get_utevent [1]
get_utevent [2], get_utrange, go_sxt_sss2secondary, go_yo_prod_batch
goes_plot [1], goes_plot [2], goes_plot [3], goes_plot [4], goes_plot [5]
grid_data [1], grid_data [2], gtab_summary, gtt_orbit, has_overlap [1]
has_overlap [2], hsi_1orbit_allpak, hsi_anytim_2_filename, hsi_as_sim
hsi_as_sim_packet, hsi_aspect [1], hsi_aspect [2], hsi_ast_seesource_time
hsi_ast_sourceangle, hsi_atten_state, hsi_bad_pak, hsi_badpak_test
hsi_bproj2size, hsi_chk_obj, hsi_cld_sav_init, hsi_clk_delta_calc
hsi_clock_drift_dxdt, hsi_clock_drift_redo, hsi_clock_drift_soc
hsi_create_filedb, hsi_cw_ut_range, hsi_data_recovery_fraction
hsi_decimation_anomaly, hsi_default_resolutions, hsi_default_tailfracs
hsi_demodulator [1], hsi_do_qlook_image [1], hsi_do_qlook_image [2]
hsi_earthangle, hsi_endfileinfo_fill, hsi_ephemeris__define
hsi_ephemeris_concat, hsi_ephemeris_fill, hsi_filedb__define [1]
hsi_filedb__define [2], hsi_filedb_filename, hsi_filedb_read [1]
hsi_filedb_read [2], hsi_filedb_write, hsi_filedb_write_ascii
hsi_filename_2_anytim, hsi_fits_header, hsi_flare2time, hsi_flare_flag
hsi_flare_id_assign, hsi_flare_id_check, hsi_flare_in_int, hsi_flare_list2ar
hsi_flare_list2goes [1], hsi_flare_list2goes [2], hsi_flare_list__define [1]
hsi_flare_list__define [2], hsi_flare_list_fill [1], hsi_flare_list_fill [2]
hsi_flare_position_image [1], hsi_flare_position_image [2], hsi_format_flare
hsi_full_sun_image [1], hsi_full_sun_image [2], hsi_gbo, hsi_get_e_edges [1]
hsi_get_orbit_info, hsi_get_total_time, hsi_getflare, hsi_image__getaxis [2]
hsi_image_plot, hsi_image_raw__define, hsi_imagefile_2_plotman
hsi_lambda_vs_t, hsi_last_id_write filename last_id, hsi_locate_flare [1]
hsi_locate_flare [3], hsi_mod_variance__define, hsi_mod_variance_concat
hsi_monthly_filename, hsi_mult_filedb_otp, hsi_mult_flare_list_inp
hsi_mult_qspec, hsi_new_spec_bck, hsi_night_bck, hsi_obs_flag
hsi_obs_summ_allrates [1], hsi_obs_summ_concat, hsi_obs_summ_fill [1]
hsi_obs_summ_fill [2], hsi_obs_summ_flag__define, hsi_obs_summ_flag_concat
hsi_obs_summ_otp, hsi_obs_summ_rate__define, hsi_obs_summ_rate_concat
hsi_obs_summ_soc__define, hsi_obs_summ_soc_concat, hsi_obs_summ_timarr
hsi_obs_summ_write, hsi_obs_summary__define [1], hsi_obs_summary__define [2]
hsi_obs_summary_adapter__define, hsi_obs_summary_concat, hsi_obs_times
hsi_ok_intv [1], hsi_ok_intv [2], hsi_onedatagap__define, hsi_orbpar4bck
hsi_params2script, hsi_particle_rate__define, hsi_particle_rate_concat
hsi_plot_flux, hsi_pmtras_lookup, hsi_print_decimation_state
hsi_qlook__define, hsi_qlook_call_ospex [1], hsi_qlook_call_ospex [2]
hsi_qlook_concat, hsi_qlook_image, hsi_qlook_monitor_rate__define
hsi_qlook_packet_rate__define, hsi_qlook_pointing__define
hsi_qlook_rate_per_det__define, hsi_qlook_roll_angle__define
hsi_qlook_roll_period__define, hsi_qlook_spectrum
hsi_qlook_spin_axis__define, hsi_qspec [1], hsi_qspec [2], hsi_rd_ephfile
hsi_rd_orbit_files, hsi_rdstatevectorfile, hsi_read_all_flare_list
hsi_read_vcfiletimes, hsi_replace_flare_list, hsi_select_flare
hsi_show_flags [2], hsi_show_flare_on_image, hsi_sim_pflux_2_cflux
hsi_spectrogramACCBIN [2], hsi_spectrogram__define [1]
hsi_spectrogram__define [2], hsi_spectrogram__define [3]
hsi_spectrogram__get_obs [1], hsi_spectrogram__livetime [1]
hsi_spectrum__filewrite, hsi_spectrum__fitswrite, hsi_ssr_fill_per_orbit [1]
hsi_state_vectors, hsi_test_files, hsi_test_packet_rate, hsi_test_qlook
hsi_time_widget, hsi_ui_flarecat, hsi_ui_img, hsi_ui_img_doimage [1]
hsi_ui_img_doimage [2], hsi_ui_lc, hsi_ui_obs, hsi_ui_qlimage, hsi_ui_spec
hsi_vcfile_gaps, hsi_vis_fwdfit, hsi_whichflare, hsi_whole_flare_list
hsi_write_all_flare_list, hsi_write_decimation_settings
hsi_write_txt_flare_list, hsi_xy_test [1], hsi_xy_test [2], hsi_xy_test_new
hxrbs_response, hxrs_drm2fits [1], hxrs_drm2fits [2], hxrs_drm2fits [3]
image2movie, imspec [10], imspec [11], imspec [12], imspec [13], imspec [14]
imspec [15], imspec [16], imspec [17], imspec [18], imspec [19], imspec [1]
imspec [20], imspec [21], imspec [22], imspec [23], imspec [24], imspec [25]
imspec [26], imspec [27], imspec [28], imspec [29], imspec [2], imspec [30]
imspec [31], imspec [32], imspec [33], imspec [34], imspec [35], imspec [36]
imspec [3], imspec [4], imspec [5], imspec [6], imspec [7], imspec [8], imspec [9]
index2fov, kluge_att, lasco_time2file, lasco_time2nrlwww, lastgki, later, lcur_image
les_archive_info, make_goes_chianti_response [1]
make_goes_chianti_response [2], make_goes_chianti_response [3]
make_goes_chianti_response [4], make_grid_sphere, map2index, mark_intervals
may_eclipse, mdi_time2file, mees_log_read, mees_name_format, mk_mdi_fits
mk_sff_pair [1], mk_sff_pair [2], mk_ssc [1], mk_ssc [2], mk_ssc_batch [1]
mk_ssc_batch [2], mk_sumer_dbase_ff, mk_synsfc_coeff [1], mk_synsfc_coeff [2]
mksort, mon_sci5k, mrdfits_spectra, norh_alpha, norh_t2azel, op_term_score
option_changer [1], option_changer [2], parse_atime [2], pctime2ssw
phoenix_filedb_get, phoenix_spg_get, plot_ace, plot_fov [1], plot_goes_ospex
plotman, plotman_draw_event, plotman_setaxes, plotman_zoom, pmtras_analysis
pr_his_index [1], pr_his_index [2], pr_his_index [3], ptim, rapp_get_spectrogram
rd_goesp_ascii, rd_goesx_ascii, rd_mdi [1], rd_mdi [2], rd_sxs_pha [1]
rd_sxs_pha [2], rd_therm_rs232, rd_wbs_pha [1], rd_wbs_pha [2], rdbda_smm
read_eit, read_genxcat, read_hessi_4_ospex, read_hessi_4_spex [1]
read_hessi_4_spex [2], read_hessi_fits_4_spex [1]
read_hessi_fits_4_spex [2], read_lapalma, read_mdi, read_soxs_4_ospex
read_trace, read_xsm_4_ospex, read_yohkoh_4_spex [1], read_yohkoh_4_spex [2]
redo_disploi, redo_mon_sci5k, rhessi_get_spin_axis_position, save_idl_routines
sec_name_format, soxs_readfile, special_movie, spectro_plot2
spectrogram__define, spex_bk__define, spex_bkint__define, spex_bksub__define
spex_data__define, spex_evnt [1], spex_evnt [2], spex_hessi_image__define
spex_image__define, ssc_files [1], ssc_files [2], ssc_files [3], ssw_build_trace
ssw_composite, ssw_deltat, ssw_expand_times, ssw_flare_locator, ssw_fov_context
ssw_fs_cat2db, ssw_getcme_cactus, ssw_getcme_cdaw, ssw_getdst
ssw_gxd_remove_flares, ssw_javamovie, ssw_nar2armurl, ssw_pos2zenith
ssw_sec_aktxt2struct, ssw_time2filelist, ssw_time2paths, ssw_timestat
ssw_track_fov, sswdb_files, sswstruct_fill [1], stt_plot, sxi_files, sxt_files
sxt_his2dbase, sxt_is_synsfc, sxt_mk3 mk3 index data [1]
sxt_mk3 mk3 index data [2], sxt_orhis, sxt_prep [1], sxt_prep [2], sxt_prep [3]
sxt_ssn2fits [1], sxt_uvf_info [1], sxt_uvf_info [3], t_utplot [1], t_utplot [2]
time_at_meridian, time_window, timegrid, tr_lut_conv, tr_rd_index
tr_wrt_fits_i1 [2], trace_cosmic2hist_accum, trace_files, trace_get_vignette
trace_goodobs, trace_movie_index [1], trace_movie_index [2]
trace_recent_movie_summary, trace_sswhere [2], trace_sswhere [3]
trace_sswhere [4], trace_wave2point, ut_2_yydoy [2], ut_label, valid_time_range
wbs_response [1], wbs_response [2], week_loop [1], week_loop [2], week_loop [3]
weeks_in_year [1], weeks_in_year [2], where_are [1], where_are [2]
which_hessi_version, write_genxcat, xy2lonlat, xzchange, yo_index2path
yoh_orb_interp [1], yoh_orb_interp [2], yohkoh_files, yohkoh_legacy_files [1]
yohkoh_legacy_files [2], zcheck_hdr, zmovify, ztrack
OPTIONAL KEYWORD INPUT:
out_style - Output representation, specified by a string:
INTS - structure with [msod, ds79]
STC - same as INTS
2XN - longword array [msod,ds79] X N
EX - 7 element external representation (hh,mm,ss,msec,dd,mm,yy)
UTIME - Utime format, Real*8 seconds since 1-jan-79, DEFAULT!!!!
SEC - same as Utime format
SECONDS - same as Utime format
ATIME - Variable Atime format, Yohkoh
Yohkoh style - 'dd-mon-yy hh:mm:ss.xxx' or
HXRBS pub style - 'yy/mm/dd, hh:mm:ss.xxx'
depending on atime_format set by
hxrbs_format or yohkoh_format
YOHKOH - yohkoh style string
HXRBS - HXRBS Atime format /pub, 'yy/mm/dd, hh:mm:ss.xxx'
YY/MM/DD- same as HXRBS
or by keywords
/ints -
/stc
/_2xn
/external
/utime
/seconds
/atimes
/yohkoh
/hxrbs
/yymmdd
mdy - If set, use the MM/DD/YY order for converting the string date
date - return only the calendar date portion,
e.g. anytime('93/6/1, 20:00:00',/date,/hxrbs) ==> '93/06/01'
time - return only the time of day portion
e.g. anytime('93/6/1, 20:00:00',/date,/hxrbs) ==> '20:00:00.000'
keyword output:
error - set if an error, dummy for now, ras 18-Nov-93
restrictions:
one dimensional or scalar longwords will be interpreted as
double precision seconds unless they have either two or seven
elements
HISTORY:
Written 31-Oct-93 ras
modified 4-jan-94 ras, made argument recognition more robust
also made output dimensions similar for /yohkoh and /hxrbs
modified 25-jan-94 ras, made SEC or SECONDS work
ras 30-jan-94, fixed string outputs for /date and /time
[Previous]
[Next]
NAME:
anytim2doy
PURPOSE:
Given a time in the form of a (1) structure, (2) 7-element time
representation, or (3) a string representation,
return the day of the year for that day
CALLING SEQUENCE:
xx = anytim2doy(roadmap)
xx = anytim2doy('12:33 5-Nov-91')
INPUT:
tim_in - The input time
Form can be (1) structure with a .time and .day
field, (2) the standard 7-element external representation
or (3) a string of the format "hh:mm dd-mmm-yy"
OPTIONAL KEYWORD OUTPUT:
year - The year for the time(s) passed in
CALLS: ***
anytim2ex [1], anytim2ex [2], anytim2ints [1], anytim2ints [2]
CALLED BY:
auto_toban, mees_name_format, mk_bad_pix_map_load, mk_daily_ints, mk_nar [1]
mk_nar [2], sec_name_format, timeline, topsdb [1], topsdb [2], web_seq
HISTORY:
Written 7-Jun-92 by M.Morrison
11-Jan-94 (MDM) - Updated the header information
[Previous]
[Next]
NAME:
anytim2ex
PURPOSE:
Given a time in the form of a (1) structure, (2) 7-element time
representation, or (3) a string representation, or (4) an array
2xN where the first dimension holds (MSOD, DS79)
convert to the 7-element time representation (hh,mm,ss,msec,dd,mm,yy)
CALLING SEQUENCE:
xx = anytim2ex(roadmap)
xx = anytim2ex('12:33 5-Nov-91')
xx = anytim2ex([0, 4000])
INPUT:
tim_in - The input time
Form can be (1) structure with a .time and .day
field, (2) the standard 7-element external representation
or (3) a string of the format "hh:mm dd-mmm-yy"
CALLS: ***
Int2Ex [1], Int2Ex [2], gt_day [1], gt_day [2], gt_time [1], gt_time [2]
timstr2ex [1], timstr2ex [2]
CALLED BY:
ACOPY [1], ADDTIME [1], ADDTIME [2], ALIGN_AR, ANAL_BCS_PHA, BCS_ADDGOES
BCS_BROWSE24, BCS_LOAD_CAT, BCS_SPMOVIE [1], BCS_SPMOVIE [2], BUILD_SSX, CARR2EX
CV_BSC2BSD, DISK_SUMMARY, DISPLOI_MON5K, DR, DSN_DMP_FINDER, DSN_FINAL, EUTPLOT
GBO_HEL, GET_FRAME_TIME, GET_SID, GET_SUBARR2, GET_TRACUBE, GET_TRANGE
GO_DSN_FINAL [1], GO_DSN_FINAL [2], G_H, HXTPIXON, HXT_QLOOK, JD2EX, MK_BSC [1]
MK_BSC [2], MK_ORB_WEEK, OBS_PLOT, OP_ADD_SPECIAL, OUTPLOT [1], OUTPLOT [2]
OUTPLOT [3], OUT_GRSPHL1, OUT_GRSPHL2, OUT_HXSPH, PRINT_OP, RD_AR, READ_SPFDGRS
READ_SPFDHXS, SEL_AR, TIM2JD [1], TIM2JD [2], TV_SSX, UPDATE_SXT_CO_INDEX
UPDATE_TERM, UTPLOT [1], UTPLOT [2], UTPLOT [3], UTPLOT [4], UTPLOT [5], WBDA [1]
WBDA [2], WBS_DB2, WOBS_PLOT, any_decay_time, any_fsp, anyrts, anytim2dd79
anytim2doy [1], anytim2doy [2], anytim2weekid [1], anytim2weekid [2]
anytim2weeks [1], anytim2weeks [2], ar_prep, auto_bck_find, auto_toban
bbso_copy [1], bbso_copy [2], bbso_name_fix, cam_run_sum, cancel_dsn_fil
cfl_summary [1], cfl_summary [2], check_compile [1], check_compile [2]
check_dumps [1], check_sci5k_trunc, chk_flares [1], chk_flares [2], contacts [1]
contacts [2], daily_forecast [2], days_2_xmas, disp_sci5k, disp_therm_rs232
do_reg_backup, doy2ex [1], doy2ex [2], dsn_input, event_movie [1], event_movie [2]
file_info2 [1], file_info2 [2], fits2time [1], fits2time [2], fits2time [3]
fits_disp_month [1], fits_disp_month [2], gbo_pfi, get1hk_info [1]
get1hk_info [2], get_gbo_pfi, get_hk_info [1], get_hk_info [2], get_mk3 [1]
get_mk3 [2], get_sfm, get_sirius_yr, get_sunset, getm1ans, go_lasdisk golaserdisk
go_lasdisk2 golaserdisk, go_nvs5, goes3sec_copy, goes_teem, goesem_eqn [1]
goest_eqn [1], grs32_fsp, grsl_fsp, gtab_file, hxi_interp, hxs_fsp, hxsgrs_fsp
hxt_fsp, hxt_fsp1, hxt_sources, hxtimg_accum, interp_arr [1], interp_arr [2]
interp_arr [3], interp_img, ip_que_dmpver, jitter_gif_xyimg, kp_name_fix
ksc_commands, last_lc, laststat [1], laststat [2], launch [1], launch [2], mk_aoslos
mk_bad_pix_map_load, mk_daily_ints, mk_gbl, mk_gev [1], mk_gev [2], mk_gsn_obs
mk_gsn_obs_s1, mk_gx, mk_hst_summary, mk_imgsum_html, mk_lasteit_movie
mk_mdi_fits, mk_mdi_iap, mk_op_file, mk_orbit_files, mk_pnt, mk_ptv_title, mk_sd2
mk_sdc [2], mk_sdc [3], mk_sdc [4], mk_sdl, mk_sfc [1], mk_sfc [2], mk_sl [1]
mk_sl [2], mk_sot, mk_ssl, mk_trace_i1, mk_week_file [1], mk_week_file [2]
monthly_summary, mplot_nar, mult_th_fsp, mwlt_select, new_disp_sci5k [1]
new_disp_sci5k [2], nob_img_copy, nob_name_fix, norik_name_fix, op_facom_ftp
op_get_special, plot_ar_pfi, plot_nar [1], plot_nar [2], plot_ref, plot_trav [1]
plot_trav [2], plot_trav [3], pr_evn [2], pr_nar, pr_trav_summ, pref_super
print_ogsel, rd_gbl_raw [1], rd_gbl_raw [2], rd_goes_fits, rd_lonlat, rd_sci5k
rd_so_at_ftr, rd_therm_rs232, rd_week_file [1], rd_week_file [2]
rd_week_file [3], rd_week_file [4], redo_disploi, redo_mon_sci5k, reslot, sda2fits
selsis_copy [1], selsis_copy [2], seq_run_sum [1], seq_run_sum [2], sft2sfc
soon2fits, sxt2file, sxt2mpeg, sxt_interp [1], sxt_interp [2], sxthxt_fsp, sxtth_hxt
syst2ex [1], syst2ex [2], syst2ex [3], term_times, time_2_fileid, timeline
topsdb [1], topsdb [2], tr_reformat, unixtime2ex, ut_time [1], ut_time [2], web_seq
week2ex [1], week2ex [2], weekid [2], weekid2ex [1], weekid2ex [2], weekid2ex [3]
wfile, xdisp_fits, xdisp_trace [1], xdisp_trace2, xdisp_trace3, xhkplot, xread_hist
xset_chain [1], xset_chain [2], xwrite_hist, ycopy, ydb_exist [2], ydump
OPTIONAL KEYWORD INPUT:
mdy - If set, use the MM/DD/YY order for converting the string date
HISTORY:
Written 15-Nov-91 by M.Morrison
5-Jan-93 (MDM) - Added /MDY option for TIMSTR2EX
11-Jan-93 (MDM) - Updated document header
[Previous]
[Next]
NAME:
anytim2ints
PURPOSE:
Given a time in the form of a (1) structure, (2) 7-element time
representation, or (3) a string representation, or (4) an array
2xN where the first dimension holds (MSOD, DS79)
convert to the a simple structure with .TIME and .DAY
CALLING SEQUENCE:
xx = anytim2ints(roadmap)
xx = anytim2ints('1-sep-91', off=findgen(1000)*86400)
xx = anytim2ints('12:33 5-Nov-91')
xx = anytim2ints([0, 4000])
INPUT:
tim_in - The input time
Form can be (1) structure with a .time and .day
field, (2) the standard 7-element external representation
or (3) a string of the format "hh:mm dd-mmm-yy"
CALLS: ***
CHECK_TIME, Ex2Int [1], Ex2Int [2], gt_day [1], gt_day [2], gt_time [1], gt_time [2]
timstr2ex [1], timstr2ex [2]
CALLED BY:
ANAL_BCS_PHA, ANAL_STIMS, ANYTIM2MSV, Alt_tim_sel, BCS_24HR_PLOT [1]
BCS_24HR_PLOT [3], BCS_CONT [1], BCS_CONT [2], BCS_SPMOVIE [1], BCS_SPMOVIE [2]
BCS_TVEC, BSC_TIM2DSET, BUILD_SSX, CARR2EX, CCCA, CONV_A2H [1], CONV_A2H [2]
CONV_H2A [1], CONV_H2A [2], CONV_LP2INDEX, CV_BSC2BSD, DISPLOI_MON5K, DO_TEEM
DSN_DMP_FINDER, FE25_BSC_TEMP, FIRST_LIGHT [1], FIRST_LIGHT [2], FITIM2INTS
FITS_TIME, GET_FRAME_TIME, GET_LATLON, GET_SUBARR2, GET_SUNCENTER [1]
GET_SUNCENTER [2], GET_TIME_LAPSE, GET_TRACUBE, GOES2DPE, GOES_TEK [1]
GOES_TEK [2], GOES_TODAY, GT_BSC_TIME, Goes_bck0, HELIOCENTRIC, HXASCAN2HXAXY
HXTIMG2INTS, HXTPIXON, HXT_FLARE_POS, HXT_IMAGE_TIME, HXT_LCURVE, HXT_QLOOK
HXT_TIME2FRAME, IRUHXA2SXT, IRUHXASCAN2SXT [1], IRUHXASCAN2SXT [2], JD2EX
MAKE_VTRANGE, MK_ORB_WEEK, MSV2INTS, NORH_IMG2IDX [1], NORH_IMG2IDX [2]
NORH_JST2UT [1], NORH_JST2UT [2], NORH_PR_EVX [1], NORH_PR_EVX [2]
NORH_TCX2IDX [1], NORH_TCX2IDX [2], NORH_TSX2IDX [1], NORH_TSX2IDX [2]
NORH_UT2JST [1], NORH_UT2JST [2], NORP_RDT2DATA_17G, NORP_RDT2DATA_1G
NORP_RDT2DATA_2G, NORP_RDT2DATA_35G, NORP_RDT2DATA_4G, NORP_RDT2DATA_9G
NORP_RD_DAT, OBS_PLOT, OVER_THE_LIMB, PLOT_BSC_AS2, PLOT_CLON, PP_MWLT2SXT
PP_SXT2VLA, QUICKATT [1], QUICKATT [2], QUICKDARK [2], RD_HXT_DBOOK, SSDA
SXT_OBSRPT, Sxt_goes_teem, TIM2JD [1], TIM2JD [2], TIM2UPOS, TRACE_MDI_ALIGN
TRACE_SSWHERE [1], TV_SSX, TV_SYNOP, TYKW_RD_DAT, ULYSSES_FEM, VIEW_TRACE_MOSAIC
WBS_DB2, WOBS_PLOT, XMOVIE_SFM, adjust_times, ads_into_att, ads_into_pnt
adsdirs [1], adsdirs [2], align_hxi, align_prep [1], align_prep [2]
align_prep [3], any_decay_time, anystr2tim [1], anystr2tim [2], anytim [1]
anytim [2], anytim [3], anytim [4], anytim [5], anytim2doy [1], anytim2doy [2]
anytim2weekid [1], anytim2weekid [2], anytim2weeks [1], anytim2weeks [2]
ars2_plan, atr2hxa_dbase, auto_bck_find, auto_toban, bbso_copy [1], bbso_copy [2]
bck_interval, bcs_clock_fix, bcs_trange, box_sxtth_hxt, build_timarr [1]
build_timarr [2], cam_run_sum, ccd_hdr_info, cfl_summary [1], cfl_summary [2]
check_oldprocess [1], check_oldprocess [2], check_oldprocess [3]
check_oldprocess [4], check_sci5k_trunc, choose_interval, cnvt [2]
cont2time [1], cont2time [2], contact_num [1], contact_num [2], contacts [1]
contacts [2], conv_a2ap, conv_a2p [1], conv_a2p [2], conv_p2a [1], conv_p2a [2]
copy_visible, dat2bsc, days_2_xmas, deciyr2ints, decode_gev, def_yssysv [1]
def_yssysv [2], delete_week [1], delete_week [2], disp_sci5k, disp_therm_rs232
do_ads, do_tr_reformat, doy2ex [1], doy2ex [2], doytim2ints, dps_fname2time
ea_view_angle [2], edac_summary, emi_plot [1], event_movie [1], event_movie [2]
evt_grid, ex2week [1], ex2week [2], fem_grid [1], fem_grid [2], file_info2 [1]
file_info2 [2], fits_disp_month [1], fits_disp_month [2], fix_hxtindex
fl_mktext, fort2hxi [1], fort2hxi [2], gbo_pfi, get1gbo, get1hk_info [1]
get1hk_info [2], get_ar, get_atr, get_att, get_del_pnt, get_hk_info [1]
get_hk_info [2], get_hxt_pos, get_ksc_holiday, get_mk3 [1], get_mk3 [2]
get_mwlt_roll, get_orb_epoch, get_pnt, get_rb0p [1], get_rb0p [2], get_roll
get_selsis, get_seq_tab, get_sfm, get_sirius [1], get_sirius [2], get_suncenter2
get_sunset, get_sxa, get_utevent [1], get_utevent [2], go_teem [1], go_teem [2]
go_teem_nn, go_teem_t, goes2str, goes3sec_copy, goes_gaps, goes_log, goes_plot [1]
goes_plot [2], goes_plot [3], goes_plot [4], goes_plot [5], goes_summary
goes_teem, goesem_eqn [1], goest_eqn [1], grs32_fsp, grsl_fsp, gt_day [1]
gt_day [2], gt_time [1], gt_time [2], gtab_summary, gtt_info, gtt_orbit, hkplot_info
hxi_interp, hxs_chsums, hxs_fsp, hxsgrs_fsp, hxt_chsums, hxt_fsp, hxt_fsp1, hxt_utplot
hxtaccumulate, hxtimg_accum, image2movie, in_fov, int2secarr [1], int2secarr [2]
interpol_yoh, ip_que_dmpver, iperr_sea, jitter_gif_xyimg, jst, killold [1]
killold [2], ksc_commands, last_lc, list_nrt_times, list_tfi, mk_att [1], mk_att [2]
mk_daily_ints, mk_evn [1], mk_evn [2], mk_fem [1], mk_fem [2], mk_gbl, mk_gsn_obs
mk_gsn_obs_s1, mk_gx, mk_hst_summary, mk_mdi_fits, mk_mdi_iap, mk_mo_log, mk_obs_str
mk_orbit [1], mk_orbit [2], mk_pnt, mk_sdm, mk_sdmi, mk_sfc [1], mk_sfc [2]
mk_sun_mosaic, mk_timarr [1], mk_timarr [2], mk_trace_i1, mk_week_file [1]
mk_week_file [2], mk_ydbtab, mon_health [1], mon_health [2], mon_sci5k
monthly_summary, mwlt_select, mwlt_tape2jpeg, new_disp_sci5k [1]
new_disp_sci5k [2], new_edac_summary, new_mon_health [1], new_mon_health [2]
nn_rd3_sxt_noaa, nob_img_copy, obs_summary, op_times, oplot_nts, pfi_dominant
pfi_loc, pl_dt_genx, pl_monitor_center, plot_door_open, plot_evn, plot_fem
plot_fov [1], plot_gbl [1], plot_gbl [2], plot_gsn, plot_loi_mmad
plot_loi_summary [1], plot_loi_summary [2], plot_pzt_corr, plot_shutter_perf
plot_ssw_fov, plot_therm_rs232a, plot_therm_rs232c, plot_trav [1], plot_trav [2]
plot_trav [3], plott_bda, plott_hda, plott_wda, ploty [1], ploty [2], pr_evn [2]
pr_fem, pr_gbe, pr_gev, pr_gsn [1], pr_gsn [2], pr_his_index [1], pr_his_index [2]
pr_his_index [3], pr_nar, pr_nel, pr_seq_frame_info, pr_sxtobs, pr_tim2week [1]
pr_tim2week [2]
pro interpretfemfemfemtimefemflgfemstrfemstrverboseverbose
pro loadopfemfiletimeOGfemverboseverbose
pro loadoptextfiletimeOGverboseverbose
pro plotogonalgdogtimeogfemtimefemflgstarttimestarttimeendtimeendtimepsps
pro showaoslosgdfemtimefemflg, quick_hkplot [1], quick_hkplot [2]
quick_plottrav, rd_gbl_raw [1], rd_gbl_raw [2], rd_goes3sec [1], rd_goes3sec [2]
rd_goes_fits, rd_gxd [1], rd_gxd [2], rd_gxd [3], rd_old_obs, rd_pnt_hist, rd_rasm
rd_raw_station_plan, rd_rdb [1], rd_rdb [2], rd_so_at_ftr, rd_sol, rd_soup
rd_srspas, rd_station_plan, rd_therm_rs232, rd_week_file [1], rd_week_file [2]
rd_week_file [3], rd_week_file [4], read_eit, read_mdi, read_spartan, redo_disploi
redo_mon_sci5k, ref_term [2], reget_dc_image, res_freq, reslot
return a solar disk mask using SSW standard keywords, sda2fits, search_obs
sel_dc_image [1], sel_dc_image [2], sel_dc_image [3], sel_filetimes [1]
sel_filetimes [2], sel_timrange [1], sel_timrange [2], selsis_copy [1]
selsis_copy [2], seq_run_sum [1], seq_run_sum [2], show_contacts, show_hxafid
soon_cadence, soon_search [1], soon_search [3], soon_table, ssw_check_contrib
sswstruct_fill [1], sxl2radiance, sxt_anycomp, sxt_eff_area, sxt_fl_analxpro
sxt_flux [1], sxt_flux [2], sxt_flux [3], sxt_interp [1], sxt_interp [2]
sxt_mwave, sxt_t6_resp0, sxtbox_teem, sxthxt_fsp, sxtth_hxt, telem_sum, term_obs
term_times, tfr_summary, tfr_summary2, tim2dset [1], tim2dset [2], tim2match [1]
tim2match [2], tim2match [3], tim2orbit [1], tim2orbit [2], tim_bin, time_interp
time_smooth, timegrid, timeline, timeline2html, topsdb [1], topsdb [2]
tr_decode_head [1], tr_decode_head [2], tr_inventory_telem, tr_rd_index
tr_rd_inventory, tr_reformat, tr_wrt_fits_i1 [1], trace_sswhere [2]
trace_sswhere [3], trace_sswhere [4], track_h2a [1], track_h2a [2]
track_h2a [3], ut_time [1], ut_time [2], utcursor [1], utcursor [2], v_orbital
wdefroi [3], wdefroi [4], web_seq, week2ex [1], week2ex [2], weekid [2]
weekid2ex [1], weekid2ex [2], weekid2ex [3], wrt_fits_bin_exten [2], xanal_emi
xdate [1], xdate [2], xdisp_sci5k, xdisp_trace2, xfem_grid, xhkplot, xread_hist
xset_chain [1], xset_chain [2], xso_search, xspr [1], xspr [2], ydb_exist [2]
yopos [1], yopos [2], yoyo_man2
OPTIONAL KEYWORD INPUT:
offset - The input time can be offset by a scalar or vector number of
seconds. If "offset" is an array, it should be the same
length at tim_in
HISTORY:
Written 30-May-92 by M.Morrison
5-Jan-93 (MDM) - Added /MDY option for TIMSTR2EX
12-May-93 (MDM) - Modified to allow TIM_IN to be a single time, and
OFFSET to be an array
11-Jan-94 (MDM) - Updated document header
[Previous]
[Next]
Project : SOHO - CDS
Name : ANYTIM2UTC()
Purpose : Converts (almost) any time format to CDS UTC format.
Explanation : Tests the type of input and tries to use the appropriate
conversion routine to create the date/time in CDS UTC
format (either internal (default), external or string)
CDS time format.
Use : IDL> utc = anytim2utc(any_format)
Inputs : any_format - date/time in any of the acceptable CDS
time formats -- for acceptable formats see file
aaareadme.txt.
Opt. Inputs : None
Outputs : Function returns CDS UTC time structure.
Opt. Outputs: None
Keywords : EXTERNAL = Create output in external format
CCSDS = Create string output in CCSDS format
ECS = Create string output in ECS format
VMS = Create string output in VMS format
STIME = Create string output in STIME format
Only one of the above keywords can be set. If none of them are
set, then the output is in internal format. The following
keywords are only valid if a string format was selected.
TRUNCATE = If set, then the time will be truncated to 1 second
accuracy. Note that this is not the same thing as
rounding off to the nearest second, but is a
rounding down.
DATE_ONLY = If set, then only the date part of the string is
returned.
TIME_ONLY = If set, then only the time part of the string is
returned.
UPPERCASE = If set, then the month field in either the VMS or
STIME format is returned as uppercase.
The following keyword is always valid.
ERRMSG = If defined and passed, then any error messages
will be returned to the user in this parameter
rather than being printed to the screen. If no
errors are encountered, then a null string is
returned. In order to use this feature, the
string ERRMSG must be defined first, e.g.,
ERRMSG = ''
UTC = ANYTIM2UTC ( DT, ERRMSG=ERRMSG, ...)
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2CAL, ANYTIM2UTC_KB, DATATYPE [1], DATATYPE [2], DATATYPE [3], GET_UTC
INT2UTC, STR2UTC [1], STR2UTC [2], STR2UTC [3], STR_SEP, TAI2UTC, UTC2INT [1]
UTC2INT [2], UTC2INT [3]
CALLED BY:
ADJUST_HDR_TCR, ANYTIM2CAL, ANYTIM2CDF, ANYTIM2TAI, ANYTIM2WEEK, ARCMIN2HEL2
BBSO__DEFINE, CAT_DIRECTORY, CAT_DURATION, CAT_FITS, CAT_OPEN [1], CAT_TO_TEXT
CDS2JD, CDSPICKFILE, CDS_ASRUN_POINT, CDS_FILES, CDS_PLAN_BRIEF, CDS_PLAN_POINT
CDS_SNAPSHOT, CFITSLIST, CF_GIS1A, CF_GIS1B, CF_GIS1C, CF_GIS2A [1], CF_GIS4A
CF_GIS4B, CF_GIS4C, CHECK_KAP, CHKSCPCKTIME, DATE_CODE, DISPLAY_CDS_BURNIN
DISPLAY_NIMCP, DMOVIE [1], DMOVIE [2], DROT_MAP, DROT_MAP_FAST, DROT_NAR, DSP_WAV
DTSELECT, EIS_CAT [1], EIS_CAT [2], EIS_CPT_NOW [1], EIS_CPT_NOW [2]
EIS_CPT_OBSTBL_MAP_TEXT [1], EIS_CPT_OBSTBL_MAP_TEXT [2]
EIS_CPT_TIMEFORMAT [1], EIS_CPT_TIMEFORMAT [2]
EIS_CPT_TIME_PERIOD_DEFAULT [1], EIS_CPT_TIME_PERIOD_DEFAULT [2]
EIS_DROT_FOV [1], EIS_DROT_FOV [2], EIS_IMAGE_TOOL [1], EIS_IMAGE_TOOL [2]
EIS_IMAGE_TOOL_EVENT [1], EIS_IMAGE_TOOL_EVENT [2], EIS_LOAD_IMAGE [1]
EIS_LOAD_IMAGE [2], EIS_PLAN_STC [1], EIS_PLAN_STC [2], EIS_PLOT_OBEV [1]
EIS_PLOT_OBEV [2], EIS_PLOT_OPEV, EIS_PLOT_STEV [1], EIS_PLOT_STEV [2]
EIT_CATRD [1], EIT_COPY, EIT_DAILY, EIT_DISPLAY, EIT_FXPAR, EIT_GBO, EIT_IMAGE
EIT_MKMOVIE, EIT_PA, EIT_PA_PROCESS, EIT_PA_ev, EIT_POSTAGE, EIT_PREP, EIT_SUBFIELD
EIT_SUB_DRAW, EIT_SUB_MAN_INPUT, EIT_SUB_ROTATE, EIT_SUB_UTIL_HELIO
EIT_TIME_CORRECTION, EIT__DEFINE, ETHZ__DEFINE, EXPORT_PLAN, FILE_CONTENT
FILE_DATE_MOD, FILT_EVENTS, FIND_CAMPAIGN, FIND_FID, FIND_KAP_FILE, FLUSH_CATALOG
FTP_BBSO, FTP_KISF, FTP_MLSO_IMAGES, FTP_MWSO, FTP_NOBE, FTP_SYNOP, GDSPSPEC
GET_CDS_OH, GET_CDS_PNTCAL, GET_DETAIL, GET_EFFICIENCY, GET_EFF_AREA, GET_FID
GET_FITS_CDELT, GET_FITS_CEN, GET_FITS_TIME, GET_GEV, GET_LATEST_IAP
GET_LATEST_KAP, GET_LIST, GET_MAP_TIME, GET_MIRSHIFT, GET_NAR, GET_NOAA
GET_ORBIT [1], GET_ORBIT [2], GET_ORBIT_CDF, GET_ORBIT_CDF2, GET_ORBIT_FITS
GET_PLAN, GET_PLAN_TIME, GET_PLAN_TT, GET_RECENT_EIT, GET_ROLL_OR_XY
GET_SC_ATT [1], GET_SC_ATT [2], GET_SC_POINT, GET_SOHO_ROLL, GET_SOLAR_RADIUS
GET_SUMER_FILES, GET_SYNOPTIC, GET_TILTCAL, GET_VDS_SLITPOS, GET_VDS_STATE
GET_WAVECAL, GET_WAVE_EFF, GET_WIDTH_CORR, GISPLOT, GIS_UTPLOT, GOES__DEFINE
GT_BIMAGE, GT_CDS_TIME, GT_LAMBDA, GT_MIMAGE, GT_VALID, GT_WLIMITS, HEL2ARCMIN [1]
HFITS__DEFINE, HTML_SPLAN, HTTP__DEFINE, IMAGE_TOOL, IMAGE_TOOL_EVENT, ITOOL2MAP
ITOOL_BUTTON_REFRESH, ITOOL_DIFF_ROT, ITOOL_DISP_ROT, ITOOL_EIT_DEGRID
ITOOL_GETFILE, ITOOL_LOAD_IMAGE, ITOOL_PICKFILE, ITOOL_RD_GIF, ITOOL_SET_CSI
LABEL_TAI, LAST_KAP_VERS, LAT2Y, LATEST_IMAGE, LIST_ANOMALY, LIST_CACHE__DEFINE
LIST_CDROM, LIST_DETAIL, LIST_EXP_COMM, LIST_FITS, LIST_PLAN, LIST_RESOURCE
LIST_SUPPORT, MAKE_MAP, MAP2WCS, MAP__DEFINE, MDI_GBO, MKDI_C1, MKQUERY, MK_CDS_PLAN
MK_GISPLOT_LBL, MK_GIS_PLT, MK_IVM_MAP, MK_PLAN_CHANGE, MK_PLAN_CLONE
MK_PLAN_CUSTOM, MK_PLAN_FORM, MK_PLAN_HTML, MK_PLAN_PLOT, MK_PLAN_PRIV
MK_PLAN_RECAL, MK_SOHO, MK_SOHO_CUSTOM, MK_SOHO_EDP, MK_SOHO_TARGET, MK_TIMETICK
MK_WAVECAL, MONO_SPEC, MOVIE_MAKER, NDSPSPEC, NIS_BIAS_DEMO, NRL2EIT, OPLOT_SPLAN
OSRA__DEFINE, OVSA_LTC_DEFINE, PARSE_TIME, PB0R, PLOT_HELIO [1], PLOT_HELIO [2]
PLOT_MAP, PLOT_MAP2 WARNINGTEMPORARY FIX ONLY FOR 16 bit ZBuffer support
PLOT_RESOURCE, PLOT_VDS_BIAS, POINTING3, POLY_SPEC, PRG_DETAIL, PRG_PLAN, QTILT
QUERY_ANOMALY, RD_CDS_POINT, RD_GOES, RD_PLAN, RD_RESOURCE, RD_RSTN, READCDSFITS
READ_FULL_ATT, READ_KAP, READ_MERGED_DSN, READ_SC_ATT, REDUCE_LEVEL_1
ROT_SUBIMAGE, ROT_XY, ROUND_TIME, RSTN__DEFINE, RTMOVIE, SELECTD, SET_KAP_VERS
SHOW_PLAN, SHOW_SYNOP__DEFINE, SID__DEFINE, SITE__DEFINE, SOHOFILE2TIME
SOHO_CAMPAIGN, SOHO_ITEMS_HTML, SOHO_XY, STARFIELD, SUBFIELD_EV, SUM_ANA_TEMP
SUN_EPHEM, SURVANAL, SXI_GBO, S_HK0_SYSCONFIG, TEXT_ANOMALY, TIME2FID, TIME_AVERAGE
TIME_CHECK, TIME_CORRECTION, TPANALYZE, TRACE_COPY, TRACE_GBO, TRACE_MOSAIC_IMAGE
UPDATE_CAMPAIGN, UPDATE_CDS_TARGETS, UPDATE_IAP, UPDATE_KAP, UPDATE_MM
UPDATE_SOHO_TARGETS, UTC2DIFF, UTPLOT__DEFINE, V4DIFF_ROT, VALID_TIME, VDS_CALIB
VDS_READ_FLAT, VSO__DEFINE, WCS2MAP, WCS_FIND_TIME, WEEK2UTC, WHERE_OFF_LIMB
WRITE_ANOMALY, WRITE_CAP, WRITE_CIF, WRITE_IAP, XCALENDAR, XCAMP, XCAT, XCLONE_PLAN
XCPT, XGET_SYNOPTIC, XGET_UTC, XIAP, XREPORT, XREPORT_EDIT, XVALIDATE, XZOOM_PLAN
Y2KFIX, YMD2DATE, anytim2jd, closest_time, datify, datify_fname, db_gbo, dsp_menu
ef2time, eis_cpt_gui [1], eis_cpt_gui [2], eis_ct_summary_gui [1]
eis_ct_summary_gui [2], eis_datetime_gui [1], eis_datetime_gui [2]
eis_dr_obj__DEFINE [1], eis_dr_obj__DEFINE [2], eis_get_events_filename [2]
eis_get_events_filename [4], eis_import_linelist [1]
eis_import_linelist [2], eis_mk_plan_gui [1], eis_mk_plan_gui [2]
eis_read_linelist_block [1], eis_read_linelist_block [2]
eis_read_raster_block [1], eis_read_raster_block [2]
eis_read_study_block [1], eis_read_study_block [2]
eis_timeline_plot_gui [1], eis_timeline_plot_gui [2], eit_dark, eit_degrid
eit_degrid_fft, eit_dump, eit_file2path, eit_find_last_cal, eit_findcalgroup
eit_flat, eit_getcal, eit_getlimb, eit_norm_response [1], eit_point
fitshead2struct, get_def_times, get_eit_data, hsi_gbo, hsi_plot_flux, ihy_db
mk_atlas, mk_mdi_fits, mk_sumer_map [1], mk_sumer_map [2], mk_sumer_map [3]
smk_atlas, soho_fac, vso_format, write_ovsa_fits, zdiff_rot
Common : None
Restrictions: None
Side effects: None
Category : Util, time
Prev. Hist. : None
Written : C D Pike, RAL, 16-May-94
Modified : Version 1, C D Pike, RAL, 16-May-94
Version 2, William Thompson, GSFC, 14 November 1994
Changed .DAY to .MJD
Version 3, Donald G. Luttermoser, GSFC/ARC, 20 December 1994
Added the keyword ERRMSG. Included ON_ERROR flag.
Version 4, Donald G. Luttermoser, GSFC/ARC, 30 January 1995
Added ERRMSG keyword to internally called procedures.
Made error handling routine more robust.
Version 5, Donald G. Luttermoser, GSFC/ARC, 8 February 1995
Allowed for input to be either scalar or vector.
Version 6, William Thompson, GSFC, 14 March 1995
Added keywords VDS, STIME, TRUNCATE, DATE_ONLY,
TIME_ONLY, UPPERCASE
Version 7, William Thompson, GSFC, 5 May 1995
Fixed bug with use of ERRMSG keyword.
Made so that TAI times are supported.
Version 8, William Thompson, GSFC, 8 May 1995
Fixed bug introduced in version 7
Version 9 C D Pike, RAL, 17-May-95
Handle time only (no date) string input.
Version : Version 9, 17 May 1995
[Previous]
[Next]
NAME:
anytim2weeks
PURPOSE:
Given a starting and ending time, return a vector
of week numbers and year numbers where the times fall
INPUT:
sttim - the start time in "any" format
OPTIONAL INPUT:
entim - if not defined, just return the week/year for
the start time
OUTPUT:
weeks - the week number
years - the year numbers
CALLS: ***
anytim2ex [1], anytim2ex [2], anytim2ints [1], anytim2ints [2], ex2dow [1]
ex2dow [2], ex2week [1], ex2week [2]
CALLED BY:
OBS_PLOT, do_reg_backup, dsn_input, get1gbo, goes_summary, rd_old_obs
rd_week_file [1], rd_week_file [2], rd_week_file [3], rd_week_file [4]
show_obs3, show_obs4, tim2weekid, weekid [2], ydb_exist [2], ydb_install [1]
ydb_install [2]
OPTIONAL KEYWORD INPUT:
nobackup - If set, then do not back up a week if the start
time is within 90 minutes of the first day of the week.
string - If set, then return the answer in string format (WIDs)
HISTORY:
Written Feb-92 by M.Morrison
8-Feb-92 (MDM) - Added code to back up a week if the start time
is within 90 minutes of the first day of a week
29-Aug-94 (MDM) - Added /NOBACKUP option to NOT back up a week
when start time is within 90 minutes of the first
day of the week.
20-Sep-94 (MDM) - Added /STRING option
[Previous]
[Next]
Project : SOHO - CDS
Name : APPLY_CDS_ADEF
Purpose : Apply CDS analysis definition(s), generating an analysis.
Explanation : Applies the information in one or more CDS Analysis
Definition(s) - ADEF(s) - to a specific CDS data set returning
the resulting analysis structure(s).
The data set (raster) may be given either by the file name (in
which case the QLDS will be read in) or through the QLDS
keyword.
If the QLDS has to be read in, the following applies:
Only the data windows used in the analysis will be
selected.
Also, unless the /LEAVE_QLDS flag is set, the QLDS will
be deleted after the data has been extracted in
Use : ANALYSIS = APPLY_CDS_ADEF(ADEF,FILE)
Inputs : ADEF : CDS Analysis Defintion
Opt. Inputs : FILE : E.g., "s5500r00" - the name of a CDS fits file. Must
be supplied if no QLDS is supplied.
Outputs : Returns CFIT Analysis Structure according to the Analysis
Definition.
Opt. Outputs:
Keywords : QLDS : You may supply the QLDS to which the analysis
definition should be applied through this keyword.
Alternatively, if /LEAVE_QLDS is set, get the QLDS
through this keyword after it has been read in.
LEAVE_QLDS : See QLDS.
CALIBRATED_QLDS : Returns a *copy* of the QLDS after the
calibrations defined in the ADEF have been
applied. Only valid when /LEAVE_CALIBRATION
is set, and only if calibrations beyond
VDS_DEBIAS has been selected.
LEAVE_CALIBRATION : See CALIBRATED_QLDS
Calls : ***
AVERAGE, BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CDS_ADEF_PARSEFILE
CDS_READ_MISSING, DATATYPE [1], DATATYPE [2], DATATYPE [3], DEFAULT
DELETE_ANALYSIS, DELETE_QLDS, DIMREBIN, DIMREFORM, EXIST, FIND_WITH_DEF [1]
FIND_WITH_DEF [2], FIND_WITH_DEF [3], MAKE_SFIT_STC, MK_ANALYSIS
MK_CDS_ANALYSIS, QLMGR, READCDSFITS, STR_SEP, TRIM, UNIQ [1], UNIQ [2], UNIQ [3]
VDS_DEBIAS, break_file [4]
CALLED BY:
XCDS_ANALYSIS
Common : None.
Restrictions: ...
Side effects: ...
Category : Analysis
Prev. Hist. : None.
Written : SVH Haugan, UiO, 21 October 1997
Modified : Version 2, SVHH, 17 November 1998
Small changes, mostly to avoid multiple
calibration calls.
Version : 2, 17 November 1998
[Previous]
[Next]
NAME: archive_ck
Purpose: Check an archive copy for completeness. It checks the
file names to ensure that all files were copied and it
ensures that the file sizes are correct.
Default is to do both checks.
Calling Sequence:
badfiles = archive_ck(path, [filename=filename,
filesize=filesize, output=output, xbd_path=xbd_path]
where:
badfiles is a list of files missing files or
files with incorrect sizes.
'' null string indicates NO bad files found!
'-1' -1 string indicates possible error in that
there were NO file found in the given path.
INPUT:
path full path of archive to check. eg.
path='/yd1/feb93/'
range first and last valid fileid to check
for a range of archive files. eg.
range=['930208.1324','930212.1856']
option not available yet...
weeks list of archive weeks to check found
in the path. eg. weeks=['93_07','93_08']
Optional Inputs:
DEFAULTS to checks of filenames and filesizes:
filename Only check that all files were copied.
filesize Only check files sizes of copied files.
The following options not available yet:
output Write the names of the missing or bad
files to a file.
xbd_path specify the path to the "xbd" files if
they are located in a non-standard dir.
CALLS: ***
FILE_STAT [1], FILE_STAT [2], file_stat [3], gen_file_id [1], gen_file_id [2]
get_afile_size [1], get_afile_size [2]
History:
written 5-May-94, gal.
[Previous]
[Next]
Project : SOHO - CDS
Name : ARCMIN2HEL()
Purpose : Convert arcmin from sun centre to heliographic coords.
Explanation : Converts an (x,y) position given in arcmins relative to the
solar disk centre to heliographic coordinates for the date
supplied ( default date = today).
Use : IDL> helio = arcmin2hel(xx,yy,date=date)
Inputs : xx - E/W coordinate in arc minutes relative to sun center
(West is positive)
yy - S/N coordinate in arc minutes relative to sun center
(North is positive)
Opt. Inputs : None
Outputs : Function returns 2 element vector: [lat, long] in degrees.
Opt. Outputs: None
Keywords : date - date/time in any CDS format
off_limb - flag which is true if the coordinates are beyond
the solar limb.
Calls : ***
ANYTIM2UTC_KB, ARCMIN2HEL_KB, GET_UTC, PB0R
CALLED BY:
ALIGN_AR, ARCMIN2HEL2, BCS_POINT, CNVT_COORD [1], DROT_COORD, DROT_RASTER
EIT_SUB_DRAW, EIT_SUB_ROTATE, MK_HEAD_CAT, PFI_CENT, ROT_XY, SOHO_XY, XY2HEL
ssw_flare_locator, ssw_track_fov, todays_targets, zdeheliographinize, zxy2helio
Restrictions: If the supplied coordinates are outside the solar disk, the
region is projected onto the limb.
Side effects: None
Category : Util, coord
Prev. Hist. : Original by J P Wuelser.
Written : CDS version by C D Pike, RAL, 6 Sept 93
Modified : Converted to use CDS time and pb0r routines, CDP, 17-May-94
Version 3, William Thompson, GSFC, 14 November 1994
Modified .DAY to .MJD
Version : Version 3, 14 November 1994
[Previous]
[Next]
Name:
Arr2Str
Purpose: convert array to a delimited string (def delim is comma)
Input:
arr input data array which is to be converted
to a simple string.
Input/keyword:
delimitor default delimitor is ','
trim If set, call STRTRIM when converting to string
Returned:
simple string using the delimitor to seperate the
elements of the orginal array.
CALLED BY:
ADD_METHOD, ADD_PATH [1], ADD_PATH [2], BATSE_TIME_INPUT, BUILD_DRM_MER_CONT
CDS_PLAN_BRIEF, CHECK_KAP, CH_LINE_LIST, CLEAN_PATH, CRONTAB, CkFurFiles
Create_update_tar, DB_CHECK, DEF2C_FORMAT, DEF2STRUCT, DISCSP_BANDS, EIT_COPY
EIT_GBO, EIT_QUALITY [1], EIT_QUALITY [2], EVAL_SHERB, EXEC_STRUCT, EXP_DBASE
EXP_ZDBASE, FIND_CAT, FITS WRITER CLASS FOR ANY RHESSI DATA TYPES, FIX_DATE
FTP__DEFINE, GET_ANOMALY, GET_CDS_FOV, GET_CDS_XY, GET_SID, HESSI
HESSI CALIBRATED EVENTLIST CLASS DEFINITION [3]
HESSI PACKET FILE ABSTRACT CLASS, HESSI_DATA_PATHS [1], HESSI_DATA_PATHS [2]
HSI_CHK_DUPLICATE, HSI_EST_MEMMAX, HSI_EVENTLIST_SELECT_BY_ENERGY
HSI_EVENTLIST_SELECT_BY_TIME [1], HSI_EVENTLIST_SELECT_BY_TIME [2]
HSI_RD_FITS_SPECTRUM, HXFITS, LATEST_IMAGE, LIST_ANOMALY, LIST_GEV, LIST_NAR
LOCAL_DIFFS, Load_recs, MCURVEFIT, MDI_GBO, MERGE_DISCSP_HKG_OCC, MK_CDS_ANALYSIS
MK_CDS_PLAN, MK_MER_CONT, MK_PLAN_ORDER, MK_PLAN_WRITE, MK_RASTER
MkFnMapMake Filename Map, Modify_Merge_list [1], Modify_Merge_list [2]
OCC_DBASE, OP_COM [1], OP_COM [2], OVSA_EXPLORER formerly OVSA_PRESUB, OVSA_FIT
OVSA__DEFINE, PAIR_STRUCT, PARSE_GROSSC_ATTITUDE
POINT SPREAD FUNCTION CLASS DEFINITION, POINT [1], QUERY_ANOMALY
RATIO_PLOTTER [1], RD_IMAGE_FITS, READ_GDFILE_GD, REMOVE_PATH, RM_FILE
RM_PATH [1], RM_PATH [2], ROUTINE_NAME [4], ROUTINE_NAME [7], RTMVI [1], RdTap [1]
RdTap [2], RdTap [3], SEL_LINE_EVENT, SETUP_DRM, SET_CDS_FITS, SITE__DEFINE
SOHO_ITEMS_HTML, SPEX_BACKGROUND [1], SPEX_BACKGROUND [2], SPEX_COMMONS [2]
SPEX_COMMONS [4], SPEX_DRM__DEFINE, SPEX_ENV [2], SPEX_ENV [4], SPEX_ENV [5]
SPEX_FIT__DEFINE, SPEX_GEN__DEFINE, SPEX_HANDLES [1], SPEX_HANDLES [2]
SPEX_PROC [1], SPEX_PROC [2], SPEX_SAVE [1], SPEX_SAVE [2], SPEX_SAVE_DATA [1]
SPEX_SAVE_DATA [2], SPEX_SUMMARY [1], SPEX_SUMMARY [2], SPEX_THISTORY [1]
SPEX_THISTORY [2], SPEX__DEFINE, SSW_LOCAL_PATH, STRUCTURE TO VOTABLE, STR_CHOP
STR_DEBLANK, STR_FIND, STR_TRAIL, SXI_GBO, SYNOP_DEFINE, TEST_DIR2, TRACE_COPY
TRACE_GBO, TRACE_SSWHERE [1], UPDATE_CAMPAIGN, UPDATE_MPG, UPDATE_SXT_CO_INDEX
VALID_TIME, WHICH, WRT_GEN [1], WRT_GEN [2], WRT_GENX [1], WRT_GENX [2], W_HISTOGRAM
XACK, XCAMP, XCAT, XCRON, XLIST, XMATRIX, break_doc [1], break_doc [2], break_doc [3]
cal_fig_mich, ch_ss, check_dumps [1], check_ff_load, check_oldprocess [1]
check_oldprocess [2], check_oldprocess [3], check_oldprocess [4], cnvtimstr
copy_visible, db_gbo, disk_monitor [1], disk_monitor [2], disp_dt_genx
disp_therm_rs232, do_reg_backup, drm_4_spex [1], drm_4_spex [2]
eit_proton_summary, evt_grid, expand_dirs, extract_val, fidmap, fit_comp_kw
fitshead2struct, get_eit_info, get_ovsa_log, get_survey, getcurstr [1]
getcurstr [2], getwkprelst, go_batch [1], go_batch [2], go_ssw_batch
go_yo_prod_batch, goes_summary, gt2exe [1], gt2exe [2], help_merge [1]
help_merge [2], hist_summary, hkplot_info, hsi_a2d_list, hsi_coll_segment_list
hsi_gbo, hsi_get_flare_flags, hsi_getflare, hsi_image_plot
hsi_image_raw__define, hsi_imagemisc_widget, hsi_params_write_pro
hsi_plot_flux, hsi_select_flare, hsi_show_flags [2], hsi_spectrum__filewrite
hsi_ui_flarecat, hsi_ui_lc, hsi_ui_mon, hsi_ui_obs, hsi_ui_qlimage, hsi_ui_spec
html_get_files, hxt_images2ps, ihy_db, image2movie, image_summary, img_summary [1]
img_summary [2], ip_que_dmpver, is_alive [1], is_alive [2], is_bestnode [1]
is_bestnode [2], jitter_gif_xyimg, lastgki, list_mo_log [1], list_mo_log [2]
load_hd, mail [1], mail [2], make_mirror, mk_bad_pix_map_load, mk_lasteit_movie
mk_orbit_files, mk_sfc [1], mk_sfc [2], mk_ssc_batch [1], mk_ssc_batch [2]
mmap_imgnum, mo_patch, mon_sci5k, mtcmd [1], mtcmd [2], mwritefits, netscape_control
nob_img_copy, option_changer [1], option_changer [2], ospex_params_write_pro
ovsa_calib, ovsa_interact, parse_lines [1], parse_lines [2], path_ucon, pathfix
plot_fov [1], plot_goesp, plotman, plotman_imageoptions, point [2]
pr_his_index [1], pr_his_index [2], pr_his_index [3], pref_super, psk_correlate
ratio_plotter [2], rd_guf_ascii, rd_sxg, rd_sxs_pha [1], rd_sxs_pha [2]
rd_tr_seq_head, rdbda_smm, read_batse_4_spex [1], read_batse_4_spex [2], reads
redo_disploi, redo_mon_sci5k, required_tags, restgenx, save_idl_routines, savegenx
secchi_time2files, seq_cubes, set_fastpath [1], set_fastpath [2], set_logwindows
set_oldpath [1], set_oldpath [2], setssw_windows, soon_search [1]
soon_search [3], spec_plot [1], spec_plot [2], spec_plot [3], spec_plot [4]
special_movie, spex_convert_results [1], spex_convert_results [2]
spex_data__define, spex_delete [1], spex_delete [2], spex_evnt [1]
spex_evnt [2], spex_hold [1], spex_hold [2], spex_image__define, spex_merge [1]
spex_merge [2], spex_merge_control [1], spex_merge_control [2]
spex_preview [1], spex_preview [2], spex_source [1], spex_source [2]
spex_spec_plot [1], spex_spec_plot [2], spex_spec_plot [3], spex_spec_plot [4]
ssw_imapcoord2html, ssw_install [1], ssw_install [2], ssw_instr_info
ssw_javamovie, ssw_path, ssw_set_instr, ssw_setup_windows, ssw_start_rpcserver
ssw_swmap_info, str_pow_conv, str_replace [1], str_replace [2], strlist2html [1]
strlist2html [2], strpair2struct, sw_tape, sxt_orhis, sxt_prep_exe, synop_link
table2struct, timeavg [1], timeavg [2], timeline, timstr2ex [1], timstr2ex [2]
todays_targets, topsdb [1], topsdb [2], tr_decode_head [1], tr_decode_head [2]
trace_cosmic2filename, trace_cosmic2hist_accum, trace_dph2struct [1]
trace_scale, trace_sswhere [2], trace_sswhere [3], trace_sswhere [4]
track_proc [1], track_proc [2], ucon_path, url_decode, url_encode, vso_format
wbs_response [1], wbs_response [2], web_seq, where_pattern [1]
where_pattern [2], where_title [1], where_title [2], write_genxcat
write_ovsa_fits, write_trace, write_trace_bin, wrt_rate_ext, wwwidl_server_check
wwwidl_watchdog [1], wwwidl_watchdog [2], xcheckip, xdisp_fits, xdisp_trace [1]
xdisp_trace2, xdisp_trace3, xhkplot, xread_hist, xset_chain [1], xset_chain [2]
xso_butevents [1], xso_butevents [2], xsxt_prep_event, ys_contrib [1]
ys_contrib [2], zformat [1], zformat [2]
History:
written by SLF
modified, slf, 11/19/91 - handle leading delimintor
more gracfully
2-Dec-91 (MDM) - Fixed bug induced by 19-Nov fix
it was not handling cases where input
was an non-string array of more than one element
25-feb-91, slf - added positional delim parameter
4-Jun-92, mdm - Changed to use N_ELEMENTS instead of KEYWORD_SET
for checking "delimitor" so that null strings
can be used with "STR_REPLACE" function
12-May-94, slf - remove strtrim and strcompress(???)
15-Jun-94, MDM - Added /TRIM optional keyword
[Previous]
[Next]
NAME:
ARRAY_JHUAPL
PURPOSE:
Force given argument to be an array.
CATEGORY:
CALLING SEQUENCE:
y = array_jhuapl(x)
INPUTS:
x = input which may be an array or scalar. in
KEYWORD PARAMETERS:
OUTPUTS:
y = out which is an array. out
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3]
CALLED BY:
RECPOL [1], RECPOL [2], RECPOL [3], STRSEC [1], STRSEC [2]
COMMON BLOCKS:
NOTES:
MODIFICATION HISTORY:
R. Sterner, JHU-APL, 28 Jan, 1986.
Converted to SUN 14 Aug, 1989 --- R. Sterner.
30-Apr-92 (MDM) - Renamed from "array.pro" to "array_jhuapl.pro"
Copyright (C) 1986, Johns Hopkins University/Applied Physics Laboratory
This software may be used, copied, or redistributed as long as it is not
sold and this copyright notice is reproduced on each copy made. This
routine is provided as is without any express or implied warranties
whatsoever. Other limitations apply as described in the file disclaimer.txt.
[Previous]
[Next]
NAME:
ASPECT
PURPOSE:
This function calculates and returns the normalized position
coordinates necessary to put a plot with a specified aspect ratio
into the currently active graphics window. It works on the display
output window as well as in a PostScript output window.
AUTHOR:
FANNING SOFTWARE CONSULTING
David Fanning, Ph.D.
1645 Sheely Drive
Fort Collins, CO 80526 USA
Phone: 970-221-0438
E-mail: davidf@dfanning.com
Coyote's Guide to IDL Programming: http://www.dfanning.com/
CATEGORY:
Graphics
CALLING SEQUENCE:
position = ASPECT(aspectRatio)
INPUTS:
aspectRatio: A floating point value that is the desired aspect
ratio (ratio of heigth to width) of the plot in the current
graphics output window. If this parameter is missing, an aspect
ratio of 1.0 (a square plot) is assumed.
KEYWORD PARAMETERS:
MARGIN: The margin around the edges of the plot. The value must be
a floating point value between 0.0 and 0.5. It is expressed in
normalized coordinate units. The default margin is 0.15.
WINDOWASPECT: The aspect ratio of the target window. If not provided,
the value is obtained from the current graphics window.
OUTPUTS:
position: A four-element floating array of normalized coordinates.
The order of the elements is [x0, y0, x1, y1], similar to the
!P.POSITION system variable or the POSITION keyword on any IDL
graphic command.
EXAMPLE:
To create a plot with an aspect ratio of 1:2 and a margin of
0.10 around the edge of the output window, do this:
plotPosition = ASPECT(0.5, Margin=0.10)
PLOT, Findgen(11), POSITION=plotPosition
Notice this can be done in a single IDL command, like this:
PLOT, Findgen(11), POSITION=ASPECT(0.5, Margin=0.10)
MODIFICATION HISTORY:
Written by: David Fanning, November 1996.
Added better error checking, 18 Feb 1997, DWF.
Added WindowAspect keyword. 10 Feb 2000. DWF
[Previous]
[Next]
Project : SOHO - CDS
Name : ASSIGN_NOCOPY
Purpose : Move data from one variable to another, without copying.
Explanation : Under IDL Version 3.1 or later, the use of the NO_COPY keyword
in the call to WIDGET_CONTROL when setting or getting the
UVALUE of a widget provides a method of moving large amounts
of data from one variable to another without actually copying
it from one place to another.
From version 3.6 an on, handles are used instead of bases.
Use : ASSIGN_NOCOPY,DESTINATION,SOURCE
Inputs : SOURCE: The variable containing the data to move.
Opt. Inputs : None.
Outputs : DESTINATION : A named variable to receive the contents of
SOURCE.
Opt. Outputs: None.
Keywords : None.
Calls : ***
SINCE_VERSION [1], SINCE_VERSION [2], XALIVE
CALLED BY:
DSPEXP, DSPWAV, DSP_AUX, DSP_MOVIE, GDSPSPEC, NDSPSPEC, QLDS_FETCH, dsp_menu
Common : None.
Restrictions: None.
Side effects: Creates a widget base.
Category : Utility
Prev. Hist. : None.
Written : Stein Vidar Hagfors Haugan, ItA/UiO, 11-June-1994
Modified : Version: 2, SVHH, 30 September 1996 Using SINCE_VERSION to
determine whether NO_COPY can be used. Using handles
from IDL v 3.6 and on.
Version : 2, 30 September 1996
[Previous]
[Next]
NAME:
ATIME
PURPOSE:
Convert argument UT to string of format YY/MM/DD, HHMM:SS.XXX or
YY/MM/DD, HH:MM:SS.XXX, if PUB is set
CALLING SEQUENCE:
RESULT = ATIME(UT,/PUB)
INPUTS:
UT - Time to convert to string, in double precision seconds since
79/1/1, 0000:00.000
OPTIONAL INPUTS:
/PUB - Resulting string will have a colon (:) between hours and minutes
CALLS: ***
YMD2SEC [1], YMD2SEC [2], gt_day [1], gt_day [2], gt_time [1], gt_time [2]
CALLED BY:
ASCII_RATES, ASCII_RAW, BATSE_ONTIMES, BCS, CAL_SHER, CHKPOINT, CHOOSE_FL, DCFREAD
DCFSUMMARY, DC_FILESUMMARY, DC_HEADER, DC_USERTIMES, DN_FILE, DO_FITSFILES
DO_QLARCHIVE, EDITOC, EVAL_SHERB, FILELIST, FIND_DBFILE, FLARES, FLARE_FDB, FLARE_LIST
FLISTOC, FSOC, FSPLOT, FS_ARCHIVE_DRAW, FS_ARCHIVE_RW, FS_GEN_ARR, FS_GRAPH
FS_OPEN [1], FS_PRINT, FS_READ_DD, FS_SUBTITLE, FWD_DISPLAY, Fits_spectra [1]
Fits_spectra [2], GD, GETUT [1], GETUT [2], GET_HXRBS_FITS, GET_SPEC_CAL, GFITS_R
GFITS_W, GRABDATA, GRABTIME, GRS_EXTRACT, HFLARE, HSI_FORWARDFIT, HV_FILE, HV_FINDER
HXIS, HXISLIFE, HXISTPLOT, HXISXPLOT, HXR2FILE, HXRBS_OCC, HXRFITS_EXT1, HXRFITS_EXT2
HXRFITS_HEAD, LISTQUAL, Load_sher, MEMORY_INTRVLS, MERGE_BURSTS
MERGE_DISCSP_HKG_OCC, MK_DISCSP_CAL, NEXTBDB, OP_COM [1], OP_COM [2], PEAK_MARK
PLOTBATSE, PLOTFIT, PLOT_FLARE, PLOT_OCC_ONDAY, POINT [1], PRTHDR, Pointing_Change
QLARCHIVE, QLDISPLAY, QL_DAY_PLOT, QL_ORBIT_PLOT, RATESDUMPOC, RAWDUMPOC, RDBDA, RDFIS
RDFIS_SPEC, RD_DMP, RD_EXB, RD_NEAR_PIN [1], RD_NEAR_PIN [2], RD_UVCAT, READSUM
READ_DNFILE, READ_GAPFILE, READ_HVFILE, READ_HXRS_4_SPEX [1]
READ_HXRS_4_SPEX [2], READ_HXRS_4_SPEX [3], READ_OCC_DISCSP, RESOLVE_NEW_OBS
SAVE_DCDATA, SC4TREAD, SETUT [1], SETUT [2], SET_UTPLOT [1], SET_UTPLOT [2]
SPEX_COMMONS [2], SPEX_COMMONS [4], SPEX_HANDLES [1], SPEX_HANDLES [2]
SPEX_PROC [1], SPEX_PROC [2], SPEX_SAVE_DATA [1], SPEX_SAVE_DATA [2]
TIME_ARC_NAME, TJD2YMD, TYPE_FLARE, UTHELP, UTPLOT [1], UTPLOT [2], UTPLOT [3]
UTPLOT [4], UTPLOT [5], WBDA [1], WBDA [2], WBSC [1], WBSC [2], WBSC_FPAR_EV [1]
WBSC_FPAR_EV [2], WRITE_DD, WRITE_FDB, WRITE_LOG, Y_AVERAGE [1], Y_AVERAGE [2]
anytim [1], anytim [2], anytim [3], anytim [4], anytim [5], batse_write_log
cp_catwidget, dc_getfile, drot, file name, find_uvexp, getbrr_spec, gfits_ext1
gfits_ext2, gfits_files, gfits_head, help_merge [1], help_merge [2]
hxrbs_response, plot_bda, plot_goes_ospex, plotfda, point [2], rdfis_img, rdmap
read_4_spex [1], read_4_spex [2], read_batse_4_spex [1], read_batse_4_spex [2]
read_dd, read_smm_4_spex [1], read_smm_4_spex [2], read_yohkoh_4_spex [1]
read_yohkoh_4_spex [2], setup_params [1], setup_params [2], spec_plot [1]
spec_plot [2], spec_plot [3], spec_plot [4], spex_batse_preview [1]
spex_batse_preview [2], spex_delete [1], spex_delete [2], spex_hold [1]
spex_hold [2], spex_merge [1], spex_merge [2], spex_source [1], spex_source [2]
spex_spec_plot [1], spex_spec_plot [2], spex_spec_plot [3], spex_spec_plot [4]
uvspmagni, where_are [1], where_are [2], xzchange
MODIFICATION HISTORY:
Written by Richard Schwartz for IDL Version 2, Feb. 1991
[Previous]
[Next]
Project : SOHO - CDS
Name : AUXREAD()
Purpose : Read block of auxiliary data from a CDS FITS level-1 file.
Explanation : READCDSCOL is used to read all information
about the auxiliary data with 'TTYPEx' == NAME.
The data is returned in an IDL structure,
with the tags DATA, which contains the actual
data, and DESC, which contains the CDS QL Data Format
auxiliary data descriptor.
If the specified auxiliary data are not found,
the tags will have a value of zero.
Use : AUX = AUXREAD(UNIT,HEADER,NAME)
Inputs : UNIT = the file unit associated with the FITS file.
HEADER= the header of the FITS file
NAME = the type/label name of the desired auxiliary
data.
Opt. Inputs : None.
Outputs : Returns structure with auxiliary data and descriptor.
Opt. Outputs: None.
Keywords : STATUS : Set to initialized variable in order to return
error message instead of crashing on error. Returns
empty string if ok.
Calls : ***
FXBFIND [1], FXBFIND [2], MKAUXDESC, READCDSCOL, TRIM
CALLED BY:
GT_MIRRPOS, GT_SLITPOS, GT_START, PLOT_DELTAT, READCDSFITS
Common : None.
Restrictions: The file has to be a CDS FITS level-1 file.
Side effects: None.
Category : Data_Handling, I_O, CDS, FITS, QuickLook
Prev. Hist. : None.
Written : Stein Vidar Hagfors Haugan, 27 September 1993
Modified : SVHH, Version 2, 8-June-1994
Added status=status
SVHH, 25 Aug. 1994,
Switched READ_CDS-->READCDSCOL
Version : 2, 8-June-1994
[Previous]
[Next]
NAME:
avoid_spikes
PURPOSE:
Return the subscript list of data values which don't have spikes
SAMPLE CALLING SEQUENCE:
ss = avoid_spikes(yarr, nss)
INPUT:
yarr - the input array
OUTPUT:
ss - the list of subscripts which are ok
nss - the number of points which are ok
CALLS: ***
deriv_arr [1], deriv_arr [2]
CALLED BY:
plot_loi_mmad, plot_loi_summary [1], plot_loi_summary [2], plot_pzt_corr
plot_shutter_perf
HISTORY:
Written 29-May-96 by M.Morrison
10-Jun-96 (MDM) - Put in protection for problem data (median=0)
10-Jun-96 (MDM) - Added thresh keyword
28-Jun-96 (MDM) - Modified logic since it did not protect against
positive spikes (it only protected against
negative spikes). It removes twice as many
points now.
[Previous]
[Next]
NAME:
AWIN
PURPOSE:
This procedure opens a window of the same size as the input array
CATEGORY:
UTIL
CALLING SEQUENCE:
AWIN, Arr
INPUTS:
Arr: A two dimensional array of any type
OUTPUTS:
None
CALLED BY:
C3_CME, C3_CME_FRONT, CME_MASS, CME_MASSIMG2TOTAL, MAKE_DAILY_IMAGE, WRUNMOVIE [2]
SIDE EFFECTS:
A blank window is displayed.
EXAMPLE:
Open a window of the same size as an arbitrary image array
AWIN, image
MODIFICATION HISTORY:
Written by: SE Paswaters, NRL, June 1996
@(#)awin.pro 1.2 05/14/97 LASCO IDL LIBRARY