[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_5vdpu()
PURPOSE:
Return HK0 Voltage DPU +5 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_5vdpu()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_detchax()
PURPOSE:
Return HK0 Detector X-charge Threshold
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_detchax()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_detchay()
PURPOSE:
Return HK0 Detector Y-charge Threshold
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_detchay()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_dethighv()
PURPOSE:
Return HK0 Detector High Voltage in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_dethighv()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_detlvpi()
PURPOSE:
Return HK0 Detector LVPS Current Monitor
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_detlvpi()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_detmcpi()
PURPOSE:
Return HK0 Detector MCP Current in uA
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_detmcpi()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_dettimx()
PURPOSE:
Return HK0 Detector X-timing Threshold
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_dettimx()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_dettimy()
PURPOSE:
Return HK0 Detector Y-timing Threshold
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_dettimy()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_ecpb()
PURPOSE:
Return HK0 ECP Bank Registers (Byte 44)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_ecpb()
EXAMPLES:
INPUTS:
HK0 - HK) Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_ecpbsr()
PURPOSE:
Return HK0 ECP Bank Select Registers (Byte 45)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_ecpbsr()
EXAMPLES:
INPUTS:
HK0 - HK) Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_ecperr()
PURPOSE:
Return HK0 ECP Error Status Register (Byte 47)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_ecperr()
EXAMPLES:
INPUTS:
HK0 - HK) Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_HELP
PURPOSE:
CATEGORY:
EXPLANATION:
SYNTAX:
s_hk0_help,
EXAMPLES:
INPUTS:
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, January 3, 2000, GERMEROTT, MPAE LINDAU. Written
CONTACT:
GERMEROTT, MPAE LINDAU (GERMEROTT@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_IBB1M18V()
PURPOSE:
Return HK0 Current IBB1 -18 V in mA
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_IBB1M18V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_IBB2M18V()
PURPOSE:
Return HK0 Current IBB2 -18 V in mA
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_IBB2M18V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_IBOARDP28V()
PURPOSE:
Return HK0 Current Board +28 V in mA
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_IBOARDP28V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_ICCP5V()
PURPOSE:
Return HK0 Current Board +5 V in mA
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_ICCP5V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_IDD1P18V()
PURPOSE:
Return HK0 Current IDD1 +18 V in mA
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_IDD1P18V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_IDD2P18V()
PURPOSE:
Return HK0 Current IDD2 +18 V in mA
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_IDD2P18V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_IDDRSCP15V()
PURPOSE:
Return HK0 Current IDDRSC +15 V in mA
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_IDDRSCP15V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_IDEFL()
PURPOSE:
Return HK0 Current Deflector in mA
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_IDEFL()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_ideta()
PURPOSE:
Return HK0 Current Detector A in mA
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_ideta()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_idetb()
PURPOSE:
Return HK0 Current Detector B in mA
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_idetb()
EXAMPLES:
INPUTS:
HK0 - HK) Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_idpup5v()
PURPOSE:
Return HK0 Current DPU +5 V in mA
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_idpup5v()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_iheaterd()
PURPOSE:
Return HK0 Current Heater D in mA
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_iheaterd()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_IRSCM15()
PURPOSE:
Return HK0 RSC minus 15 V current
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_IRSCM15()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_IRSCM15V()
PURPOSE:
Return HK0 RSC -15 V Current in mA
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_irscm15v()
EXAMPLES:
INPUTS:
HK0 - HK) Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_iwaxmotor()
PURPOSE:
Return HK0 Current WAX Motor Door in mA
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_iwaxmotor()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC1M15V()
PURPOSE:
Return HK0 MC1 -15 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC1M15V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC1P15V()
PURPOSE:
Return HK0 MC1 +15 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC1P15V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC1P5V()
PURPOSE:
Return HK0 MC1 +5 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC1P5V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC1POS()
PURPOSE:
Return HK0 MC1 Encoder Value
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC1POS()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC1STAT()
PURPOSE:
Return HK0 MC1 Status (Byte 79)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC1STAT()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC2M15V()
PURPOSE:
Return HK0 MC2 -15 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC2M15V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC2P15V()
PURPOSE:
Return HK0 MC2 +15 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC2P15V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC2POS()
PURPOSE:
Return HK0 MC2 Encoder Value
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC2POS()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC2STAT()
PURPOSE:
Return HK0 MC2 Status (Byte 85)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC2STAT()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC3M15V()
PURPOSE:
Return HK0 MC3 -15 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC3M15V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC3P15V()
PURPOSE:
Return HK0 MC3 +15 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC3P15V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC3POS()
PURPOSE:
Return HK0 MC3 Encoder Value
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC3POS()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC3STAT()
PURPOSE:
Return HK0 MC3 Status (Byte 91)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC3STAT()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC4M15V()
PURPOSE:
Return HK0 MC4 -15 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC4M15V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC4P15V()
PURPOSE:
Return HK0 MC4 +15 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC4P15V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC4POS()
PURPOSE:
Return HK0 MC4 Encoder Value
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC4POS()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC4STAT()
PURPOSE:
Return HK0 MC4 Status (Byte 97)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC4STAT()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC5M15V()
PURPOSE:
Return HK0 MC5 -15 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC5M15V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC5P15V()
PURPOSE:
Return HK0 MC5 +15 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC5P15V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC5POS()
PURPOSE:
Return HK0 MC5 Encoder Value
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC5POS()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC5STAT()
PURPOSE:
Return HK0 MC5 Status (Byte 103)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC5STAT()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC6M15V()
PURPOSE:
Return HK0 MC6 -15 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC6M15V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC6P15V()
PURPOSE:
Return HK0 MC6 +15 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC6P15V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC6POS()
PURPOSE:
Return HK0 MC6 Encoder Value
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC6POS()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC6STAT()
PURPOSE:
Return HK0 MC6 Status (Byte 109)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC6STAT()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC8M15V()
PURPOSE:
Return HK0 MC8 -15 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC8M15V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC8P15V()
PURPOSE:
Return HK0 MC8 +15 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC8P15V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC8POS()
PURPOSE:
Return HK0 MC8 Encoder Value
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC8POS()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_MC8STAT()
PURPOSE:
Return HK0 MC8 Status (Byte 115)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_MC8STAT()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_RECTIME()
PURPOSE:
Get the SUMER HK0 Record compilation time in TAI
CATEGORY:
HK0 Decode
EXPLANATION:
SYNTAX:
Result = s_hk0_rectime(hk_record_array)
EXAMPLE:
INPUTS:
hk_record_array - SUMER HK0 byte_array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
errmsg - return Error Message
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, November 12, 2006, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_spub()
PURPOSE:
Return HK0 SPU Bank Registers (Byte 49)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_spub()
EXAMPLES:
INPUTS:
HK0 - HK) Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_spubsr()
PURPOSE:
Return HK0 SPU Bank Select Registers (Byte 46)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_spubsr()
EXAMPLES:
INPUTS:
HK0 - HK) Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_spuerr()
PURPOSE:
Return HK0 SPU Error Status Register (Byte 48)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_spuerr()
EXAMPLES:
INPUTS:
HK0 - HK) Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_STATUS0()
PURPOSE:
Return HK0 Status 0 (Byte 1)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_status0()
EXAMPLES:
INPUTS:
HK0 - HK) Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_STATUS1()
PURPOSE:
Return HK0 Status 1 (Byte 1)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_status1()
EXAMPLES:
INPUTS:
HK0 - HK) Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_STATUS2()
PURPOSE:
Return HK0 Status 2 (Byte 1)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_status2()
EXAMPLES:
INPUTS:
HK0 - HK) Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_STATUS3()
PURPOSE:
Return HK0 Status 3 (Byte 1)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_status3()
EXAMPLES:
INPUTS:
HK0 - HK) Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_STATUS4()
PURPOSE:
Return HK0 Status 4 (Byte 1)
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_status4()
EXAMPLES:
INPUTS:
HK0 - HK) Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_SYSCONFIG
PURPOSE:
Display SUMER Config Words in plain text
CATEGORY:
EXPLANATION:
S_HK0_SYSCONFIG displays the plain text meaning of'
the SUMER hk0 SysConfig Words of the first present'
HK0 record in the array. The others can be displayed'
by choosing the record position'
SYNTAX:
s_hk0_sysconfig,hk0 [,errmsg=errmsg]
EXAMPLES:
hk0=read_bin_hk0(date='9-Sep-2005')"
s_hk0_sysconfig,xx'
or to test the config words
sysword=['17'xb,'b9'xb,'fe'xb,'ff'xb,'ff'xb,'ff'xb,'ff'xb,'3f'xb,3a'xb] ;bytarr(9)
s_hk0_sysconfig,sysword
INPUTS:
HK0 - HK Byte Array (200,*) or bytarr(9)
OPTIONAL INPUTS:
position - position of hk0 record in array to be displayed
(default is position 0, first entry)
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
ermsg - Return Error Message if one
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, September 23, 2005, Dietmar Germerott, MPS Lindau. Written
CONTACT:
Dietmar Germerott, MPS Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_tdcm13v()
PURPOSE:
Return HK0 Detector TDC -13 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_tdcm13v()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_tdcm15v()
PURPOSE:
Return HK0 Detector TDC -15 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_tdcm15v()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_tdcm5v()
PURPOSE:
Return HK0 Detector TDC -5 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_tdcm5v()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_tdcp10v()
PURPOSE:
Return HK0 Detector TDC +10 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_tdcp10v()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_tdcp13v()
PURPOSE:
Return HK0 Detector TDC +13 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_tdcp13v()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_tdcp5v()
PURPOSE:
Return HK0 Detector TDC +5 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_tdcp5v()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
Version 1.1, November 10, 2006, Dietmar Germerott, MPAE Lindau
Corrected REFORM call
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_TDCPM5V()
PURPOSE:
Return HK0 Detector TDC +5 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_TDCPM5V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_tdpucu1()
PURPOSE:
Return HK0 Temperature DPU CU1 in deg C
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_tdpucu1()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_tdpucu2()
PURPOSE:
Return HK0 Temperature DPU CU2 in deg C
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_tdpucu2()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_tdpudcc()
PURPOSE:
Return HK0 Temperature DPU DCC in deg C
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_tdpudcc()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_tdpuebx()
PURPOSE:
Return HK0 Temperature DPU EBX in deg C
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_tdpuebx()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_TSUMER4()
PURPOSE:
Return HK0 SUMER4 Temperature in deg C Resolution 0.35 K
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_tsumer4()
EXAMPLES:
INPUTS:
HK0 - HK) Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_utc()
PURPOSE:
Return UTC of HK0 Packages
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_utc(hk0[,/EXTERNAL,/CCSDS,/ECS])
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
struct or string Array of dimension n
The result of the function will be the UTC calendar time in one
of several formats, depending on the keywords passed.
Internal: A structure containing the tags:
MJD: The Modified Julian Day number.
TIME: The time of day, in milliseconds since
the beginning of the day.
Both are long integers. This is the default
format.
External: A structure containing the integer tags
"18-JAN-1988 17:20:43.12", "18-JAN-1988 17:20:43.123"
"1988-01-18T17:20:43.123Z", "1988/01/18 17:20:43.123"
CCSDS: An ASCII string containing the UTC time to, DAY
ECS: Similar to CCSDS, HOUR, MILLISECOND., MINUTE, MONTH, None.
OPTIONAL OUTPUTS:, SECOND, STIME: The date and time has the format
See UTC2STR for more information.
VMS: The date and time has the format, YEAR, and, e.g.
except that the date has, for Space Data Systems (ISO 8601)
millisecond accuracy in the format
recommended by the Consultative Committee, the format:
Keywords : EXTERNAL = If set, then the output is in external format, as
explained above.
CCSDS = If set, then the output is in CCSDS format, as
explained above.
ECS = If set, then the output is in ECS format, as
explained above.
VMS = If set, then the output will be in VMS format, as
described above.
STIME = If set, then the output will be in STIME format, as
described above.
The following keywords are only valid if one of the string
formats is 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 handled by the IDL MESSAGE
utility. 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 = ''
RESULT = UTC_HEAD( head, ERRMSG=ERRMSG )
IF ERRMSG NE '' THEN ...
CALLS: ***
OBT2TAI, TAI2UTC
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, January 7, 1999, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_VBB1M18V()
PURPOSE:
Return HK0 Voltage VBB1 -18 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_VBB1M18V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_VBB2M18V()
PURPOSE:
Return HK0 Voltage VBB2 -18 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_VBB2M18V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_VBBRSCM15V()
PURPOSE:
Return HK0 RSC -15 V VBB Voltage
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_vbbrscm15v()
EXAMPLES:
INPUTS:
HK0 - HK) Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_VBOARDP28V()
PURPOSE:
Return HK0 Voltage Board +28 V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_VBOARDP28V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_VCCP5V()
PURPOSE:
Return HK0 Voltage Board +5 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_VCCP5V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_VDD1P18V()
PURPOSE:
Return HK0 Voltage Board +18 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_VDD1P18V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_VDD2P18V()
PURPOSE:
Return HK0 Voltage VDD2 +18 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_VDD2P18V()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_vddrscp15v()
PURPOSE:
Return HK0 Voltage VDDRSC +15 V in V
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_vddrscp15v()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_XEVENT()
PURPOSE:
Return HK0 MC1 Encoder Value
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_XEVENT()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_XPHA()
PURPOSE:
Return HK0 Detector XPHA as Bytarr (12,*)
CATEGORY:
EXPLANATION:
This Routine Returns the XPHA as BYTARR(12,*)
displaying the PHA distribution do:
PLOT,HISTOGRAM(S_HK0_XPHA(hk0_array))
SYNTAX:
Result = s_hk0_XPHA()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_YEVENT()
PURPOSE:
Return HK0 MC1 Encoder Value
CATEGORY:
EXPLANATION:
SYNTAX:
Result = s_hk0_YEVENT()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_HK0_YPHA()
PURPOSE:
Return HK0 Detector YPHA as Bytarr (12,*)
CATEGORY:
EXPLANATION:
This Routine Returns the YPHA as BYTARR(12,*)
displaying the PHA distribution do:
PLOT,HISTOGRAM(S_HK0_YPHA(hk0_array))
SYNTAX:
Result = s_hk0_YPHA()
EXAMPLES:
INPUTS:
HK0 - HK0 Byte Array (200,*)
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
Timeline - Return the timeline for plotting
ermsg - Return Error Message if one
CALLS: ***
OBT2TAI
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 9, 1998, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
S_MC2POSFIT
PURPOSE:
Print the expected SUMER MC2 Encoder / Step Position
CATEGORY:
EXPLANATION:
SYNTAX:
s_mc2posfit, inpos
EXAMPLES:
s_mc2posfit, inpos,/step
prints Encoder Position for Step position inpos
s_mc2posfit, inpos,/enco
prints Step Position for Encoder position inpos
INPUTS:
inpos - either Pointing Coordinates or Steps
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
STEP_ - indicates that inpos is in Steps
OUTPOS - Return the Encoder Values
P_CENTER - Set Pointing Center (default is 5830)
P_SLOPE - Set Pointing Slope (default is 2.66876)
ENCODER_ - indicates that input is Encoder Value
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, March 13, 2000, Dietmar Germerott, MPAE Lindau. Written
CONTACT:
Dietmar Germerott, MPAE Lindau (germerott@linmpi.mpg.de)
[Previous]
[Next]
Project:
SOHO - SUMER
Name: sa_gt_specrange
Purpose:
Enables user to select spatial ranges from a sumer reference spectrum
Use:
SpecRange=sa_gt_specrange('data3$disk:[fits]SUM_960126_022347.FITS')
Inputs:
Filename - name of FITS file containing reference spectrum.
The first scan in the file will be shown and only
the data from the KBr coated part of the detector.
Outputs:
Array of dimentions 2 x N, where N is the number of ranges selected.
Calls: ***
XLOADCT [1], XLOADCT [2], XLOADCT [3], rd_sumer [1], rd_sumer [2], sgt_detector
sgt_dims
CALLED BY:
smk_atlas
Common:
None
Written:
Terry Kucera, 27 Feb 1996
Modifications
Changed to use rd_sumer rather
than ft_sumread_fits 13 Nov 1996
Added BLOCK keyword to xloadct call 15 Sep 1999
[Previous]
[Next]
Name: saa_in
Purpose: boolean - is input time in SAA? Use Yohkoh ephemeris OR/AND RBM
Input Paramters:
index - Yohkoh index record (roadmap ok, but cant check RBM)
Keyword Parameters:
rbm_only - just check rbm veto flag
fem_only - just check FEM file (via tim2orbit,saa=saa)
rbm_and_fem - if set, do logical AND of FEM and RBM (default is OR)
Restrictions - need to handle flares in rbm_status
CALLS: ***
MASK, str_is [1], str_is [2], tim2orbit [1], tim2orbit [2]
CALLED BY:
QUICKDARK [2], chk_pointing, may_eclipse, mk_sdc [2], mk_sdc [3], mk_sdc [4]
mk_sff_pair [1], mk_sff_pair [2]
History:
8-Sep-1993 (SLF) - Written
8-Jul-1994 (SLF) - Return ephem saa if roadmap, just print warning
[Previous]
[Next]
NAME:
sat_obs_loc
PURPOSE:
To return the location of a saturated point source.
INPUT:
img - a single image or array of images
OUTPUT:
x - The x location in pixels
y - The y location
CALLS: ***
PAUSE [1], SUMCOL [1], SUMCOL [2], SUMROW [1], SUMROW [2], SUMROW [3], pause [2]
CALLED BY:
mdidust
OPTIONAL KEYWORD INPUT:
qplot - If set, display plots of the summed rows/columns
METHOD:
It assumes that there is some scatter and that if you
add up all of the line you can find the x location, and
the same is true for adding the columns and finding
the y location
HISTORY:
Written 4-Apr-94 by M.Morrison
27-Apr-94 (MDM) - Patch to work on MDIBBS (??) - segment
fault at "total" line.
[Previous]
[Next]
Name: sav_string
Purpose: save string to xdr file for Yohkoh !path, documentation, filemaps
Input Parameters:
infile - filename of file to write
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], concat_dir [4]
NOTE: by default, the extention .strx is forced
string - string variable to save
Optional Keyword Parameters:
Method:
special files contain a single string (but the string may be long)
in XDR format for transporability
Calling Sequence:
sav_string, string, infile [,type=type] [,/path] [,/doc] [,/refdata]
Categories:
swmaint, file i/o, gen, util
Notes:
The pair of routines [sav_string/get_string] were developed to allow
saving and restoring of several yohkoh parameters (ex: !path) to help
manage the Yohkoh idl environment but they are generic in nature and
other uses may be considered. They can be used in conjunction with
arr2str and str2arr to allow storing of string 'arrays'
History: slf, 30-July-92
slf, 22-Jul-93 (use SITE instead of GEN)
[Previous]
[Next]
Project : SOHO - CDS
Name : SAVE_CDS_ADEF
Purpose : Save a CDS Analysis Definition (ADEF)
Explanation : Saves the contents of a CDS ADEF to the file name found in the
ADEF structure (ADEF.FILENAME). If the file name is empty, or
if the keyword SAVE_AS is set, the user is prompted (by
pickfile) for the file name. The FILENAME tag of the ADEF will
be updated to reflect the actual file name where the data were
saved.
Use : SAVE_CDS_ADEF,ADEF
Inputs : ADEF : CDS ANALYSIS DEFINITION structure.
Opt. Inputs : None
Outputs : None
Opt. Outputs: None.
Keywords : VERBOSE : Propagated to the SAVE command.
SAVE_AS : Set to prompt the user for a file name.
Calls : ***
BIGPICKFILE, BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CDS_ADEF_PARSEFILE
CHK_DIR [1], CHK_DIR [2], DEFAULT, TEST_OPEN, break_file [4]
CALLED BY:
XCDS_ANALYSIS
Common : None
Restrictions: Needs widgets to prompt the user.
Side effects: Modifies ADEF.FILENAME
Category : QuickLoook,Analysis
Prev. Hist. : None
Written : SVH Haugan, UiO, 25 September 1997
Modified : Not yet.
Version : 1, 25 September 1997
[Previous]
[Next]
Name: save_data
Purpose: save data(images and text descriptions as widget user values.
an index is maintained to allow queue type operation
Input Parameters:
data - data set to save
descrip - string descriptor - for SolarA, probably -idx2list
put - could be fileid and string indicating indices
str - any other associated data - for SolarA, is probably
structure or array of structures defining data
Original intent of three input arguments was to allow association
of 1, 2, or 3 data sets under a single index
**** update to return structure
Can be used for non-images (cubes, other things, etc)
CALLS:
CALLED BY
sda_look [1]
[Previous]
[Next]
Name: save_data
Purpose: save relavent roadmap and roadmap derived data
as widget uvalues for communicaton between widgets
CALLS:
CALLED BY
sda_look [1]
[Previous]
[Next]
Project : SOHO - CDS
Name : SAVE_QLDS
Purpose : Save a QLDS to an IDL save-file.
Explanation : With the new storage scheme using handles it's impossible to
simply use the SAVE command to store all the data in a QLDS
with just one simple statement. This routine (together with
the function QLDS_RESTORE) provides a simple interface to save
and restore Quick Look Data Structures.
By default, the /XDR switch to SAVE is used, to enable
platform-independent save files under VMS. This can be turned
off by setting XDR=0.
If the QLDS has been read in with the old storage system, the
whole QLDS is simply SAVEd.
Use : SAVE_QLDS,QLDS [ ,FILENAME=FILENAME ]
Inputs : QLDS : Quick Look Data Structure
Opt. Inputs : FILENAME : Name of file to store the QLDS in. Default is the
file name (e.g., 's3300r00') plus extension
'.qlsave'.
Outputs : None.
Opt. Outputs: None.
Keywords : XDR : Set to zero to avoid XDR format on VMS.
Calls : ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], DEFAULT, TAG_EXIST [1]
TAG_EXIST [2], TRIM, break_file [4]
Common : None.
Restrictions: Only handles 60 data windows.
Side effects: None known.
Category : Data_Handling, I_O, Quicklook.
Prev. Hist. : None.
Written : Stein Vidar H. Haugan (UiO), 3 October 1996
Modified : Not yet.
Version : 1, 3 October 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : SAVE_WAVECAL()
Purpose : Returns wavecal from common block for temporary storage
Explanation : In some circumstances a routine may wish to temporarily load
a wavecal into the wavecal common block and to restore the
original calibration when it has finished. This function
retrieves the common block entries. Use LOAD_WAVECAL with
the cal_struct keyword for the reverse process.
Use : IDL> wcal = save_wavecal(detector)
Inputs : detector - either 'NIS' or 'GIS' (can be abbreviated)
Opt. Inputs : None
Outputs : Function returns either NIS or GIS wavecal structure from
common block.
Opt. Outputs: None
Keywords : None
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3]
CALLED BY:
MK_RASTER, UPDATE_DEX
Common : CDS_WAVECAL
Restrictions: None
Side effects: None
Category : Data analysis, wavelength calibration
Prev. Hist. : None
Written : C D Pike, RAL, 14-Mar-96
Modified :
Version : Version 1, 14-Mar-96
[Previous]
[Next]
Name: saveenv
Purpose: save current environment (UNIX environmentals/VMS logicals)
(for temporary change and later restoration via restenv.pro)
History:
9-Jan-1994 (SLF)
Method:
calls get_logenv.pro to return envrionment
CALLS: ***
get_logenv [1], get_logenv [2]
Common Blocks:
saveenv_blk (store environmentals and translation)
Assumptions/Restrictions
[Previous]
[Next]
NAME: savegen
Purpose: save user specified parameters (idl variables) in a generic file
[front end to wrt_genx - files are restored via savegen.pro]
Input Parameters:
p1, p2, p3... p15 - idl variables to save
Optional Keyword Parameters
file - file name for save - default is 'save.genx' in current direct
if name is supplied and notype keyword is not set, the
actual file name used will have .genx appended
names - strarr or delimited string containg saved variable names -
number elements in array (or expanded array) should equal
the number of input parameters - Use to document saved names
text - string or string array describing file (for user internal
documentation)
notype - if set, inhibits default file type assignment
by default, filename=file+'.gen' for non xdr and
filename=file+'.genx' for xdr format
replace - [note: version 1.0 replace is default]
xdr - [note: version 1.0 and greater is always xdr]
Calling Sequence:
savegen,v1 [,v2, v3..., v15, name=name, file=file, text=text]
Calling Examples: [file name]
savegen, spectra , times, file='spec_01' 'spec_01.genx'
savegen, temp, EM, index(3:4), text=info_array(3:4), $ 'save.genx'
names=['temp', 'EM']
savegen, pimage,infil,ss, file='sxt_kp', $ 'sxt_kp.genx'
text=['SXT:KP Mag Overlay',info_array(4:5)], $
CALLS: ***
BUILDGEN, STR2ARR [1], STR2ARR [2], WRT_GENX [1], WRT_GENX [2]
CALLED BY:
CH_SYNTHETIC, EIS_LIST_EXPER [1], EIS_LIST_EXPER [2], EIS_LIST_MAIN [1]
EIS_LIST_MAIN [2], GE_WINDOW [1], GOES_TF, GOES_TF_COEFF
HW_SYNSPEC__DEFINE defines the class HW_SYNSPEC Objects of this [1]
HW_SYNSPEC__DEFINE defines the class HW_SYNSPEC Objects of this [2]
MAKE_GOES_RESP, MK_MER_CONT, MK_SUMER_DBASE, RATIO_PLOTTER [1], UPDATE_KAP
UPDATE_TERM, XCDS_BOOK, XCPT, atr2hxa_dbase, av_dt_genx, ccd_sunc [1], ccd_sunc [2]
ch_ss, eit_genx_cat, eit_proton_summary, fl_goesplot [1], fl_goesplot [2]
fl_goesplot [3], fl_suntoday [1], fl_suntoday [2], fl_suntoday [3]
fl_sxtobsnar [1], fl_sxtobsnar [2], genx_newver [1], genx_newver [2]
hsi_spectrum__filewrite, hsi_spectrum__genxwrite, jitter_gif_xyimg
make_goes_chianti_response [1], make_goes_chianti_response [2]
make_goes_chianti_response [3], make_goes_chianti_response [4]
mk_mapfile [1], mk_mapfile [2], mk_mo_log, mk_pix [1], mk_pix [2], mk_sdmi
mk_soup_hcat, msok_poi_copy [1], msok_poi_copy [2], ratio_plotter [2]
rd_dpc_table, res_freq, search_obs, sun_today [1], sun_today [2], sun_today [3]
sxt2file, sxt_etemp, sxt_mornint, sxt_summary, synop_movie, timeline, topsdb [1]
topsdb [2], trace_last_movie [1], trace_last_movie [3]
trace_special_movie [1], trace_special_movie2, video_title, web_seq
write_genxcat, xr_mk_abun_file, xsearch_obs, xset_chain [1], xset_chain [2]
History:
30-oct-91 - SLF (originally for Calibration files)
8-Nov-91 - MDM Expanded from 10 to 15 parameters
15-Apr-93 - SLF file name updates (dont clobber input)
16-Mar-93 - SLF - add struct input keyword
24-Mar-93 - SLF - update documentation and 'unclutter'
30-Mar-93 - SLF - error check positional paramter(0)
31-Mar-93 - SLF - allow names keyword to be delimited string
some documentation upgrades
Hints - if you intend on keeping a file around, it pays to include
internal documentation which will jog your memory later. The simplest
method is to supply a string or string array via the TEXT keyword.
You could save additional documentation via additional input paramters.
For example, if you journal your idl session while creating a final
data product, you could pass that in as internal documentation.
For this, you could use the generic text reader <rd_tfile.pro> to
transform the journal file to a string array - this could then
be passed in as a positional parameter (or via keyword TEXT)
For example, the following call might save an image, an index record,
reformated file info, and the journal file used during image creation:
savegen, fltimage, index, fileid, rd_tfile('idlsave.pro'), $
text='Nobel Candidate', file='apj_fig1'
An additional level of internal documentation is available through
the use of the NAMES keyword - you should use this if you desire to
retain the actual names used in the call to savegen.
EX: (may use X-cut and paste of call sequence)
savegen,index,data,info_array,names='index,data,info_array'
|-------cut---------| |----- paste -------|
Use of savegen/restgen pair (simple example):
savegen,v1,v2,v3 ; saves user variables v1,v2,v3 in 'save.genx'
restgen,a,b,c ; restores them (now named a,b,c)
To verify your file after writing, use restgen inquire option:
restgen,/inquire [,/nodata] ; displays summary of 'save.genx' contents
[Previous]
[Next]
Name: savesys
Purpose: save idl system variables for later restoration via restsys
(variables saved in yohkoh system variable: !ys_idlsys_temp)
Input Keyword Parameters:
all - if set, save all (writeable) idl system variables
aplot - if set, save all plot related variables (!x,!y,!z,!p)
x,y,z - if set, save specified axis variable (!x, !y, and/or !z)
c,order,map,more - save associated system variable(s)
Calling Examples:
savesys,/x,/y ; save !x, !y
savesys,/p ; save !p
savesys,/aplot ; save !x,!y,!z,!p
savesys,/all ; save above plus some others (!c, !map..)
Generally, a routine would use this routine paired with restsys.pro
pro junk,a,b,c
savesys,/aplot ; save plot variables
<change !x,!y,!p> ; routine plays with global variables
restsys,/aplot ; restore plot values
return
CALLED BY:
DRAW_GRID [1], DRAW_GRID [2], HSI_CWTOOLS_LINESET, HSI_FORWARDFIT, NORH_GRID [1]
NORH_GRID [2], PLOT_CLON, POLAR_GRID, SXT_GRID [1], SXT_GRID [2], SXT_GRID [3]
TV_SYNOP, event_movie [1], event_movie [2], goes_summary, goes_widget, last_lc
lcur_image, plot_nar [1], plot_nar [2], sun_grid
Side Effects:
def_yssysv.pro is called if it has not been done already to define
Yohkoh system variables
CALLS: ***
def_yssysv [1], def_yssysv [2]
Common Blocks:
def_yssysv_blk - determine if Yohkoh system variables are defined
History:
21-Apr-1993 (SLF)
22-apr-1993 (SLF) ; remove !more references
[Previous]
[Next]
NAME:
SC
PURPOSE:
To convert a numerical value in a string cutting all
trailing blanks (performed with STRCOMRESS)
CATEGORY:
PICO
CALLING SEQUENCE:
result=SC(value)
INPUTS:
value: The numerical value to be converted into a
string. This might also be a vector (one
dimensional array)
OPTIONAL INPUTS:
None
KEYWORD PARAMETERS:
DECIMALS: gives the number of decimals returned in
the string. Numbers are rounded.
SIGNIFICANT: gives the number of significant digits.
The number of decimals is automatically de-
termined.
FIELD: The number of characters in the output string
result. If the number can not be displayed
with the number of characters, asterisks are
returned (as in FORTRAN); If field is greater
than the number of characters, blanks are added
in front of the string so that the string
always ends with a character.
OUTPUTS:
result: The string without any leading or trailing
blank
OPTIONAL OUTPUTS:
None
EXAMPLE:
To print the result of a calculation execute
print,'The result is: '+SC(result,DEC=3)
Or: print a number with a width of 5 characters:
print, SC(13,FIELD=5) -> ' 13'
print, SC(100000,FIELD=3) -> '**'
COMMON BLOCKS:
None
SIDE EFFECTS:
Unknown
RESTRICTIONS:
None
PROCEDURE:
Straightforward. For Vectors recursive calls are
executed
MODIFICATION HISTORY:
Alo Epple, 31-AUG-1994
Extension for vectors 4-MAY-1995 MPAe Lindau
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
SC_CRE_POP_TRT, event
PURPOSE:
UDP creation
CATEGORY:
SC_SUMER
SYNTAX:
sc_cre_pop_trt [, event]
INPUTS:
None.
OPTIONAL INPUTS:
EVENT - Event structure from SC_SUMER
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
Too many to mention
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, June 8, 1995, Emmanuel Petit, IAS. Written
Version 2, May 13, 1996, Liyun Wang, NASA/GSFC
Added filename confliction check
Version 3, August 7, 1996, Liyun Wang, NASA/GSFC
Started using the new technical simulator
Version 4, August 26, 1996, Liyun Wang, NASA/GSFC
Modified such that .OBJ and .SCL files are copied to the UDP
directory only when POP/UDP is registered in the DB
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
SC_MNG_POP_SIM
PURPOSE:
Manage POP/UDP simulation
CATEGORY:
SC_SUMER
SYNTAX:
sc_mng_pop_sim, err
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
ERR - Error flag. 0: successful, otherwise: failed
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
Too many to mention
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, August 24, 1994, Emmanual Petit, IAS. Written
Version 2, September, 28, 1994, Emmanual Petit, IAS
Added common blocks
Version 3, November 3, 1994, Emmanual Petit, IAS
Added simu call
Version 4, January 24, 1996, Nicolas Morisset, IAS
Added current_det parameter for I_SIM7
Version 5, August 7, 1996, Liyun Wang, NASA/GSFC
Started using new technical simulator
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
SC_MNG_STD_SIM
PURPOSE:
Manage study simulation
CATEGORY:
SC_SUMER
SYNTAX:
sc_mng_std_sim, err
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
ERR - Error flag. 0: successful, otherwise: failed
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
Too many to mention
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, May 15, 1995, Emmanuel Petit. Written
Version 2, January 24, 1996, Nicolas Morisset, IAS
Added current_det parameter for I_SIM7
Version 3, June 12, 1996, Liyun Wang, GSFC/ARC
Converted some time and point related parameters into the
right units before calling technical simulator
Version 4, August 7, 1996, Liyun Wang, NASA/GSFC
Started using new technical simulator
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
SC_MNG_TKI_SSIM
PURPOSE:
Manage sequence simulation
CATEGORY:
SC_SUMER
SYNTAX:
sc_mng_tki_ssim, err
EXAMPLES:
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
ERR - Error flag. 0: successful, otherwise: failed
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
Too many to mention
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, July 4, 1995, Emmanuel Petit, IAS. Written
Version 2, January 24, 1996, Nicolas Morisset, IAS
Added current_det parameter for I_SIM7
Version 3, August 6, 1996, Liyun Wang, NASA/GSFC
Started using the new technical simulator
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
SC_TKI_INIT
PURPOSE:
Set up some TKI parameters based on SC_SUMER status
CALLING SEQUENCE:
SC_TKI_INIT
INPUTS:
None.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORD PARAMETERS:
None.
CALLED BY:
ST_SUMER, ST_TKI_INIT
COMMON BLOCKS:
SC_COM, @TKI_COMMON_SHARE
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
PREVIOUS HISTORY:
Written March 4, 1996, Liyun Wang, GSFC/ARC
MODIFICATION HISTORY:
Version 1, Liyun Wang, GSFC/ARC, March 4, 1996
VERSION:
Version 1, March 4, 1996
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
SC_UPDATE_STATUS()
PURPOSE:
Return status of database update status
CATEGORY:
Database, planning
SYNTAX:
Result = sc_update_status()
INPUTS:
Noe required
OPTIONAL INPUTS:
NODE_NAME - Node name (applicable only to VMS system)
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
USER - Name of current IDL user; Default: sys$login
SITE - A named variable containing name of the operations site
CALLED BY:
ST_SUMER
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, May 12, 1997, Liyun Wang, NASA/GSFC. Written
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
NAME:
SCALE_ROTATE
PURPOSE:
This function moves, scales and rotates an
image to a new position and plate scale
factor.
CATEGORY:
ANALYSIS
CALLING SEQUENCE:
Result = SCALE_ROTATE (Img,Roll,
Oldscale,Xcen,Ycen,
Newscale,Newxcen,Newycen)
INPUTS:
Img: Input image array
Roll: Angle between solar north and the top
of the image measured eastward (radians)
Oldscale: Plate scale (arc sec/pixel) of input image
Xcen: Column of sun center of input
Ycen: Row of sun center of input
Newscale: Plate scale (arc sec/pixel) of output image
Newxcen: Column of sun center to move to
Newycen: Row of sun center to move to
OPTIONAL INPUTS:
None
KEYWORD PARAMETERS:
Xsize: Number of columns in output image
Default is input image
Ysize: Number of rows in output image
Default is input image
OUTPUTS:
Result: The scaled and rotated image
OPTIONAL OUTPUTS:
None
COMMON BLOCKS:
None
SIDE EFFECTS:
None
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
MODIFICATION HISTORY:
Written by: RA Howard, NRL, 27 Nov 1995.
@(#)scale_rotate.pro 1.2 05/14/97 :NRL Solar Physics
[Previous]
[Next]
Project : SOHO - LASCO
Name :
Purpose :
Category :
Explanation :
Syntax :
CALLED BY:
WC2P, mk_minim, mk_stdim, mk_stdim_list
Examples :
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
CALLS: ***
SXADDPAR [1], SXADDPAR [2], SXADDPAR [3], WFLIMB, chk_h4s
Common :
Restrictions:
Side effects: Not known
History : Version 1, 02-Sep-1995, B Podlipnik. Written
Contact : BP, borut@lasco1.mpae.gwdg.de
[Previous]
[Next]
NAME: SCAN_PROFILE
PURPOSE:
This function returns the values of the Img in a straight line between
the end points specified by P0 and P1.
CATEGORY:
LASCO ANALYSIS
CALLING SEQUENCE:
Result = SCAN_PROFILE(Img,P0,P1,Col,Row)
INPUTS:
Img: A 2-D array containing the image intensities
P0: A 2 element array containing the column and row
values of one of the end points
P1: A 2 element array containing the column and row
values of the other end point
OUTPUTS:
Result: An array containing the scan profile from P0 to P1
OPTIONAL OUTPUTS:
COL: An array containing the image column values,
where the Function result has been computed.
ROW: An array containing the image row values,
where the Function result has been computed.
MODIFICATION HISTORY:
Written by: RA Howard, 17 Mar 1996
@(#)scan_profile.pro 1.2 05/14/97 :NRL Solar Physics
[Previous]
[Next]
NAME:
SCAN_SC_HDR
PURPOSE:
This procedure identifies the subpacket headers in the science packets
CATEGORY:
LASCO PACKETS
CALLING SEQUENCE:
SCAN_SC_HDR,Sc
INPUTS:
Sc: A 2D byte array of the packet data as read in by
READ_TM_PACKET
OUTPUTS:
This procedure writes the subpacket information to a file in
the current directory. The file name is scan_YYYY-MM-DD,
where the date is today's date.
CALLS: ***
GET_UTC, OBT2TAI, TAI2UTC, UTC2STR
PROCEDURE:
The science packet is scanned for the 4-byte subpacket headers.
The first byte is the number of 2-byte data words in the
subpacket. The second byte is the subpacket type. The
packet data are only valid when the OBE is running. WHen
OBE is not running the packets will contain 'FF'X.
MODIFICATION HISTORY:
Written by: R.A. Howard, NRL, 1993
Sep, 1999 RAH, The input data is now a byte array
@(#)scan_sc_hdr.pro 1.4 09/08/99 LASCO IDL LIBRARY
[Previous]
[Next]
Project:
SOHO - SUMER
Name:
SCONV_TAGNAMES
Purpose:
Formulate new wavelength tagnames for sumer index and data structures.
Use:
res = sconv_tagnames(waves,bte)
Inputs:
Index - A list of wavelengths, either number or string
Output:
If WAVES is an array of numbers, outputs array of strings. If
input is string with the same format as a wavelength tagname,
it will output a floating point array of wavelengths. (This
is mostly redundant with sgt_refval)
Optional Input/Output
BTE - a list of binary table extension numbers. An input is WAVES is
a list of numbers, an output if WAVES is an array of strings.
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3]
CALLED BY:
SGT_NEWREF, SUM_XINPUT
Common:
None
Written:
Terry Kucera, 14 Aug 1996
[Previous]
[Next]
Project : SOHO - CDS
Name :
SCR_ATTRIB
Purpose :
Set screen attributes to those given, in the given order.
Explanation :
To set the screen attribute to those given, in the given order.
A string containing the appropriate DEC terminal command is put
together and printed. NOTE: In general, the DEC commands correspond
to the ANSI escape sequences.
Use :
scr_attrib [, a1, a2, a3, a4, a5]
Inputs :
a1 - a5 -- The attribute codes. The attributes are set in the
command string in the given order. Thus, if a1 turns
the attributes off and a2 sets reverse video, the final
attribute will reset and then set to reverse video. If
the order were reversed, then the current attribute
would have reverse video added to it, and then would be
reset, leaving the terminal with all attributes off. Up
to five attribute codes may be specified. The codes are:
0 : all attributes off (default)
1 : bold on
2 : underscore on
3 : blink on
4 : reverse video on
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
SELECT_O [1], SELECT_O [2], SELECT_O [3]
Common : None.
Restrictions:
This procedure will only work with DEC compatible equipment (or
terminal emulators).
Side effects: None.
Category : Utilities, User_interface
Prev. Hist. :
Written by Michael R. Greason, STX, May 1990.
Written : Michael R. Greason, GSFC/UIT (STX), May 1990
Modified : Version 1, William Thompson, GSFC, 29 March 1994
Incorporated into CDS library
Version : Version 1, 29 March 1994
[Previous]
[Next]
Project : SOHO - CDS
Name :
SCR_CHARSET
Purpose :
To change the character sets.
Explanation :
To change the character sets.
A string containing the appropriate DEC terminal command is put
together and printed. NOTE: In general, the DEC commands correspond
to the ANSI escape sequences.
Use :
scr_charset [, g, cset]
Inputs :
g -- The terminal character set to change (either 0, for the
G0 designator, or 1, for the G1 designator). 0 = default.
cset -- The character set to use:
0 : United Kingdom.
1 : United States (USASCII) -- default.
2 : Special graphics characters and line drawing set.
3 : Alternate character ROM.
4 : Alternate character ROM special graphics chars.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : None.
Common : None.
Restrictions:
This procedure will only work with DEC compatible equipment (or
terminal emulators).
Side effects: None.
Category : Utilities, User_interface
Prev. Hist. :
Written by Michael R. Greason, STX, May 1990.
Written : Michael R. Greason, GSFC/UIT (STX), May 1990
Modified : Version 1, William Thompson, GSFC, 29 March 1994
Incorporated into CDS library
Version : Version 1, 29 March 1994
[Previous]
[Next]
Project : SOHO - CDS
Name :
SCR_CURMOV
Purpose :
Moves the cursor relative to its original position.
Explanation :
To move the cursor around the screen relative to its original position.
A string containing the appropriate DEC terminal command is put
together and printed. NOTE: In general, the DEC commands correspond
to the ANSI escape sequences.
Use :
scr_curmov [, cmd, n]
Inputs :
cmd -- An integer indicating the direction in which to move the curs.
0 : Up
1 : Down (Default)
2 : Left
3 : Right
n -- The number of spaces to move the cursor. If not specified
(or if less than or equal to zero), this is set to one.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
CURS
Common : None.
Restrictions:
This procedure will only work with DEC compatible equipment (or
terminal emulators).
Side effects: None.
Category : Utilities, User_interface
Prev. Hist. :
Written by Michael R. Greason, STX, May 1990.
Written : Michael R. Greason, GSFC/UIT (STX), May 1990
Modified : Version 1, William Thompson, GSFC, 29 March 1994
Incorporated into CDS library.
Version : Version 1, 29 March 1994
[Previous]
[Next]
Project : SOHO - CDS
Name :
SCR_CURPOS
Purpose :
Positions the cursor at the specified screen location.
Explanation :
To position the cursor at the specified screen location. Unspecified
coordinates are set to one. Please note that the ESCAPE sequence
expects the coordinates to be counted from (1,1).
A string containing the appropriate DEC terminal command is put
together and printed. NOTE: In general, the DEC commands correspond
to the ANSI escape sequences.
Use :
scr_curpos [, lin, col]
Inputs :
lin -- The screen line coordinate.
col -- The screen column coordinate.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
SELECT_O [1], SELECT_O [2], SELECT_O [3]
Common : None.
Restrictions:
This procedure will only work with DEC compatible equipment (or
terminal emulators).
Side effects: None.
Category : Utilities, User_interface
Prev. Hist. :
Written by Michael R. Greason, STX, May 1990.
Written : Michael R. Greason, GSFC/UIT (STX), May 1990
Modified : Version 1, William Thompson, GSFC, 29 March 1994
Incorporated into CDS library
Version : Version 1, 29 March 1994
[Previous]
[Next]
Project : SOHO - CDS
Name :
SCR_ERASE
Purpose :
To erase portions of the terminal screen.
Explanation :
To erase portions of the terminal screen.
A string containing the appropriate DEC terminal command is put
together and printed. NOTE: In general, the DEC commands correspond
to the ANSI escape sequences.
Use :
scr_erase [, cmd]
Inputs : None.
Opt. Inputs :
cmd -- An integer telling the procedure what part of the screen to
erase. If not specified, it is set to 5. Key:
0 : From cursor to end-of-line.
1 : From beginning-of-line to cursor.
2 : Entire line containing cursor.
3 : From cursor to end-of-screen.
4 : from beginning-of-screen to cursor.
ELSE : Entire screen.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
SELECT_O [1], SELECT_O [2], SELECT_O [3]
Common : None.
Restrictions:
This procedure will only work with DEC compatible equipment (or
terminal emulators).
Side effects: None.
Category : Utilities, User_interface
Prev. Hist. :
Written by Michael R. Greason, STX, May 1990.
Written : Michael R. Greason, GSFC/UIT (STX), May 1990
Modified : Version 1, William Thompson, GSFC, 29 March 1994
Incorporated into CDS library
Version : Version 1, 29 March 1994
[Previous]
[Next]
Project : SOHO - CDS
Name :
SCR_OTHER
Purpose :
To allow the user to issue any ESCAPE sequence.
Explanation :
To allow the user to issue any ESCAPE sequence.
A string containing the appropriate DEC terminal command is put
together and printed. NOTE: In general, the DEC commands correspond
to the ANSI escape sequences.
Use :
scr_other, str
Inputs :
str -- A string containing the escape sequence. The initial ESCAPE
should not be included; this will be added by this procedure.
This parameter is NOT optional; if not available, the
procedure will return without doing anything.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
SELECT_O [1], SELECT_O [2], SELECT_O [3]
Common : None.
Restrictions:
This procedure will only work with DEC compatible equipment (or
terminal emulators).
Side effects: None.
Category : Utilities, User_interface
Prev. Hist. :
Written by Michael R. Greason, STX, May 1990.
Written : Michael R. Greason, GSFC/UIT (STX), May 1990
Modified : Version 1, William Thompson, GSFC, 29 March 1994
Incorporated into CDS library
Version : Version 1, 29 March 1994
[Previous]
[Next]
Project : SOHO - CDS
Name :
SCR_RESET
Purpose :
To reset the terminal.
Explanation :
To reset the terminal.
A string containing the appropriate DEC terminal command is put
together and printed. NOTE: In general, the DEC commands correspond
to the ANSI escape sequences.
Use :
scr_reset
Inputs : None.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : None.
Common : None.
Restrictions:
This procedure will only work with DEC compatible equipment (or
terminal emulators).
Side effects: None.
Category : Utilities, User_interface
Prev. Hist. :
Written by Michael R. Greason, STX, May 1990.
Written : Michael R. Greason, GSFC/UIT (STX), May 1990
Modified : Version 1, William Thompson, GSFC, 29 March 1994
Incorporated into CDS library
Version : Version 1, 29 March 1994
[Previous]
[Next]
Project : SOHO - CDS
Name :
SCR_SCROLL
Purpose :
Defines the scrolling area on the screen.
Explanation :
To define the scrolling area on the screen. Please note that the
line coordinates should be counted from 1.
A string containing the appropriate DEC terminal command is put
together and printed. NOTE: In general, the DEC commands correspond
to the ANSI escape sequences.
Use :
scr_scroll [, top, bot]
Inputs :
top -- The line to be the top of the scrolling area.
The default value is 1 and the maximum value is 23.
bot -- The line to be the bottom of the scrolling area.
The default value is 24 and the minimum value is 2.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : None.
Common : None.
Restrictions:
This procedure will only work with DEC compatible equipment (or
terminal emulators).
Side effects:
NOTE: The screen coordinate system is NOT effected. (1,1) is not
the top of the scrolling area but the top of the screen.
Category : Utilities, User_interface
Prev. Hist. :
Written by Michael R. Greason, STX, May 1990.
Written : Michael R. Greason, GSFC/UIT (STX), May 1990
Modified : Version 1, William Thompson, GSFC, 29 March 1994
Incorporated into CDS library
Version : Version 1, 29 March 1994
[Previous]
[Next]
Name: scratch
Purpose: manage scratch files (names, auto-delete, units,...)
(compatible with VMS/Unix)
Input Parameters:
u0, u1, ... u9 ;if defined on input, log units to close and delete
Output Parameters:
u0, u1, ... u9 ;if undefined, logical units assigned during open
Keyword Parameters:
nodelete - (input) dont delete on close (default is to delete)
cleanup - (input) deletes all scratch generated files (even old stuff)
open - (input) force open mode (default if u0 present and undefined)
close - (input) force close mode (default if u0 present and defined)
names - (output) scratch file names acted upon (open/close/delete)
file - (input) use this name, not system derived
Calling Sequence:
scratch,u1,u2,u3 ; if parameters undefined, open 3 scratch files
; if parameters defined, close/delete files
Calling Examples:
scratch, u1, u2, u3, /open ; open 3 files, return luns in u1, u2, u3
scratch, u1, u2, /close ; close and delete files open w/luns u1/u2
scratch, u2, /print ; same, but print before deleting
scratch, u1, /nodelete ; close, dont delete
scratch, u1, u2 ; if u1 is undfined: open 2 files
(same as scratch, u1, u2 ,/open)
if u1 is defined, close/delete 2 files
(same as scratch, u1, u2, /close)
scratch, u1, name=name ; return system derived file name used
scratch ; close/delete all open scratch files
scratch,/cleanup ; same plus any old scratch files from
scratch,/clean,/nodel,name=name ; new and old scratch file names
scratch,u1,file='fname',/open ; opens fname
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DPRINT, LPRINT, concat_dir [4]
CALLED BY:
F0READ, RICE, prstr [1], prstr [2], teambb [1], teambb [2]
Restrictions:
uses execute statement, so no recursion allowed
if user supplies file names (with file= keyword), then some
auto-mangagement functions are lost (ex: /cleanup function)
History: slf, 3-March-1993
slf, 1-jun-93 ; dont force file in home directory
slf, 3-jun-93 ; openw not openu
[Previous]
[Next]
Project : SOHO - CDS
Name :
SCREEN_SELECT
Purpose : Interactively select from list using widgets, X or terminal
Explanation :
Routine to allow a user to make an interactive screen selection
from a list (array) of strings. This procedure determines whether
to use dumb terminal version, the non- widget x-windows version or
the widget version by examining the !D.NAME system variable.
The actual processing is farmed out to different procedures depending
on the terminal type.
Widget Terminal ==> SELECT_W.PRO
Vanilla X windows ==> SELECT_X.PRO
VT100 Terminal ==> SELECT_O.PRO
Use :
screen_select, selections, iselected, comments, command_line, only_one
Inputs :
selections - string array giving list of items that can be
selected.
Opt. Inputs :
comments - comments which can be requested for each item in
array selections. It can be:
string array - same length as array selections.
null string - no comments available
scalar string - name of a procedure which will
return comments. It will take selections
as its first argument and return comments
as its second argument.
command_line - optional command line to be placed at the bottom
of the screen. It is usually used to specify what the
user is selecting.
only_one - integer flag. If set to 1 then the user can only select
one item. The routine returns immediately after the first
selection is made.
Outputs :
iselected - list of indices in selections giving the selected
items.
Opt. Outputs: None.
Keywords : None.
Calls : ***
SELECT_O [1], SELECT_O [2], SELECT_O [3], SELECT_W [1], SELECT_W [2], SELECT_W [3]
SELECT_X
CALLED BY:
DBOPEN [1], DBOPEN [2], DBOPEN [3], DB_ITEM [1], DB_ITEM [2], DB_ITEM [3]
Common : None.
Restrictions: None.
Side effects:
!err is set to the number of selections made
Category : Utilities, User_interface
Prev. Hist. :
Written by M. Greason, STX, May 1990.
Added widget support W. Landsman January, 1992
Written : M. Greason, GSFC/UIT (STX), May 1990
Modified : Version 1, William Thompson, GSFC, 29 March 1994
Incorporated into CDS library
Version : Version 1, 29 March 1994
[Previous]
[Next]
CALLS:
[Previous]
[Next]
[Previous]
[Next]
Name: search
Purpose: emulate VMS search utility
Input Parameters:
file - file to search (can be string array also)
string - string to search for
Keyword Parameters:
window - number of lines above/below matches to display
case_ignore - force search to be case insensitive
Calling Sequence:
search, file, string [, window=[above,below], /case_ignore]
search, file, string, window=delta
search, array, string
CALLS: ***
FILE_EXIST [2], data_chk [1], data_chk [2], file_exist [1], file_exist [3]
prstr [1], prstr [2], rd_tfile [1], rd_tfile [2], uniqo [1], uniqo [2], wc_where [1]
wc_where [2]
CALLED BY:
check_log [1], check_log [2], sfc_check
History:
15-Apr-1994 (SLF) Written (uses rd_tfile and wc_where)
18-Apr-1994 (SLF) Minor change to delimit logic
22-Apr-1994 (SLF) Allow string array, add FIRST and LAST keywords
[Previous]
[Next]
Name: search_file
Purpose: Search data path list for input file
Input: filename
Output: function returns file name with path or '' if not found
Method: quick and dirty (calls data_paths)
CALLS: ***
DATA_PATHS, browse_files
CALLED BY:
CkFurFiles
History: slf, 10/91
[Previous]
[Next]
NAME:
sel_filetimes
PURPOSE:
To select the files within a time range (assuming the file
date/time is in the filename in YYMMDD.HHMM format
SAMPLE CALLING SEQUENCE:
files = sel_filetimes('1-jun','1-jul',files)
files = sel_filetimes('1-jun','1-jul',dir='/data14/mdi_summary/daily/mag')
INPUTS:
sttim - the starting date/time
entim - the ending date/time
INPUT/OUTPUT:
files - The full list of files to search through. It is output
if it is not defined coming in
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], anytim2ints [1], anytim2ints [2]
break_file [4], fid2ex [1], fid2ex [2], file_list [1], file_list [2]
sel_timrange [1], sel_timrange [2]
CALLED BY:
QUICKSTRAY [2], TR_DARK_SUB, TR_FLAT_SUB, edac_summary, get1hk_info [1]
get1hk_info [2], get_epoch_sfcs [1], get_epoch_sfcs [2], hxt_impulsivness
new_edac_summary, rd_fdss, rd_raw_station_plan, ssc_files [1], ssc_files [2]
ssc_files [3], sxt_files, tr_rd_index, tr_rd_inventory, yohkoh_files
OPTIONAL KEYWORD INPUT:
dir - The director(ies) to search
filter - The wildcard filter to use to select files in the
directories
position- The starting position of the YYMMDD.HHMM string. It is
derived by looking for the charcter "9" otherwise.
RESTRICTION:
All file names must be of the same form
HISTORY:
Written 30-Aug-96 by M.Morrison
4-Feb-97 (MDM) - Modification to not call BREAK_FILE if FILE_LIST
was used and passed the file name back already
[Previous]
[Next]
Project : SOHO - CDS
Name : SEL_LINE_EVENT
Purpose : Processes events from the SEL_LINE_MENU.
Explanation : Any events originating within the widgets realized by
SEL_LINE_MENU are handled by this routine.
Use : Only by XMANAGER
Inputs : ev - the event structure
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
ARR2STR [1], Arr2Str [2], Bell, REM_DUP [1], REM_DUP [2], REM_DUP [3], WAVE2PIX
WHICH_GIS_BAND, WHICH_NIS_BAND
Restrictions: For use with SEL_LINE_MENU.
Side effects: None
Category : Telemetry
Prev. Hist. : None
Written : C D Pike, RAL, 3-Apr-95
Modified : Improve sorting by element. CDP, 12-Apr-95
Limit number of lines to size of array given. CDP, 9-Nov-95
Version : Version 3, 9-Nov-95
[Previous]
[Next]
Project : SOHO - CDS
Name : SEL_LINE_MENU
Purpose : Defines the mk_raster line selection window.
Explanation : Creates the widgets which form the window within which
the spectral lines can be selected.
Use : sel_line_menu
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
CDS_SLINE, CONCAT2D, PIX2WAVE, STRPAD, XMANAGER, XPDMENU, XREGISTERED
Restrictions: None
Side effects: None
Category : Technical, planning
Prev. Hist. : None
Written : C D Pike, RAL, 3-Apr-95
Modified :
Version : Version 1, 3-Apr-95
[Previous]
[Next]
NAME:
sel_timrange
PURPOSE:
Given a range of times (or a single time) and a time array, return the
subscripts of the times between the selected time range. If /BOOLEAN,
then return a bytarr the length of the input marking where within range.
SAMPLE CALLING SEQUENCE:
ss = sel_timrange(timarr, st_tarr, en_tarr)
ss = sel_timrange(timarr, st_tarr, en_tarr, /between)
ss = sel_timrange(roadmap, '1-nov-91 22:00', '1-nov-91 22:30')
ist = sel_timrange(neworb_p, st_tarr, st_before1st=st_before1st)
ien = sel_timrange(neworb_p, en_tarr, en_afterlast=en_afterlast, /after)
INPUT:
timarr - An array of times
st_tarr - The specified start time
OPTIONAL INPUT:
en_tarr - The specified end time. If it is not passed, then the
start time is used (time range of 0 seconds)
CALLS: ***
anytim2ints [1], anytim2ints [2], int2secarr [1], int2secarr [2]
CALLED BY:
GET_SUNCENTER [1], GET_SUNCENTER [2], IRUHXA2SXT, IRUHXASCAN2SXT [1]
IRUHXASCAN2SXT [2], IRU_S2Y, SXT_BAKEOUT_IN, SXT_OBSRPT, Sxt_goes_teem
ads_into_att, atr2hxa_dbase, cdrom_files [2], choose_interval, contact_num [1]
contact_num [2], eit_files, eit_proton_summary, get_acedata, get_selsis
get_utevent [1], get_utevent [2], goes3sec_copy, goes_widget, gtab_summary
hkplot_info, lapalma_cat, lapalma_files, lasco_time2file, les_archive_info
mdi_cat, mdi_files, mk_sdc [2], mk_sdc [3], mk_sdc [4], mk_sfc [1], mk_sfc [2]
mk_sft [1], mk_sft [2], pr_pnt_hist, pr_visible, rd_fdss, rd_goes_fits
rd_goesp_ascii, rd_goesx_ascii, rd_guf_ascii, rd_old_obs, rd_raw_station_plan
rd_sxa, rd_sxc, rd_sxl, rd_sxtgoes, rd_therm_rs232, rd_week_file [1]
rd_week_file [2], rd_week_file [3], rd_week_file [4], read_genxcat, ref_term [2]
res_freq, search_obs, sel_dc_image [1], sel_dc_image [2], sel_dc_image [3]
sel_filetimes [1], sel_filetimes [2], sel_leak_image [1], sel_leak_image [3]
sel_leak_image [4], show_contacts, sooncat_cadence, ssw_getdst, sswdb_files
sxi_files, sxt_imgtypes, term_times, timeline2html, tr_rd_index, weekid [2]
wrt_fits_bin_exten [2], ydb_exist [2], yohkoh_legacy_files [1]
yohkoh_legacy_files [2]
OPTIONAL KEYWORD INPUT:
between - The default is to give the last entry before the start time.
This is because the input time is usually a pointer (or file name)
with the time of the start of the orbit. So the selection
desired is needs to back up one element in the timarr. This
is only done when the input start time does not exactly match the
"timarr" value.
after - If set, get the first dataset after the input time range
boolean - If set, then return an array the same length as the input, and
set all values within the range to 1.
OPTIONAL KEYWORD OUTPUT:
st_before1st - If set, then the input start time is before the first time
in "timarr"
en_afterlast - If set, then the input end time is after the last time
in "timarr"
HISTORY:
Written Oct-92 by M.Morrison
29-Oct-92 (MDM) - Corrected an error in "en_afterlast" determination
30-Oct-92 (MDM) - Added /AFTER which corrected for a problem
with the RD_PNT logic
[Previous]
[Next]
Project : SOHO - CDS
Name :
SELECT_O
Purpose :
Allows interactive (text) screen selection from a list.
Explanation :
Routine to allow a user to make an interactive screen selection
from a list (array) of strings. This assumes a non-x-windows device.
Use :
select_o, selections, iselected, comments, command_line, only_one
Inputs :
selections - string array giving list of items that can be
selected.
Opt. Inputs :
comments - comments which can be requested for each item in
array selections. It can be:
string array - same length as array selections.
null string - no comments available
scalar string - name of a procedure which will
return comments. It will take selections
as its first argument and return comments
as its second argument.
command_line - optional command line to be placed at the bottom
of the screen. It is usually used to specify what the
user is selecting.
only_one - integer flag. If set to 1 then the user can only select
one item. The routine returns immediately after the first
selection is made.
Outputs :
iselected - list of indices in selections giving the selected
items.
Opt. Outputs: None.
Keywords : None.
Calls : ***
READ_KEY [1], READ_KEY [2], READ_KEY [3], SCR_ATTRIB [1], SCR_ATTRIB [2]
SCR_ATTRIB [3], SCR_CURPOS [1], SCR_CURPOS [2], SCR_CURPOS [3], SCR_ERASE [1]
SCR_ERASE [2], SCR_ERASE [3], SCR_OTHER [1], SCR_OTHER [2], SCR_OTHER [3]
CALLED BY:
SCREEN_SELECT [1], SCREEN_SELECT [2], SCREEN_SELECT [3]
Common : None.
Restrictions: None.
Side effects:
!err is set to the number of selections made
Category : Utilities, User_interface
Prev. Hist. :
version 1, D. Lindler April 88.
modified to IDL V2 (from screen_select). M. Greason, May 1990.
changed name from screen_select_o W. Landsman January 1993
Written : D. Lindler, GSFC/HRS, April 1988
Modified : Version 1, William Thompson, GSFC, 29 March 1994
Incorporated into CDS library
Version : Version 1, 29 March 1994
[Previous]
[Next]
Project : SOHO - CDS
Name :
SELECT_W
Purpose :
Creates a non-exclusive menu in widget form.
Explanation :
This procedure creates a non-exclusive menu of items
in widget form. More than one item may be selected or
'de-selected'. Normally called by SCREEN_SELECT
Use :
SELECT_W, items ,iselected, [ comments, command_line, only_one ]
Inputs :
items - string array giving list of items that can be
selected.
Opt. Inputs :
comments - comments which can be requested for each item in
array selections. NOT YET IMPLEMENTED
command_line - optional command line to be placed at the bottom
of the screen. It is usually used to specify what the
user is selecting.
only_one - integer flag. If set to 1 then the user can only select
one item. The routine returns immediately after the first
selection is made.
Outputs :
iselected - list of indices in selections giving the selected
items.
Opt. Outputs: None.
Keywords : None.
Calls : ***
SELECT_W_EVENT, XMANAGER, XMENU [1], XMENU [2]
CALLED BY:
SCREEN_SELECT [1], SCREEN_SELECT [2], SCREEN_SELECT [3]
Common :
SELECT_W - Used to communicate with the SELECT_W_EVENT procedure
Restrictions: None.
Side effects: None.
Category : Utilities, User_interface
Prev. Hist. :
Written, K. Venkatakrishna & W. Landsman, Hughes/STX January, 1992
Widgets made MODAL. M. Greason, Hughes STX, 15 July 1992.
Written : K. Venkatakrishna & W. Landsman, GSFC/UIT (Hughes/STX),
January 1992
Modified : Version 1, William Thompson, GSFC, 29 March 1994
Incorporated into CDS library
Version : Version 1, 29 March 1994
[Previous]
[Next]
Project : SOHO - LASCO/EIT
Name : SELECTD
Purpose : Select images on date
Category : Utils
Explanation : From a list of FITS files header is read and a keyword DATE-OBS
is checked .
Syntax : result = selectd ( files, start_date, end_date )
CALLED BY:
WOBSDATE
Examples :
Inputs : STRARR files : list with FITS files to be checked
STRING start_date, end_date in form : "95-MAR-8"
Opt. Inputs : None.
Outputs : STRARR result with a list of FITS files found.
Opt. Outputs: None.
Keywords : None.
Common : None.
Restrictions: None.
Side effects: None.
History : 22 mar 1995,Borut Podlipnik,MPAe,Written
Contact : BP, borut@lasco1.mpae.gwdg.de
Calls : anytim2utc(), grep(), headfits()
[Previous]
[Next]
Name: seq_cubes
Purpose: return indices corresponding to sequence table entries
13 element string array returned
CALLS:
CALLED BY
make_views
[Previous]
[Next]
Name: seq_dset
Purpose: return dset vector corresponding to one occurence of 1 sequence
table entry - uses serial number for grouping. Function return
value is used in rd_sda call.
Parameters:
Input - rmap=roadmap structure
sequence=sxt sequence number
occurence=which occurence
Output- function returns data set vector
Calling Sequence:
dset = SEQ_DSET(rmap, sequence#, occurence
CALLS:
[Previous]
[Next]
NAME:
seq_frame_info
PURPOSE:
To read the housekeeping data and to return information on the per-exposure
frames ("unwrap" the circular queue)
SAMPLE CALLING SEQUENCE:
seq_frame_info, '25-oct-95 19:50', '25-oct-95 20:10'
seq_frame_info, sttim, entim, mat, hk0
seq_frame_info, sttim, entim, mat, hk0, outfil='dd.dd', /qprint, /qplot
CALLS: ***
data_type [1], data_type [2], fmt_tim [1], fmt_tim [2], get_hk_info [1]
get_hk_info [2], int2secarr [1], int2secarr [2], plottime [1], plottime [2]
CALLED BY:
plot_expos_hist, pr_seq_frame_info
HISTORY:
Written Dec-95 by M.Morrison
20-Feb-96 (MDM) - Added header and put on-line
27-Feb-96 (DBG) - Patched a check for no data available
18-Mar-96 (MDM) - Made the FOR loop be a long word
- Added reftime output
17-Dec-96 (MDM) - Added shifting of the time by 3 sec per entry
[Previous]
[Next]
NAME:
seq_run_sum
PURPOSE:
To look through the Sequence ID and log all times when the
sequence was running
SAMPLE CALLING SEQUENCE:
seq_run_sum, '18-dec-95', !stime
seq_run_sum, month='Jan-96', outfil='$MDI_CAL_INFO/9601.seq_run_sum
seq_run_sum, sttim, entim, outfil=outfil, month=month, info=info
INPUTS:
sttim - starting time
entim - ending time
CALLS: ***
MASK, SEQ_SUM_P2, UNIQ [1], UNIQ [2], UNIQ [3], anytim2ex [1], anytim2ex [2]
anytim2ints [1], anytim2ints [2], data_type [1], data_type [2], fmt_tim [1]
fmt_tim [2], get_hk_info [1], get_hk_info [2], gt_day [1], gt_day [2]
hk_time_sort, int2secarr [1], int2secarr [2], restgen [1], restgen [2]
ut_time [1], ut_time [2]
CALLED BY:
MDI_SUMMARY
OPTIONAL KEYWORD INPUT:
outfil - an output file name to write to
month - Optionally specify the month rather than the sttim/entim
info - The get_hk_info returned structure
HISTORY:
Written Jan-96 by M.Morrison
15-Jan-96 (MDM) - Added documentation and cleaned it up
31-Jan-96 (MDM) - Added call to HK_TIME_SORT to clean up the slotted
file error problem
22-Feb-96 (MDM) - Corrected for case where the sequence was never running
- Modified to not corrupt/change the input variable
[Previous]
[Next]
NAME: set_cal_hdr.pro
PURPOSE: set some keywords in Calibration headers
CATEGORY: General tools low level routine
CALLING SEQUENCE: set_ima_hdr,ima_header,refpix_x,refpix_y
INPUTS: ima_header = structure
refpix_x = float, (position of reference 0.,0.)
refpix_y = float, (position of reference 0.,0.)
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: ima_header
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS: None
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
All 4/25/93 for VMS files in general
SCCS variables for IDL use
@(#)set_ima_header.pro 1.3 4/10/93 :NRL Solar Physics
[Previous]
[Next]
NAME: SET_CATALOG.PRO
PURPOSE: Set a catalog of images in memory
CATEGORY: Preprocessing high level routine
CALLING SEQUENCE: SET_CATALOG
INPUTS: template Template For image names
db_dark Liste of images
ndarks Number of images in catalog
drk_name Associate dark name
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: catalog list in the screen
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: None
SIDE EFFECTS: opens a catalog of darks if it don't exists
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)set_catalog.pro 1.0 25/6/93 :LAS
[Previous]
[Next]
Project : SOHO - CDS
Name : SET_CDS_FITS
Purpose : Define CDS_FITS_DATA environment variable to
available disks
Category : planning
Explanation :
Syntax : IDL>set_cds_fits
Inputs : None
Opt. Inputs : DEF_PATH = default path for CDS_FITS_DATA [def = current]
Keywords : IMAX = max disk number to search [def=20]
FIRST = put default path first
ROOT = lead root directory (def = '/')
CALLS: ***
ARR2STR [1], Arr2Str [2], DATATYPE [1], DATATYPE [2], DATATYPE [3], EXIST, IS_DIR
LOC_FILE [1], LOC_FILE [2], LOC_FILE [3], TRIM
Side effects: CDS_FITS_DATA is defined
History : Version 1, 31-May-1997, D.M. Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Project : SOHO - CDS
Name : SET_CDS_SDB
Purpose : append 'sdb' directories to ZDBASE
Category : Planning
Syntax : IDL> set_cds_sdb
CALLS: ***
CHKLOG [1], CHKLOG [2], DEF_DIRLIST, DPRINT, FIND_ALL_DIR [1], FIND_ALL_DIR [2]
FIND_ALL_DIR [3], FIX_ZDBASE, IS_BLANK, IS_DIR, IS_STRING
CALLED BY:
CDS_FILES, GT_CDS_QL, RD_CDS_POINT, XCAT
Side effects: Environment/logical ZDBASE is reset
History : Version 1, 5-August-1997, D M Zarro. Written
Contact : DZARRO@SOLAR.STANFORD.EDU
[Previous]
[Next]
Name: set_fastpath
Purpose: use ys environmentals and path file to do fast path setup
Output:
function returns string in !path format
Optional Keyword Parameters:
arr - switch, if set, return as array, not delimited string
Calling Examples:
!path=set_fastpath() ; update IDL !path
parr =set_fastpath(/arr) ; array version
History:
21-Apr-93 (SLF) - to hide temp variables during IDL_STARTUP
10-oct-93 (slf) - allow '/ys/' <==> getenv('ys') for uniq check
29-Jun-94 (SLF) - dont eliminate astronomy library during fast start
30-Jun-94 (SLF) - dont add non-existant paths
CALLS: ***
ARR2STR [1], Arr2Str [2], STR2ARR [1], STR2ARR [2], rem_elem [1], rem_elem [2]
uniqo [1], uniqo [2]
Restrictions:
This routine must be in path already! UNIX only for today
[Previous]
[Next]
Project : SOHO - CDS
Name : SET_KAP_VERS()
Purpose : Sets version number of last KAP file read for given date
Explanation : This procedure sets the version number of the last KAP file
read for a given date.
Use : Result = SET_KAP_VERS( DATE, VERSION )
IF NOT SET_KAP_VERS( DATE, VERSION ) THEN ...
Inputs : DATE = The date that the user wishes to look up the version
for. This can be in any of the standard CDS time
formats.
VERSION = The version number. This must be a non-negative
integer 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.
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 = SET_KAP_VERS( ERRMSG=ERRMSG, ... )
IF ERRMSG NE '' THEN ...
Calls : ***
ANYTIM2UTC [1], ANYTIM2UTC [2], DBBUILD [1], DBBUILD [2], DBBUILD [3], DBCLOSE [1]
DBCLOSE [2], DBCLOSE [3], DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2]
DBOPEN [3], DBUPDATE [1], DBUPDATE [2], DBUPDATE [3], DBUPDATE [4], LAST_KAP_VERS
TRIM
CALLED BY:
READ_KAP
Common : None.
Restrictions: Only this routine can be used to add KAP version information to
the database. Modifying the database by hand could corrupt its
integrity.
!PRIV must be 2 or greater to use this routine.
Side effects: None.
Category : Planning, Databases.
Prev. Hist. : None.
Written : William Thompson, GSFC, 24 May 1995
Modified : Version 1, William Thompson, GSFC, 24 May 1995
Version : Version 1, 24 May 1995
[Previous]
[Next]
NAME:
set_list_addr
PURPOSE:
Given a bin list and a start address, modify all address
references within the list to allow the table to reside at
that address
CALLED BY:
check_dumps [1], mk_list_load, mk_mdi_load
HISTORY:
Written 24-Jul-95 by M.Morrison
25-Jul-95 (MDM) - Added header information
2-Aug-95 (MDM) - Fixed bug with IRBIN processing
19-Mar-96 (MDM) - Added capability to stop list processing when
reach the number of entries (for VWBIN) because
of problem with 6003 list.
23-May-96 (MDM) - Corrected error for IRBIN when going from addressed
offset back to an offset of 0
19-Jul-96 (MDM) - Removed address adjustment for crop list (the
addresses it was moving were ccd pixel address.
15-Nov-96 (MDM) - Removed "printf,lun"
6-Jan-97 (MDM) - Adjusted 23-May-96 mod to allow forward offsets
CALLS: ***
MOD_LIST_ADDR, RFITS [1], RFITS [2], RFITS [3], SEA_MARK_LIST, UNSIGN, bits [1]
bits [2]
RESTRICTIONS:
* The start table address must be 0000 for the input list
[Previous]
[Next]
Name: set_logenv
Purpose: set environmental variable (unix) and logicals (vms)
(allow dynamic updates of Yohkoh environment)
Input Paramters:
logenv - string or string vector - unix environ or vms logical names
value - string or string vector - values to assign to logenv
Calling Examples:
set_logenv,'DIR_GEN_PNT',curdir() ; redefine PNT to current
set_logenv,file=concat_dir('$DIR_SITE_SETUP','setup_dirs')
Keyword Parameters:
file - string (scaler/vector) of file names to process
files are expected to be two or three column tables containing
logical/environmental information - embedded comments are ok
if # is used for unix and ! for vms (readable by rd_tfile.pro)
NCOLS
2: first column are logicals/environmentals
second column are values to assign (ie, table)
3: first column is ignored (example ('setenv' or 'define')
second and third columns are interpreted as logs/envs
and values to assign, respectively.
(This option allows direct processing of Yohkoh
(files like setup_dirs and setup_ysenv)
When file is a vector, they are processed in order so
logs/envs defined in multiple files get the final assignment
from the last reference.
CALLED BY:
CHANPHZCHEK, FS_OPEN [1], F_TH_NT, HESI_MENU, HESSI_DEV, HSI_MODEL_TO_SCORE
HSI_VCFILE_PACKET_RATE, Hsi_contact2fits [1], Hsi_contact2fits [2], choose_sfc
configure_http, get_pix, get_sirius [1], get_sirius [2], hessi_version
hsi_clk_delta_calc, hsi_do_qlook_image [1], hsi_do_qlook_image [2]
hsi_monthly_average, hsi_qlook_call_ospex [1], hsi_qlook_call_ospex [2]
hsi_switch, mo_patch, pref_super, printing [1], printing [2], rd_goesp_ascii
rd_goesx_ascii, read_trace, restenv [1], restenv [2], setssw_windows
ssw_instr_info, ssw_set_instr, ssw_setsswdb_gen, ssw_setup_windows
ssw_upgrade [1], ssw_upgrade [2], ssw_upgrade_backup, sswdb_upgrade
sxt_patch_att, sxt_prep [1], sxt_prep [2], sxt_prep [3], trace_last_movie [1]
trace_last_movie [2], trace_last_movie [3], trace_movie_index [1]
trace_movie_index [2], trace_special_movie [1], trace_special_movie [2]
trace_special_movie [3], trace_special_movie2, trace_write_genxcat, ydb_use
History:
27-Apr-1993 (SLF) - For dynamic relocation/additon of pointers
30-Apr-1993 (SLF) - improved file option / parameter validation
16-May-1994 (SLF) - fixed type in vms code
CALLS: ***
SETLOG, data_chk [1], data_chk [2], rd_tfile [1], rd_tfile [2]
Restrictions:
Can't specify both array and file
Not all VMS setlog options are available
[Previous]
[Next]
NAME:
set_offset
PURPOSE:
To display the tcblock command to set the offset corner
for extract
SAMPLE CALLING SEQUENCE:
set_offset, 9, 300, 700
set_offset, 15, center=300
HISTORY:
Written 22-Mar-96 by M.Morrison
[Previous]
[Next]
Purpose: incorporate idl version specific directorys in !path
History: slf, 23-feb-1993
slf, 30-mar-1993 return to caller on error
rdb, 16-Aug-94 modified to also run under VMS
rdb, 26-Aug-94 moved printe statement inside conditional
CALLS: ***
ARR2STR [1], Arr2Str [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
concat_dir [4]
Side Effects:
If IDL version is older than ys master, !path may be modified
[Previous]
[Next]
NAME:
set_printer
PURPOSE:
To allow the user to set the printer queue where the output will
come out
CALLS: ***
input [1], input [2], tbeep [1], tbeep [2], tbeep [3], wmenu_sel [1], wmenu_sel [2]
CALLED BY:
xanal_emi, xdisp_fits, xdisp_trace [1], xdisp_trace2, xdisp_trace3, xhkplot
HISTORY:
Written 25-Apr-94 by M.Morrison
27-Apr-94 (MDM) - Various changes
20-Jan-95 (MDM) - Changed "lp -dlaser" to "lp -c -dlaser"
28-Feb-95 (MDM) - Added option to send to QUAKE qms printer remotely
30-Nov-95 (MDM) - Changed "To redirect to LPARL lps20 from outside LPARL"
option to point to umbra and que saglps20ps
30-Apr-96 (MDM) - Added option to print to SAG
27-Jan-97 (MDM) - Added option to print to DIAPASON
[Previous]
[Next]
NAME:
set_printer
PURPOSE:
To allow the user to set the printer queue where the output will
come out
CALLED BY:
xanal_emi, xdisp_fits, xdisp_trace [1], xdisp_trace2, xdisp_trace3, xhkplot
HISTORY:
Written 25-Apr-94 by M.Morrison
27-Apr-94 (MDM) - Various changes
20-Jan-95 (MDM) - Changed "lp -dlaser" to "lp -c -dlaser"
28-Feb-95 (MDM) - Added option to send to QUAKE qms printer remotely
30-Nov-95 (MDM) - Changed "To redirect to LPARL lps20 from outside LPARL"
option to point to umbra and que saglps20ps
30-Apr-96 (MDM) - Added option to print to SAG
27-Jan-97 (MDM) - Added option to print to DIAPASON
------------ Big variation ----------------
15-Apr-97 (MDM) - Modified to work with SPRINT instead of PPRINT
- Also modified to use a /ssw/site/setup/set_printer.tab
file to define the options
[Previous]
[Next]
NAME:
set_printer
PURPOSE:
To allow the user to set the printer queue where the output will
come out
CALLED BY:
xanal_emi, xdisp_fits, xdisp_trace [1], xdisp_trace2, xdisp_trace3, xhkplot
HISTORY:
Written 25-Apr-94 by M.Morrison
27-Apr-94 (MDM) - Various changes
20-Jan-95 (MDM) - Changed "lp -dlaser" to "lp -c -dlaser"
28-Feb-95 (MDM) - Added option to send to QUAKE qms printer remotely
30-Nov-95 (MDM) - Changed "To redirect to LPARL lps20 from outside LPARL"
option to point to umbra and que saglps20ps
30-Apr-96 (MDM) - Added option to print to SAG
27-Jan-97 (MDM) - Added option to print to DIAPASON
[Previous]
[Next]
NAME:
set_printer
PURPOSE:
To allow the user to set the printer queue where the output will
come out
CALLS: ***
input [1], input [2], tbeep [1], tbeep [2], tbeep [3], wmenu_sel [1], wmenu_sel [2]
CALLED BY:
xanal_emi, xdisp_fits, xdisp_trace [1], xdisp_trace2, xdisp_trace3, xhkplot
HISTORY:
Written 25-Apr-94 by M.Morrison
27-Apr-94 (MDM) - Various changes
20-Jan-95 (MDM) - Changed "lp -dlaser" to "lp -c -dlaser"
28-Feb-95 (MDM) - Added option to send to QUAKE qms printer remotely
30-Nov-95 (MDM) - Changed "To redirect to LPARL lps20 from outside LPARL"
option to point to umbra and que saglps20ps
30-Apr-96 (MDM) - Added option to print to SAG
27-Jan-97 (MDM) - Added option to print to DIAPASON
[Previous]
[Next]
Project : SOHO - CDS
Name : SET_QLDS()
Purpose : Put back QLDS that the display routine is working on.
Explanation : In order to avoid multiple storage of the data
structures operated upon by the display routines,
the _FIRST_ display routine invoked interactively
by the user has the responsibility to keep the
QLDS as the UVALUE of its top level base.
The window generated in this way is called the MASTER
window. All display routines called by the MASTER
window's event handling routine should be passed
the widget ID of the MASTER window in the keyword
GROUP_LEADER, and this should be stored in the
UVALUE of the invoked, (SLAVE) TOP_LEVEL_BASE.
If a SLAVE window event handling routine invokes another
display routine, (a sub-SLAVE), it passes the widget ID
of its own TOP_LEVEL_BASE so that GET_QLDS can follow the
trace of widget IDs up to the MASTER, to retrieve the
QLDS. SET_QLDS should then also be used to "put back"
the QLDS after use/alteration.
Use : SET_QLDS,EV.TOP,QLDS
Inputs : EV.TOP -- the widget ID of the TOP_LEVEL_BASE of
a window generated by a CDS QL display routine.
QLDS: The CDS QL Data Structure to be put back
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3]
Common : None.
Restrictions: See 'Explanation'
Side effects: The use of this scheme reserves the user value (UVALUE)
of the TOP_LEVEL_BASE of any display window.
Category : CDS, QuickLook
Prev. Hist. : None.
Written : Stein Vidar Hagfors Haugan, 10 October, 1993
Modified : CDP, 25 October 1993 -- cut /no_copy keyword
SVHH, 21 November 1993 - Documentation added.
Version : 1.0
[Previous]
[Next]
NAME:
set_sci160k_dir
PURPOSE:
To allow the user to select a SCI160K directory
CALLS: ***
XMENU_SEL [1], XMENU_SEL [2], file_list [1], file_list [2], input [1], input [2]
CALLED BY:
xdisp_tfr
HISTORY:
Written 25-Jan-96 by M.Morrison
31-Jan-96 (MDM) - Added /data13 to the list
[Previous]
[Next]
Project : SOHO - CDS
Name : SET_SERTSW
Purpose : Set current SERTS window to the one in the descriptor
Explanation :
Use : SET_SERTSW,SERTSW
Inputs : SERTSW: a SERTS window descriptor as returned by GET_SERTSW()
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
GET_TV_SCALE, GET_VIEWPORT [1], GET_VIEWPORT [2], SETWINDOW [1], SETWINDOW [2]
CALLED BY:
PIXELS_2_DATA, PIXELS_2_DEVICE, TLB_PLACE
Common : IMAGE_AREA, from Bill Thompsons image routines
Restrictions: There must be a data coordinate system associated with
the SERTS window.
Side effects: Changes the current SETIMAGE settings.
Category : QuickLook
Prev. Hist. : None.
Written : Stein V Hagfors Haugan, December -93
Modified :
Version : 1.0
[Previous]
[Next]
NAME:
SET_UTPLOT
PURPOSE:
Allows user flexibility in setting up time axis labelling.
Prepares IDL system variables (!X.RANGE, !X.TICKV, !X.TICKNAME,
and !X.TICKNAME) for plotting X vs Y with Universal time labels
on bottom X axis. After calling SET_UTPLOT, user calls the
standard IDL PLOT routine to draw the plot.
SET_UTPLOT is normally called by UTPLOT, and is transparent to
the user.
CATEGORY:
CALLING SEQUENCE:
SET_UTPLOT,XRANGE=X,LABELPAR=LBL,UTBASE=BASE,ERROR_RANGE=ERROR_RANGE,
ERR_FORMAT=ERR_FORMAT,TICK_UNIT=TICK_UNIT,MINORS=MINORS,
XSTYLE=XSTYLE
INPUT PARAMETERS:
X - X array to plot (seconds relative to base time).
LBL - 2 element vector selecting substring from publication format
of ASCII time (YY/MM/DD, HH:MM:SS.XXX). For example,
LBL=[11,18] would select the HH:MM:SS part of the string.
BASE - ASCII string containing base time for X axis. Format for
time is YY/MM/DD,HHMM:SS.XXX. If this parameter isn't present
and hasn't been set yet (by a previous call to UTPLOT, via
routine SETUTBASE, or directly), user is prompted for base time.
ERROR_RANGE - = 0/1. If set to 1, the X array is outside of the
limits defined by start and end times selected by user.
ERR_FORMAT - =0/1. If set to 1, there was an error in the ASCII time
format for the base time.
TICK_UNIT - Time between Major tick marks is forced to TICK_UNIT
Has no effect for axis longer than 62 days.
MINORS - Number of minor tick marks is forced to MINORS
XSTYLE - Same meaning as in PLOT, if SET xaxis is exact
CALLS: ***
ATIME [1], ATIME [2], CHECKVAR [1], DUMMYPLOTS, FCHECK, SETUT [1], SETUT [2]
SETUTBASE [1], SETUTBASE [2], YMD2SEC [1], YMD2SEC [2], checkvar [2]
CALLED BY:
DEF_UTPLOT, HXISXPLOT, SETUT [1], SETUT [2], UTPLOT [1], UTPLOT [2], UTPLOT [3]
UTPLOT [4], UTPLOT [5], plotbft [1], plotbft [2]
COMMON BLOCKS:
COMMON UTCOMMON, UTBASE, UTSTART, UTEND = base, start, and
end time for X axis in double precision variables containing
seconds since 79/1/1, 00:00.
COMMON CLEARCOMMON,XOLD,YOLD,CLEARSET = holding area for previous
!x and !y structures if clearset=1
RESTRICTIONS:
Cannot be used for times before 79/1/1 or after 99/1/1.
MODIFICATION HISTORY:
Written by Richard Schwartz 91/02/17
Modified 91/03/27, RAS
Clears all !x vectors which will be set.
Modified 91/05/02, RAS
New Keywords Tick_unit, and Minors
Modified 91/10/18, RAS
if xstyle is set then utstart and utend are set by limits of x
26-Aug-92 (MDM) - Added keyword YEAR - put year on tick labels
18-Mar-93 (MDM) - Removed the modification made 91/10/18 since it was
causing problems on subsequent plots (giving a
error_range error)
[Previous]
[Next]
Name: set_xcolors
Purpose: part of idl setup - avoid order dependent X call effects
History: slf, 3-Apr-1992
slf, 9-Aug-1992 - verify DISPLAY is defined
(ultrix bug? p0 host is not avail /etc/utmp)
slf, 30-mar-93 - return to caller on error
slf, 4-Jan-93 - else case
slf, 5-Jan-93 A.M. - sgi case (240 colors) /
slf, 5-Jan-93 P.M. - change logic, allow environmental
slf, 6-Jan-93 - fix bug from yesterdays changes
slf, 7-Apr-94 - reduce SGI to 234 (empirical)
Restrictions:
ideally, I should find the parameter which lets me know the maximum
number of IDL colors without window manager corruption...
currently, this is empirically derived
[Previous]
[Next]
Name: setdisp
Purpose: set X windows display to remote node while in idl
Input Parameters:
node - string node name or string node number
History: slf, 3-nov-1992
Restrictions:
o does not handle local machine security issues
o probably a lot of others
Side Effects:
redirects X output to specified node
may generate warning messages when 1st window is created (but works)
[Previous]
[Next]
Project : SOHO - CDS
Name : SETENV
Purpose : Emulates the SETENV routine in VMS.
Explanation : Converts the SETENV syntax used in Unix and Microsoft Windows
to the equivalent SETLOG statement in VMS.
Use : SETENV, EXPRESSION
SETENV, 'ZDBASE=SYS$USER1:[CDS.DATA.PLAN.DATABASE]'
Inputs : EXPRESSION = A scalar string containing the name of the
environment variable to be defined, followed by
the equals "=" character, and the value to set
this environment variable to.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], SETLOG
Common : None.
Restrictions: VMS-only. In Unix and Microsoft Windows, the built-in SETENV
routine is used instead.
Side effects: None.
Category : Utilities, Operating_system.
Prev. Hist. : None.
Written : William Thompson, GSFC, 27 March 1995
Modified : Version 1, William Thompson, 27 March 1995
Version : Version 1, 27 March 1995
[Previous]
[Next]
Project : SOHO - CDS
Name :
SETPLOT
Purpose :
Switch between plotting devices with memory about each.
Explanation :
Switches among the various available plotting devices. The plotting
variables for each device are saved in a common block so that the user
retains the ability to reset to a previously used device and do over-
plots, even if plots were produced on another device in the meantime.
Calling SETPLOT with the name of the currently selected device resets
the system variables to either default values, or those from the last
time SETPLOT was called.
The !BCOLOR and !ASPECT system variables are also saved.
Use :
SETPLOT, DEVICE
Inputs :
DEVICE - Name of the plotting device one is changing to.
Opt. Inputs :
None.
Outputs :
None.
Opt. Outputs:
None.
Keywords :
COPY = If set, then the current color table is copied to the new
graphics device. Also, the SETFLAG routine is called to set TOP
equal to the number of colors. Also makes sure that !P.COLOR
does not exceed the TOP color. Requires the SERTS image display
software.
Calls : ***
ADD_DEVICE, SETFLAG, SETSCALE [1], SETSCALE [2], STORE_INTO_SV
CALLED BY:
ASK, CDS_THUMBNAIL, PCL [1], PCL [2], PCLCLOSE [1], PCLCLOSE [2], PCLPLOT [1]
PCLPLOT [2], PS [1], PS [2], PSCLOSE [1], PSCLOSE [2], PSPLOT [1], PSPLOT [2]
QMCLOSE [1], QMCLOSE [2], QMPLOT [1], QMPLOT [2], QMS [1], QMS [2], REGIS [1]
REGIS [2], RESET [2], RESET [3], SELECT_WINDOWS, SUNVIEW [1], SUNVIEW [2], TEK [1]
TEK [2], TEK [3], TEK4105 [1], TEK4105 [2], TEK4211 [1], TEK4211 [2], TEKMONO [1]
TEKMONO [2], TVSELECT, TVUNSELECT, WIN [1], WIN [2], XDOC, XWIN [1], XWIN [2], xwin [3]
Common :
PLOTFILE - Saves system variables for later retrieval. Not to be used
by other routines.
Restrictions:
The procedure will not work correctly unless it is used exclusively to
change the plotting device.
In general, the SERTS graphics devices routines use the special system
variables !BCOLOR and !ASPECT. These system variables are defined in
the procedure DEVICELIB. It is suggested that the command DEVICELIB be
placed in the user's IDL_STARTUP file.
Side effects:
Many system variables are manipulated by this routine--in particular
!P.CHARSIZE and !P.FONT.
The first time the routine is called for a particular graphics device,
certain plot parameters may be set to default values.
Any SETSCALE settings will be lost.
Category :
Utilities, Devices.
Prev. Hist. :
W.T.T., Sept. 1987.
William Thompson, February, 1990.
William Thompson, October, 1991, added !ASPECT system variable.
William Thompson, November 1992, changed to save !P.NOERASE and
!Z.THICK.
Written :
William Thompson, GSFC, September 1987.
Modified :
Version 1, William Thompson, GSFC, 27 April 1993.
Incorporated into CDS library.
Version 2, William Thompson, GSFC, 14 September 1994
Added COPY keyword.
Version 3, William Thompson, GSFC, 21 June 1995
Added INTERPOLATE keyword.
Version :
Version 3, 21 June 1995
[Previous]
[Next]
Project : SOHO - CDS
Name :
SETSCALE
Purpose :
Sets plot scale so it is the same in X and Y directions.
Explanation :
The data limits in the X and Y directions (plus 5%) are calculated and
compared against the the physical size of the plotting area in device
coordinates. Whichever scale is larger is then used for both axes, and
the plot limits are set to center the data in both directions. The
parameters !X.STYLE and !Y.STYLE are then set to 1 for exact spacing.
Use :
SETSCALE - Resets to previous state.
SETSCALE, ARRAY - Calculates scale for CONTOUR.
SETSCALE, XARRAY, YARRAY - Calculates scale from arrays.
SETSCALE, XMIN, XMAX, YMIN, YMAX - Calculates scale from limits.
Inputs :
None required. Calling SETSCALE without any parameters resets to the
default behavior.
Opt. Inputs :
ARRAY - Two dimensional array to be used in a simple
contour plot. The minima are set to zero,
and the maxima are set to one less than the
dimensions of the array.
XARRAY, YARRAY - Arrays from which the minimum and maximum
values are calculated.
XMIN, XMAX, YMIN, YMAX - The limits in the X and Y directions from
which the scale is calculated. The actual
X and Y ranges must include these values.
Outputs :
None.
Opt. Outputs:
None.
Keywords :
NOBORDER = If set, then the 5% border is not applied.
NOADJUST = If set, then the edges of the plot (!P.POSITION) are
not modified.
Calls : ***
GET_VIEWPORT [1], GET_VIEWPORT [2], REVERSE
CALLED BY:
PLOT_IMAGE, SETPLOT [1], SETPLOT [2], SETVIEW [1], SETVIEW [2], SETWINDOW [1]
SETWINDOW [2]
Common :
SETSCALE = Keeps track of the system variables changed by this routine.
Restrictions:
Unpredictable results may occur if SETSCALE is in effect when WINDOW,
WSET or SET_PLOT are called. It is recommended that SETSCALE be called
without parameters to reset to the ordinary behavior before the
graphics device or window is changed.
In general, the SERTS graphics devices routines use the special system
variables !BCOLOR and !ASPECT. These system variables are defined in
the procedure DEVICELIB. It is suggested that the command DEVICELIB be
placed in the user's IDL_STARTUP file.
Side effects:
The system variables !X.STYLE, !Y.STYLE, !X.S, !Y.S, !X.RANGE (!XMIN
and !XMAX) and !Y.RANGE (!YMIN and !YMAX) are modified.
Unless NOADJUST is set, the edges of the plot (!P.POSITION) are
adjusted to fit the data. Then, when SETSCALE is called without any
parameters, these parameters are returned to their original settings.
System variables may be changed even if the routine exits with an error
message.
If SETSCALE is called without any parameters, then the modified system
variables are restored to their original values. Additional graphics
functions such as OPLOT will still be possible.
Category :
Utilities, Devices.
Prev. Hist. :
William Thompson, Feb. 1991.
William Thompson, Oct. 1991, added !ASPECT system variable.
William Thompson, May 1992, added common block and changing viewport.
William Thompson, Nov. 1992, changed structure of common block, and
removed support for changing viewport.
William Thompson, Nov. 1992, changed to use GET_VIEWPORT instead of
INIT_SC1_SC4, and to restore original !P.POSITION when called
with no parameters.
William Thompson, December 1992, changed common block to keep better
track of the state of the system variables.
Written :
William Thompson, GSFC, February 1991.
Modified :
Version 1, William Thompson, 27 April 1993.
Incorporated into CDS library.
Version :
Version 1, 27 April 1993.
[Previous]
[Next]
Project : SOHO - LASCO
Name :
Purpose :
Category :
Explanation :
Syntax :
CALLED BY:
WLOADC, wrt_fits_bin_exten [2]
Examples :
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Common :
Restrictions:
Side effects: Not known
History : Version 1, 02-Sep-1995, B Podlipnik. Written
Contact : BP, borut@lasco1.mpae.gwdg.de
[Previous]
[Next]
PROJECT:
SOHO - LASCO
NAME:
SETUP_ASTROM
PURPOSE:
Set up FITS-type astrometry structure in CD format for any
of the LASCO telescopes.
CALLING SEQUENCE:
setup_astrom, telescope, astrom
INPUTS:
telescope: string containing telescope name.
sunephem: structure containing solar ephemeris information
(obtained from sohoephem.pro).
naxis1: no. of pixels in horizontal direction.
naxis2: no. of pixels in vertical direction.
OUTPUTS:
astrom: Anonymous structure containing astrometry info in FITS
CD format.
OPTIONAL INPUTS:
ocentre: Two-element vector giving pixel location of centre of
occulting disk (defaults to image centre).
pscale: Scalar giving plate scale in arcsec/pixel (defaults to
nominal value for specified telescope.
vangle: Scalar giving angle of image vertical (Y-axis) from
solar north in degrees (defaults to zero).
CALLED BY:
STARFIELD
PROCEDURE:
Straightforward.
RESTRICTIONS:
Assumes nominal values for astrometry parameters for each
telescope (i.e. solar north is straight up, Sun at centre of
occulter and nominal values for plate scale).
Intended to be called from another routine (e.g. starfield.pro).
MODIFICATION HISTORY:
Written by Simon Plunkett, February 1996.
2003.08.18, nbr - Add latpole to astrom structure to make compatible
with SSW; add sccs version
@(#)setup_astrom.pro 1.2 08/18/03 - LASCO NRL IDL Library
[Previous]
[Next]
NAME:
SETUT
PURPOSE:
Set base,start, or end time in common UTCOMMON.
SETUTBASE, SETUTSTART, and SETUTEND are all implemented through
SETUT as in SETUTBASE,'UTSTRING'.
When using UTPLOT, UTPLOT_IO, or OUTPLOT command, X array is
assumed to be in seconds relative to the base time.
CALLED BY:
BATSE_ONTIMES, DCFREAD, EDITOC, FIND_DBFILE, FLISTOC, FSOC, FSPLOT, FS_ARCHIVE_RW
FS_GRAPH, GFITS_R, PLOT_FLARE, QLDISPLAY, RATESDUMPOC, RAWDUMPOC, SETUTBASE [1]
SETUTBASE [2], SETUTEND [1], SETUTEND [2], SETUTSTART [1], SETUTSTART [2]
SET_UTPLOT [1], SET_UTPLOT [2], SPEX_COMMONS [2], SPEX_COMMONS [4]
SPEX_PROC [1], SPEX_PROC [2], plotman, t_utplot [1], t_utplot [2]
Note: UTBASE, UTSTART, and UTEND are in common UTCOMMON and can
also be set directly (double precision seconds relative to
79/1/1, 00:00).
Can also be used to call SET_UTPLOT which creates !x.tickv and
!x.tickname.
CATEGORY:
CALLING SEQUENCE:
SETUT, UTBASE=BASE, UTSTART=START, UTEND=END, ERROR=ERROR, $
SET_UTPLOT=SET
INPUT PARAMETERS:
BASE, START, or END - ASCII string in format YY/MM/DD,HHMM:SS.XXX.
Sets UTBASE, UTSTART, or UTEND variables in common UTCOMMON to the
number of seconds since 79/1/1, 0000.
Partial strings are allowed. If the date is omitted, the last date
passed (for base, start, or end time) is used.
For example, if the string '88/3/4,1230' had already been passed:
'1200' means 88/3/4,1200
'01' means 88/3/4,0001 (1 minute into the day)
'01:2' means 88/3/4,0001:02.000 (1 min., 2 sec into day)
'1200:20.1' means 88/3/4,1200:20.100 (20.100 sec. after 12)
ERROR - 0/1 indicates no error/error in converting ASCII time to
double precision seconds.
SET_UTPLOT - if 1 and START and END are set then SET_UTPLOT is called
for those values, remembered in subsequent calls.
- if 0 then SET_UTPLOT is not called or subsequently.
OUTPUTS:
None.
OPTIONAL OUTPUT PARAMETERS:
None.
CALLS: ***
ATIME [1], ATIME [2], CHECKVAR [1], SET_UTPLOT [1], SET_UTPLOT [2], checkvar [2]
utplot_UTIME [1], utplot_UTIME [2]
COMMON BLOCKS:
COMMON UTCOMMON, UTBASE, UTSTART, UTEND = base, start, and
end time for X axis in double precision variables containing
seconds since 79/1/1, 00:00.
COMMON LASTDATECOM, LASTDATE = YY/MM/DD string for last entry
into SETUT
COMMON SETCOMMON, SETPLOT
SIDE EFFECTS:
UTXXXX in common UTCOMMON is set to time passed in string translated
into a double precision floating point value representing the time
in seconds since 79/1/1, 00:00. Function ATIME can be used to
display this time as an ASCII string. If switch SET_UTPLOT is used
then the procedure SET_UTPLOT is called with the new values of
UTBASE, UTSTART, and UTEND.
RESTRICTIONS:
Times must be between 79/1/1 and 99/1/1. A base time must be set before
plotting with UTPLOT (or UTPLOT_IO), however the easiest ways to set it
are either in the calling arguments to UTPLOT (or UTPLOT_IO) or by
letting UTPLOT (or UTPLOT_IO) prompt for it.
PROCEDURE:
Keyword parameters are used to route the input string(s) to their
proper variable in UTCOMMON.
utplot_UTIME is called to translate UTSTRING to epoch day and msec,
UTBASE is epoch day * 86400 + msec/1000 from 79/1/1
MODIFICATION HISTORY:
Written by Kim Tolbert, 4/88
Modified for IDL Version 2 by Richard Schwartz, 2/91
Keyword SET_UTPLOT added 9/91
Corrections and new comments added 10/91 by RS.
[Previous]
[Next]
NAME:
SETUTBASE
PURPOSE:
Set UTBASE variable in common UTCOMMON to the number of seconds
since 79/1/1, 0000 represented by the ASCII string passed as an
argument.
CALLING SEQUENCE:
SETUTBASE,UTSTRING,ERROR=ERROR
INPUT PARAMETERS:
UTSTRING - string in YY/MM/DD, HHMM:SS.XXX format to be converted
to internal representation and stored in UTCOMMON variable UTBASE.
ERROR - 0/1 indicates no error/error in converting UTSTRING
CALLS: ***
CHECKVAR [1], SETUT [1], SETUT [2], checkvar [2]
CALLED BY:
CONT_READ, DISCSP_READ, EVAL_SHERB, FDBREAD, FS_ACC_CONT, FS_ACC_DISCSP, FS_GEN_ARR
FS_GRAPH, HXARCHIVE, HXFITS, PLOTBATSE_QL, PLOTFIT, PLOT_OCCS, PLOT_OCC_ONDAY
QL_DAY_PLOT, QL_ORBIT_PLOT, READ_DISCLA, SC4TREAD, SET_UTPLOT [1], SET_UTPLOT [2]
SPEX_COMMONS [2], SPEX_COMMONS [4], SPEX_PLOT_SAVED [1], SPEX_PLOT_SAVED [2]
SPEX_PROC [1], SPEX_PROC [2], Show Image [1], Show Image [2], Show Image [3]
plotfda, read_batse_4_spex [1], read_batse_4_spex [2], t_utplot [1]
t_utplot [2]
PROCEDURE:
Calls SETUT. See SETUT.PRO program description.
MODIFICATION HISTORY:
Written by Richard Schwartz, Feb. 1991
[Previous]
[Next]
NAME:
SETUTEND
PURPOSE:
Set UTEND variable in common UTCOMMON to the number of seconds
since 79/1/1, 0000 represented by the ASCII string passed as an
argument.
CALLING SEQUENCE:
SETUTEND,UTSTRING,ERROR=ERROR
INPUT PARAMETERS:
UTSTRING - string in YY/MM/DD, HHMM:SS.XXX format to be converted
to internal representation and stored in UTCOMMON variable UTEND.
ERROR - 0/1 indicates no error/error in converting UTSTRING
CALLS: ***
CHECKVAR [1], SETUT [1], SETUT [2], checkvar [2]
CALLED BY:
CONT_READ, DISCSP_READ, FDBREAD, QL_DAY_PLOT, QL_ORBIT_PLOT, READ_DISCLA
PROCEDURE:
Calls SETUT. See SETUT.PRO program description.
MODIFICATION HISTORY:
Written by Richard Schwartz, Feb. 1991
[Previous]
[Next]
NAME:
SETUTSTART
PURPOSE:
Set UTSTART variable in common UTCOMMON to the number of seconds
since 79/1/1, 0000 represented by the ASCII string passed as an
argument.
CALLING SEQUENCE:
SETUTSTART,UTSTRING,ERROR=ERROR
INPUT PARAMETERS:
UTSTRING - string in YY/MM/DD, HHMM:SS.XXX format to be converted
to internal representation and stored in UTCOMMON variable UTSTART.
ERROR - 0/1 indicates no error/error in converting UTSTRING
CALLS: ***
CHECKVAR [1], SETUT [1], SETUT [2], checkvar [2]
CALLED BY:
CONT_READ, DISCSP_READ, FDBREAD, QL_DAY_PLOT, QL_ORBIT_PLOT, READ_DISCLA
PROCEDURE:
Calls SETUT. See SETUT.PRO program description.
MODIFICATION HISTORY:
Written by Richard Schwartz, Feb. 1991
[Previous]
[Next]
Project : SOHO - CDS
Name :
SETVIEW
Purpose :
Switch between several plots on one page.
Explanation :
SETVIEW modifies the viewport parameters !SC1, !SC2, !SC3 and !SC4 to
allow several plots on one page, arranged horizontally and/or
vertically.
Calling SETVIEW with nontrivial parameters also sets !NOERAS to 1.
New plots must be started with an explicit ERASE command.
Calling SETVIEW without any parameters, or IX,NX and IY,NY all equal
to 1 resets the viewport, and sets !NOERAS to 0.
Recalling SETVIEW with the same parameters as before will restore the
system variables associated with that setting. This allows the user to
switch between several plots without losing the scaling information
associated with each. Note that when switching between windows that
both WSET and SETVIEW must be called each time for this to work.
Alternatively, SETWINDOW can be used to switch between windows.
Use :
SETVIEW [, IX, NX [, IY, NY [, SX [, SY ]]]]
Inputs :
None required. Calling SETVIEW without any parameters resets to the
default behavior.
Opt. Inputs :
IX, NX = Relative position along X axis, expressed as position IX
out of a possible NX, from left to right. If not passed,
then 1,1 is assumed.
IY, NY = Relative position along Y axis, from top to bottom. If
not passed, then 1,1 is assumed.
SX = Multiplication factor for space between plots in X
direction. A value of SX between 0 and 1 decreases the
amount of space between plots, a value greater than 1
increases the amount of space. If not passed, then 1 is
assumed.
SY = Multiplication factor for space between plots in Y
direction. If not passed, then 1 is assumed.
Outputs :
None.
Opt. Outputs:
None.
Keywords :
None.
Calls : ***
ADD_VIEWPORT, SETSCALE [1], SETSCALE [2], TRIM
CALLED BY:
AN_NIMCP, AN_NIMCP_1_2, AN_NIMCP_AVG, CDS_SNAPSHOT, NIS_AVG_SPECT_DEMO
SHOW_SYNOPTIC
Common :
VIEWPORT = Contains data to maintain information about the viewports
as a function of graphics device and window.
Restrictions:
IX must be between 1 and NX. IY must be between 1 and NY.
SX and SY must not be negative.
This routine must be called separately for each graphics device.
In general, the SERTS graphics devices routines use the special system
variables !BCOLOR and !ASPECT. These system variables are defined in
the procedure DEVICELIB. It is suggested that the command DEVICELIB be
placed in the user's IDL_STARTUP file.
Side effects:
The system variable !NOERAS is changed.
Any SETSCALE settings will be lost.
Category :
Utilities, Devices.
Prev. Hist. :
William Thompson Applied Research Corporation
September, 1988 8201 Corporate Drive
Landover, MD 20785
William Thompson, Nov 1992, changed common block to allow system
variables to be saved between multiple
plots. Also added call to disable
possible SETSCALE settings.
Written :
William Thompson, GSFC, September 1988.
Modified :
Version 1, William Thompson, GSFC, 27 April 1993.
Incorporated into CDS library.
Version 2, William Thompson, GSFC, 4 January 1994.
Fixed bug where original state was not being completely
restored.
Version :
Version 2, 4 January 1994.
[Previous]
[Next]
Project : SOHO - CDS
Name :
SETWINDOW
Purpose :
Switch between windows, retaining parameters for each.
Explanation :
SETWINDOW stores the plot parameters for the current window in a common
block, switches to the desired window, and restores the plot parameters
from the last time that window was used.
Use :
SETWINDOW [, WINDOW ]
Inputs :
None required.
Opt. Inputs :
WINDOW = Number of window to switch to. If not passed, then the
parameters for the current window are saved.
Outputs :
None.
Opt. Outputs:
None.
Keywords :
SHOW : call WSHOW
Calls : ***
ADD_WINDOW, SETSCALE [1], SETSCALE [2], TRIM
CALLED BY:
CDS_ENG_N1_VW, DSPEXP, DSPWAV, EIS_IMAGE_TOOL [1], EIS_IMAGE_TOOL [2]
EIS_IMAGE_TOOL_EVENT [1], EIS_IMAGE_TOOL_EVENT [2], EIS_ITOOL_PTOOL [1]
EIS_ITOOL_PTOOL [2], EIS_ITOOL_ZOOMINOUT [1], EIS_ITOOL_ZOOMINOUT [2]
EIS_LOAD_IMAGE [1], EIS_LOAD_IMAGE [2], GDSPSPEC, IMAGE_TOOL, IMAGE_TOOL_EVENT
ITOOL_DISP_ROT, ITOOL_DRAW, ITOOL_DRAW_ICON, ITOOL_LIMBFITTER, ITOOL_LOAD_IMAGE
ITOOL_OVERLAYER, ITOOL_PTOOL, ITOOL_ZOOMINOUT, ITOOL_ZOOMMER, LOCATE_FFCAL
MAKE_AUTO_FIT, MAKE_MANUAL_FIT, MK_LIMBFIT_BS, MK_POINT_BASE, MK_SOHO, NDSPSPEC
PQLPROFILE, PQLZOOM, PRESTORE, PTEST, SET_SERTSW, TLB_PLACE, TVPROFILE, TVSELECT
TVUNSELECT, UPDATE_FITLIMB, WDISPLAY, XCDS_SNAPSHOT, XCOR_CDS
Common :
SETWINDOW = Contains WINDOWS, and the structure SAVE which contains the
graphics system variables.
Restrictions:
WINDOW must be a valid, existing window.
Creating a new window with the WINDOW command will also switch to that
window. To save the settings for the current window, call SETWINDOW
before calling WINDOW.
In general, the SERTS graphics devices routines use the special system
variables !BCOLOR and !ASPECT. These system variables are defined in
the procedure DEVICELIB. It is suggested that the command DEVICELIB be
placed in the user's IDL_STARTUP file.
Side effects:
Certain system variables from the previous time the window was used are
recalled.
Any SETSCALE settings will be lost.
Category :
Utilities, Devices.
Prev. Hist. :
William Thompson Applied Research Corporation
November, 1992 8201 Corporate Drive
Landover, MD 20785
Written :
William Thompson, GSFC, November 1992.
Modified :
Version 1, William Thompson, GSFC, 27 April 1993.
Incorporated into CDS library.
Version 1.1, Dominic Zarro, (ARC/GFSC), 15 December 1994.
Added WSHOW
Version :
Version 1.1, 15 December 1994.
[Previous]
[Next]
Project:
SOHO - SUMER
Name:
SF_GAUSSB
Purpose:
Fit data to Gaussian function using the GaussB compression
used on board SOHO/SUMER (compression method 12)
Use:
res = sf_gaussb(data)
Inputs:
data - floating point array of dimensions
WAVELENGTH x SOLAR_Y x anything else
Output:
A floating point array with the 4 gaussian fit parameters in
place of the wavelength dimension
Gaussian fit parameters
Gaussian parameters:
0: Background (counts/pixel)
1: Maximum (counts/pixel)
2: Centroid (pixels, Original units: pixels*100.)
3: Width (sigma in pixels, Original: sigma*0.745*100.)
Input Keywords:
Original - Output results in the original compression units
CALLS: ***
SCMP_NEAR2
CALLED BY:
SUM_GAUSSB
Common:
None
Written:
Terry Kucera, 12 Aug 1996
Based on earlier programs by Ingolf Dammasch and Jong-Chul Chae
[Previous]
[Next]
Project : SOHO - CDS
Name : SFITSLIST
Purpose : Create/update the lfitslist.txt file.
Explanation : CDS fits file names don't tell you much about their
content. This program creates/updates a file
called lfitslist.txt in the fits file directory, with
various information on the content of the files.
This file is used by PICKFITS in order to search
the list of files for those files that the user wants.
Use : SFITSLIST [,FITSDIR [,LISTDIR]]
Inputs : None required.
Opt. Inputs : FITSDIR : The directory with the fits files to be in
the list. Default "CDS_FITS_DATA"
LISTDIR : The directory to place the list in. This is
also the directory where the lfitslist.txt
file is created/updated. The default is
"$CDS_FITS_DATA_W".
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], DATATYPE [1], DATATYPE [2], DATATYPE [3], DEFAULT, FILE_EXIST [2]
FIND_FILES, FITSLIST_ADD, FITSLIST_ADDTX, FXPAR [1], FXPAR [2], HEADFITS [1]
HEADFITS [2], HEADFITS [3], INCSFITSLIST, PARCHECK, RD_ASCII [1], RD_ASCII [2]
SFITSLIST_PROP, SFITSLIST_SRNUMBER, STRPAD, STR_SEP, TEST_OPEN, TRIM, TYP
break_file [4], concat_dir [4], file_exist [1], file_exist [3]
Common : None.
Restrictions: Expects to find fits files in the specified directory.
If there is already a lfitslist.txt file in the same
directory, it has to have one or more entries.
Side effects: Creates/updates the file "sfitslist.txt" in the
specified directory.
Category : CDS_Utility
Prev. Hist. :
Written : Stein Vidar H. Haugan, UiO, 22 March 1996
Modified : Version 2, SVHH, 18 April 1996
Changed format of fitslist.txt -> lfitslist.txt
Generic format.
Version 3, SVHH, 19 April 1996
Added check for errors after FXBOPEN call.
Version 4, SVHH, 22 April 1996
TITLE expanded to 80 chars max
Version 5, SVHH, 23 April 1996
Using find_files for multi-path CDS_FITS_DATA.
Allowing both FITSDIR and LISTDIR to be
specified.
For updates the new list is collected before
it's written -- direct overwrite, no spawns.
Version 6, SVHH, 29 April 1996
Wrote fitslist_add, fitslist_addtx to shorten
sfitslist_prop. These are identical in sfitslist
Tested on VMS (suman1), caught an error in the
use of CATCH.
Version 7, Using lowercase fits file names, since that's what
is used on soho-archive disks.
Version : 7, 6 August 1996
[Previous]
[Next]
NAME:
sgt_bin
PURPOSE:
To retrieve the binning parameters from a SOHO/SUMER observation.
CATEGORY:
Data handling.
CALLING SEQUENCE:
bin = sgt_bin(index)
INPUTS:
The index structure returned from rd_sumer.
OPTIONAL INPUTS:
None.
KEYWORD PARAMETERS:
None.
OUTPUTS:
The wavelength and spatial binning performed on the data.
OPTIONAL OUTPUTS:
None.
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], sgt_tagname
CALLED BY:
CALL_TRIWARP, SGT_CRPIX, destr_bilin [2], sumer_destretch
COMMON BLOCKS:
None.
SIDE EFFECTS:
If the BINX and BINY tag names can not be found in the index
structure passed to the routine, an error occurs.
RESTRICTIONS:
Only the index structure may be passed as input. It may turn out to
be useful to pass the filename as input and this option may be added
in the future.
PROCEDURE:
The routine returns the values of index.gen.binx and index.gen.biny
from the index structure. The values of binx and biny have been
taken directly from the primary FITS header.
EXAMPLE:
IDl> filename = '$SUMER_DATA/sum_960513_085055.fits'
IDL> rd_sumer,index,data
IDL> bin = sgt_bin(index)
IDL> print,bin
1 1
which indicates that no binning has been performed on the data.
MODIFICATION HISTORY:
HPW 24-JUL-1996:
HPW 07-AUG-1996: Renamed sgt_bin.
[Previous]
[Next]
Project:
SOHO - SUMER
Name:
SGT_BTE
Purpose:
To calculate the refence pixel in the data corresponding to the
reference pixel on the detector. The result should be analogous to the
fits CRVAL.
Use:
Result = SGT_BTE(index)
Inputs
index - The index structure returned from rd_sumer.
Output
BTE - the Binary Table Extension number for each collumn
Input Keywords:
None
Calls:
None
CALLED BY:
SGT_NEWREF, SMK_FULLDET, get_sum_column
Common:
None
Written:
Terry Kucera, Aug 14, 1996
[Previous]
[Next]
NAME:
sgt_column
PURPOSE:
To retrieve a column of SOHO/SUMER data from a data structure or
fits file.
CATEGORY:
Data handling.
CALLING SEQUENCE:
column = sgt_column(data,data_col=1)
column = sgt_column(filename,data_col=1)
column = sgt_column(index,data,data_col=1,lambda=lambda)
INPUTS:
Either the data structure returned from rd_sumer or a file name. If
the data column and detector exposure are not specified the first
data column is returned.
OPTIONAL INPUTS:
If the wavelength range is also desired then the index structure
must also be passed. Note that in this case the index variable
PRECEEDES the data variable.
KEYWORD PARAMETERS:
data_col: The column from which the detector exposure is to be
returned. The columns are number from 1 to the number of
data columns.
OUTPUTS:
The data from a colum of a SUMER fits file.
OPTIONAL OUTPUTS:
An array corresponding to the wavelength (dispersion) direction of
the detector.
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], rd_sumer [1], rd_sumer [2], sgt_wave
COMMON BLOCKS:
None.
SIDE EFFECTS:
None.
RESTRICTIONS:
Only a single column may be specified.
PROCEDURE:
If the data structure is passed then the routine simply returns the
specified data. If a file name is passed then the specified data
column is first read with rd_sumer.
EXAMPLE:
Here the first data column is returned.
IDL> filename = 'sum_960513_085055.fits'
IDL> mk_query,filename
File: sum_960513_085055.fits
C Name Dimensions Wmin Wmax Xmin Xmax Ymin Ymax
1 W_937.803 (50,360,5) 936.69 938.91 -1.50 4.50 400.12 400.12
2 W_933.380 (50,360,5) 932.27 934.49 -1.50 4.50 400.12 400.12
3 W_930.748 (50,360,5) 929.64 931.86 -1.50 4.50 400.12 400.12
4 W_926.226 (50,360,5) 925.11 927.34 -1.50 4.50 400.12 400.12
5 W_909.000 (50,360,5) 907.89 910.11 -1.50 4.50 400.12 400.12
6 W_944.520 (50,360,5) 943.41 945.63 -1.50 4.50 400.12 400.12
IDL> col = sgt_column(filename,data_col=1)
or
IDL> rd_sumer,filename,index,data
IDL> col = sgt_column(data,data_col=1)
or
IDL> rd_sumer,filename,index,data
IDL> col = sgt_column(index,data,data_col=1,lambda=lambda)
MODIFICATION HISTORY:
HPW 08-AUG-1996:
[Previous]
[Next]
NAME:
sgt_compress
PURPOSE:
To retrieve the compression scheme used on date from a SOHO/SUMER
observation.
CATEGORY:
Data handling.
CALLING SEQUENCE:
c = sgt_compress(index)
INPUTS:
The index structure returned from rd_sumer.
OPTIONAL INPUTS:
None.
KEYWORD PARAMETERS:
None.
OUTPUTS:
The code of the compression scheme used to compress the data.
OPTIONAL OUTPUTS:
compar: The compression parameters used.
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], sgt_tagname
COMMON BLOCKS:
None.
SIDE EFFECTS:
If the COMPRESS, COMPAR1, COMPAR2, or COMPAR3 tag names can not be
found in the index structure passed to the routine, an error occurs.
If COMPRESS equals a null string ('') then -1 is returned.
RESTRICTIONS:
Only the index structure may be passed as input. It may turn out to
be useful to pass the filename as input and this option may be added
in the future.
PROCEDURE:
The routine returns the values of index.gen.compress and
index.gen.compar* from the index structure. The values of binx and
biny have been taken directly from the primary FITS header.
EXAMPLE:
IDl> filename = '$SUMER_DATA/sum_960513_085055.fits'
IDL> rd_sumer,index,data
IDL> c = sgt_compress(index,compar=compar)
IDL> print,c
5
IDL> print,compar
33 89 0
MODIFICATION HISTORY:
HPW 24-JUL-1996:
HPW 07-AUG-1996: Renamed sgt_compress.
[Previous]
[Next]
Project:
SOHO - SUMER
Name:
SGT_CRPIX
Purpose:
To calculate the refence pixel in the data corresponding to the
reference pixel on the detector. The result should be analogous to the
fits CRVAL.
Use:
Result = SGT_CRPIX(index)
Result = SGT_CRPIX(index(0))
Inputs
index - The index structure returned from rd_sumer.
Output
CRPIX - the reference pixel in the data format
Input Keywords:
PreBin - Calculate the crval for the format before binning
Calls: ***
sgt_bin, sgt_dims, sgt_refpix, sgt_tagname
CALLED BY:
CALL_TRIWARP, SGT_NEWREF, SMK_FULLDET, SUM_GAUSSB, sgt_det_y
Common:
None
Written:
Terry Kucera, 2 Aug 1996
Added PreBin keyword, Sept. 5, 1996, TAK
Now it can deal correctly with index sub-elements, Sept. 26, 1996, TAK
Now returns correct idl index for dimensions other
than wavelength and solar_y, Dec 21, 1996, TAK
[Previous]
[Next]
NAME:
sgt_delta
PURPOSE:
To retrieve the spatial and spectral resolution of a SOHO/SUMER
observation.
CATEGORY:
Data handling.
CALLING SEQUENCE:
delta = sgt_delta(index)
delta = sgt_delta(index.(i))
INPUTS:
The index structure returned from rd_sumer.
OPTIONAL INPUTS:
None.
KEYWORD PARAMETERS:
None.
OUTPUTS:
The spatial and spectral resolution of an observation.
OPTIONAL OUTPUTS:
None.
CALLS: ***
BOOST_ARRAY [1], BOOST_ARRAY [2], BOOST_ARRAY [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], sgt_tagname
CALLED BY:
SGT_NEWREF, mk_query_genx, sgt_det_y, sgt_wave, smk_atlas
COMMON BLOCKS:
None.
SIDE EFFECTS:
If the DELTA tag name can not be found in the index structure passed
to the routine, an error occurs.
RESTRICTIONS:
Only the index structure may be passed as input. It may turn out to
be useful to pass the filename as input and this option may be added
in the future.
PROCEDURE:
The routine returns the values of index.(i).delta which have been
taken from the binary table extension header in the FITS file.
EXAMPLE:
IDl> filename = '$SUMER_DATA/sum_960513_085055.fits'
IDL> rd_sumer,index,data
IDL> help,/str,index
** Structure <21fa08>, 7 tags, length=1648, refs=1:
W_937_803 STRUCT -> <Anonymous> Array(1)
W_933_380 STRUCT -> <Anonymous> Array(1)
W_930_748 STRUCT -> <Anonymous> Array(1)
W_926_226 STRUCT -> <Anonymous> Array(1)
W_909_000 STRUCT -> <Anonymous> Array(1)
W_944_520 STRUCT -> <Anonymous> Array(1)
GEN STRUCT -> <Anonymous> Array(1)
IDL> delta = sgt_delta(index)
IDL> print,delta
0.0444715 1.01629 1.20000
0.0444845 1.01659 1.20000
0.0444922 1.01676 1.20000
0.0445055 1.01707 1.20000
0.0445552 1.01820 1.20000
0.0444515 1.01583 1.20000
Note that in some files, such as this one, the delta value
corresponding to the x pointing corrdinate may be incorrect.
IDL> delta = sgt_delta(index.(0))
IDL> print,delta
0.0444715 1.01629 1.20000
IDL> delta = sgt_delta(index.(6))
% GT_DELTA: Pathological index structure.
MODIFICATION HISTORY:
HPW 24-JUL-1996:
HPW 07-AUG-1996: Renamed sgt_delta.
HPW 15-OCT-1996: Modified the routine to use boost_array for array
concatenation.
[Previous]
[Next]
NAME:
sgt_det_y
PURPOSE:
Returns a position array based on the index structure
CATEGORY:
Data handling.
CALLING SEQUENCE:
y = sgt_det_y(index)
y = sgt_det_y(index.(i))
INPUTS:
Either the entire index structure, in which case an array for each
column of data in the index is returned or part of the index
structure.
OPTIONAL INPUTS:
None
KEYWORD PARAMETERS:
no_flip: Don't reverse the direction of y.
Default no_flip=1 for .fts files,
no_flip=0 for .fits files.
OUTPUTS:
The position along the slit in arcseconds.
OPTIONAL OUTPUTS:
None.
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], SGT_CRPIX, UNIQ [1], UNIQ [2], UNIQ [3]
sgt_delta, sgt_dims, sgt_solar_y
CALLED BY:
mk_sumer_map [1], mk_sumer_map [2], mk_sumer_map [3]
COMMON BLOCKS:
None.
SIDE EFFECTS:
If the necessary tag names can not be found in the index structure
passed to the routine, an error occurs.
RESTRICTIONS:
None.
PROCEDURE:
Uses the refpix, refval, dim, and delta variables from the index
structure to compute the position array
EXAMPLE:
IDL> filename = '$SUMER_DATA/sum_960513_085055.fits'
IDL> mk_query,filename
File: /net/solb2/soho/sumer_fits/mariska/sum_960513_085055.fits
C Name Dimensions Wmin Wmax Xmin Xmax Ymin Ymax
1 W_937.803 (50,360,5) 936.69 938.91 -1.50 4.50 400.12 400.12
2 W_933.380 (50,360,5) 932.27 934.49 -1.50 4.50 400.12 400.12
3 W_930.748 (50,360,5) 929.64 931.86 -1.50 4.50 400.12 400.12
4 W_926.226 (50,360,5) 925.11 927.34 -1.50 4.50 400.12 400.12
5 W_909.000 (50,360,5) 907.89 910.11 -1.50 4.50 400.12 400.12
6 W_944.520 (50,360,5) 943.41 945.63 -1.50 4.50 400.12 400.12
IDL> rd_sumer,index,data
IDL> y = sgt_det_y(index)
IDL> help,y
Y FLOAT = Array(360, 6)
IDL> plot,y(*,0),data.(0)(25,*,0)
MODIFICATION HISTORY:
HPW 09-AUG-1996:
TAK 06-JAN-1999: Default no_flip=1 for .fts files,
no_flip=0 for .fits files.
[Previous]
[Next]
NAME:
sgt_detector
PURPOSE:
To retrieve the detector used for a SOHO/SUMER observation.
CATEGORY:
Data handling.
CALLING SEQUENCE:
dector = sgt_detector(index)
INPUTS:
The index structure returned from rd_sumer.
OPTIONAL INPUTS:
None.
KEYWORD PARAMETERS:
Text: Returns a string (A, B, or RSC) rather than a number (1, 2, or 3).
OUTPUTS:
The detector used for a SOHO/SUMER observation in either string (A,
B, or RSC) or number (1, 2, or 3) format.
OPTIONAL OUTPUTS:
None.
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], sgt_tagname
CALLED BY:
GET_SUMER_FLAT, destr_bilin [2], mk_query_genx, mk_sumer_dbase_ff
sa_gt_specrange, smk_atlas, sumer_destretch, sumer_ffdb
COMMON BLOCKS:
None.
SIDE EFFECTS:
If the detector tag name can not be found in the index structure
passed to the routine, an error occurs.
RESTRICTIONS:
Only the index structure may be passed as input. It may turn out to
be useful to pass the filename as input and this option may be added
in the future.
PROCEDURE:
The routine returns the values of index.gen.detector from the index
structure. The value for detector has been taken directly from the
primary FITS header.
EXAMPLE:
IDl> filename = '$SUMER_DATA/sum_960513_085055.fits'
IDL> rd_sumer,index,data
IDL> detector = sgt_detector(index)
IDL> print,detector
1
IDL> detector = sgt_detector(index,/text)
IDL> print,detector
A
MODIFICATION HISTORY:
HPW 24-JUL-1996:
HPW 07-AUG-1996: Renamed sgt_detector.
[Previous]
[Next]
NAME:
sgt_dettime
PURPOSE:
To retrieve the time since the start of observations
for a SOHO/SUMER observation.
CATEGORY:
Data handling.
CALLING SEQUENCE:
dettime = sgt_dettime(index)
dettime = sgt_dettime(index.(i))
INPUTS:
The index structure returned from rd_sumer.
OPTIONAL INPUTS:
None.
KEYWORD PARAMETERS:
None.
OUTPUTS:
The time since the starttime listed in the file header in seconds.
If the entire index structure is
passed then an time for each exposure in the corresponding data
structure is returned. If the index structure corresponding to a
single column of data is passed then times for those data are returned.
OPTIONAL OUTPUTS:
None.
CALLS: ***
BOOST_ARRAY [1], BOOST_ARRAY [2], BOOST_ARRAY [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], sgt_tagname
CALLED BY:
mk_sumer_map [1], mk_sumer_map [2], mk_sumer_map [3], sgt_raster_time
COMMON BLOCKS:
None.
SIDE EFFECTS:
If the DETTIME tag name can not be found in the index structure
passed to the routine, an error occurs.
RESTRICTIONS:
Only the index structure may be passed as input. It may turn out to
be useful to pass the filename as input and this option may be added
in the future.
PROCEDURE:
The routine returns the values of index.(i).dettime which have been
taken from the binary table extension header in the FITS file.
EXAMPLE:
IDl> filename = '$SUMER_DATA/sum_960513_085055.fits'
IDL> rd_sumer,filename,index,data
IDL> help,/str,index
** Structure <21fa08>, 7 tags, length=1648, refs=1:
W_937_803 STRUCT -> <Anonymous> Array(1)
W_933_380 STRUCT -> <Anonymous> Array(1)
W_930_748 STRUCT -> <Anonymous> Array(1)
W_926_226 STRUCT -> <Anonymous> Array(1)
W_909_000 STRUCT -> <Anonymous> Array(1)
W_944_520 STRUCT -> <Anonymous> Array(1)
GEN STRUCT -> <Anonymous> Array(1)
IDL> dettime = sgt_dettime(index)
IDL> print,dettime
0.000 100.017 200.028 300.970 400.982
0.000 100.017 200.028 300.970 400.982
0.000 100.017 200.028 300.970 400.982
0.000 100.017 200.028 300.970 400.982
0.000 100.017 200.028 300.970 400.982
0.000 100.017 200.028 300.970 400.982
IDL> dettime = sgt_dettime(index.(0))
IDL> print,dettime
0.000 100.017 200.028 300.970 400.982
IDL> dettime = sgt_dettime(index.(6))
% GT_DETTIME: Pathological index structure.
MODIFICATION HISTORY:
TAK 28-Oct-1996: based on HPW's sgt_exptime
[Previous]
[Next]
NAME:
sgt_dims
PURPOSE:
To retrieve the spatial and spectral dimensions of a SOHO/SUMER
observation.
CATEGORY:
Data handling.
CALLING SEQUENCE:
dims = sgt_dims(index)
dims = sgt_dims(index.(i))
INPUTS:
The index structure returned from rd_sumer.
OPTIONAL INPUTS:
None.
KEYWORD PARAMETERS:
None.
OUTPUTS:
The spatial and spectral dimensions of the array which holds data
from an observation. If the entire index structure is passed then
the dimensions of all of the data columns are used. If only a subset
of the index structure is passed then only the dimensions of those
data columds are returned.
OPTIONAL OUTPUTS:
None.
CALLS: ***
BOOST_ARRAY [1], BOOST_ARRAY [2], BOOST_ARRAY [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], sgt_tagname
CALLED BY:
CALL_TRIWARP, SGT_CRPIX, SGT_NEWREF, SMK_FULLDET, SUM_GAUSSB, destr_bilin [2]
mk_query_genx, mk_sumer_map [1], mk_sumer_map [2], mk_sumer_map [3]
sa_gt_specrange, sgt_det_y, sgt_range, sgt_wave, smk_atlas, sumer_destretch
COMMON BLOCKS:
None.
SIDE EFFECTS:
If the DIMS tag name can not be found in the index structure passed
to the routine, an error occurs.
RESTRICTIONS:
Only the index structure may be passed as input. It may turn out to
be useful to pass the filename as input and this option may be added
in the future.
PROCEDURE:
The routine returns the values of index.(i).dims which have been
taken from the binary table extension header in the FITS file.
EXAMPLE:
IDl> filename = '$SUMER_DATA/sum_960513_085055.fits'
IDL> rd_sumer,index,data
IDL> help,/str,index
** Structure <21fa08>, 7 tags, length=1648, refs=1:
W_937_803 STRUCT -> <Anonymous> Array(1)
W_933_380 STRUCT -> <Anonymous> Array(1)
W_930_748 STRUCT -> <Anonymous> Array(1)
W_926_226 STRUCT -> <Anonymous> Array(1)
W_909_000 STRUCT -> <Anonymous> Array(1)
W_944_520 STRUCT -> <Anonymous> Array(1)
GEN STRUCT -> <Anonymous> Array(1)
IDL> dims = sgt_dims(index)
IDL> print,dims
50 360 5
50 360 5
50 360 5
50 360 5
50 360 5
50 360 5
IDL> dims = sgt_dims(index.(0))
IDL> print,dims
50 360 5
IDL> dims = sgt_dims(index.(6))
% GT_DIMS: Pathological index structure.
MODIFICATION HISTORY:
HPW 24-JUL-1996:
HPW 07-AUG-1996: Renamed sgt_dims.
HPW 15-OCT-1996: Modified the routine to use boost_array for array
concatenation.
[Previous]
[Next]
NAME:
sgt_exposure
PURPOSE:
To retrieve an exposure of a SOHO/SUMER detector from a data
structure or fits file.
CATEGORY:
Data handling.
CALLING SEQUENCE:
exposure = sgt_exposure(data,data_col=1,data_exp=1)
exposure = sgt_exposure(filename,data_col=1,data_exp=1)
exposure = sgt_exposure(index,data,data_col=1,data_exp=1,lambda=lambda)
INPUTS:
Either the data structure returned from rd_sumer or a file name. If
the data column and detector exposure are not specified the first
exposure from the first data column is returned.
OPTIONAL INPUTS:
If the wavelength range is also desired then the index structure
must also be passed. Note that in this case the index variable
PRECEEDES the data variable.
KEYWORD PARAMETERS:
data_col: The column from which the detector exposure is to be
returned. The columns are number from 1 to the number of
data columns.
data_exp: The detector exposure to be returned. The exposures are
numbered from 1 to the number of exposures within a data
column.
OUTPUTS:
The data from an exposure of the detector.
OPTIONAL OUTPUTS:
An array corresponding to the wavelength (dispersion) direction of
the detector.
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], rd_sumer [1], rd_sumer [2], sgt_wave
CALLED BY:
sgt_spectrum
COMMON BLOCKS:
None.
SIDE EFFECTS:
None.
RESTRICTIONS:
Only a single exposure may be specified.
PROCEDURE:
If the data structure is passed then the routine simply returns the
specified data. If a file name is passed then the specified data
column is first read with rd_sumer.
EXAMPLE:
Here the fifth exposure from the first data column is returned.
IDL> filename = 'sum_960513_085055.fits'
IDL> mk_query,filename
File: sum_960513_085055.fits
C Name Dimensions Wmin Wmax Xmin Xmax Ymin Ymax
1 W_937.803 (50,360,5) 936.69 938.91 -1.50 4.50 400.12 400.12
2 W_933.380 (50,360,5) 932.27 934.49 -1.50 4.50 400.12 400.12
3 W_930.748 (50,360,5) 929.64 931.86 -1.50 4.50 400.12 400.12
4 W_926.226 (50,360,5) 925.11 927.34 -1.50 4.50 400.12 400.12
5 W_909.000 (50,360,5) 907.89 910.11 -1.50 4.50 400.12 400.12
6 W_944.520 (50,360,5) 943.41 945.63 -1.50 4.50 400.12 400.12
IDL> dat = sgt_exposure(filename,data_col=1,data_exp=5)
or
IDL> rd_sumer,filename,index,data
IDL> dat = sgt_exposure(data,data_col=1,data_exp=5)
or
IDL> rd_sumer,filename,index,data
IDL> dat = sgt_exposure(index,data,data_col=1,data_exp=5,lambda=lambda)
MODIFICATION HISTORY:
HPW 08-AUG-1996:
HPW 30-DEC-1996: Fixed a bug that made it impossible to read the
specified exposure.
[Previous]
[Next]
NAME:
sgt_exptime
PURPOSE:
To retrieve the exposure time for a SOHO/SUMER observation.
CATEGORY:
Data handling.
CALLING SEQUENCE:
exptime = sgt_exptime(index)
exptime = sgt_exptime(index.(i))
INPUTS:
The index structure returned from rd_sumer.
OPTIONAL INPUTS:
None.
KEYWORD PARAMETERS:
None.
OUTPUTS:
The exposure time in seconds. If the entire index structure is
passed then an time for each exposure in the corresponding data
structure is returned. If the index structure corresponding to a
single column of data is passed then times for those data are returned.
OPTIONAL OUTPUTS:
None.
CALLS: ***
BOOST_ARRAY [1], BOOST_ARRAY [2], BOOST_ARRAY [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], sgt_tagname
CALLED BY:
counts2countrate, mk_query_genx, sgt_raster_time
COMMON BLOCKS:
None.
SIDE EFFECTS:
If the EXPTIME tag name can not be found in the index structure
passed to the routine, an error occurs.
RESTRICTIONS:
Only the index structure may be passed as input. It may turn out to
be useful to pass the filename as input and this option may be added
in the future.
PROCEDURE:
The routine returns the values of index.(i).exptime which have been
taken from the binary table extension header in the FITS file.
EXAMPLE:
IDl> filename = '$SUMER_DATA/sum_960513_085055.fits'
IDL> rd_sumer,index,data
IDL> help,/str,index
** Structure <21fa08>, 7 tags, length=1648, refs=1:
W_937_803 STRUCT -> <Anonymous> Array(1)
W_933_380 STRUCT -> <Anonymous> Array(1)
W_930_748 STRUCT -> <Anonymous> Array(1)
W_926_226 STRUCT -> <Anonymous> Array(1)
W_909_000 STRUCT -> <Anonymous> Array(1)
W_944_520 STRUCT -> <Anonymous> Array(1)
GEN STRUCT -> <Anonymous> Array(1)
IDL> exptime = sgt_exptime(index)
IDL> print,exptime
100.000 100.000 100.000 100.000 100.000
100.000 100.000 100.000 100.000 100.000
100.000 100.000 100.000 100.000 100.000
100.000 100.000 100.000 100.000 100.000
100.000 100.000 100.000 100.000 100.000
100.000 100.000 100.000 100.000 100.000
IDL> exptime = sgt_exptime(index.(0))
IDL> print,exptime
100.000 100.000 100.000 100.000 100.000
IDL> exptime = sgt_exptime(index.(6))
% GT_EXPTIME: Pathological index structure.
MODIFICATION HISTORY:
HPW 24-JUL-1996:
HPW 07-AUG-1996: Renamed sgt_exptime.
HPW 15-OCT-1996: Modified the routine to use boost_array for array
concatenation.
HPW 06-MAY-1999: Modified to return scalar if only one element.
[Previous]
[Next]
NAME:
sgt_file_type
PURPOSE:
Determines if a file is a fits file or a genx file.
CATEGORY:
Data handling.
CALLING SEQUENCE:
file_type = sgt_file_type(filename)
INPUTS:
The file name.
OPTIONAL INPUTS:
None.
KEYWORD PARAMETERS:
sumer: Returns SUMERGENX if the file is a genx file written with
wrt_sumer and YOHOGENX if the file was written with wrt_genx.
OUTPUTS:
A string which contains 'FITS', 'GENX', 'SUMERGENX', 'YOHKOHGENX',
or 'UNKNOWN'.
OPTIONAL OUTPUTS:
None.
CALLED BY:
mk_query [1], mk_query [2], mk_query_genx, rd_sumer [1], rd_sumer [2]
rd_sumer_genx
COMMON BLOCKS:
None.
SIDE EFFECTS:
None?
RESTRICTIONS:
Only identifies FITS files or files written with wrt_genx or
wrt_sumer. Note that non-genx files that happen to have the first 4
bytes equal to 0 will erronously be indentified as genx files.
PROCEDURE:
The obvious: Reads the fits few bytes of the file and looks for the
FITS keyword SIMPLE. Alternatively, the version number
of the genx file is checked.
EXAMPLE:
IDL> file = 'MyFitsFile.file'
IDL> print,sgt_file_type(file)
FITS
IDL> file = 'MyGenxFile.file'
IDL> print,sgt_file_type(file)
GENX
IDL> file = 'MyUnknownFile.file'
IDL> print,sgt_file_type(file)
UNKNOWN
MODIFICATION HISTORY:
HPW 31-OCT-1996: Original version.
HPW 17-JUL-1997: Modified to identify new version of sumer genx
file (version 998).
HPW 18-JUL-1997: Added SUMER keyword to allow the differentiation
of SUMER genx and YOHKOH genx files.
HPW 26-APR-1999: Fixed bug - no /xdr on open.
[Previous]
[Next]
Project:
SOHO - SUMER
Name:
SGT_NEWREF
Purpose:
Create new index containing new values for refpix, refval, and dims
given a subset of data format.
Use:
index_out = sgt_newref(index,wrange=[2,80],yrange=[10,20])
Inputs:
Index - a sumer index structure
Output:
Index_Out - a sumer index strucutue with new valies for REFVAL,
REFPIX, DIMS, and the tagnames. The dispersion and wavelengths
listed in the header are used to calculate the new REFVAL
and tagnames.
Input Keywords:
WRange - range of extracted data in wavelength dimension. In pixels
of the data format.
YRange - range of extracted data in SOLAR_Y dimension . In pixels
of the data format.
CALLS: ***
SCONV_TAGNAMES, SGT_BTE, SGT_CRPIX, sgt_delta, sgt_dims, sgt_refpix, sgt_refval
CALLED BY:
SUM_GAUSSB
Common:
None
Written:
Terry Kucera, 14 Aug 1996
[Previous]
[Next]
NAME:
sgt_range
PURPOSE:
provides the range of pixels for SUMER subformats
CATEGORY:
Data analysis.
CALLING SEQUENCE:
sgt_range,index[,/spatial]
INPUTS:
The index structure returned from rd_sumer.
OPTIONAL INPUTS:
None.
KEYWORD PARAMETERS:
spatial: if set give the spatial (y) pixel limits
spectral: if set give the specxtral pixel limits (default)
OUTPUTS:
The range in pixels of the data on the detector in either the y
direction (along the slit) or in the x (wavelength) direction
OPTIONAL OUTPUTS:
None.
CALLS: ***
BOOST_ARRAY [1], BOOST_ARRAY [2], BOOST_ARRAY [3], sgt_dims, sgt_refpix, sgt_slit
CALLED BY:
destr_bilin [2], sumer_destretch
COMMON BLOCKS:
None.
SIDE EFFECTS:
None.
MODIFICATION HISTORY:
HPW :
TAK 5-May-1999: Now gives correct yrange for both real time data
and cd-rom data.
[Previous]
[Next]
Project:
SOHO - SUMER
Name:
sgt_raster_time
Purpose:
To calculate the times at which individual exposures were taken.
Use:
Result = SGT_RASTER_TIME(index)
Inputs
index - The index structure returned from rd_sumer.
Output
the times of the individual exposures or (with keyword LIMITS) rasters
in data
Input Keywords:
Limits - give only start and end times of each raster, rather than the
time of each individual exposure
All keywords used with ANYTIM2CAL, including
FORM = n where
n output format
0 dd/mmm/yy hh:mm:ss [default]
1 dd-mmm-yy hh:mm:ss
2 dd/mm/yy hh:mm:ss
3 dd-mm-yy hh:mm:ss
4 mm/dd/yy hh:mm:ss
5 mm-dd-yy hh:mm:ss
6 yy/mm/dd hh:mm:ss
7 yy-mm-dd hh:mm:ss
8 yyyymmddhhmmss
9 dd-mmm-yyyy hh:mm:ss.sss (VMS-like)
10 dd-mmm-yyyy hh:mm:ss.ss (!stime-like)
etc TBD
Calls: ***
ANYTIM2CAL, ANYTIM2TAI, sgt_dettime, sgt_exptime
Common:
None
Written:
Terry Kucera, 28 Oct 1996
Modifications:
Fixed bug related to files with just one exposure. 28 sept. 1998, tak
[Previous]
[Next]
NAME:
sgt_refpix
PURPOSE:
To retrieve the reference pixels used to co-register the data with
the detector face.
CATEGORY:
Data handling.
CALLING SEQUENCE:
refpix = sgt_refpix(index)
refpix = sgt_refpix(index.(i))
INPUTS:
The index structure returned from rd_sumer.
OPTIONAL INPUTS:
None.
KEYWORD PARAMETERS:
None.
OUTPUTS:
The wavelength and spatial reference pixels. If the entire index
structure is passed then all of reference pixels are returned. If
the index structure corresponding to a single column of data is
passed then only those reference pixels are returned.
Note that the reference pixel returned corresponds to the
co-pixel+1.
OPTIONAL OUTPUTS:
None.
CALLS: ***
BOOST_ARRAY [1], BOOST_ARRAY [2], BOOST_ARRAY [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], sgt_tagname
CALLED BY:
CALL_TRIWARP, SGT_CRPIX, SGT_NEWREF, SMK_FULLDET, SUM_GAUSSB, destr_bilin [2]
mk_query_genx, sgt_range, sgt_wave, smk_atlas, sumer_destretch
COMMON BLOCKS:
None.
SIDE EFFECTS:
If the REFPIX tag name can not be found in the index structure
passed to the routine, an error occurs.
RESTRICTIONS:
Only the index structure may be passed as input. It may turn out to
be useful to pass the filename as input and this option may be added
in the future.
PROCEDURE:
The routine returns the values of index.(i).refpix which have been
taken from the binary table extension header in the FITS file.
EXAMPLE:
IDl> filename = '$SUMER_DATA/sum_960513_085055.fits'
IDL> rd_sumer,index,data
IDL> help,/str,index
** Structure <21fa08>, 7 tags, length=1648, refs=1:
W_937_803 STRUCT -> <Anonymous> Array(1)
W_933_380 STRUCT -> <Anonymous> Array(1)
W_930_748 STRUCT -> <Anonymous> Array(1)
W_926_226 STRUCT -> <Anonymous> Array(1)
W_909_000 STRUCT -> <Anonymous> Array(1)
W_944_520 STRUCT -> <Anonymous> Array(1)
GEN STRUCT -> <Anonymous> Array(1)
IDL> refpix = sgt_refpix(index)
IDL> print,refpix
715.000 179.000 1.00000
616.000 179.000 1.00000
557.000 179.000 1.00000
456.000 179.000 1.00000
72.0000 179.000 1.00000
865.000 179.000 1.00000
IDL> refpix = sgt_refpix(index.(0))
IDL> print,refpix
715.000 179.000 1.00000
IDL> refpix = sgt_refpix(index.(6))
% GT_REFPIX: Pathological index structure.
MODIFICATION HISTORY:
HPW 24-JUL-1996:
HPW 07-AUG-1996: Renamed sgt_refpix.
HPW 15-OCT-1996: Modified the routine to use boost_array for array
concatenation.
[Previous]
[Next]
NAME:
sgt_refval
PURPOSE:
To retrieve the reference values used to co-register the data with
the SOHO/SUMER detector face.
CATEGORY:
Data handling.
CALLING SEQUENCE:
refval = sgt_refval(index)
refval = sgt_refval(index.(i))
INPUTS:
The index structure returned from rd_sumer.
OPTIONAL INPUTS:
None.
KEYWORD PARAMETERS:
None.
OUTPUTS:
The wavelength and spatial reference values in pixels. If the entire
index structure is passed then all of reference pixels are
returned. If the index structure corresponding to a single column of
data is passed then only those reference pixels are returned.
OPTIONAL OUTPUTS:
None.
CALLS: ***
BOOST_ARRAY [1], BOOST_ARRAY [2], BOOST_ARRAY [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], sgt_tagname
CALLED BY:
SGT_NEWREF, SMK_FULLDET, get_sum_column, mk_query_genx, sgt_wave, smk_atlas
COMMON BLOCKS:
None.
SIDE EFFECTS:
If the refval tag name can not be found in the index structure
passed to the routine, an error occurs.
RESTRICTIONS:
Only the index structure may be passed as input. It may turn out to
be useful to pass the filename as input and this option may be added
in the future.
PROCEDURE:
The routine returns the values of index.(i).refval which have been
taken from the binary table extension header in the FITS file.
EXAMPLE:
IDl> filename = '$SUMER_DATA/sum_960513_085055.fits'
IDL> rd_sumer,index,data
IDL> help,/str,index
** Structure <21fa08>, 7 tags, length=1648, refs=1:
W_937_803 STRUCT -> <Anonymous> Array(1)
W_933_380 STRUCT -> <Anonymous> Array(1)
W_930_748 STRUCT -> <Anonymous> Array(1)
W_926_226 STRUCT -> <Anonymous> Array(1)
W_909_000 STRUCT -> <Anonymous> Array(1)
W_944_520 STRUCT -> <Anonymous> Array(1)
GEN STRUCT -> <Anonymous> Array(1)
IDL> refval = sgt_refval(index)
IDL> print,refval
937.803 400.000 -1.00000
933.380 400.000 -1.00000
930.748 400.000 -1.00000
926.226 400.000 -1.00000
909.000 400.000 -1.00000
944.520 400.000 -1.00000
IDL> refval = sgt_refval(index.(0))
IDL> print,refval
937.803 400.000 -1.00000
IDL> refval = sgt_refval(index.(6))
% GT_REFVAL: Pathological index structure.
MODIFICATION HISTORY:
HPW 24-JUL-1996:
HPW 07-AUG-1996: Renamed sgt_refval.
HPW 15-OCT-1996: Modified the routine to use boost_array for array
concatenation.
[Previous]
[Next]
NAME:
sgt_slit
PURPOSE:
To retrieve the slit used for an SOHO/SUMER observation.
CATEGORY:
Data handling.
CALLING SEQUENCE:
slit = sgt_slit(index)
INPUTS:
The index structure returned from rd_sumer.
OPTIONAL INPUTS:
None.
KEYWORD PARAMETERS:
Text: Returns a string describing the slit instead of a numerical
code.
OUTPUTS:
An integer code or string which identifies the slit used in an
observation.
OPTIONAL OUTPUTS:
None.
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], sgt_tagname
CALLED BY:
CALL_TRIWARP, destr_bilin [2], mk_query_genx, sgt_range, sumer_destretch
COMMON BLOCKS:
None.
SIDE EFFECTS:
If the SLIT tag name can not be found in the index structure passed
to the routine, an error occurs.
RESTRICTIONS:
Only the index structure may be passed as input. It may turn out to
be useful to pass the filename as input and this option may be added
in the future.
PROCEDURE:
The routine parses the value of index.gen.slit from the index
structure. The value for slit has been taken directly from the
primary FITS header.
EXAMPLE:
IDl> filename = '$SUMER_DATA/sum_960513_085055.fits'
IDL> rd_sumer,index,/nodata
IDL> slit = sgt_slit(index)
IDL> print,slit
2
IDL> slit = sgt_slit(index,/text)
IDL> print,slit
<2> 1.0 * 300 centered
MODIFICATION HISTORY:
HPW 24-JUL-1996:
HPW 07-AUG-1996: Renamed sgt_slit.
[Previous]
[Next]
NAME:
sgt_solar_x
PURPOSE:
To retrieve the x corrdinate of the pointing of a SOHO/SUMER
observation.
CATEGORY:
Data handling.
CALLING SEQUENCE:
solar_x = sgt_solar_x(index)
solar_x = sgt_solar_x(index.(i))
INPUTS:
The index structure returned from rd_sumer.
OPTIONAL INPUTS:
None.
KEYWORD PARAMETERS:
None.
OUTPUTS:
The x coordinate of the pointing in arcsec. If the entire index
structure is passed then all of x coordinates are returned. If the
index structure corresponding to a single column of data is passed
then only those x coordinates are returned.
OPTIONAL OUTPUTS:
None.
CALLS: ***
BOOST_ARRAY [1], BOOST_ARRAY [2], BOOST_ARRAY [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], sgt_tagname
CALLED BY:
mk_query_genx, mk_sumer_map [1], mk_sumer_map [2], mk_sumer_map [3]
COMMON BLOCKS:
None.
SIDE EFFECTS:
If the SOLAR_X tag name can not be found in the index structure
passed to the routine, an error occurs.
RESTRICTIONS:
Only the index structure may be passed as input. It may turn out to
be useful to pass the filename as input and this option may be added
in the future.
PROCEDURE:
The routine returns the values of index.(i).solar_x which have been
taken from the binary table extension header in the FITS file.
EXAMPLE:
IDl> filename = '$SUMER_DATA/sum_960513_085055.fits'
IDL> rd_sumer,index,data
IDL> help,/str,index
** Structure <21fa08>, 7 tags, length=1648, refs=1:
W_937_803 STRUCT -> <Anonymous> Array(1)
W_933_380 STRUCT -> <Anonymous> Array(1)
W_930_748 STRUCT -> <Anonymous> Array(1)
W_926_226 STRUCT -> <Anonymous> Array(1)
W_909_000 STRUCT -> <Anonymous> Array(1)
W_944_520 STRUCT -> <Anonymous> Array(1)
GEN STRUCT -> <Anonymous> Array(1)
IDL> solar_x = sgt_solar_x(index)
IDL> print,solar_x
-1.50000 0.00000 1.50000 3.00000 4.50000
-1.50000 0.00000 1.50000 3.00000 4.50000
-1.50000 0.00000 1.50000 3.00000 4.50000
-1.50000 0.00000 1.50000 3.00000 4.50000
-1.50000 0.00000 1.50000 3.00000 4.50000
-1.50000 0.00000 1.50000 3.00000 4.50000
IDL> solar_x = sgt_solar_x(index.(0))
IDL> print,solar_x
-1.50000 0.00000 1.50000 3.00000 4.50000
IDL> solar_x = sgt_solar_x(index.(6))
% GT_SOLAR_X: Pathological index structure.
MODIFICATION HISTORY:
HPW 24-JUL-1996:
HPW 07-AUG-1996: Renamed sgt_solar_x.
HPW 15-OCT-1996: Modified the routine to use boost_array for array
concatenation.
[Previous]
[Next]
NAME:
sgt_solar_y
PURPOSE:
To retrieve the y corrdinate of the pointing of a SOHO/SUMER
observation.
CATEGORY:
Data handling.
CALLING SEQUENCE:
solar_y = sgt_solar_y(index)
solar_y = sgt_solar_y(index.(i))
INPUTS:
The index structure returned from rd_sumer.
OPTIONAL INPUTS:
None.
KEYWORD PARAMETERS:
None.
OUTPUTS:
The y coordinate of the pointing in arcsec. If the entire index
structure is passed then all of y coordinates are returned. If the
index structure corresponding to a single column of data is passed
then only those y coordinates are returned.
OPTIONAL OUTPUTS:
None.
CALLS: ***
BOOST_ARRAY [1], BOOST_ARRAY [2], BOOST_ARRAY [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], sgt_tagname
CALLED BY:
mk_query_genx, sgt_det_y
COMMON BLOCKS:
None.
SIDE EFFECTS:
If the SOLAR_Y tag name can not be found in the index structure
passed to the routine, an error occurs.
RESTRICTIONS:
Only the index structure may be passed as input. It may turn out to
be useful to pass the filename as input and this option may be added
in the future.
PROCEDURE:
The routine returns the values of index.(i).solar_y which have been
taken from the binary table extension header in the FITS file.
EXAMPLE:
IDl> filename = '$SUMER_DATA/sum_960513_085055.fits'
IDL> rd_sumer,index,data
IDL> help,/str,index
** Structure <21fa08>, 7 tags, length=1648, refs=1:
W_937_803 STRUCT -> <Anonymous> Array(1)
W_933_380 STRUCT -> <Anonymous> Array(1)
W_930_748 STRUCT -> <Anonymous> Array(1)
W_926_226 STRUCT -> <Anonymous> Array(1)
W_909_000 STRUCT -> <Anonymous> Array(1)
W_944_520 STRUCT -> <Anonymous> Array(1)
GEN STRUCT -> <Anonymous> Array(1)
IDL> solar_y = sgt_solar_y(index)
IDL> print,solar_y
400.125 400.125 400.125 400.125 400.125
400.125 400.125 400.125 400.125 400.125
400.125 400.125 400.125 400.125 400.125
400.125 400.125 400.125 400.125 400.125
400.125 400.125 400.125 400.125 400.125
400.125 400.125 400.125 400.125 400.125
IDL> solar_y = sgt_solar_y(index.(0))
IDL> print,solar_y
400.125 400.125 400.125 400.125 400.125
IDL> solar_y = sgt_solar_y(index.(6))
% GT_SOLAR_Y: Pathological index structure.
MODIFICATION HISTORY:
HPW 24-JUL-1996:
HPW 07-AUG-1996: Renamed sgt_solar_y.
HPW 15-OCT-1996: Modified the routine to use boost_array for array
concatenation.
[Previous]
[Next]
NAME:
sgt_spectrum
PURPOSE:
To retrieve an SOHO/SUMER spectrum from a data structure or fits
file.
CATEGORY:
Data handling.
CALLING SEQUENCE:
spectrum = sgt_spectrum(data,data_col=1,data_exp=1,data_spec=180)
spectrum = sgt_spectrum(filename,data_col=1,data_exp=1,data_spec=180)
spectrum = sgt_spectrum(index,data,data_col=1,data_exp=1,data_spec=180,$
lambda=lambda)
INPUTS:
Either the data structure returned from rd_sumer or a file name. If
the data column, detector exposure, and/or spectrum are not
specified the first spectrum from the first exposure in the first
data column is returned.
OPTIONAL INPUTS:
If the wavelength range is also desired then the index structure
must also be passed. Note that in this case the index variable
PRECEEDES the data variable.
KEYWORD PARAMETERS:
data_col: The column from which the spectrum is to be returned. The
columns are number from 1 to the number of data columns.
data_exp: The detector exposure from which the spectrum is to be
returned. The exposures are numbered from 1 to the number
of exposures within a data column.
data_spec: The spectrum to be returned. The spectra are number from
1 to the number of spectra (essentially the length of the
slit) within an exposure.
OUTPUTS:
A spectrum.
OPTIONAL OUTPUTS:
An array corresponding to the wavelength (dispersion) direction of
the detector.
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], sgt_exposure
COMMON BLOCKS:
None.
SIDE EFFECTS:
None.
RESTRICTIONS:
Only a single spectrum may be specified.
PROCEDURE:
Calls sgt_exposure and then returns the specified spectrum.
EXAMPLE:
Here a spectrum at the center of the slit from the fifth exposure in
the first data column is returned.
IDL> filename = 'sum_960513_085055.fits'
IDL> mk_query,filename
File: sum_960513_085055.fits
C Name Dimensions Wmin Wmax Xmin Xmax Ymin Ymax
1 W_937.803 (50,360,5) 936.69 938.91 -1.50 4.50 400.12 400.12
2 W_933.380 (50,360,5) 932.27 934.49 -1.50 4.50 400.12 400.12
3 W_930.748 (50,360,5) 929.64 931.86 -1.50 4.50 400.12 400.12
4 W_926.226 (50,360,5) 925.11 927.34 -1.50 4.50 400.12 400.12
5 W_909.000 (50,360,5) 907.89 910.11 -1.50 4.50 400.12 400.12
6 W_944.520 (50,360,5) 943.41 945.63 -1.50 4.50 400.12 400.12
IDL> spec = sgt_spectrum(filename,data_col=1,data_exp=5,data_spec=180)
or
IDL> rd_sumer,filename,index,data
IDL> spec = sgt_spectrum(data,data_col=1,data_exp=5,data_spec=180)
or
IDL> rd_sumer,filename,index,data
IDL> spec = sgt_spectrum(index,data,data_col=1,data_exp=5,data_spec=180,$
lambda=lambda)
MODIFICATION HISTORY:
HPW 08-AUG-1996:
[Previous]
[Next]
NAME:
sgt_tagname
PURPOSE:
To retrieve the value of structure tag name.
CATEGORY:
Data handling.
CALLING SEQUENCE:
tag_value = sgt_tagname(structure,tag_name,status=status)
INPUTS:
A structure and tag name.
OPTIONAL INPUTS:
None.
KEYWORD PARAMETERS:
None.
OUTPUTS:
The value of structure tag name.
OPTIONAL OUTPUTS:
Status: Status is 0 (FALSE) if the input tag name is not found and 1
(TRUE) if it is. If status is false the routine returns a
null string ('') as output.
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3]
CALLED BY:
SGT_CRPIX, sgt_bin, sgt_compress, sgt_delta, sgt_detector, sgt_dettime, sgt_dims
sgt_exptime, sgt_refpix, sgt_refval, sgt_slit, sgt_solar_x, sgt_solar_y, sgt_time
COMMON BLOCKS:
None.
SIDE EFFECTS:
None?
RESTRICTIONS:
Input variable must be a structure. Only the first instance of a tag
name is returned. Additional sub-structures will not be searched
after the first instance of the specified tag name is found.
PROCEDURE:
The routine recursively desends the stucture searching for the
specified tag name.
EXAMPLE:
IDl> filename = '$SUMER_DATA/sum_960513_085055.fits'
IDL> rd_sumer,index,/nodata
IDL> date_obs = sgt_tagname(index,'date_obs',status=status)
IDL> print,date_obs
1996-05-13T08:50:55.030
IDL> print,status
1
MODIFICATION HISTORY:
HPW 24-JUL-1996:
HPW 07-AUG-1996: Renamed sgt_tagname.
[Previous]
[Next]
NAME:
sgt_time
PURPOSE:
To retrieve the time at which a SOHO/SUMER observation began.
CATEGORY:
Data handling.
CALLING SEQUENCE:
time = sgt_time(index)
INPUTS:
The index structure returned from rd_sumer.
OPTIONAL INPUTS:
None.
KEYWORD PARAMETERS:
DET_TIME: The start time for each exposure in the data structure.
OUTPUTS:
A seven element array containing the time. The elements of the array
are the hour, minute, second, millisecond, day, month, year that an
observation began. If the keyword DET_TIME is used the format will
be an array of the form (7,n_exposures,n_columns).
OPTIONAL OUTPUTS:
None.
CALLS: ***
ADDTIME [1], ADDTIME [2], BOOST_ARRAY [1], BOOST_ARRAY [2], BOOST_ARRAY [3]
DATATYPE [1], DATATYPE [2], DATATYPE [3], sgt_tagname
CALLED BY:
GET_SUMER_FLAT
COMMON BLOCKS:
None.
SIDE EFFECTS:
If the DATE_OBS tag name can not be found in the index structure
passed to the routine, an error occurs.
RESTRICTIONS:
Only the index structure may be passed as input. It may turn out to
be useful to pass the filename as input and this option may be added
in the future.
PROCEDURE:
The routine parses the value of index.gen.date_obs and returns it as
a seven element array. Optially, the det_time tag in the index
struture is used to determine the start time for each exposure.
EXAMPLE:
IDl> filename = '$SUMER_DATA/sum_960513_085055.fits'
IDL> rd_sumer,index,/nodata
IDL> time = sgt_time(index)
IDL> print,time
8 50 55 30 13 5 96
MODIFICATION HISTORY:
HPW 24-JUL-1996:
HPW 07-AUG-1996: Renamed sgt_time.
HPW 20-OCT-1997: Modified to return start times for each exposure.
[Previous]
[Next]
NAME:
sgt_wave
PURPOSE:
Returns a wavelength array based on the index structure
CATEGORY:
Data handling.
CALLING SEQUENCE:
wave = sgt_wave(index)
wave = sgt_wave(index.(i))
INPUTS:
Either the entire index structure, in which case the wavelength
array is based on the first data column, or the subset of the index
structure pertaining to a specific data column. See the routine
rd_sumer.pro for the definition of the index structure.
OPTIONAL INPUTS:
None
KEYWORD PARAMETERS:
None
OUTPUTS:
The wavelength array in Angstroms.
OPTIONAL OUTPUTS:
None.
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], UNIQ [1], UNIQ [2], UNIQ [3], sgt_delta
sgt_dims, sgt_refpix, sgt_refval
CALLED BY:
mk_query_genx, sgt_column, sgt_exposure
COMMON BLOCKS:
None.
SIDE EFFECTS:
If the necessary tag names can not be found in the index structure
passed to the routine, an error occurs.
RESTRICTIONS:
None.
PROCEDURE:
Uses the refpix, refval, dim, and delta variables from the index
structure to compute the wavelgnth array
EXAMPLE:
IDL> filename = '$SUMER_DATA/sum_960513_085055.fits'
IDL> mk_query,filename
File: /net/solb2/soho/sumer_fits/mariska/sum_960513_085055.fits
C Name Dimensions Wmin Wmax Xmin Xmax Ymin Ymax
1 W_937.803 (50,360,5) 936.69 938.91 -1.50 4.50 400.12 400.12
2 W_933.380 (50,360,5) 932.27 934.49 -1.50 4.50 400.12 400.12
3 W_930.748 (50,360,5) 929.64 931.86 -1.50 4.50 400.12 400.12
4 W_926.226 (50,360,5) 925.11 927.34 -1.50 4.50 400.12 400.12
5 W_909.000 (50,360,5) 907.89 910.11 -1.50 4.50 400.12 400.12
6 W_944.520 (50,360,5) 943.41 945.63 -1.50 4.50 400.12 400.12
IDL> rd_sumer,index,data
IDL> wave = sgt_wave(index)
IDL> help,wave
WAVE FLOAT = Array(50, 6)
IDL> plot,wave(*,0),total(data.(0)(*,*,0),2)
MODIFICATION HISTORY:
HPW 17-JUN-1996:
HPW 10-JUL-1996: Modified to work with new index structure.
HPW 24-JUL-1996: Modified to produce a wavelength array for each
column of the index structure that is passed to
the routine.
HPW 07-AUG-1996: Renamed sgt_wave.
HPW 27-FEB-1997: Fixed bug related to refpix.
HPW 21-JUL-1997: Added keywords first_order and second_order to
return selected wavelength range. The default is
still to return the wavelength range indicated by
delta and refval.
HPW 24-MAY-1999: Fixed a bug related to generating second order
wavelength scales.
[Previous]
[Next]
Project : SOHO - LASCO
Name :
Purpose :
Category :
Explanation :
Syntax :
CALLED BY:
LAYOUT
Examples :
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
CALLS: ***
LASCO_FITSHDR2STRUCT
Common :
Restrictions:
Side effects: Not known
History : Version 1, 14-May-1996, B Podlipnik. Written
Contact : BP, borut@lasco1.mpae.gwdg.de
[Previous]
[Next]
NAME:
SHARPEN
PURPOSE:
Sharpens a ratio image by adding in a small amount of an edge enhanced image
CATEGORY:
LASCO UTIL
CALLING SEQUENCE:
Result = SHARPEN(Img,Bkg,factor)
INPUTS:
Img: Input image in DN/sec
Bkg: Background image in DN/sec
Factor: Factor of edge enhanced image to add to original image, Default is .015
KEYWORD PARAMETERS:
PF: Point filter factor, default is 4
BOX_SIZE: Size of box to use in unsharp mask. Default is 11 points
NO_RATIO: Return straight edge-enhanced image
OUTPUTS:
This function returns the edge enhance ratio image as a real number.
CALLS: ***
point_filter
CALLED BY:
MKMOVIE, MKMOVIE0 obsolete version of mkmoviepro, MK_IMG
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
The procedure to enhance an image adds a little edge enhancement to the original image.
First the image (in DN/sec) is point filtered to remove the stars and cosmic rays.
Then the unsharp mask image is formed with the original image and the background
image. The edge enhanced image is the difference between the unsharp mask of
the original image and the background image. The difference is performed to remove
any artifacts such as stray light arcs that are in both the original and background images.
The ratio image is computed and the missing blocks are set to 1.0.
The edge enhanced image is computed as:
(Img/Bkg) + factor*edge_enhanced_image
EXAMPLE:
MODIFICATION HISTORY:
Written by: RAH, 20 Apr 98
99/10/27, N Rich Add NO_RATIO keyword
%W% %H% LASCO IDL LIBRARY
[Previous]
[Next]
NAME:
sharpfocus
PURPOSE:
To
CALLS: ***
FOCUS_AREA, SHARPFOCUS2, SHARPNESS
HISTORY:
Written 6-Apr-94 by M.Morrison (using Zayer routine as start)
26-Apr-94 (MDM) - Added /ISS option
[Previous]
[Next]
Project : SOHO - CDS
Name : SHOW_AXES
Purpose : Informs of axes type of CDS data structure.
Explanation : The data array returned in the .detdata tag by readcdsfits
can have either 2,3 or 4 dimensions. This routine lists the
axes descriptors by way of explanation of what the data array
represents.
Use : IDL> show_axes, structure
Inputs : structure - CDS data structure returned by READCDSFITS
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
FMT_VECT, GT_WINSIZE, N_DIMENSIONS
Common : None
Restrictions: None
Side effects: None
Category : CDS, FITS, array
Prev. Hist. : None
Written : C D Pike, RAL, 11-Jul-95
Modified :
Version : Version 1, 11-Jul-95
[Previous]
[Next]
NAME: show_catalog.pro
PURPOSE: list the catalog in memory
CATEGORY: Preprocessing
CALLING SEQUENCE: SHOW_CATALOG
INPUTS: None
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: None
OUTPUTS: catalog list in the screen
OPTIONAL OUTPUT PARAMETERS: None
COMMON BLOCKS: CATA, db_dark, ndarks, drk_name
SIDE EFFECTS: opens a catalog of darks if this dont exists
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY: defined by ALL 6/24/93
SCCS variables for IDL use
@(#)show_catalog.pro 1.0 25/6/93 :LAS
[Previous]
[Next]
Project : SOHO - CDS
Name : SHOW_CDHS
Purpose : Interprets CDHS series and raster IDs
Explanation : The series and raster IDs used by the CDHS are not the same
as the study and raster IDs in the ground based databases.
The correspondence between them is kept in the series_id and
raster_id databases. This routine allows the user to see which
groundbased studies and rasters are associated with a given
CDHS ID. If neither a series ID nor a raster ID are given then
a summary of all CDHS IDs is produced.
Use : IDL> show_cdhs [,raster=raster, series=series, /hardcopy, $
file=file, /quiet, /keep]
Inputs : None
Opt. Inputs : None
Outputs : Information is optionally printed to the screen and hardcopy.
Opt. Outputs: None
Keywords : RASTER - specifies the CDHS raster ID
SERIES - specifies the CDHS series ID
HARDCOPY - send copy of output to printer
KEEP - inhibits deletion of hardcopy file created in the
user's home directory.
FILE - if null on entry then the hardcopy file name
created is returned in this. If non-null on
entry then that file name is used for the output.
QUIET - if present, no information is output to the screen
Calls : ***
ANYTIM2CAL, Bell, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DELETE_FILE [1]
DELETE_FILE [2], FILEPATH, GET_CDHS_RASTER, GET_CDHS_SERIES, GET_UTC, PRINT_STR
RD_ASCII [1], RD_ASCII [2], SHOW_RASTER, SHOW_STUDY, concat_dir [4]
Common : None
Restrictions: None
Side effects: None
Category : Telemetry, planning
Prev. Hist. : None
Written : C D Pike, RAL, 9-Jun-95
Modified : Added message when output KEEPed. CDP, 27-Jul-95
Version : Version 2, 27-Jul-95
[Previous]
[Next]
Project : SOHO - CDS
Name : SHOW_DATAWIN
Purpose : To list the contents of the datawin database.
Explanation : Uses the datawin database access routines to present the
user with a listing of the requested line list(s).
Use : IDL> show_datawin [, num_list, /hardcopy, etc.]
Inputs : num_list - Integer or integer array giving ID numbers
of specific data window(s) required.
or
dw_struct - data window structure as returned by get_datawin
Opt. Inputs : None
Outputs : Listing is given to screen or printer if required.
Opt. Outputs: None
Keywords : DETECTOR - specify detector to which line lists relate.
HARDCOPY - print hardcopy of output.
QUIET - no output to screen
KEEP - keep output file
FILE - specify output file, or retrieve file used if
file = '' on entry. If file is omitted or
blank on entry then output is written to standard
file in user's 'home' directory. If a name is
supplied on entry, that filename is used
unchanged.
SUMMARY - summary of all lists (no details of individual
lines).
ERRMSG - return error in this if it is defined on entry
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], DELETE_FILE [1], DELETE_FILE [2], FILEPATH, FIND_ALL_DIR [1]
FIND_ALL_DIR [2], FIND_ALL_DIR [3], FMT_VECT, GET_DATAWIN, REM_MULT_CHAR, STRPAD
UPDATE_DEX, concat_dir [4]
Common : None
Restrictions: None
Side effects: None
Category : Database
Prev. Hist. : Based on tp_dump_setup.
Written : C D Pike, RAL, 24-May-95
Modified : Rework output file name calculation. CDP, 2-Jum-95
Added message when output KEEPed. CDP, 27-Jul-95
Update for new format of structure input. CDP, 6-Feb-96
Include CURRENT keyword. CDP, 7-Feb-96
Use FIND_ALL_DIR. CDP, 09-Aug-96
Version : Version 6, 09-Aug-96
[Previous]
[Next]
Project : SOHO - CDS
Name : SHOW_EVARS
Purpose : List current definitions of CDS environment variables.
Explanation : Collects and lists the definitions of the various environment
variables used by CDS.
Use : IDL> show_evars [,/hard]
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : HARDCOPY - produces a hardcopy listing.
QUIET - no screen output
KEEP - keeps the disk file of output (cds_evars_list) in
current directory.
Calls : ***
Bell, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DELETE_FILE [1]
DELETE_FILE [2], FILEPATH, GET_ENVIRON, STR2ARR [1], STR2ARR [2], STRPAD
concat_dir [4]
Common : None
Restrictions: None
Side effects: None
Category : Help
Prev. Hist. : None
Written : C D Pike, RAL, 3-Nov-95
Modified : Added CDS_CP_STMFILES(_W). CDP, 21-Nov-95
Added CDS_CP_UPDATE and _ENG. CDP, 8-Dec-95
Added CDS_SUMMARY_DATA CDP, 25-Jun-96
Added CDS_ENG_DEMO and use GET_ENVIRON
CDP, 09-Aug-96
Version : Version 5, 09-Aug-96
[Previous]
[Next]
NAME: show_hdr.pro
PURPOSE: visualize keywords in Calibration headers
CATEGORY: General tools high level routine
CALLING SEQUENCE: show_hdr or show_hdr,/FULL
INPUTS: None
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: /FULL
OUTPUTS: A list of ima_header
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS: None
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
All 4/25/93 for VMS files in general
SCCS variables for IDL use
@(#)show_hdr.pro 1.3 4/25/93 :LAS
[Previous]
[Next]
NAME: show_ima_hdr.pro
PURPOSE: visualize keywords from file headers
CATEGORY: General tools high level routine
CALLING SEQUENCE: show_ima_hdr, hdr_name
show_ima_hdr, hdr_name,/FULL
INPUTS: hdr_name Name of header file
OPTIONAL INPUT PARAMETERS: None
KEYWORD PARAMETERS: /FULL
OUTPUTS: A list of ima_header
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS: None
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
All 4/25/93 for VMS files in general
corrected by M.B according to the new features of headers
11/03/93
SCCS variables for IDL use
@(#)show_ima_hdr.pro 1.3 4/25/93 :LAS
[Previous]
[Next]
Project : SOHO - CDS
Name : SHOW_LINELIST
Purpose : To list the contents of the linelist database.
Explanation : Uses the linelist database access routines to present the
user with a listing of the requested line list(s).
Use : IDL> show_linelist [, num_list, /hardcopy, etc.]
Inputs : num_list - Integer or integer array giving ID numbers
of specific line list(s) required.
or
line_struct - line list structure as returned by get_linelist
Opt. Inputs : None
Outputs : Listing is given to screen or printer if required.
Opt. Outputs: None
Keywords : DETECTOR - specify detector to which line lists relate.
HARDCOPY - print hardcopy of output.
QUIET - no output to screen
KEEP - keep output file
FILE - specify output file, or retrieve file used if
file = '' on entry. If file is omitted or blank
on entry, then a standard file is written to
user's 'home' directory. Otherwise the file
name supplied is used unchanged.
SUMMARY - summary of all lists (no details of individual
lines).
ERRMSG - return error in this if it is defined on entry
Calls : ***
Bell, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], DELETE_FILE [1], DELETE_FILE [2], FILEPATH, FIND_ALL_DIR [1]
FIND_ALL_DIR [2], FIND_ALL_DIR [3], GET_LINELIST, LIST_LINELIST, concat_dir [4]
Common : None
Restrictions: None
Side effects: None
Category : Database
Prev. Hist. : None
Written : C D Pike, RAL, 14-Aug-94
Modified : Version 1, C D Pike, RAL, 14-Aug-94
Version 2, William Thompson, GSFC, 16 September 1994
Output to screen with /MORE
Version 3, William Thompson, GSFC, 15 March 1995
Removed LL_TITLE
Version 4, CDP, 24-May-95. Major revision to bring into line
with other show_xxx routines.
Version 5, CDP, 2-Jun-95. Rework file name handling.
Version 6, CDP, 08-Aug-96. Use FIND_ALL_DIR.
Version : Version 6, 08-Aug-96
[Previous]
[Next]
Name: show_pix_event
Purpose: event driver for xshow_pix
CALLS: ***
BREAK_FILE [1], BREAK_FILE [2], BREAK_FILE [3], EVENT_NAME, GET_WUVALUE
GET_WVALUE, WDEF [1], WDEF [2], XLOADCT [1], XLOADCT [2], XLOADCT [3], XMOVIE [1]
XMOVIE [2], break_file [4], data_chk [1], data_chk [2], get_info [1], get_info [2]
get_info [3], get_info [4], get_logenv [1], get_logenv [2], mapx [1], mapx [2]
restgen [1], restgen [2], ut_time [1], ut_time [2], wc_where [1], wc_where [2]
CALLED BY:
show_pix [1], show_pix [2]
History:
20-Dec-1993 (SLF) (guts of show_pix.pro, 10-Nov)
22-Dec-1993 (SLF) window creation logic (IDL feature workaround)
1-Feb-1994 (SLF) allow empty directories
18-Jul-1994 (SLF) if new data disply, show current UT Time
22-Jul-1994 (SLF) add common block (externalize after exit)
7-Sep-1994 (SLF) Prepend (not append) UT TIME for new_data subdirectory
16-feb-1994 (SLF) enable hardcopy option
2-apr-1995 (slf) movie option
10-apr-1995 (SLF) problem with pre-existing window display
[Previous]
[Next]
Project : SOHO - CDS
Name : SHOW_PLAN
Purpose : Produce a listing of a CDS observation plan.
Explanation : For those who like to read paper, this routine displays
the salient points in the definition of a CDS entry in
one of the planning databases.
Use : IDL> show_plan, str [,/detail, /sci etc.]
or
IDL> show_plan, utc [,/detail etc.]
Inputs : str - a valid CDS details definition structure
as returned by one of the get_xxxx routines.
OR
utc - a valid CDS time in utc internal format
Opt. Inputs : None
Outputs : Can send to file and print, also output to screen if needed.
Opt. Outputs: None
Keywords : KEEP - keep temporary output file. File name is
detail_yyyymmddhhmmss.dmp where the yyyy.... is
date and time of the start of the entry. For other
than the details database the prefic 'detail' is
replaced by something appropriate.
QUIET - no information to screen
HARDCOPY - send output to printer
ERRMSG - if defined on entry this will be returned with
any error messages that occur.
FILE - file name created is returned in this if defined
on entry (and set to '') or any input value is
used as the output file name.
SUMMARY - just give a summary of all entries (needs one
of following keywords to identify the plan
required.
DETAIL - use only the CDS details database
SCIENCE - use only the CDS science plan database
SOHO - use the Soho plan database
FLAG - use only the CDS flag database
ALT - use only the CDS alternative science plan
INSTRUMENT - instrument when selecting science plans (default
= all instruments)
NOW - do a summary from now to infinity
FROM - do a summary from this time to infinity
Calls : ***
ANYTIM2CAL, ANYTIM2UTC [1], ANYTIM2UTC [2], CONCAT_DIR [1], CONCAT_DIR [2]
CONCAT_DIR [3], DATATYPE [1], DATATYPE [2], DATATYPE [3], DELETE_FILE [1]
DELETE_FILE [2], FILEPATH, FMT_VECT, GET_DETAIL, GET_STUDY, GET_UTC, LIST_DETAIL
LIST_PLAN, STR2UTC [1], STR2UTC [2], STR2UTC [3], STRPAD, TAI2UTC, TRIM, UTC2STR
concat_dir [4]
Common : None
Restrictions: None
Side effects: None
Category : Planning, databases
Prev. Hist. : Based on original dump_detail.
Written : C D Pike, RAL, 26-Apr-95
Modified : Rework output file name use. CDP, 2-Jun-95
Add time tag info for details time line. CDP, 8-Jun-95
Added message when output KEEPed. CDP, 27-Jul-95
Added NOW keyword. CDP, 15-Nov-95
Added FROM keyword. CDP, 26-Feb-96
Added numberof rasters in /det,/summ mode. CDP, 1-Apr-96
Use tai in cal to get_detail instead of string. CDP, 3-May-96
Version : Version 8, 3-May-96
[Previous]
[Next]
Project : SOHO - CDS
Name :
SHOW_QUEUE
Purpose :
Show the contents of a print queue.
Explanation :
Spawns the proper command to the operating system to display the
contents of print queues.
Use :
SHOW_QUEUE [, QUEUE ]
Inputs :
None required.
Opt. Inputs :
QUEUE = Name of queue to be listed. If not passed, then the
environment variable PSLASER (or PSCOLOR) is checked for the
name of the print queue.
Outputs :
The information about the print queue is printed to the terminal
screen.
Opt. Outputs:
None.
Keywords :
COLOR = If set, then the environment variable PSCOLOR is checked for
the name of the print queue rather then PSLASER. Ignored if
QUEUE is passed.
Calls : ***
TRIM
Common :
None.
Restrictions:
In general, the SERTS graphics devices routines use the special system
variables !BCOLOR and !ASPECT. These system variables are defined in
the procedure DEVICELIB. It is suggested that the command DEVICELIB be
placed in the user's IDL_STARTUP file.
Side effects:
None.
Category :
Utilities, Devices.
Prev. Hist. :
William Thompson, July 1992.
Written :
William Thompson, GSFC, July 1992.
Modified :
Version 1, William Thompson, GSFC, 27 April 1993.
Incorporated into CDS library.
Version :
Version 1, 27 April 1993.
[Previous]
[Next]
Project : SOHO - CDS
Name : SHOW_RASTER
Purpose : Show details of a raster definition.
Explanation : Sets down on paper the details contained within the
raster structure. Output is stored in files 'raster_list'
for summary data or 'raster_{raster id}_{variation id}' for
details of specific rasters. All file are written to the
users home directory (unless the directory is specified by
the FILE keyword on entry).
Use : IDL> show_raster, ras_id, var_id
or
IDL> show_raster, ras_struct
Inputs : ras_id - fundamental raster ID number
var_id - raster variation number
or
ras_struct - structure returned by get_raster
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : QUIET - no output to screen
HARDCOPY - send details to printer
KEEP - keep disk file of details
DETECTOR - select from rasters of a given detector (only in
conjunction with SUMMARY keyword.
SUMMARY - give a summary of all rasters.
FILE - specify particular file name for output or
receive file name used if this is '' on entry.
If this keyword is omitted or is blank on entry
then output is written to a standard file in the
user's 'home' directory.
ERRMSG - if defined on entry, return error messages
in this variable
Calls : ***
Bell, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], DELETE_FILE [1], DELETE_FILE [2], FILEPATH, FIND_ALL_DIR [1]
FIND_ALL_DIR [2], FIND_ALL_DIR [3], FMT_VECT, GET_RASTER, LIST_F_RASTER
LIST_V_RASTER, concat_dir [4]
CALLED BY:
SHOW_CDHS
Common : None
Restrictions: None
Side effects: None
Category : Planning, databases
Prev. Hist. : Derived from tp_dump_setup used in mk_raster
Written : C D Pike, RAL, 24-May-95
Modified : Added spectrograph ID to summary listing. CDP, 17-Jul-95
Added message when file KEEPed. CDP, 27-Jul-95
Update for compression scheme IDs. CDP, 27-Nov-95
Use FIND_ALL_DIR. CDP, 09-Aug-96
Take note of new LOW++ telemetry mode. CDP, 12-Dec-97
Version : Version 6, 12-Dec-97
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
SHOW_RES_STC
PURPOSE:
Show resource structure selected from the display
CATEGORY:
Science planning, utility
EXPLANATION:
SYNTAX:
show_res_stc, group, ctime, ypos, row_title
CALLED BY:
MK_CDS_PLAN, MK_SOHO
EXAMPLES:
(when handling draw events)
bb = grep(row_id, ['Telemetry', 'Command'], /exact)
IF bb(0) NE '' THEN BEGIN
rtime = DOUBLE(ROUND(day+x*3600.d))
show_res_stc, event.top, rtime, y, bb(0)
ENDIF
INPUTS:
GROUP - ID of the widget who serves as a group leader
CTIME - Cursor time in TAI
YPOS - Coordinate in Y direction, in device pixels
ROW_TITLE - Title of the resource row (either 'Telemetry' or 'Command')
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
WBASE - Parent widget base into which place structure
WTAGS - Text widget ID's for each tag
JUST_REG - If set, just register the widget
CALLS: ***
ADD_TAG [1], ADD_TAG [2], GET_SOHO_SUBMODE, MK_PLAN_CONV, REP_TAG_VALUE, RES_SHOW
SEC2DHMS, TAG_EXIST [1], TAG_EXIST [2], XSTRUCT
COMMON:
@mk_plan_shared, FOR_RES_SHOW
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, November 10, 1995, Liyun Wang, GSFC/ARC. Written
Version 2, January 4, 1996, Liyun Wang, GSFC/ARC
Added DURATION tag in displayed resource structure
Version 3, January 16, 1996, Liyun Wang, GSFC/ARC
Added keywords WBASE, WTAGS, and JUST_REG
Made wiget title to reflect the resource name
Version 4, March 26, 1996, Liyun Wang, GSFC/ARC
Modified such that duration of resource items is displayed
in DHMS format
Version 5, 15 Oct 2001, Ronald Yurow GSFC/EITI
Modified code so that mouse clicks on DSN_27 resources would
be detected and displayed.
CONTACT:
Liyun Wang, GSFC/ARC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
Project : SOHO - CDS
Name : SHOW_SCATTER
Purpose : Demonstrates difference between wide slit and rastered images.
Explanation :
Use : IDL> show_scatter
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], EXPTV, SETIMAGE, SIGRANGE [1]
SIGRANGE [2], concat_dir [4]
Common : None
Restrictions: None
Side effects: None
Category : Engineering
Prev. Hist. : None
Written : C D Pike, RAL, 15-May-96
Modified :
Version : Version 1, 15-May-96
[Previous]
[Next]
Project : SOHO - CDS
Name : SHOW_SLIT6
Purpose : Shows spectral overlap regions in CDS wide slit data.
Explanation : Plots on the average spectrum the possible spectral confusion
in wide slit mode. Use cursor to indicate lines.
Use : IDL> show_slit6, [/n2]
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : N2 - displays NIS2 spectrum - default is NIS1
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], GET_AVGSPEC, LOAD_WAVECAL
PIX2WAVE, PRINT_STR, TRIM, WAVE2PIX, concat_dir [4]
Common : None
Restrictions: None
Side effects: None
Category : Planning
Prev. Hist. : None
Written : C D Pike, RAL, 30-Oct-97
Modified : Force use of old wavecal. CDP, 19-Aug-99
Version : Version 2, 19-Aug-99
[Previous]
[Next]
Project : SOHO - CDS
Name : SHOW_STUDY
Purpose : Produce a listing of a CDS study definition.
Explanation : For those who like to read paper, this routine displays
the salient points in the definition of a CDS study.
Use : IDL> show_study, str
or
IDL> show_study, study_id, study_var_id
Inputs : str - a valid CDS study definition structure
as returned by get_study.
OR
study_id - the study ID in the current (ie pointed to
by env. var. ZDBASE) database
study_var_id - the study variation ID
Opt. Inputs : None
Outputs : If required, sends to file and prints and outputs to screen.
Opt. Outputs: None
Keywords : KEEP - keep output file. Default ile name is
study_ss_vv.dmp where ss and vv are the ID numbers
for study-specific output or study_list for
summary information (both in $HOME directory).
QUIET - no information to screen
ERRMSG - if defined on entry will be returned with any
error messages.
FILE - specify file to be written or if blank on entry
file name written is returned. If omitted or
blank on entry then data are written to a file
in users 'home' directory.
SUMMARY - give summary of all entries in study database.
HARDCOPY - send output to printer.
Calls : ***
Bell, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], DELETE_FILE [1], DELETE_FILE [2], FILEPATH, FIND_ALL_DIR [1]
FIND_ALL_DIR [2], FIND_ALL_DIR [3], FIND_STUDY, GET_RASTER, GET_STUDY
LIST_F_STUDY, STRPAD, TRIM, UTC2STR, concat_dir [4]
CALLED BY:
MK_STUDY, SHOW_CDHS
Common : None
Restrictions: None
Side effects: None
Category : Planning, databases
Prev. Hist. : Based on original show_study and dump_study
Written : C D Pike, RAL, 23-May-95
Modified : Fix bug not returning file name. CDP, 2-Jun-95
Include raster duration. CDP, 9-Jun-95
Added messgae when output KEEPed. CDP, 27-Jul-95
Fixed calculation of study duration to take account
of n_repeat_r=1 meaning just do it once. CDP, 13-Oct-95
Refix it. CDP, 10-Nov-95
Trap failure to find raster ID CDP, 22-Nov-95
Trap cranky zone_ids. CDP, 18-Jan-96
Trap no rasters. CDP, 25-Jan-96
Add detector to raster output. CDP, 26-Feb-96
Use FIND_ALL_DIR. CDP, 08-Aug-96
Sort on study ID in summary mode. CDP, 23-Sep-97
Version : Version 12, 23-Sep-97
[Previous]
[Next]
Project : SOHO - CDS
Name : SHOW_SYNOPTIC
Purpose : Displays data from a single CDS synoptic scan.
Explanation : On a regular basis (daily as operations allow), CDS performs
a series of 4'x4' rasters along the solar meridian. These
rasters are put together in a single image and stored in
an IDL save file for easy retrieval. This routine provides
a simple display of the data taken from one such series of
rasters. Note that the rasters overlap slightly in Solar Y
and no account is taken of solar rotation when the rasters
are performed.
Use : IDL> show_synoptic, file_number
Inputs : file_number - the date 'number' in format yyyymmdd
Opt. Inputs : None
Outputs : None
Opt. Outputs: status - success at finding file.
Keywords : PUBLIC = If set, then only the three strongest lines are
shown.
CLEAN = If set, then CDS_CLEAN_IMAGE is called.
DEBUG = print files to be used to screen
Calls : ***
ANYTIM2CAL, AVERAGE, BSORT [1], BSORT [2], BSORT [3], BSORT [4], CDS_CLEAN_IMAGE
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], FXPAR [1], FXPAR [2], LAST_ITEM
N_DIMENSIONS, PLOT_IMAGE, PRINT_STR, READFITS [1], READFITS [2], READFITS [3]
SETVIEW [1], SETVIEW [2], SIGRANGE [1], SIGRANGE [2], STR_PICK, TRIM, concat_dir [4]
Common : None
Restrictions: Needs CDS_SUMMARY_DATA to be defined to point to where the
FITS files are.
Side effects: None
Category : Data analysis
Prev. Hist. : None
Written : C D Pike, RAL, 7-May-96
Modified : Use FITS files instead of IDL save files. 08-May-96
Version 3, 18-Jun-1996, William Thompson
Use FXPAR instead of STR_PICK to read observation date
from FITS header.
Version 4, 22-Jul-1996, William Thompson, GSFC
Modified to use SETVIEW for multiple plots.
Added keyword /CLEAN
Version 5, 13-Jun-1997, CDP, added status return variable.
Version 6, 7-Jul-1997, CDP, Trap incomplete set of FITS files.
Version 7, 17-Oct-1997, JP, Modified to handle either 4 or 8 lines
Version 8, 23-Dec-1997, William Thompson, GSFC
Also handle only 1 line, for SYNOP_LP case
Version 9, 29-Jun-1998, William Thompson, GSFC
Handle version 4 of SYNOP_F
Version 10, handle slit 5 raster with 4" steps. CDP, 25-Aug-99
Version 11, Fix multiple copies of .fts files. CDP, 25-Mar-03
version 12, Added DEBUG keyword to avoid problems in cron job
Version : Version 12, 15-Apr-2003
[Previous]
[Next]
Project : SOHO - SUMER
Name : SHRINK_SUMER_FITS
Purpose : Convert long to short integers to reduce file size
Category :
Explanation : This routine reads in a SUMER FITS file, and writes out a new
version with the data windows converted from long to short
integers. This decreases the size of the FITS files by
approximately a factor of two.
Detector data columns are distinguished from auxilliary data
columns by the inclusion of an associated TWAVE keyword in the
header.
This routine will not attempt to shrink files which are already
using short integers for the data, or files containing floating
point data. If the data is in long integer format, but the
numbers are large enough that they cannot be expressed as short
integers, then the file is not processed.
This routine makes two passes through the file. In the first
pass, all the binary table extensions are read in, and a
decision is made as to whether to proceed or not. The second
pass converts the data, and writes out the new file to a
temporary filename. At the end, the new file is substituted
for the old.
Syntax : SHRINK_SUMER_FITS, FILENAME
Examples : cd,'/soho-arch01/private/data/processed/sumer/fits96/march'
files = find_file('sum*.fits*')
for i=0,n_elements(files)-1 do shrink_sumer_fits, files(i)
Inputs : FILENAME = Name of the file to process.
Opt. Inputs : None.
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : ***
FXADDPAR [1], FXADDPAR [2], FXBCLOSE [1], FXBCLOSE [2], FXBCREATE [1]
FXBCREATE [2], FXBFIND [1], FXBFIND [2], FXBFINISH [1], FXBFINISH [2], FXBOPEN [1]
FXBOPEN [2], FXBOPEN [3], FXBREAD [1], FXBREAD [2], FXBREAD [3], FXBTFORM [1]
FXBTFORM [2], FXBWRITE [1], FXBWRITE [2], FXHREAD [1], FXHREAD [2], FXPAR [1]
FXPAR [2], FXWRITE [1], FXWRITE [2], OS_FAMILY, TRIM
Common : None.
Restrictions: None.
Side effects: None.
Prev. Hist. : None.
History : Version 1, 31-Jul-1996, William Thompson, GSFC
Version 2, 02-Aug-1996, William Thompson, GSFC
Added version specification for deleting in VMS
Contact : WTHOMPSON
[Previous]
[Next]
NAME:
sigma_mask
PURPOSE:
Computes the mean and standard deviation of pixels in a box
centered at
each pixel of the image, but excluding the center pixel. If the center
pixel value exceeds some # of standard deviations from the mean, it is
flagged. Note option to process pixels on
the edges.
CALLING SEQUENCE:
Result = sigma_mask( image, box_width, N_sigma=(#), /ALL,/MON )
INPUTS:
image = 2-D image (matrix)
box_width = width of square filter box, in # pixels (default = 3)
KEYWORDS:
N_sigma - # standard deviations to define outliers, floating point,
recommend > 2, default = 3. For gaussian statistics:
N_sigma = 1 flags 35% of pixels, 2 = 5%, 3 = 1%.
RADIUS - alternative to specify box radius, so box_width = 2*radius+1.
/ALL_PIXELS causes computation to include edges of image,
/MONITOR prints information about % pixels replaced.
Optional Outputs:
N_CHANGE - # of pixels flagged (mask = 0)
VARIANCE - image of pixel neighborhood variances * (N_sigma)^2,
DEVIATION - image of pixel deviations from neighborhood means,
squared.
OUTBOX - Size of box to return flagged around any marked pixel
(default 1)
CALLS: ***
FILTER_IMAGE
CALLED BY:
las_exp_norm, mk_stdim, mk_stdim_list
PROCEDURE:
Compute mean over moving box-cars using smooth, subtract center values,
compute variance using smooth on deviations from mean,
check where pixel deviation from mean is within variance of
box.
Return a mask array with ones where the deviation is less than
the specified amount and zeros for the points outside the range.
MODIFICATION HISTORY:
Derived from Frank Varosi's SIGMA_FILTER routine. Mar 1996, SJT.
[Previous]
[Next]
Project : SOHO - CDS
Name : simpson_a()
Purpose : Simpson integration
Explanation : Simpson integration when the function to be
integrated is given in array y calculated for
eqidistant intervals in x. Integration proceeds
from beginning to end of the given array if the
number of array points is odd.
Use : IDL> value = simpson_a(array, dispersion)
Inputs : array, dispersion,
Opt. Inputs : None
Outputs : Integrated value
Opt. Outputs: None
Keywords : None
Calls : None
CALLED BY:
three_moment
Common : None
Restrictions: None
Side effects: None
Category : ?
Prev. Hist. : ?
Written : Olav Kjeldseth-Moe, ITA, UiO
Modified : Version 1 Nils Brynildsen, ITA, UiO, 1-July-1993
Version : Version 1 1-July-1993
[Previous]
[Next]
Project : SOHO - CDS
Name :
SINCE_VERSION
Purpose :
Determine if current release is later than specified.
Explanation :
Determine if the current release of IDL (as given in the
!VERSION.RELEASE system variable) comes after the user specified
release.
Use :
test = SINCE_VERSION( release )
Use the /FTOXDR keyword to the BYTEORDER procedure if the current
release of IDL is 2.2.2 or later
IDL> if since_version('2.2.2') then byteorder, a, /FTOXDR
Inputs :
release - scalar string, must be formatted exactly like the
!VERSION.RELEASE system variable (e.g. '3.0.0')
Opt. Inputs :
None.
Outputs :
test - 1 if current release is identical or later than the specified
'release' else 0
Opt. Outputs: None.
Keywords : None.
Calls : None.
CALLED BY:
ADD_TAG [1], ALLOW_WINDOWS, ASSIGN_NOCOPY, Array_Despike, BIGPICKFILE, Brm_GauLeg
CHMOD, CLEANPLOT [1], CLEANPLOT [2], CLEANPLOT [3], CLEAN_PATH, CLOSE_LUN
COMBINE_STRUCT, COMPILE_SFIT, CONCAT_STRUCT, CREATE_PARAM [1], CREATE_PARAM [2]
CWF_COMPONENT, CWF_FIT, CWF_STATUS, CWQ_CUBE, CWQ_DSPWAV [1], CWQ_IMAGE [1]
CWQ_SPECTR [1], CWQ_WINSEL [1], CW_CUBEVEIW, CW_ENTERB, CW_FLIPSWITCH, CW_MOUSE
CW_PSELECT, DSP_INFO, DSP_WAV, EIS_GET_HDR [1], EIS_GET_HDR [2]
EIS_IMAGE_TOOL [1], EIS_IMAGE_TOOL [2], EIT__DEFINE, FILE_COPY2, FITS__DEFINE
FRAMEWORK ABSTRACT CLASS DEFINITION, GEN__DEFINE, HOST_TO_IEEE [1]
HOST_TO_IEEE [2], HOST_TO_IEEE [3], HOST_TO_IEEE [4], HSI_SIM11
HSI_SPECTRUM__DEFINE, IEEE_TO_HOST [1], IEEE_TO_HOST [2], IEEE_TO_HOST [3]
IEEE_TO_HOST [4], IMAGE_TOOL, IS_DIR, ITOOL_PICKFILE, JOIN_STRUCT [1]
LIGHTCURVE CLASS DEFINITION, LOC_FILE_NEW, MERGE_STRUCT, MK_DIR, MK_PLAN_PLOT
MRD_HEAD, OBJ_STRUCT, PICKFILE, PLOT_MAP, PQLPROFILE, PQLZOOM, REM_TAG [1], REPLICATE2
RM_FILE, SAME_DATA [1], SOAP__DEFINE, SOCK_DOWNLOAD, SPECTRUM CLASS DEFINITION
SPEX_SAVE_DATA [1], SPEX_SAVE_DATA [2], SPEX_SUMMARY [1], SPEX_SUMMARY [2]
SPEX__DEFINE, TEST_OPEN, VALID_FITS, WHERE2, WIDGET_MBASE, WRITE_DIR, XCDS_ANALYSIS
XCDS_COSMIC, XCFIT, XCFIT_BLOCK, XCR_REMOVE, XDIFF, XINPUT, XPLOTSCALE, XRECORDER
XUPDATE, cw_edroplist, cwq_dspwav [2], cwq_image [2], cwq_spectr [2]
cwq_winsel [2], dsp_menu, get_gevloc_data, is_number [1], les_archive_info
mark_intervals, mreadfits_urls, nospike, obj_restore, obj_save, plotman
plotman_create_files_event, pmtras_analysis, save_idl_routines, spectro_plot2
spex_energy_ranges [1], spex_energy_ranges [2], spex_preview [1]
spex_preview [2], ssw_getdst, ssw_post_query, ssw_time2filelist, str_subset
strwhere, sxi_files, sxt2file, update_history, yopos [1], yopos [2]
Common : None.
Restrictions: None.
Side effects: None.
Category : Utilities, Miscellaneous
Prev. Hist. :
Written Wayne Landsman Hughes/STX January, 1992
Corrected algorithm W. Landsman April, 1992
Written : Wayne Landsman, Hughes/STX, January 1992
Modified : Version 1, William Thompson, GSFC, 14 December 1994
Incorporated into CDS library
Version : Version 1, 14 December 1994
[Previous]
[Next]
Project : SOHO - CDS
Name : SKIPF
Purpose : Emulates the VMS SKIPF function on UNIX machines.
Explanation : Emulates the VMS SKIPF function on UNIX machines.
Use : SKIPF, UNIT, NSKIP
SKIPF, UNIT, NSKIP, RECORDS
Inputs : UNIT = Tape unit number. Tape drives are selected via the
UNIX environment variables "MT1", "MT2", etc. The
desired tape drive is thus specified by numbers, as
in VMS. Must be from 0 to 9.
NSKIP = Number of files or records to skip.
Opt. Inputs : RECORDS = If present, then records are skipped instead of
files.
Outputs : None. However, !ERR is set to ABS(NSKIP)
Opt. Outputs: None.
Keywords : None.
Calls : ***
CHECK_TAPE_DRV [1], CHECK_TAPE_DRV [2]
CALLED BY:
FITSTAPE, FXTAPEREAD, FXTPIO_WRITE, RD_EXB, TCOPY, mt
Common : None.
Restrictions: This routine may not act exactly the same as the VMS
equivalent, particularly in regards to the behavior of the !ERR
system variable.
The environment variable "MTn", where n corresponds to the
variable UNIT, must be defined. E.g.,
setenv MT0 /dev/nrst0
Requires IDL v3.1 or later.
Side effects: The device file is opened. !ERR is set to ABS(NSKIP).
Category : Utilities, I/O, Tape.
Prev. Hist. : VERSION 1, R. W. Thompson 12/4/89
William Thompson, Apr 1991, rewrote to better emulate VMS
version.
Written : R. W. Thompson, GSFC/IUE, 4 December 1989.
Modified : Version 1, William Thompson, GSFC, 21 December 1993.
Rewrote to use IOCTL.
Version : Version 1, 21 December 1993.
[Previous]
[Next]
NAME:
SLIDE_IMAGEf
PURPOSE:
Create a scrolling graphics window for examining large images.
By default, 2 draw widgets are used. The left draw widget shows
a reduced version of the complete image, while the draw widget on
the right displays the actual image with scrollbars that allow sliding
the visible window.
CALLING SEQUENCE:
SLIDE_IMAGE [, Image]
INPUTS:
Image: The 2-dimensional image array to be displayed. If this
argument is not specified, no image is displayed. The
FULL_WINDOW and SCROLL_WINDOW keywords can be used to obtain
the window numbers of the 2 draw widgets so they can be drawn
into at a later time.
KEYWORDS:
CONGRID: Normally, the image is processed with the CONGRID
procedure before it is written to the fully visible
window on the left. Specifying CONGIRD=0 will force
the image to be drawn as is.
FULL_WINDOW: A named variable in which to store the IDL window number of \
the non-sliding window. This window number can be used with
the WSET procedure to draw to the scrolling window at a later
point.
GROUP: The widget ID of the widget that calls SLIDE_IMAGE. If this
keyword is specified, the death of the caller results in the
death of SLIDE_IMAGE.
ORDER: This keyword is passed directly to the TV procedure
to control the order in which the images are drawn. Usually,
images are drawn from the bottom up. Set this keyword to a
non-zero value to draw images from the top down.
REGISTER: Set this keyword to create a "Done" button for SLIDE_IMAGE
and register the widgets with the XMANAGER procedure.
The basic widgets used in this procedure do not generate
widget events, so it is not necessary to process events
in an event loop. The default is therefore to simply create
the widgets and return. Hence, when register is not set,
SLIDE_IMAGE can be displayed and the user can still type
commands at the "IDL>" prompt that use the widgets.
RETAIN: This keyword is passed directly to the WIDGET_DRAW
function, and controls the type of backing store
used for the draw windows. If not present, a value of
2 is used to make IDL handle backing store.
SLIDE_WINDOW: A named variable in which to store the IDL window number of
the sliding window. This window number can be used with the
WSET procedure to draw to the scrolling window at a later
time.
TITLE: The title to be used for the SLIDE_IMAGE widget. If this
keyword is not specified, "Slide Image" is used.
TOP_ID: A named variable in which to store the top widget ID of the
SLIDE_IMAGE hierarchy. This ID can be used to kill the
hierarchy as shown below:
SLIDE_IMAGE, TOP_ID=base, ...
.
.
.
WIDGET_CONTROL, /DESTROY, base
XSIZE: The maximum width of the image that can be displayed by
the scrolling window. This keyword should not be confused
with the visible size of the image, controlled by the XVISIBLE
keyword. If XSIZE is not specified, the width of Image is
used. If Image is not specified, 256 is used.
XVISIBLE: The width of the viewport on the scrolling window. If this
keyword is not specified, 256 is used.
YSIZE: The maximum height of the image that can be displayed by
the scrolling window. This keyword should not be confused
with the visible size of the image, controlled by the YVISIBLE
keyword. If YSIZE is not present the height of Image is used.
If Image is not specified, 256 is used.
YVISIBLE: The height of the viewport on the scrolling window. If
this keyword is not present, 256 is used.
OUTPUTS:
None.
CALLS: ***
CONGRID [1], CONGRID [2], CONGRID [3], SLIDE_IMG_EVENT, XMANAGER
CALLED BY:
COMBINE_IMG
COMMON BLOCKS:
None.
SIDE EFFECTS:
Widgets for displaying a very large image are created.
The user typically uses the window manager to destroy
the window, although the TOP_ID keyword can also be used to
obtain the widget ID to use in destroying it via WIDGET_CONTROL.
RESTRICTIONS:
Scrolling windows don't work correctly if backing store is not
provided. They work best with window-system-provided backing store
(RETAIN=1), but are also usable with IDL provided backing store
(RETAIN=2).
Various machines place different restrictions on the size of the
actual image that can be handled.
MODIFICATION HISTORY:
7 August, 1991, Written by AB, RSI.
10 March, 1993, ACY, Change default RETAIN=2
23 Sept., 1994 KDB, Fixed Typo in comments. Fixed error in
Congrid call. xvisible was used instead of yvisible.
14 June, 1999 NBR, Make full-image window always 256x256;
change name to SLIDE_IMAGEf
[Previous]
[Next]
Project : SOHO - CDS
Name : SLIT45_IMAGE_DEMO
Purpose : Demonstrates slit 4 and 5 NIS image data.
Explanation : Rastered images taken with slit 4 and 5 are displayed.
Use : IDL> slit45_image_demo
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], PLOT_IMAGE, SETFLAG, SIGRANGE [1]
SIGRANGE [2], concat_dir [4]
Common : None
Restrictions: None
Side effects: None
Category : Calibration
Prev. Hist. : None
Written : C D Pike, RAL, 11-Dec-96
Modified :
Version : Version 1, 11-Dec-96
[Previous]
[Next]
Project : SOHO - CDS
Name : SLIT4V5_DEMO
Purpose : Demonstrates slit 4 and 5 NIS data.
Explanation : The use of slit 5 (4" wide) is shown to degrade the spectral
resolution achieved only slightly compared to use of slit 4
(2" wide). The count rate of course is higher by approx a
factor 2.
Use : IDL> slit4v5_demo
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : ***
CIRCLE_SYM, CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], concat_dir [4]
Common : None
Restrictions: None
Side effects: None
Category : Calibration
Prev. Hist. : None
Written : C D Pike, RAL, 12-Nov-96
Modified :
Version : Version 1, 12-Nov-96
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
SLITNUM()
PURPOSE:
Return slit number
CATEGORY:
EXPLANATION:
SYNTAX:
Result = slitnum()
CALLED BY:
FF_GC, FF_ODDEVEN, MAKE_FF
EXAMPLES:
INPUTS:
header - BYTARR(92) 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]
NAME:
slog_get_day
PURPOSE
return the day from a SOHO log structure
CALLING SEQUENCE:
result = slog_get_day(log_str)
INPUTS:
log_str - SOHO log structure
OUTPUTS:
result - day number
CALLED BY:
XSEL_PD_EVENT
MODIFICATION HISTORY:
(29 APR 96) JTM: original version
[Previous]
[Next]
NAME:
slog_get_day
PURPOSE
return the day from a SOHO log structure
CALLING SEQUENCE:
result = slog_get_day(log_str)
INPUTS:
log_str - SOHO log structure
OUTPUTS:
result - day number
CALLED BY:
XSEL_PD_EVENT
MODIFICATION HISTORY:
(29 APR 96) JTM: original version
[Previous]
[Next]
NAME:
slog_get_file
PURPOSE
return the file name from a SOHO log structure
CALLING SEQUENCE:
result = slog_get_file(log_str)
INPUTS:
log_str - SOHO log structure
OUTPUTS:
result - file name without the version number
MODIFICATION HISTORY:
(29 APR 96) JTM: original version
(10 Oct 96) JTM: modified for new log structure
[Previous]
[Next]
NAME:
slog_get_file
PURPOSE
return the file name from a SOHO log structure
CALLING SEQUENCE:
result = slog_get_file(log_str)
INPUTS:
log_str - SOHO log structure
OUTPUTS:
result - file name without the version number
MODIFICATION HISTORY:
(29 APR 96) JTM: original version
(10 Oct 96) JTM: modified for new log structure
[Previous]
[Next]
NAME: slog_get_sci
PURPOSE: return an array of indices of structure elements that
contain a give string in their sci_obj entry
CALLING SEQUENCE: ss = slog_get_sci(log_str, string)
[Previous]
[Next]
NAME: slog_get_sci
PURPOSE: return an array of indices of structure elements that
contain a give string in their sci_obj entry
CALLING SEQUENCE: ss = slog_get_sci(log_str, string)
[Previous]
[Next]
NAME: slog_get_scientist
PURPOSE: return an array of indices of structure elements that
contain a give string in their scientis entry
CALLING SEQUENCE: ss = slog_get_scientist(log_str, string)
[Previous]
[Next]
NAME: slog_get_scientist
PURPOSE: return an array of indices of structure elements that
contain a give string in their scientis entry
CALLING SEQUENCE: ss = slog_get_scientist(log_str, string)
[Previous]
[Next]
NAME: slog_get_sn
PURPOSE: return an array of indices of structure elements that
contain a give string in their scientis entry
CALLING SEQUENCE: ss = slog_get_sn(log_str, string)
[Previous]
[Next]
NAME: slog_get_sn
PURPOSE: return an array of indices of structure elements that
contain a give string in their scientis entry
CALLING SEQUENCE: ss = slog_get_sn(log_str, string)
[Previous]
[Next]
NAME:
slog_get_time
PURPOSE:
return the time from a SUMER log structure
CALLING SEQUENCE:
result = slog_get_time(log_str)
INPUTS:
log_str - SUMER log structure
OUTPUTS:
result - time array (hh mm ss)
CALLED BY:
XSEL_PD_EVENT
MODIFICATION HISTORY:
(29 APR 96) JTM: initial version
[Previous]
[Next]
NAME:
slog_get_time
PURPOSE:
return the time from a SUMER log structure
CALLING SEQUENCE:
result = slog_get_time(log_str)
INPUTS:
log_str - SUMER log structure
OUTPUTS:
result - time array (hh mm ss)
CALLED BY:
XSEL_PD_EVENT
MODIFICATION HISTORY:
(29 APR 96) JTM: initial version
[Previous]
[Next]
NAME:
slog_headinfo
PURPOSE:
Gather information for log from fits main header
CATEGORY:
CALLING SEQUENCE:
slog_headinfo, infil, log_str
INPUTS:
infil - input file name
log_str - the log structure to fill
OPTIONAL INPUT PARAMETERS:
none
KEYWORD PARAMETERS:
none
OUTPUTS:
log_str - the log structure filled
OPTIONAL OUTPUT PARAMETERS:
none
CALLS: ***
FITS_INFO [1], FITS_INFO [2], FXPAR [1], FXPAR [2], HEADFITS [1], HEADFITS [2]
HEADFITS [3]
CALLED BY:
slog_sumlog
COMMON BLOCKS:
none
SIDE EFFECTS:
none
RESTRICTIONS:
none
PROCEDURE:
MODIFICATION HISTORY:
(26 Apr 96) JTM: initial version
(27 May 96) JTM: modified file name determination--now VMS specific!
(25 Jul 96) JTM: added more info and read file name from fits file
[Previous]
[Next]
NAME:
slog_logstr
PURPOSE:
define the sumer log structure
CATEGORY:
CALLING SEQUENCE:
slog_logstr, d
INPUTS:
none
OPTIONAL INPUT PARAMETERS:
none
KEYWORD PARAMETERS:
none
OUTPUTS:
d - the structure definition
OPTIONAL OUTPUT PARAMETERS:
CALLED BY:
slog_rdlog [1], slog_rdlog [2], slog_sumlog
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
(26 Apr 96) JTM: initial version
(25 Jul 96) JTM: added filename and a few other things
[Previous]
[Next]
NAME:
slog_logstr
PURPOSE:
define the sumer log structure
CATEGORY:
CALLING SEQUENCE:
slog_logstr, d
INPUTS:
none
OPTIONAL INPUT PARAMETERS:
none
KEYWORD PARAMETERS:
none
OUTPUTS:
d - the structure definition
OPTIONAL OUTPUT PARAMETERS:
CALLED BY:
slog_rdlog [1], slog_rdlog [2], slog_sumlog
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
(26 Apr 96) JTM: initial version
(25 Jul 96) JTM: added filename and a few other things
[Previous]
[Next]
NAME:
slog_rdlog
PURPOSE:
Read log files produced by jtm_sumlog.pro
CATEGORY:
CALLING SEQUENCE:
slog_sumlog, logfile, lstr
INPUTS:
logfile - name of log file produced by jtm_sumlog
OPTIONAL INPUT PARAMETERS:
none
KEYWORD PARAMETERS:
OUTPUTS:
lstr - structure containing information in log file
OPTIONAL OUTPUT PARAMETERS:
none
CALLS: ***
slog_logstr [1], slog_logstr [2]
CALLED BY:
SUMER_SEARCH_PD_EVENT, XSEL_PD_EVENT
COMMON BLOCKS:
none
SIDE EFFECTS:
RESTRICTIONS:
Max size of structure is currently set to 6000 elements
PROCEDURE:
MODIFICATION HISTORY:
(12 Apr 96) JTM: first attempt
(28 Apr 96) JTM: using structured log
(10 Oct 96) JTM: new structure def
[Previous]
[Next]
NAME:
slog_rdlog
PURPOSE:
Read log files produced by jtm_sumlog.pro
CATEGORY:
CALLING SEQUENCE:
slog_sumlog, logfile, lstr
INPUTS:
logfile - name of log file produced by jtm_sumlog
OPTIONAL INPUT PARAMETERS:
none
KEYWORD PARAMETERS:
OUTPUTS:
lstr - structure containing information in log file
OPTIONAL OUTPUT PARAMETERS:
none
CALLS: ***
slog_logstr [1], slog_logstr [2]
CALLED BY:
SUMER_SEARCH_PD_EVENT, XSEL_PD_EVENT
COMMON BLOCKS:
none
SIDE EFFECTS:
RESTRICTIONS:
Max size of structure is currently set to 6000 elements
PROCEDURE:
MODIFICATION HISTORY:
(12 Apr 96) JTM: first attempt
(28 Apr 96) JTM: using structured log
(10 Oct 96) JTM: new structure def
[Previous]
[Next]
NAME:
slog_splot
PURPOSE:
Plot slit locations on a disk
CATEGORY:
CALLING SEQUENCE:
slog_splot, log_str, /circle
slog_splot, x, y, slit, /circle
slog_splot, /circle
INPUTS:
log_str - a SUMER log structure
OPTIONAL INPUT PARAMETERS:
circle - use /circle on first entry and then don't use to overplot
KEYWORD PARAMETERS:
OUTPUTS:
none
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
(12 Apr 96) JTM: First simple version
(28 Apr 96) JTM: Process any structure containing x, y, slit
[Previous]
[Next]
NAME:
slog_splot
PURPOSE:
Plot slit locations on a disk
CATEGORY:
CALLING SEQUENCE:
slog_splot, log_str, /circle
slog_splot, x, y, slit, /circle
slog_splot, /circle
INPUTS:
log_str - a SUMER log structure
OPTIONAL INPUT PARAMETERS:
circle - use /circle on first entry and then don't use to overplot
KEYWORD PARAMETERS:
OUTPUTS:
none
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
(12 Apr 96) JTM: First simple version
(28 Apr 96) JTM: Process any structure containing x, y, slit
[Previous]
[Next]
NAME:
slog_sumlog
PURPOSE:
Build a simple log of SUMER file contents
CATEGORY:
CALLING SEQUENCE:
slog_sumlog, infil, outfil, outstr=outstr
INPUTS:
infil - an array of file names to include in the log
OPTIONAL INPUT PARAMETERS:
none
KEYWORD PARAMETERS:
none
OUTPUTS:
outfil - output log file to write
OPTIONAL OUTPUT PARAMETERS:
outstr - the structure that was used to write the log file
CALLS: ***
slog_headinfo, slog_logstr [1], slog_logstr [2]
COMMON BLOCKS:
none
SIDE EFFECTS:
A file is created in the current directory
RESTRICTIONS:
none
PROCEDURE:
MODIFICATION HISTORY:
(5 Apr 96) JTM: first cut
(26 Apr 96) JTM: more info, pass data around with structures
(10 Feb 98) CHAE: change jtm_ into slog_
[Previous]
[Next]
Project:
SOHO - SUMER
Name:
smk_atlas
Purpose:
To calculate construct full reference spectra from SUMER reference
spectra observations
Use:
smk_atlas,filenames,lambda,spec,header,SpecRange=SpecRange,$
more_info=more_info
Inputs
FileNames - Names of files containing the reference spectrum.
If there is more than one file, this should be an array of
type string.
Output
Lambda_Out - Wavelength values in Angstroms (2nd order)
Spec_Out - Spectral data summed over spectral bands specified by
SpecRange. Units are counts/s/pix
Atlas_index - Stucture containing header information and information about how the
components of the spectra were put together.
Some of the tags:
Trans - indexes in lambda_out of transitions between
different exposures.
Uncoated - array containg indexes of elements taken from
uncoated part of detector. If no such elements,
it will = -1
Attenuated - array containg indexes of elements taken from
attenuated part of detector. If no such elements,
it will = -1
Edge - array containg indexes of elements taken from
edge of detector. If no such elements, it will = -1
Input Keywords:
SpecRange - Array containing the spatial ranges over which the
spectra should be summed. Should have dimensions 2 x N,
where N is the number of spectral locations, and in
units of pixels. If this is not entered the program
SA_Gt_SpecRange will be called so that the user may
select the ranges graphically.
Splice_Adjust - If set the user will be prompted to manually
select the splice point between each overlapping pair
of exposures. If more than one spectral zone has been
selected, the splice selection plots will be made with
the zone given by Splice_Adjust.
DetRange - Range on the Detector to use in making spectra. Default corresponds
to the KBr coated portion with an extention to include Ly Alpha.
OverRides keywords BareL, BareR, KBrOnly, and AllDetector
KBrOnly - use only the KBr coated part of the detector to make spectra,
do not attempt to include Ly Alpha on attenuators
FullDetector - use entire detector to make spectra
Bare - Use the bare portion of the detector to make spectra
TriWarp - Correct for pixel scale image distortion
Output Keywords:
None
Calls: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CALL_DESTRETCH, UTC2TAI, rd_sumer [1]
rd_sumer [2], sa_gt_specrange, sgt_delta, sgt_detector, sgt_dims, sgt_refpix
sgt_refval, splice_sel
Common:
None
Written:
Terry Kucera, 27 Feb 1996
Modifications
Added Splice_Adjust TAK, 9 Apr 1996
Added keywords for warping and selcting which part of
detector to use TAK, 21 May 1996
Changed how bare spectra made TAK, 19 June 1996
Now uses rd_sumer rather than ft_sumread_fits
Previous outputs Header and More_Info now incorporated into the structure atlas_index
TAK, 14 Nov 1996
Changed upper limit in the number of spectra TAK, 15 Sept. 1999
[Previous]
[Next]
Project:
SOHO - SUMER
Name:
SMK_FULLDET
Purpose:
To construct a full detector format from partial detector formats.
Explanation :
This should be useful in cases in which data formats
overlap, and/or features extend between formats.
Use:
smk_fulldet,index,data,index_out,data_out,bte=[1,2]
Inputs:
index - The index structure returned from rd_sumer.
data - data returned from rd_sumer
Output:
index_out - index structure for data_out
data_out - data reformatted so that all the different wavelength
columns are in a single 1024 pixel wide format.
Input Keywords:
BTE - array listing the BTE's from which to extract data.
The default is to return all.
Calls: ***
MAKE_STR [1], MAKE_STR [2], MATCH [1], MATCH [2], MATCH [3], SGT_BTE, SGT_CRPIX
UNIQ [1], UNIQ [2], UNIQ [3], sgt_dims, sgt_refpix, sgt_refval
Common:
None
Written:
Terry Kucera, 6 Aug 1996
[Previous]
[Next]
Project : SOHO - CDS
Name : SNAP_MOVIE
Purpose : Makes a movie out of CDS snapshots.
Category : CDS, Quicklook, Animation, Class3
Explanation : Uses CDS_SNAPSHOT and WR_MOVIE to generate an animation from a
study. Each frame of the animation is made by running
CDS_SNAPSHOT against each raster in the study. Thus, the first
frame will be from s#r00.fits, the second from s#r01.fits, and
so on. This is appropriate when the study consists of a number
of repeated rasters with a single target. The techniques used
here can serve as an example of how to put an animation
together in more complicated cases.
Each frame is first generated on the screen by CDS_SNAPSHOT,
and then read back from the screen and written to the
animation. Whatever color table is loaded when the program is
called will be used for the animation. The graphics window
should remain in view until the animation is completed.
Syntax : SNAP_MOVIE, STUDY [, FILENAME ] [, /keywords ]
Examples : SNAP_MOVIE, 10345, /GIF, /MPEG, /JAVA, /DEL
Inputs : STUDY = The study number to generate the movie from.
Opt. Inputs : FILENAME = Base filename to use when creating MPEG and GIF
movies. If a GIF movie is created, then it will be
named filename.gif. If a MPEG movie is created,
then it will be called filename.mpg. The default is
to generate the filename from the letter "s" and the
study number, e.g. "s10345.gif".
Outputs : The output of the program is one or more animation formats,
depending on which keywords were passed.
Opt. Outputs: None.
Keywords : The following keywords are passed to CDS_SNAPSHOT.
REVERSE = If set, then plot is done in inverse video. In other
words, white areas on the screen will appear dark,
and visa versa. This saves toner on greyscale
printers.
NOCLEAN = If set, then CDS_CLEAN_IMAGE is not called.
WINDOWS = An array of windows to display. The windows can be
passed as either the NUMBERS of the data windows
(NOTE: numbering from 0...N-1) or as text with the
LABELS of the desired spectral windows. The windows
will be displayed in the order given by the WINDOWS
array, unless the WAVESORT keyword is passed.
WAVESORT = If set, then the windows are displayed in wavelength
order. (Note that second order lines will be
displayed according to their first order
equivalent.)
QUASI_FIT= If set, then the routine CDS_QUASI_FIT is called to
extract the images. See the documentation on that
routine for more information.
SPECTRA = If set, then spectra are shown instead of images.
For some data sets, spectra are shown by default.
WO_CR = If set, then spectra are calculated using AVG_WO_CR
instead of AVERAGE. Warning, very slow.
FRACTION = Fraction to pass to SIGRANGE function. The default
is 0.99.
CHARSIZE = Character size to use for the window labels.
CHARTHICK= Character thickness.
NOTITLE = If set, then the title information at the bottom of
the page is suppressed.
NOLABEL = If set, then the labels above each data window are
suppressed.
ROTATE = If passed, then is the value of the parameter passed
to the ROTATE function to change the image
orientation. For example, using ROTATE=1 would
rotate the image by +90 degrees, while ROTATE=3
would rotate it by -90 degrees.
MIN,MAX = Arrays of the minimum and maximum values to be
applied to each window. Must be in the same order
as the windows are displayed.
GLOBAL = If the GLOBAL keyword is set, then SNAP_MOVIE will
first make a pass through the data to determine the
MIN and MAX arrays to be passed to CDS_SNAPSHOT.
RASTER = Contains the raster ID to use in making the movie.
This is useful for making movies from studies which
use a series of different rasters. If RASTER is
passsed as a two-element array, then the second
element contains the raster variation.
The following keywords are used to determine what kind of movie
is produced. If neither are passed, then the default format is
a GIF movie. If both are passed, then both a GIF and an MPEG
movie is created.
MPEG: If set, then a MPEG movie is created.
GIF: If set, then a GIF movie is created.
Additional keywords passed to WR_MOVIE are:
PNG: When used with /JAVASCRIPT, the files written
out are in PNG format, rather than GIF. This
is the default for IDL versions 5.4 and above,
which no longer support writing GIF images.
JPEG: When used with /JAVASCRIPT, the files written
out are in JPEG format, rather than GIF or PNG.
ALT_MPEG: Uses an alternate set of parameters for
mpeg_encode, courtesy of Stein Vidar Haugan and
Bernhard Fleck, which may make a better movie,
at the expense of a slightly larger file.
INTERNAL_MPEG: If set, then the internal MPEG writer is used
instead of spawning mpeg_encode. This is the
default for IDL versions 5.4 and above, which
no longer support writing the intermediate GIF
images.
PICT: If set, then a series of PICT frames are
written out. This is suitable for converting
to a VHS tape. The filenames will be written
such that the extensions are the frame number,
e.g. "filename.00", "filename.01", etc.
JAVASCRIPT: If set, then an Java Script HTML file is
written out.
DELETE: If set, then the temporary directory
/mpegframes will be deleted before this
procedure exits.
FRAMEDELAY: The delay time between frames, in 1/100 of a
second. The default value of 10 gives a movie
rate of approximately 10 frames/second. The
bigger the number, the slower the movie will
run. Not applicable to MPEG movies.
LOOPCNT: The number of times to loop through the GIF
movie. The default value is 0, which
represents an infinite number of loops.
INCREMENT: Percent increment for speed control for Java
Script movies. [def= 10]
URL: Optional URL path to GIF images for Java Script
movies. The default is that the GIF frames
will be in the subdirectory FILENAME.
TITLE: Optional HTML title for Java Script movies.
Calls : ***
AVERAGE, CDS_CLEAN_IMAGE, CDS_QUASI_FIT, CDS_SNAPSHOT, COUNTDOWN, DATATYPE [1]
DATATYPE [2], DATATYPE [3], GOOD_PIXELS, GT_WINDATA, GT_WINDESC, LIST_EXPER, NTRIM
READCDSFITS, SIGRANGE [1], SIGRANGE [2], TRIM, TVREAD [1], TVREAD [2], TVREAD [3]
WR_MOVIE
Common :
Restrictions: The graphics window used by this routine should remain in view
until the animation is completed.
The process that is running IDL when this procedure
executes must have write priveleges to the working directory
or this procedure will fail.
If a MPEG movie is being created, then the following programs
must be in the current path:
mpeg_encode
giftoppm
If a GIF movie is being created, then the following program
must be in the current path:
whirlgif
Side effects: Files and subdirectory are created in the working directory.
Prev. Hist. : None.
History : Version 1, 03-Feb-1998, William Thompson, GSFC
Version 2, 10-Apr-1998, William Thompson, GSFC
Use TVREAD, to allow reading even obscured windows.
Version 3, 23-Oct-2000, William Thompson
Added keywords INTERNAL_MPEG, JPEG, and PNG.
Version 4, 26-Oct-2000, William Thompson
Added keyword ALT_MPEG
Version 5, 27-Mar-2002, William Thompson, GSFC
Added keywords MIN, MAX, GLOBAL
Contact : WTHOMPSON
[Previous]
[Next]
PROJECT:
SOHO
NAME:
SOHO_CAMPAIGN
PURPOSE:
Make KAP style of list of SOHO campaign entries
CATEGORY:
Planning
SYNTAX:
soho_campaign
INPUTS:
None required.
OPTIONAL INPUTS:
None.
OUTPUTS:
An ASCII file containing detailed contents of campaign
OPTIONAL OUTPUTS:
None.
KEYWORDS:
TSTART - Beginning of date/time values to use in searching the
database. If missing, DEC-1-1956 is assumed.
TEND - End of date/time values to use in searching the database.
If missing, Dec-31-2006 is assumed.
FILE - Name of the output file, default to 'soho_campaign.txt'
NOIDL - Set this keyword not to use the IDL database
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3]
DATATYPE [1], DATATYPE [2], DATATYPE [3], LIST_CAMPAIGN, LOC_FILE [1]
LOC_FILE [2], LOC_FILE [3], RD_ASCII [1], RD_ASCII [2], STR2ARR [1], STR2ARR [2]
STRPAD, TRIM, concat_dir [4]
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, March 4, 1997, Liyun Wang, NASA/GSFC. Written
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
SOHO_ITEMS_HTML
PURPOSE:
List SOHO related plans in HTML format
CATEGORY:
Utility
SYNTAX:
soho_items_html, unit, title, entries
INPUTS:
UNIT - I/O unit number (must have opened)
TITLE - Title of items (instrument name, etc.)
ENTRIES - Structure array for entries of items
OPTIONAL INPUTS:
None.
OUTPUTS:
Partial HTML document written to UNIT
OPTIONAL OUTPUTS:
None.
KEYWORDS:
NEW - A name variable which must be set to 1 when called for
the 1st time; it's set to 0 afterwards
CALLS: ***
ANYTIM2UTC [1], ANYTIM2UTC [2], ARR2STR [1], Arr2Str [2], GET_OBJECT
GET_PLAN_ITIME, GET_UTC, HTML_TABLE_HEADER, SEC2DHMS, STR2ARR [1], STR2ARR [2]
STR_INDEX [1], STR_INDEX [2], TAG_EXIST [1], TAG_EXIST [2]
CALLED BY:
HTML_SPLAN, MK_PLAN_HTML
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
Keyword variable NEW is set to 0 after the first call
HISTORY:
Version 1, August 20, 1997, Liyun Wang, NASA/GSFC. Written
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
NAME:
sohoephem
PURPOSE:
Compute solar/planetary ephemerides.
CATEGORY:
CALLING SEQUENCE:
sohoephem,tjd,rsoho,iorig,sunephem,planephem
INPUTS:
tjd: Julian date (including fraction of day).
rsoho: Position/velocity of SOHO in heliocentric coordinates
(in AU and AU/day).
iorig: Origin of coordinates.
iorig = 1: Geocentric.
iorig = 2: Sohocentric.
OUTPUTS:
sunephem: Structure containing solar ephemeris information.
planephem: Array of structures containing planetary ephemeris
information for 5 major planets.
CALLS: ***
SETLOG
CALLED BY:
GET_SOLAR_RADIUS, POINTING3, STARFIELD, get_soho_ephem
PROCEDURE:
Uses CALL_EXTERNAL to FORTRAN routine.
Results returned in structures.
HISTORY:
Written by Simon Plunkett, September 1995.
Adapted 29 March 1996 to include SOHO orbit parameters. (SPP).
Adapted 4 June 1996 to use FITS rather than CDF orbit files
(change only in output message). (SPP).
Adapted 14 March 1997 to use FITS or CDF files, including all
mods to CDF file structure (change only in output
message). (SPP).
Adapted 15 November 2000 to correct calling sequence in
comments (SPP).
Changed shareable object call for OSF from ephem.so to
ephem_dec.so, 15-Aug-2001 (SPP).
011109 Added Linux external file ephem_linux.so (DW)
011219, NR - Rename to "sohoephem"
12/19/01, @(#)sohoephem.pro 1.7 - NRL LASCO IDL Library
[Previous]
[Next]
PROJECT:
SOHO - CDS
NAME:
SOLAR_GRID
PURPOSE:
To plot gridding lines on the solar image
EXPLANATION:
CALLING SEQUENCE:
eit_sub_solar_grid, lati, longi, date=date
INPUTS:
LATI - The spacing in degrees between parallels of latitude;
default: 15.0 degrees
LONGI - The spacing in degrees between meridians of longitude;
default: 15.0 degrees
DATE - Data/time in CDS time format at which the grid is plotted.
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORD PARAMETERS:
LINESTYLE -- Line style to be used, default: dotted (1)
COLOR -- color of the line to be draw; default: !d.n_colors-1
CALLS: ***
EIT_SUB_SOLAR_GRID, HEL2ARCMIN [1], HEL2ARCMIN [2]
COMMON BLOCKS:
None.
RESTRICTIONS:
Can be called only AFTER the data coordinate system is established,
so it would be OK if it is called after PLOT_AXES is called (which
also sets the data coordinate system)
SIDE EFFECTS:
None.
CATEGORY:
Planning, Image_tool
PREVIOUS HISTORY:
Written April 11, 1995, Liyun Wang, GSFC/ARC
MODIFICATION HISTORY:
Version 1, created, Liyun Wang, GSFC/ARC, April 11, 1995
VERSION:
Version 1, April 11, 1995
[Previous]
[Next]
NAME: SOLAR_NORTH_UP
PURPOSE: Rotates the image to put the solar north at the
top of the image.
CATEGORY: REDUCTION
CALLING SEQUENCE: Result = SOLAR_NORTH_UP (Img, Tel)
INPUTS: Img = Image array, corrected for readout port
telescope = int representing telescope (0,1,2,3) -or-
string representing telescope
OPTIONAL INPUTS: None
KEYWORD PARAMETERS: None
OUTPUTS: Result = Image array, corrected for telescope
orientation
OPTIONAL OUTPUTS: None
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], TRIM
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
assumes that the images are already rectified so that the readout port
effect has been taken care of
To visualize the images properly, the parameter, !order, should be set =1
PROCEDURE:
EXAMPLE:
MODIFICATION HISTORY: Written, RA Howard, NRL
VERSION 1 rah 3 Nov 1995
VERSION 2 rah 2 Jan 1996 EIT changed from 1 to 0
nbr, 3 Jan 2002 - Can use string camera as input
@(#)solar_north_up.pro 1.2 01/03/02 LASCO IDL LIBRARY
[Previous]
[Next]
Name: sort_index
Purpose: return time sorted array of merged structures
Input Paramters:
index1, index2 - vectors of Yohkoh time structures to sort
Keyword Parameters
ss - is set, return sorted indices, not sorted/merged structures
negtim - indices where time runs backwards (-1 if none)
loud - report on number of records where time is backwards
Calling Sequnce:
newindex=sort_index(index1, index2) ; return merged index records
; (structures)
sortss=sort_index(index1, index2, /ss) ; return ssvector
; (longword array)
sortindex=sort_index(index1,/loud) ; sort single vector & report
Calling Example:
info=get_info(sort_index(findex,pindex)) ; merge SXT FFI and PFI records
; (index or roadmap)
CALLS: ***
deriv_arr [1], deriv_arr [2], int2secarr [1], int2secarr [2], str_concat [1]
str_concat [2]
CALLED BY:
PATROL_ORDER, goes_widget, lasteit, mk_sff_pair [1], mk_sff_pair [2]
pro interpretfemfemfemtimefemflgfemstrfemstrverboseverbose
pro optimizedbdrfileshowparamshowparam, rd_goesx_ascii, rd_guf_ascii
ref_term [2], soon_catstat, sxt_adjacent_image, sxt_ssn2fits [1]
History:
5-Nov-1993 (SLF)
10-Feb-1994 (SLF) - allow single input, /loud keyword
12-Dec-1994 (SLF) _ add uniq switch
[Previous]
[Next]
Project : SOHO - CDS
Name : SORT_WINDOWS
Purpose : Sort the technical planning line_window structure.
Explanation : In the line_window structure of window details an invalid
entry is signified by the tag .x_pos having a negative value.
This procedure sorts the input structure on the x_pos tag
and returns the number of valid (ie x_pos > 0) entries.
Use : IDL> sort_windows, line_window_str, num_windows
Inputs : line_window_str - the line-window structure defined in
tp_def_struct.
Opt. Inputs : None
Outputs : num_windows - the number of valid entries in the list.
Opt. Outputs: None
Keywords : None
Calls : ***
Bell, DATATYPE [1], DATATYPE [2], DATATYPE [3]
CALLED BY:
LOAD_TP_STRUCT, MK_RASTER, TP_DISP_IEF
Restrictions: None
Side effects: None
Category : Technical planning
Prev. Hist. :
Written : C D Pike, RAL, 14-May-93
Modified : Changed invalid entry to one with .x_pos < 0, CDP, 23-Mar-94
Version : Version 2, 23-Mar-94
[Previous]
[Next]
Project : SOHO - CDS
Name :
SPEC_DIR()
Purpose :
Appends a default disk or directory to a filename.
Explanation :
Provide a complete file specification by appending a default disk
or directory if necessary.
For Unix, SPEC_DIR will simply append the default directory obtained
from the CD command (if necessary). Under VMS one must also
determine if the disk and/or directory is already specified. Under
VMS, SPEC_DIR will also try to translate disk and directory logical
names.
Use :
File_spec = SPEC_DIR(filename,[extension])
Inputs :
filename - character string giving partial specification of a file
name. VMS examples include 'UIT$USER2:TEST.DAT', or
'[.SUB]TEST'. Unix examples include
'/home/idl/lib', or '$IDL_HOME/pro'.
Opt. Inputs :
exten - string giving a default file name extension to be used if
filename does not contain one. Do not include the period.
Outputs :
File_spec - Complete file specification using default disk or
directory when necessary. If the default directory
is UIT$USER1:[IDL] then, for the above VMS examples, the
output would be 'UIT$USER2:[IDL]TEST.DAT'
'UIT$USER2:[IDL.SUB]TEST'.
Opt. Outputs: None.
Keywords : None.
Calls : ***
FDECOMP [1], FDECOMP [2], FDECOMP [3]
CALLED BY:
DB_ITEM [1], DB_ITEM [2], DB_ITEM [3], DEF2C_FILL, DEF2C_FORMAT, DEF2C_INSERT
DEF2STRUCT, FITSDIR, NSTAR
Common : None.
Restrictions: None.
Side effects: None.
Category : Utilities, Operating_System
Prev. Hist. :
Written W. Landsman STX July, 1987
Revised for use on VAXes and on SUNs, W. Landsman, STX August 1991
Written : W. Landsman, GSFC/UIT (STX), July 1987
Modified : Version 1, William Thompson, GSFC, 29 March 1994
Incorporated into CDS library
Version : Version 1, 29 March 1994
[Previous]
[Next]
NAME: spikes
PURPOSE: To locate single pixel spikes, like Cosmic Rays,
in 2-D images.
METHOD: Default uses a three point median filter as a
reference, takes the difference and compares it with the
cutoff value. The returned variable is a vector of pointers
to spikes in the input variable. Default mode is to remove
holes and spikes. Average filter is also available.
CALLING SEQUENCE: spikes=(img,cutoff,[remove=remove,width=width,
average=average, pos=pos, neg=neg])
PARAMETERS: img input image
cutoff comparison cutoff
KEYWORDS: /remove when set return corrected
image
width median filter size (default
is 3).
/average use an average filter instead
of median.
/pos remove only spikes (or bright val)
/neg remove only holes (or dark values)
CALLED BY:
NAME [3], de_spiker [1], de_spiker [2], despike, sfc_de_spiker, wl_process
Note: spikes will use -1 * abs(cutoff)
NOTE: Default is to remove pos and neg.
CALLS: ***
coord_v2l
HISTORY: Drafted by A.McAllister, following a B.Labonte
algorythm, 10-jun-93.
Added code to handle borders, and keyword to
return corrected image, 2-jul-93.
trap for no spikes, 9-aug-93.
added control to filter size (default is the orginal
value of 3), also added absolute value on difference
12-Jan-94, gal
17-Mar-94, gal, added average filter, options for removal
of only pos or neg; keeping the default mode as removing
both pos and neg.
12-dec-94, JRL, Changed code to make /pos and /neg options work.
Improved the interpretation of input keywords.
Fixed the /remove option (now consistent with de_spiker).
[Previous]
[Next]
Project:
SOHO - SUMER
Name:
splice_sel
Purpose:
To select the wavelength at which two reference spectrum
exposures should be spliced together.
Use:
Result = Splice_sel(lam0,lam1,spec0,spec1,OverLap,zone_in)
Inputs:
lam0, lam1 - First and second wavelength arrays
spec0, spec1 - First and second data arrays
OverLap - Number of pixels by which the two exposures overlap
zone_in - if the spectra come from more than one spatial
zone on the referece spectrum, use this parameter
to select the zone plotted
Output:
DP1 - increase in pixel position of splice in first array
beyond the default value.
Input Keywords:
None
Output Keywords:
None
Calls:
None
CALLED BY:
mk_atlas, smk_atlas
Common:
None
Written:
Terry Kucera, 9 Apr 1996
New version to go with latest version of mk_atlas, 16 May 1996
[Previous]
[Next]
NAME: SPLIT_QKL
PURPOSE: Pre-process QKL files to split them up if they have gaps
CATEGORY: REDUCTION
CALLING SEQUENCE: SPLIT_QKL, yymmdd
INPUTS: date = Date to be processed
OPTIONAL INPUTS: None
KEYWORD PARAMETERS: None
OUTPUTS: None
OPTIONAL OUTPUTS: None
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], GET_UTC, OBT2TAI, READ_TM_PACKET, TAI2UTC
CALLED BY:
UNPACK_ALL_SCIENCE
COMMON BLOCKS: UNPACK_SCIENCE
PROCEDURE:
A QKL file is broken into smaller files, for which the times in consecutive
packets differ by no more than 30 secs.
MODIFICATION HISTORY:
WRITTEN 4 Nov 1998 by Nathan Rich, Interferometrics/NRL
12 Nov 1998 NBR change qkl allowed gap to 30 sec
30 Nov 1998 RAH Check for undefined input date.
020312 Jake Added /SH to SPAWN
SCCS variables for IDL use
@(#)split_qkl.pro 1.7 03/12/02 :NRL Solar Physics
[Previous]
[Next]
TITLE:
SPM_FCOR
PURPOSE:
This function returns the Saito-Poland-Munro F corona
INPUT PARAMETERS:
R: Radius (in solar radii) Can be a single number or an array
OPTIONAL INPUT PARAMETERS:
PA: Position angle (in degrees). If omitted, then the equatorial
corona is returned (PA=90)
OUTPUTS:
The F corona is returned in Mean Solar Brightness units as an array
of floating point numbers corresponding to the size of the input R
array.
RESTRICTION:
The F corona is only valid for radial distances from 1.5 to 5 solar
radii.
PROCEDURE:
The F-coronal values for the polar and equatorial cases given in
Saito, Poland and Munro, Solar Physics, vol 55, pp 121-134, 1977 are
used as the reference points. The logs of the brightness values are
linearly interpolated to obtain the brightness at the desired radii.
To obtain the brightness for a position angle between the pole and
equator, the polar and equatorial values are linearly interpolated
(in the log).
EXAMPLES:
To obtain the polar F-corona at 2.8 solar radii:
f = SPM_FCOR(2.8,0)
To obtain the equatorial K-corona at 2.8 solar radii:
f = SPM_FCOR(2.8,90)
or
f = SPM_FCOR(2.8)
To obtain the F-corona at 45 degrees at 2, 3, 4, 5, and 6 Rs:
r = [2,3,4,5,6]
f = SPM_FCOR(r,45)
WRITTEN:
18 Dec 1997, RAHoward, NRL
@(#)spm_fcor.pro 1.1 12/30/97 :LASCO IDL LIBRARY
[Previous]
[Next]
TITLE:
SPM_KCOR
PURPOSE:
This function returns the Saito-Poland-Munro K corona
INPUT PARAMETERS:
R: Radius (in solar radii) Can be a single number or an array
OPTIONAL INPUT PARAMETERS:
PA: Position angle (in degrees). If omitted, then the equatorial
corona is returned (PA=90)
OUTPUTS:
The K corona is returned in Mean Solar Brightness units as an array
of floating point numbers corresponding to the size of the input R
array.
PROCEDURE:
The K-coronal values for the polar and equatorial cases given in
Saito, Poland and Munro, Solar Physics, vol 55, pp 121-134, 1977 are
used as the reference points. The logs of the brightness values are
linearly interpolated to obtain the brightness at the desired radii.
To obtain the coronal intensity for a position angle between the pole
and equator, the polar and equatorial values are linearly interpolated
(in the log).
EXAMPLES:
To obtain the polar K-corona at 2.8 solar radii:
K = SPM_KCOR(2.8,0)
To obtain the equatorial K-corona at 2.8 solar radii:
K = SPM_KCOR(2.8,90)
or
K = SPM_KCOR(2.8)
To obtain the K-corona at 45 degrees at 2, 3, 4, 5, and 6 Rs:
r = [2,3,4,5,6]
k = SPM_KCOR(r,45)
WRITTEN:
18 Dec 1997, RAHoward, NRL
@(#)spm_kcor.pro 1.1 12/30/97 :LASCO IDL LIBRARY
[Previous]
[Next]
TITLE:
SPM_NE
PURPOSE:
This function returns the Saito-Poland-Munro electron density
INPUT PARAMETERS:
R: Radius (in solar radii) Can be a single number or an array
OPTIONAL INPUT PARAMETERS:
Region: =0: Return the equatorial corona density
=1: Return the polar coronal density
=2: Return the coronal hole density
If omitted, then the equatorial corona density is returned
OUTPUTS:
The electron density in particles per cm^3 as an array of floating
point numbers corresponding to the size of the input R array.
PROCEDURE:
The electron density for the polar, equatorial and coronal hole cases
given in Saito, Poland and Munro, Solar Physics, vol 55, pp 121-134,
1977 are used as the reference points. The density models are given
in a function form as
Ne = c1 * R^d1 + c2 * R^d2
The coefficients c1, c2, d1 and d2 are given by SPM for each of the
three models.
EXAMPLES:
To obtain the polar electron density at 2.8 solar radii:
dne = SPM_NE(2.8,1)
To obtain the equatorial K-corona at 2.8 solar radii:
dne = SPM_NE(2.8,0)
or
dnef = SPM_NE(2.8)
To obtain the electron density in an equatorial coronal hole at 2, 3, 4, 5, and 6 Rs:
r = [2,3,4,5,6]
dne = SPM_NE(r,2)
WRITTEN:
18 Dec 1997, RAHoward, NRL
16 Aug 2000, AHayes, NRL, switched polar and equatorial CH order to agree with paper
@(#)spm_ne.pro 1.2 08/16/00 :LASCO IDL LIBRARY
[Previous]
[Next]
TITLE:
SPM_PB
PURPOSE:
This function returns the Saito-Poland-Munro polarization brightness
INPUT PARAMETERS:
R: Radius (in solar radii) Can be a single number or an array
OPTIONAL INPUT PARAMETERS:
Region: =0: Return the equatorial pB
=1: Return the polar pB
=2: Return the coronal hole pB
If omitted, then the equatorial pB is returned
OUTPUTS:
The polarization brightness in mean solar brightness units is returned
as an array of floating point numbers corresponding to the size of the
input R array.
PROCEDURE:
The polarization brightness for the polar, equatorial and coronal hole cases
given in Saito, Poland and Munro, Solar Physics, vol 55, pp 121-134,
1977 are used as the reference points. The pB models are given
in a function form as
pB = c1 * R^d1 + c2 * R^d2
The coefficients c1, c2, d1 and d2 are given by SPM for each of the
three models.
EXAMPLES:
To obtain the polar pB model at 2.8 solar radii:
pb = SPM_PB(2.8,1)
To obtain the equatorial K-corona at 2.8 solar radii:
pb = SPM_PB(2.8,0)
or
pb = SPM_PB(2.8)
To obtain the pB in an equatorial coronal hole at 2, 3, 4, 5, and 6 Rs:
r = [2,3,4,5,6]
pb = SPM_PB(r,2)
WRITTEN:
18 Dec 1997, RAHoward, NRL
16 Aug 2000, AHayes, NRL, corrected order of polar and CH
@(#)spm_pb.pro 1.2 08/16/00 :LASCO IDL LIBRARY
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
SQL_QUERY()
PURPOSE:
Wrapper program to send SQL command to Oracle server
CATEGORY:
Utility, database
SYNTAX:
status = sql_query(sql_cmd, var1 [, var2 [, var3]])
INPUTS:
SQL_CMD - String scalar or vector, containing a maximum of three valid
SQL statements
OPTIONAL INPUTS:
None.
OUTPUTS:
STATUS - Running status; 1: succeeded, 0: failed
VAR1..3 - Named variable(s): string array of N x M elements, where
N is number of fields returned, and M is number of records
returned
OPTIONAL OUTPUTS:
None.
KEYWORDS:
NREC - Integer scalar or vector containing number of records returned
from each SQL statement passed in
ERROR - Named variable containing possible error message
CALLS: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], GET_HOSTNAME, GREP, SC_INIT_REQ
CALLED BY:
SUM_GET_LINELIST
COMMON:
screq_com (check definition in sc_common)
sql_query_com (for internal use)
RESTRICTIONS:
Requires the request server SIMUSUMER:SCREQ_SRV to be running
SIDE EFFECTS:
None.
HISTORY:
Version 1, May 21, 1997, Liyun Wang, NASA/GSFC. Written
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
Project:
SOHO - SUMER
Name:
SSEL_DATCOL
Purpose:
To determin the tag indices of data with given wavelength and BTE
Use:
result = ssel_datcol(index,bte=[1,2],wavelength=[1393.76,1405.92])
Inputs:
index - The index structure returned from rd_sumer.
Output:
the tag numbers for the data having the input BTEs and wavelengths
num - The number of tags
Input Keywords:
BTE - array listing the BTE's wanted. Default is All.
wavelength - array listing the wavelengths wanted. Default is All
if the input is in string form it must be in the
format 'W_1234_56'
Calls: ***
DATATYPE [1], DATATYPE [2], DATATYPE [3], MATCH [1], MATCH [2], MATCH [3]
str_replace [1], str_replace [2]
CALLED BY:
CALL_TRIWARP, SUM_GAUSSB
Common:
None
Written:
Terry Kucera, 12 Aug 1996
Modifications:
fixed bug in string -> float wavelength conversion. 26 Feb 96, TAK
Added NUM output and changed behavior if there
are no matches. 03 Nov 97, TAK
Replaced calls to strreplace with str_replace 10 Mar 00, TAK
[Previous]
[Next]
NAME:
ssw_bypass
PURPOSE:
While integrating into the /ssw system, it was necessary
to control the order of the /tsw tree and /mdisw tree.
CALLS: ***
ssw_path
HISTORY:
Written 15-Nov-96 by M.Morrison
14-Apr-97 (MDM) - Brought online again.
16-Apr-97 (MDM) - Make the default "/old"
- Prepend /mdisw/idl paths too
- No switches
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
ST_AREA_SIZE()
PURPOSE:
Calculate the total pointing area size
CATEGORY:
ST_SUMER
SYNTAX:
Result = st_area_size(tki_udp_stc)
INPUTS:
tki_udp_stc - UDP structure created with TKI simulator
OPTIONAL INPUTS:
None.
OUTPUTS:
RESULT - Two-element floating point array containing width and height
(in arcsecs) of the pointing area
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 8, 1996, Liyun Wang, NASA/GSFC. Written
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
PROJECT:
SOHO - CDS/SUMER
NAME:
ST_COMP_OBJ()
PURPOSE:
Compare if two object codes are the same
CATEGORY:
ST_SUMER
SYNTAX:
Result = st_comp_obj(obj_file, tki_udp_stc)
INPUTS:
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
None.
CALLS: ***
COMPARE_VAR
CALLED BY:
ST_SUMER
COMMON:
None.
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 21, 1996, Liyun Wang, NASA/GSFC. Written
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
ST_MK_UDP_STC
PURPOSE:
Create an UDP structure via TKI simulation
CATEGORY:
st_sumer
SYNTAX:
st_mk_udp_stc
INPUTS:
INIT_PT - A structure having tags INIT_Y and INIT_Z indicating the
initial pointing value (in SUMER coordinate system)
EVENT - Widget event structure
OPTIONAL INPUTS:
None.
OUTPUTS:
None.
OPTIONAL OUTPUTS:
None.
KEYWORDS:
ERROR - Named variable that holds an error message if any. If no error
occurrs, the null string is returned.
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], ST_SUMER_WIN, ST_TKI_INIT
TEST_OPEN, TKI_SHOW_LAM, TKI_TCMD, XACK, XVALID, concat_dir [4]
CALLED BY:
ST_SUMER
COMMON:
@st_sumer_com
RESTRICTIONS:
None.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 1, 1996, Liyun Wang, NASA/GSFC. Written
Version 2, November 18, 1996, Liyun Wang, NASA/GSFC
Changed pointing coordinate system to heliocentric
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)
[Previous]
[Next]
PROJECT:
SOHO - SUMER
NAME:
ST_REG_STUDY
PURPOSE:
Register a single-item study with DB from a simulated UDP
CATEGORY:
ST_SUMER
SYNTAX:
st_reg_study, udp_stc
INPUTS:
UDP_STC - UDP structure, created via TKI simulator plus an extra
tag named UDP_SEQ which itself is a structure with the
following tags:
NAME - Name of UDP
TITLE - Title of UDP
CATEGORY - Category of UDP
PURPOSE - Purpose (description) of UDP
SCL_BASE - Base Name (no extention) of SCL for the UDP
SCL_PATH - Name of path where the original UDP
associated files reside
UDP_ID - ID of newly created UDP
If the study to be created requires a pointing sequence,
UDP_STC can also have another tag named ZONE_ID indicating
the pointing zone.
OPTIONAL INPUTS:
None.
OUTPUTS:
Records inserted in database
OPTIONAL OUTPUTS:
None.
KEYWORDS:
STD_ID - A named variable containing ID of newly registered study.
If an error occurs during the process, STD_ID will be -1
ERROR - A named variable containing error message returned. If no
error occurs, the null string is returned
COMMON:
screq_com
RESTRICTIONS:
Requires the request server SIMUSUMER:SCREQ_SRV to be running.
SIDE EFFECTS:
None.
HISTORY:
Version 1, October 1, 1996, Liyun Wang, NASA/GSFC. Written
Version 2, December 4, 1996, Liyun Wang, NASA/GSFC
Recorded DEFT_X and DEFT_Y values into the POINT_AREA table
CONTACT:
Liyun Wang, NASA/GSFC (Liyun.Wang.1@gsfc.nasa.gov)