This page was created by IDL
lasco_mk_html_help.pro on
Fri Jan 12 09:28:43 2007.
NAME: cdf_cat_file PURPOSE: Print information about a CDF to an ASCII file. CALLING SEQUENCE: cdf_cat_file,cdfname,file INPUTS: cdfname: name of CDf to be opened. file: name of ASCII file to be created (defaults to cdf_info.dat). HISTORY: Adapted from routine cdf_cat in IDL distribution. Simon Plunkett, 29 March 1996.
NAME:
COCO_J2000
PROJECT:
SOHO-LASCO.
PURPOSE:
Transform between celestial and ecliptic coordinates for
equinox J2000.
CALLING SEQUENCE:
COCO_J2000, AI, BI, AO, BO, [ SELECT ]
INPUTS:
AI - Input Longitude in DEGREES, scalar or vector. If only two
parameters are supplied, then AI and BI will be modified to
contain the output longitude and latitude.
BI - Input Latitude in DEGREES
OPTIONAL INPUT:
SELECT - Integer (1-2) specifying type of coordinate transformation.
SELECT From To
1 Equatorial Ecliptic
2 Ecliptic Equatorial
If omitted, program will prompt for the value of SELECT
OUTPUTS:
AO - Output Longitude in DEGREES
BO - Output Latitude in DEGREES
HISTORY:
Adapted from IDL Astronomy Library routine EULER by
W. Landsman. Corrected to use obliquity of the ecliptic for
J2000. Simon Plunkett, February 1996.
NAME: DTSELECT PURPOSE: Widget tool for date/time selection. CATEGORY: Widgets. CALLING SEQUENCE: dtselect, curtime INPUTS: None. OUTPUTS: curtime: Time selection as defined by user. MODIFICATION HISTORY: Written by: Simon Plunkett, May 1995.
Project : SOHO - CDS Name : GET_SC_ATT() Purpose : Get the SOHO spacecraft attitude. Category : Class3, Orbit Explanation : Read the definitive attitude file to get the spacecraft pointing and roll information. If no definitive file is found, then the nominal values are returned as "Predictive". Syntax : Result = GET_SC_ATT( DATE [, TYPE ] ) Examples : Inputs : DATE = The date/time value to get the attitude information for. Can be in any CDS time format. Opt. Inputs : None. Outputs : The result of the function is a structure containing the spacecraft attitude information. It contains the following tags: SC_AVG_PITCH_ECLIP SC_AVG_ROLL_ECLIP SC_AVG_YAW_ECLIP SC_AVG_PITCH SC_AVG_ROLL SC_AVG_YAW GCI_AVG_PITCH GCI_AVG_ROLL GCI_AVG_YAW GSE_AVG_PITCH GSE_AVG_ROLL GSE_AVG_YAW GSM_AVG_PITCH GSM_AVG_ROLL GSM_AVG_YAW SC_STD_DEV_PITCH SC_STD_DEV_ROLL SC_STD_DEV_YAW SC_MIN_PITCH SC_MIN_ROLL SC_MIN_YAW SC_MAX_PITCH SC_MAX_ROLL SC_MAX_YAW All parameters are in radians. Opt. Outputs: TYPE = Returns whether predictive or definitive data was used to calculate the result. Returned as either "Definitive" or "Predictive". Keywords : RETAIN = If set, then the FITS attitude file will be left open. This speeds up subsequent reads. 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 = GET_SC_ATT( ERRMSG=ERRMSG, ... ) IF ERRMSG NE '' THEN ... Calls : CONCAT_DIR, FXBOPEN, FXBREAD Common : Private common block GET_SC_ATT is used to keep track of the attitude file opened when the RETAIN keyword is used. Restrictions: The attitude entries for the time closest to that requested is used to calculate the parameters. Since the attitude data is calculated every 10 minutes, this should be correct within +/-5 minutes. No attempt is made to interpolate to closer accuracy than that. Side effects: Any data with too much variation (max-min) in the attitude data are rejected. The limits are one arcminute in pitch and yaw, and one degree in roll. Prev. Hist. : None. History : Version 1, 3-Jan-1997, RA Howard, NRL Adapted from Version 7 of GET_SC_ATT, written by W.Thompson Removed /DIR from calls to concat_dir Changed call to OS_VERSION() to use system variable !version Contact : WTHOMPSON
Project : SOHO - LASCO Name : GET_ORBIT_CDF() Purpose : Get the SOHO orbit information. Category : Class3, Orbit Explanation : Reads orbit information from either the definitive or predictive orbit file, whichever it can find first. Syntax : Result = GET_ORBIT_CDF( DATE [, TYPE ] ) Examples : Inputs : DATE = The date/time value to get the orbit information for. Can be in any SOHO/CDS time format. Opt. Inputs : None. Outputs : The result of the function is a structure containing the spacecraft orbit information. It contains the following tags. If unable to find this information, zeroes are returned instead. Opt. Outputs: TYPE = Returns whether predictive or definitive data was used to calculate the result. Returned as either "Definitive" or "Predictive". If the routine fails to return an answer, then the null string is returned. Keywords : RETAIN = If set, then the orbit cdf file will be left open. This speeds up subsequent reads. 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 = GET_ORBIT( ERRMSG=ERRMSG, ... ) IF ERRMSG NE '' THEN ... Calls : CONCAT_DIR, Various cdf handling routines. Common : Private common block GET_ORBIT_CDF is used to keep track of the orbit file opened when the RETAIN keyword is used. Side effects: None. Prev. Hist. : Adapted from William Thompson's GET_ORBIT to read CDF files rather than FITS. History : Written by Simon Plunkett, 27 March 1996. RAH, NRL, 18 Feb 97, mods to account for changes in CDF variables DW, NRL, 26 Aug 98, mod for change in predictive CDF filenames NBR, NRL, 29 Oct 01 - Rename soho_orbit structure definition to be compatible with SSW @(#)get_orbit_cdf.pro 1.3 10/29/01 LASCO IDL LIBRARY
Project : SOHO - LASCO Name : GET_ORBIT_CDF2() Purpose : Get the SOHO orbit information. Category : Class3, Orbit Explanation : Reads orbit information from either the definitive or predictive orbit file, whichever it can find first. Syntax : Result = GET_ORBIT_CDF2( DATE [, TYPE ] ) Examples : Inputs : DATE = The date/time value to get the orbit information for. Can be in any SOHO/CDS time format. Opt. Inputs : None. Outputs : The result of the function is a structure containing the spacecraft orbit information. It contains the following tags: GCI_POS: Geocentric Inertial X,Y,Z (KM) GCI_VEL: " (KM/S) GSE_POS: Geocentric Solar Ecliptic X,Y,Z (KM) GSE_VEL: " (KM/S) GSM_POS: Geocentric Solar Magnetospheric X,Y,Z (KM) GSM_VEL: " (KM/S) SUN_VECTOR: GCI Sun Vector X,Y,Z (KM) HEC_POS: Heliocentric Ecliptic X,Y,Z (KM) HEC_VEL: " (KM/S) CRN: CARRINGTON ROTATION from EARTH LONG_EARTH: HELIOGRAPHIC LONG. EARTH (radians) LAT_EARTH: HELIOGRAPHIC LAT. EARTH (radians) LONG_SPACE: HELIOGRAPHIC LONG. SOHO (radians) LAT_SPACE: HELIOGRAPHIC LAT. SOHO (radians) For more info see http://sohowww.nascom.nasa.gov/data/ancillary/index.html If unable to find this information, zeroes are returned instead. Opt. Outputs: TYPE = Returns whether predictive or definitive data was used to calculate the result. Returned as either "Definitive" or "Predictive". If the routine fails to return an answer, then the null string is returned. Keywords : RETAIN = If set, then the orbit cdf file will be left open. This speeds up subsequent reads. 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 = GET_ORBIT( ERRMSG=ERRMSG, ... ) IF ERRMSG NE '' THEN ... Calls : CONCAT_DIR, Various cdf handling routines. Common : Private common block GET_ORBIT_CDF is used to keep track of the orbit file opened when the RETAIN keyword is used. Side effects: None. Prev. Hist. : Adapted from William Thompson's GET_ORBIT to read CDF files rather than FITS. History : Written by Simon Plunkett, 27 March 1996. Adapted to read new CDF files (CRN_EARTH and CRN_SPACE tags replaced by single CRN tag). SPP, 7 August 1996. Mods to deal with: 1) differing file names on CDs and in GSFC archive and 2) to take account of changes in CRN definition in CDF files. 14 March 1997 (SPP). 16 Nov 2000, nbr - Fix problems with using the RETAIN keyword and epoch array 29 Oct 2001, nbr - Rename soho_orbit structure to make compatible with SSW 10/29/01 @(#)get_orbit_cdf2.pro 1.4 LASCO NRL IDL LIBRARY
Project : SOHO - CDS Name : GET_ORBIT_FITS() Purpose : Get the SOHO orbit information. Category : Class3, Orbit Explanation : Reads orbit information from either the definitive or predictive orbit file, whichever it can find first. Syntax : Result = GET_ORBIT_FITS( DATE [, TYPE ] ) Examples : Inputs : DATE = The date/time value to get the orbit information for. Can be in any CDS time format. Opt. Inputs : None. Outputs : The result of the function is a structure containing the spacecraft orbit information. It contains the following tags. If unable to find this information, zeroes are returned instead. Opt. Outputs: TYPE = Returns whether predictive or definitive data was used to calculate the result. Returned as either "Definitive" or "Predictive". If the routine fails to return an answer, then the null string is returned. Keywords : RETAIN = If set, then the orbit FITS file will be left open. This speeds up subsequent reads. 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 = GET_ORBIT_FITS( ERRMSG=ERRMSG, ... ) IF ERRMSG NE '' THEN ... OLD = If set, then files are read in from the subdirectory "old_samples". This is used to test the software until real data files are available. Calls : CONCAT_DIR, FXBOPEN, FXBREAD Common : Private common block GET_ORBIT is used to keep track of the orbit file opened when the RETAIN keyword is used. Restrictions: The orbit entries for the time closest to that requested is used to calculate the orbit parameters. Since the orbit data is calculated every 10 minutes, this should be correct within +/-5 minutes. No attempt is made to interpolate to closer accuracy than that. Side effects: None. Prev. Hist. : None. History : Version 1, 04-Dec-1995, William Thompson, GSFC Adapted from Bill Thompson's GET_ORBIT. Removed /DIR keyword from calls to CONCAT_DIR, 7 August 1996 (SPP). Changed structure definition to SOHO_ORBIT_FITS to avoid clashes with structures from CDF files, 14 March 1997 (SPP). 011101, nbr - Add SCCS date /version stamp Contact : WTHOMPSON 11/01/01 @(#)get_orbit_fits.pro 1.3 ; LASCO NRL IDL Library
Returns SOHO solar ephemeris info in SUNEPHEM structure: LONG STRUCT -> COORDINATE Array[1] LAT STRUCT -> COORDINATE Array[1] ORIENT STRUCT -> ORIENT Array[1] L0 DOUBLE 3.5500000 B0 DOUBLE -5.7100000 ROTATION LONG 1934 CRSTART DOUBLE 2450892.5 DIAMETER STRUCT -> SUNDIAMETER Array[1] and planetary ephemeris info for 5 planets in PLANETEPHEM structures: NAME STRING 'Mars' LONG STRUCT -> COORDINATE Array[1] LAT STRUCT -> COORDINATE Array[1] PHASE DOUBLE 4.8000000 ILLUM DOUBLE 0.99823315 DIAMETER STRUCT -> PLANDIAMETER Array[1] Uses predictive orbital CDF files from SOHO. INPUTS: t STRING date_obs+' '+time_obs OUTPUTS: sunephem SUNEPHEM structure planephem PLANETEPHEM structure (array of 5) By Nathan Rich/NRL/Interferometrics, Nov 2000 011219, NR - Use (new) sohoephem.pro %H%, %W% ; LASCO NRL IDL Library
PROJECT:
SOHO - LASCO
NAME:
POINTING3
PURPOSE:
Widget interface to display LASCO pointing information.
CATEGORY:
Widgets.
CALLING SEQUENCE:
Pointing3
INPUTS:
OPTIONAL INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
OPTIONAL OUTPUTS:
COMMON BLOCKS:
lasco.com, chandle.com
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
MODIFICATION HISTORY:
Written by: Simon Plunkett, May 1995.
November 1995: Major revision--adapted to use FITS keywords
and do gnomonic projections. Got rid of (almost) all
common blocks. SPP.
December 1995: Included distortion effects in C2.
Tidied up format statements.
Made compatible with V1.0 of LASCO display
s/w. SPP.
April 1996: Adapted to use SOHO orbit parameters from CDF
files. SPP.
011219, NR - Fix second call to sohoephem
12/19/01, @(#)pointing3.pro 1.2 - IDL LASCO NRL Library
NAME:
RD_CATALOG
PURPOSE:
Read star catalogs for any of the three LASCO coronagraphs.
CATEGORY:
CALLING SEQUENCE:
rd_catalog,telescope,catalog
INPUTS:
telescope: string containing telescope name.
KEYWORD PARAMETERS:
None.
OUTPUTS:
catalog: structure containing fields in catalog file.
PROCEDURE:
Straightforward.
MODIFICATION HISTORY:
Written by Simon Plunkett, April 1995.
NAME:
RD_LAS_CAT_FITS
PURPOSE:
Read new star catalogs LASCO coronagraphs C2 or C3.
CATEGORY:
CALLING SEQUENCE:
rd_las_cat_fits,telescope,catalog
INPUTS:
telescope: string containing telescope name.
KEYWORD PARAMETERS:
None.
OUTPUTS:
catalog: structure containing fields in catalog file.
PROCEDURE:
Straightforward.
MODIFICATION HISTORY:
Written by Doug Biesecker, May 1999.
011101, nbr - Check in to SCCS
11/01/01 @(#)rd_las_cat_fits.pro 1.1 ; LASCO NRL IDL Library
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).
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
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.
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
PROJECT:
SOHO - LASCO
NAME:
STARFIELD
PURPOSE:
Widget interface to display stars and planets in field of view
of any of the three LASCO coronagraphs.
CATEGORY:
Widgets.
CALLING SEQUENCE:
Starfield
INPUTS:
OPTIONAL INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
OPTIONAL OUTPUTS:
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
EXAMPLE:
MODIFICATION HISTORY:
Written by: Simon Plunkett, February 1996
(adapted from pointing3.pro).
Adapted to use SOHO orbit parameters from either CDF or FITS
files. 14 March 1997 (SPP).
Removed use of LASCO_ASTROMETRY environment variable for
output. Now writes to current directory. 23-Jun-2000 (SPP).
Use library routines for C2/C3 distortion. 15-Aug-2001 (SPP).
Use default occulter centers for all telescopes, instead of
assuming occulter at center of CCD. 15-Aug-2001 (SPP).
Changes needed in future:
1) Decouple Sun location from occulter center.
011219, NBR - Change "sohoephem3" to "sohoephem"
@(#)starfield.pro 1.3, 12/19/01 : IDL NRL LIBRARY
lasco_mk_html_help.pro on
Fri Jan 12 09:28:43 2007.