Tables of Useful Yohkoh Routines
    A.1  General Useful Routines
    A.2  BCS Useful Routines
    A.3  HXT Useful Routines
    A.4  SXT Useful Routines
    A.5  WBS Useful Routines
Format and Naming of Yohkoh Data Files
    B.1  Yohkoh Data File Format
    B.2  Yohkoh Data File Names
        B.2.1  Yohkoh Directory Logicals/Environment Variables
        B.2.2  Yohkoh Prefixes
        B.2.3  Yohkoh File IDs
        B.2.4  Yohkoh Week IDs
        B.2.5  Yohkoh Carrington IDs
Accessing Yohkoh files
    C.1  How to Read Yohkoh Archive Tapes (GO_RDTAP)
    C.2  How to Read Yohkoh Database Tapes (RD_YDBTAP)
    C.3  FTP Access to Yohkoh Archive, etc...
Using the Yohkoh Team Bulletin Board (TBB)
    D.1  Overview
    D.2  Access to the TBB
    D.3  How to submit a new proposal
    D.4  How to Update a Proposal
    D.5  Where to Find TeamBB Files
Old Fortran 77 Analysis Software
    E.1  Calibrating and Fitting BCS Spectra (the BSD software)
        E.1.1  Displaying Data from the BSD File
        E.1.2  Displaying Intermediate Results (from BSDCAL)
        E.1.3  Displaying Fitted Spectral Data (from BSDFIT)
        E.1.4  Displaying Processed Parameters (from BSDFIT)
    E.2  Synthesizing HXT Images (HXTPRO; Sakao)

A  Tables of Useful Yohkoh Routines

This appendix contains a list of the most useful routines used by Yohkoh personnel. The user should consult the Reference Manual and/or use the IDL routine DOC_LIBRARY for more information. (M) is main program, (P) is procedure, (F) is function, and (S) is script.

A.1   General Useful Routines

The following table is a list of the routines useful for General Yohkoh analysis.

help_prefix P Gives information about Yohkoh file names
pr_path P Print the !path variable
pr_path_lib P Print the full path of a given routine(s) (* is ok)
doc_library P Print the documentation header to a given routine
fastdoc P Same as DOC_LIBRARY but is much faster
yodat M Select and Read any Yohkoh data files
stepper P Display images one-by-one or as a movie
show_pix P Display PR and noted Yohkoh images
xstepper P Display images in rapid fashion
data_paths F Obtain the paths to reformatted and databases files
new_dpath P Add personal directories to on-line Yohkoh data path
concat_dir F Builds a path given file name and logical or environment var
get_subdirs F Return all the subdirectories under a given dir
file_list F Get a list of files that fulfill given specifications
file_menu F Menu driven FILE_LIST but only returns single files
files_search P Search for a given string within the give directory(s)
ydb_exist F Checks status of needed Yohkoh database files
get_info F Convert index data into a readable information. (/longform)
pr_fem P Print day and night events given a date
pr_evn P Print flare-event summary for a given date(s)
plot_evn P Plot station contacts, SAA, S/C D/N, Yohkoh data periods & modes
rd_fem P Read FEM structures
rd_evn P Read EVN structures
rd_gev P Read GEV structures
pr_pnt_hist P List a summary of the spacecraft pointing history
utplot P Line plots with time axis
eutplot P Overplots error bars on plot previously drawn by UTPLOT
outplot P Overplots on plot previously drawn by UTPLOT
clear_utplot P Resets the UTPLOT plotting variables
clearplot P Reset plot parameters
ploty P Plot light curves from all Yohkoh instruments
ocontour P Contours overlaid on images
plot_arc P Plot the intensity along a path of a given width
plot_lcur P Time plots with zoom abcissa
box_latlon P Draw a box from specified latitude/longitude values
tim2dset F Return data set numbers from roadmap given time-date
sel_timrange F Return indices of roadmap or index which agrees to input times
fmt_tim F Returns formatted date and time from roadmap or index
fmt_timer P Print 1st and last formatted times from an index file
anytim2ints F Converts date and time to internal-format
anytim2ex F Converts date and time to external-format
int2secarr F Converts roadmap or index times to seconds from a ref. time
anytim2doy F Converts date and time to day of year number
ex2fid F Converts external-format to Yohkoh file ID: yymmdd.hhmm
tim2orbit P Print or return the FID, WID, D/N, SAA for given date and time
ex2dow F Converts external-format to day of the week number
gt_day F Returns date from roadmap or index
gt_time F Returns UT time from roadmap or index
doy2ex F Convert from day of year (DOY) to internal-format
doy2date P Convert from DOY and year to month and day or yymmdd
doytim2ex F Convert DOY and time to external-format, year is optional
get_yo_dates F Return significant Yohkoh dates (e.g., launch)
anytim2weekid F Convert a Yohkoh time to a week ID
pr_tim2week P Print week ID on screen for given time
weekid2ex F Convert a Yohkoh week ID to external time
pr_week2tim P Print time on screen for given Yohkoh week ID
help_roll P Display Yohkoh roll offset and sign conventions
get_roll F Return S/C roll value
hxa_suncenter F Return sun center position (SXT pix coord.) from HXA data
conv_p2a F Return angle in arcsec relative to sun center given pixel address
conv_a2p F Return pixel address given angle in arcsec relative to sun center
conv_a2h F Return heliocentric coordinates from sun center angle in arcsec
conv_h2a F Return sun center angle in arcsec from heliocentric coordinates
conv_p2h F Return heliocentric coordinates from SXT-pixel address
conv_h2p F Return SXT-pixel address from heliocentric coordinates
conv_p2hxt F Convert SXT-pixel address to HXT-HXA sun sensor address
conv_hxt2p F Convert HXT-HXA sun sensor address to SXT-pixel address
conv_p2c F Converts SXT pixel locations to Carrington coordinates
conv_c2p F Converts Carrington coordinates to SXT pixel location
get_rb0p F Return solar radius, b0 angle, p angle for given time
rd_atr P Read raw S/C pointing information for specified times
rd_att P Read processed S/C pointing information for specified times
get_att P Read processed S/C pointing information for index-times
c2s F Covert between Cartesian and spherical coordinates
get_carr F Return geocentric physical ephemeris of the Sun
gt_hxa F Read HXA data from either ATR or ADA data structures
gt_iru F Read IRU data from either ATR or ADA data structures
rdtap P Read data off a Yohkoh archive tape
def_tapd F Return the full device name of the specified tape drive #
go_rdtap P Read data off a Yohkoh archive tape via simple user interface
rd_ydbtap P Read data off a Yohkoh database (ydb) tape
rd_xda P Read any Yohkoh file data section
rd_roadmap P Read any Yohkoh file roadmap section
rd_pointer P Read any Yohkoh file pointer seciton
rd_fheader P Read any Yohkoh file header section
rd_qs P Read any Yohkoh file quasi-static section
sav_sda P Write SXT data to Yohkoh-format data file
sav_bda P Write BCS data to Yohkoh-format data file
sav_hxi P Write HXT data to Yohkoh-format data file
savegen P Save data to a GENX (GENeral Xdr) file
restgen P Restore data from GENX (GENeral Xdr) file
rfits F Read FITS format files
wrt_fits P Write a data-array into a standard FITS file
sxt2fits P Write SXT index and data to standard FITS file
mk_tiffb P Write (SXT) image to a full color (24 bit) TIFF file
mk_tiffp P Write (SXT) image to a TIFF-Palette Color (256 levels) file
rd_tfile F Read and return contents of text file
file_append P Appends text to text file
file_exist F Boolean check for finding files
file_delete P Deletes or removes files
file_purge P Purge file that have similar file names (wild cards OK)
file_info F Return standard file info. for a given file
file_compress P Compress a file using the standard Unix compress utility
file_uncompress P Decompress a file using the standard Unix compress utility
set_logenv P Set Unix environmentals/VMS logicals
get_logenv F Get Unix environmentals/VMS logicals (* wildcard ok)
rd_obs P Read the observing log
pr_sxtobs P Print get_info2 output from observing log
bcs_24hr_plot P Plots BCS light curve for 24 hour period
pfi_loc P Display the location of the the SXT PFI on the sun
wdef P Create IDL-graphics window on an X device
wshow P Pops an IDL-graphics window to the forground
rcolor P Capture and print a window on Misubishi Color Printer (D-tou)
hardcopy P Generate color or B&W PostScript file & output to PS printer
pprint P Output an file to printer
str_concat_tags F Concatenate two similar data structures
str_diff F Determine the differences in contents between two structures
show_struct S Script to print data structures. Example, show_struct sxt
prstr P Print a string-array one element per line
pmm P Print the min and max of an array
str2arr F Parse a string using a given delimiter into a string array
arr2str F Combine a string array into a string with "," delimeter
str_replace F Replace all occurances of a given string with another string
wmenu_sel F Select from a string-array list via mouse
wc_where F Perform wild card searches on string arrays
yo_file_check P Compare actual file size and file size in pointer rec.
mk_mapfile P Create/update GENX file which maps files into pathnames e.g. fastdoc
plot_nar P Plot a grid with NOAA Active Region positions
pr_nar P Print NOAA Active Region positions
plot_goes P Plot 1-minute averaged or 3 second GOES fluxes
pr_gev P Print GOES events
goes_reducer P Compute Te, EM, L_X from GOES 1 min or 3 sec fluxes
rd_gxd P Read 3-sec or 1-min data from GOES-6 or GOES-7
rd_gxt P Read 1-min averaged GOES fluxes
pr_gbe P List GRO/BATSE events for given time period or event
plot_gbl P Plot GRO/BATSE light curve

A.2   BCS Useful Routines

The following table is a list of the routines useful for BCS analysis.

yodat M Select and Read any Yohkoh data files
bcs_decomp F Decompress (8 bit) BDA spectra data
bcs_comp F Compresses BCS spectral data
ext_bcschan F Extracts spectra for a single channel from BDA data
bcs_norm F Normalizes extracted data for integration time;
extracts fast queue data
bcs_dspec F Extracts, decompresses and normalizes BDA data
bcs_tvec F Creates a intergration-time corrected time vector
sum_bda F Sums a number of BDA spectra
bcs_point F Source position on disk from resonance line bin number
bcs_dtfac F Calculates deadtime corrections
gt_total_counts F Extracts detector total counts
gt_blockid F Extracts data block ID
gt_bsc_bincal F Returns a structure with miscellaneous calibration info
plott_bda P Plot a light curve of the 4 BCS channels
wbda P Browse light curves and spectra in BDA files
plot_bsc P Plot BSC light curves and spectra
map_bsc P Stack plots of successive BSC spectra
lc_bsc P Plot and extract BSC light curves of selected spectral regions
fit_bsc_plot P Plot time series results from FIT_BSC
bcs_spec_plot P Plot BSC spectrum (landscape)
mk_fit_bsc_eps P Plot BSC spectrum (portrait and eps)
wbsc P Browse light curves and spectra in BSC files
mk_bsc P Create instrumentally corrected BCS data (BSC data)
fit_bsc P Fit synthetic spectra to observed BSC spectra
get_bsc F Extract BSC data fields
sel_bsc P Extracts wavelength and flux fields from BSC_DATA
get_bsc_anno F Return plot annotation from BSC index structure
bcs_broad F Convert between line width and Doppler velocity
gt_bsc_wave F Generate a standard wavelength vector
gt_bsc_chan F Extract BCS channel number from BSC index
gt_bsc_bincal F Get BCS crystal calibration data (calls RD_BCSCAL)
list_bsc P List BSC header information
bsc2bsd P Convert a BSC file to BSD format
help_bsc P Print a list of BSC routines
bcs_synthetic M Main program to compute BCS synthetic spectra
bcs_line P Compute theoretical line intensities
conflx F Compute theoretical continuum
collexc P Compute effective excitation rate coefficients
drexc P Compute effective dielectronic rate coefficients
wvoigt F Compute a Voigt profile
bcs_spec P Compute a BCS synthetic spectrum
get_atomic F Read atomic data files
get_elemabun F Return Yohkoh adopted coronal abundances
get_ionbal F Return ionization balance fractions
rd_bcscal P Reads calibration data for a single BCS channel
rd_bda P Reads in a BDA structures (Reformatted data)
sav_bda P Saves new or modified BDA structures
sav_bsc P Save a BSC index and data array to a file
rd_bsc P Read a BSC index and data array from a file
get_bsd P Reads in a BSD structures (F77 and IDL code)
wr_bsd P Saves new or modified BSD structures

A.3   HXT Useful Routines

The following table is a list of the routines useful for HXT analysis.

yodat M Select and Read any Yohkoh data files
plott_hda P Time series plot of 4 channels
hxt_4chplot P Time series plot of 4 channels
ave_cts F HXT count rate data (in units of cts/s/SC)
mk_hxtdata F Extract a portion of the HXT data
hxtbox_fsp P Peform spectral fit to HXT data
hxt_qlook P Quick image synthesis
hxtpro M Image synthesis program (only runs on SUN machine)
hxt_img M Image synthesis program (McTiernan)
get_hxt_pos F Returns the HXT flare position address
hxt_powerlaw F Estimate hard X-ray flux and photon index
hxt_thermal F Calculate temperature and emission measure

A.4   SXT Useful Routines

The following table is a list of the routines useful for SXT analysis.

yodat M Select and Read any Yohkoh data files
stepper P Display images one-by-one or as a movie
sswhere F Select SXT images by filter, exp., mode, etc.
show_obs3 P Plot the SXT observing table sequence
show_obs4 P Enhanced verison of SHOW_OBS3
plot_fov P Plot SXT PFI fields of view (FOV)
lcur_image P Plot a light curve from a selected area of SXT data cube
plot_arc P Plot the intensity along a path of a given width.
xmovie_sfm P Reviews the online SFM database via widget
get_sfm P Returns SFM index and image closest to requested times
disp_month P Display a month of SXT images in calendar format
rd_sot P Read the SOT files: rd_sot,sttim, entim, index, data_structure
rd_xda P Read any of the Yohkoh reformatted data files
get_info F Return formatted information from SXT index or roadmap
pr_sxtobs P Print GET_INFO output from observing log
sxtpnt_sum P Summary line for each unique pointing
pfi_loc P Display the location of the the SXT PFI on the sun
sxt_prep P Prepares SXT data for further processing (LEAK_SUB, aligns,...)
xsxt_prep M Adds a graphical user interface to SXT_PREP
exp_norm F Perform exposure normalization
go_teem P Compute Te and EM timeseries from SXT image ratios
sxt_teem P Compute Te and EM from SXT image ratios
tv_teem P Display Te's and tolerances in image format
sxt_interp P Do a linear time interpolation of SXT images
sxt_flux F Compute the Flux (DN/s or ph) given Te and filter
sxt_erg_per_dnF Compute erg/DN at the sun given Te and filter
sxt_dn2ph F Converts DN to photons counts given DN, ph energy or wavelength
sxt_prep P Aligns and dejitters SXT images
sxt_center P Returns row, column, and radius of the solar disk from images
sxt_cen F Return SXT sun center coordinates
sxtpnt_sum P Return unique PFI pointings
get_rb0p P Calculate Sun's radius, B0 angle, P angle
coal_image P A low level routine to coalign images (shift, rotate, stretch)
get_gbo_pfi F Given a SXT PFI image and GBO image, extract and align the
portion of the GBO image which corresponds to the PFI
sxt_grid P Draws heliocenteric grid over an image
profiles P Plot line or column intensity profiles
tprofiles P Plot light curve for any pixel in a data cube
xy_raster P Display a raster of images
plot_clon P Overlay Carrington longitude or grid on SXT image
unsharp_mask F Improve image contrast using unsharp mask method
sxt_merge P Merge two overlaping off-point images into a single image
compst F Interleaves two images with each using half the color table
sxt_composite F Make desaturated composite image from several images
wdefroi F Widget to extract sub-image
ext_subset P Extracts a subset (in rows and columns) from a data cube
de_spiker F Cleans images by removing SAA spikes
spikes F Locates single pixel spikes in an image array
rm_darklimb F Removes the limb darkening from optical images
sxt_off_axis F Correct an SXT image for the X-ray vignette function
sxt_vignette F Return SXT X-ray vignette function determined from WSMR1 data
go_nvs5 P Writes SXT data to SONY laser disk
go_per2opt P Writes SXT data to Panasonic laser disk
mk_vcr P Controls and commands the SONY laser disk for output to VCR
video_menu P Lists the all movie segments recorded on the SONY laser disk
video_title P Make a title page image (for laser disk)
leak_sub F Decompress and subtract dark current/stray light from SXT image
dark_sub F Decompress and subtract dark current from SXT image
sxt_decomp F Decompress SXT data
sxt_comp F Compress SXT data
sfd_decomp F Decompress an SFD image
sfd_comp F Compress an SFD image
restore_low8 F Restore low-8 (bit) optical images to 12 bit representation
get_dc_image P Return appropriate dark frame and matching index
sxt_satpix F Returns map of saturated pixels from index and data
dprate2sec F Return the major frame rate in seconds given a DP_RATE code
pr_image P Print the average DN level of a box
gt_filta F Return filter A (optical) setting from index or roadmap
gt_filtb F Return filter B (X-ray) setting from index or roadmap
gt_res F Return image pixel-resolution from index or roadmap
gt_expdur F Return effective exposure duration from index
gt_time F Return time exposure was taken
gt_day F Return date exposure was taken
gt_explat F Return Exposure latency time from indexed time
gt_dpe F Return command exposure level
gt_mbe F Return mail box exposure level
gt_dp_mode F Return Yohkoh modes of operation
gt_dp_rate F Return SXT data telemetry rate
gt_corner F Return corner pixel address relative to sun center
gt_center F Return center of FOV in full res pix, helio coord, angle, HXT pix
gt_temp_ccd F Return the temperature of the CCD in degrees celsius
gt_temp_hk F Return the monitor temperatures for the S/C and SXT
gt_comp F Return the compression mode for an image
gt_pfi_ffi F Return the image-type PFI, FFI, PFI-observing region, FFI-patrol
gt_sxt_cen F Return sun center value from history record
gt_sxt_roll F Return the roll of the SXT image
gt_sxt_axis F Returns boresight axis location for SXT
contacts P Show Yohkoh KSC contact times
first_light M Provides quick look at SXT conditions
lastsfd P Read and displays the most recent sfd file
goes_summary P Plot GOES summary (shows flares separately)
plot_fem P Plot the Yohkoh day/night, SAA, Pass schedules
pr_fem P Print the Yohkoh day/night, SAA, Pass schedules
pr_evn P Print a summary of Yohkoh data times (flare/quiet)
pr_gev P Print GOES events
gtab_entry F List SXT entry tables
gtab_pfi F List SXT PFI tables
gtab_ffi F List SXT FFI tables
gtab_comm F List SXT common tables
gtab_roi F List SXT observing region tables
gtab_summary P List a summary of SXT sequence tables
seq_summary F List SXT table (-777 in yodat) print,seq_summary(roadmap)
get_sunset F Get the time of Yohkoh sunsets (Ultrix and SGI only)
plot_sls M Plot the SXT Leak Scatter Log
plot_sld M Plot the SXT Leak Dark Current Log
sld_sls_vstripsP Run after plot_sls as: IDL > sld_sls_vstrips,index_s,sls
sxt_obs_coord P To find the coordinates for ARS2 pointing
plot_sot P Plot the aspect sensor degradation
plot_temps P Plot SXT instrument temperatures
plot_ssl P Plots SXT summaries (filter use, exposure, ...)

A.5   WBS Useful Routines

The following table is a list of the routines useful for WBS analysis.

yodat M Select and Read any Yohkoh data files
plott_wda P Time plot series of seven sub-instruments
wbspc P Plots the SXS-PC and HXS-PC time histories
sxspc P Plots the SXS-PC data
plot_hxspc P Plots the HXS-PC data
plot_hxsph P Plots the HXS-PH data
plot_grspcl P Plots the GRS-PCL data
plot_grspch P Plots the GRS-PCH data
plot_grsphl P Plots the GRS-PHL data
plot_grsphh P Plots the GRS-PHH data
disp_wda P Image representation of the WBS spectra is displayed
hxs_sp1 P Spectral plot obtained a single power law fitting
hxs_sp2 P Spectral plot obtained a double power law fitting
grs_speff P Plot a preliminary gamma-ray spectrum
mk_rbmpc F Extract the RBM data into arrays
hxs_fsp P Perform spectral fit to HXS data
spfdhxs P Fit HXS data (Runs on SUN machines only)
spfdgrs P Fit GRS data (Runs on SUN machines only)
dtcf_pc_hxs P Perform dead time correction for HXS-PC
dtcf_ph_hxs P Perform dead time correction for HXS-PH
dtcf_ph_grs1l P Perform dead time correction for GRS-PH1-L
dtcf_ph_grs2l P Perform dead time correction for GRS-PH2-L

B  Format and Naming of Yohkoh Data Files

B.1   Yohkoh Data File Format

Picture Omitted

Figure B.13: Yohkoh Data File Format

Each file is logically divided into the following six sections. Some files will not use all the sections described below, but all will have a Pointer and File Header Section.

  1. File Information and Pointer Section
  2. File Header Section
  3. Quasi-Static Index Section
  4. Index and Data Section
  5. Optional Data Section
  6. Road Map Section

The program which reads the file learns from the Pointer Section how to read the rest of the file and where to go to get certain data.

The File Header Section provides information on what data are contained in the file, generally the extent of the time covered by the contents.

The Quasi-Static Section of the file contains index information that does not vary during the course of an orbit, or varies slowly.

The Index and Data section contains `data sets'. A data set is a single image for SXT, single spectrum for BCS, a single major frame of data for HXT, and two major frames of data for WBS (it takes two major frames for a complete set of WBS data). For each data set there is an index which describes the date and time that the data were taken, the mode and position of the instrument's peripherals (e.g., filters, HV), and information on temperature and gain information.

The Optional Data Section is only used by the BCS data (BDA) files and the spacecraft attitude (ADA) files. The BDA files hold the `DP_SYNC' information, which is information that is coming down every major frame. Since the BCS spectra are asynchronous to the major frames, it is stored separately. The ADA file holds the full 2048 point HXA scans.

The Roadmap Section allows a user to access a brief summary of the contents of the file and to perform searches on that summary to select what data should be extracted.

For a full description of the Yohkoh database and all the different data structures, see the File Control Document.

B.2   Yohkoh Data File Names

B.2.1  Yohkoh Directory Logicals/Environment Variables

There is a set of VMS logicals and Unix environment variables which point to the database directories. By using these logicals in all of the access routines (along with the routine CONCAT_DIR) it is possible for software to be directly portable between VMS and Unix machines. A list of the logicals that exist for the Yohkoh database is given in Table B.1.

B.2.2  Yohkoh Prefixes

Yohkoh filesnames start with a three letter prefix. A list of currently defined prefixes is given in the Table B.2. More information about a prefix (``ppp'') can be found by using the IDL command:.
IDL >  help_prefix,'ppp',/full

B.2.3  Yohkoh File IDs

The orbit file ID's are an 11 characters date format following the prefix as shown below:


      where ppp  - Prefix of the file
            YY   - Year of data
            MM   - Month of data
            DD   - Day of data
            HH   - Hours
            MM   - Minutes

B.2.4  Yohkoh Week IDs

The Yohkoh week starts on Sunday and ends on Saturday. CAUTION: Yohkoh data taken at 00:01 (one minute after midnight) on Sunday morning is most likely in a file and tape for the previous week since the orbit started on Saturday and the first full orbit for Sunday has not started. Up to the first 90 minutes of data taken on Sunday could be stored in the previous week, depending on when the spacecraft day begins.

The weekly IDs are of the form:


      where ppp  - Prefix of the file
            YY   - Year of data
            WW   - Week number of the data (1 to 53)
             a   - is fixed (reserved for future use)
            NN   - is the program version number which created the file
A list of the dates covered by each of the weeks is given in Table B.3.

B.2.5  Yohkoh Carrington IDs

The Carrington IDs are of the form:


      where ppp  - Prefix of the file
            cr   - signifies a Carrington Rotation ID
            RRRR - is the rotation number
             a   - is fixed (reserved for future use)
            NN   - is the program version number which created the file
The starting dates for Carrington Rotations are shown in Table B.4.

Table B.1: Defined Yohkoh Enviroment Variables


Table B.2: Defined Yohkoh Prefixes

Prefix Description File Type
ADA S/C Attitude Raw Reformatted Data per Orbit
ATR Raw S/C Attitude Database Weekly
ATT Processed S/C Attitude Database Weekly
BDA BCS Raw Reformatted Data per Orbit
BSD *OLD* BCS Instrument Calibrated Spectra User Specified
BPC *OLD* BSDCAL Output (parameters) User Specified
BTH *OLD* BSDFIT Output (Fitted Spectra) User Specified
BFT *OLD* BSDFIT Output (parameters) User Specified
BSC *NEW* BCS Instrument Calibrated Spectra User Specified
BSA *NEW* Answer File for BSC Generation User Specified
BSF *NEW* Output from Spectral Fitting User Specified
CBA S/C Common Basic Raw Reformatted Data per Orbit
EVN Yohkoh Event Log Weekly
FEM Yohkoh Orbital Ephemeris Weekly
GEV GOES Event Log Weekly
GXT GOES One Minute Light Curve Data Weekly
G6D GOES 3 Sec Light Curve for S/C 6 Weekly
G7D GOES 3 Sec Light Curve for S/C 7 Weekly
GXD GOES Derived One Minute Light Curve Data Weekly
GBE GRO BATSE Event Log Mission
GBL GRO BATSE Light Curves Weekly
G_x Ground-Based Observation (GBO) Images (Sites) per Image (FITS)
Gx_ Ground-Based Observation (GBO) Images (Data Type) per Image (FITS)
GBC GBO Big Bear Large Scale H-alpha PFI FITS Image per Image (FITS)
GBH GBO Big Bear H-alpha FITS Image per Image (FITS)
GBK GBO Big Bear Calcium FITS Image per Image (FITS)
GBW GBO Big Bear White Light FITS Image per Image (FITS)
GCH GBO Boulder Colorado H-alpha FITS Image per Image (FITS)
GGH GBO GSFC H-alpha FITS Image per Image (FITS)
GHH GBO Holloman H-alpha FITS image per Image (FITS)
GLH GBO Leamonth Australia H-Alpha FITS Image per Image (FITS)
GNH GBO NAOJ Japan H-alpha FITS Image per Image (FITS)
GJH GBO CRL Hiraiso H-alpha FITS Image per Image (FITS)
GKI GBO Kitt Peak He 10830 FITS Image per Image (FITS)
GKM GBO Kitt Peak Magnetogram FITS Image per Image (FITS)
GNP GBO Nobeyama Polarized Radio Image (17 GHz) per Image (FITS)
GNT GBO Nobeyama Total Intensity Radio Image (17 GHz) per Image (FITS)
GOL GBO Observing Log Weekly

Prefix Description File Type
HDA HXT Raw Reformatted Data per Orbit
HXI HXT Synthesized Image User Specified
MDM Magneto-Optical (MO) Map Mission
NAR NOAA Active Region Weekly
NEL Nobeyama Radio Observatory Event Log Mission
NTS Nobeyama Radio Observatory Time Series Weekly
OBS *OLD* Yohkoh Observing Log Weekly
OBD BCS Observing Log Weekly
OSF SXT Full Frame Observing Log Weekly
OSP SXT Partial Frame Observing Log Weekly
OWH WBS/HXT Observing Log Weekly
PNT *OLD* S/C Pointing File Weekly
SDL SXT Dark Current Log Weekly
SDC SXT Dark Current Images Weekly (SDA)
SDW SXT Dark Current Images for Warm CCD Weekly (SDA)
SDP SXT Dark Current PFI Images Weekly (SDA)
SFD SXT FFI Desaturated Composite Images Weekly (SDA)
SFR SXT FFI Raw Reformatted Data per Orbit (SDA)
SFS SXT FFI Special Images (diffuser, flood...) Weekly (SDA)
SFT SXT FFI Terminator Images Weekly (SDA)
SFW SXT FFI White Light Images Weekly (SDA)
SFC SXT FFI Calibration (Leak) Image per Image (SDA)
SFM SXT FFI Monthly File (daily SFD image) Monthly (SDA)
SLS SXT Leak Scatter Log Weekly
SLD SXT Leak Dark Current Log Weekly
SPR SXT PFI Raw Reformatted Data per Orbit (SDA)
SOT SXT Optical Telescope Log Weekly
SSC SXT Synoptic Images (centered) Weekly (SDA)
SSE SXT Synoptic Images (east of center) Weekly (SDA)
SSW SXT Synoptic Images (west of center) Weekly (SDA)
SSL SXT Summary Log Weekly
SXC SXT X-Ray Sun Center Log Weekly
SXL SXT X-Ray Histogram Log Weekly
SXA SXT X-Ray Average Weekly
WDA WBS Raw Reformatted Data per Orbit
XAD Exabyte ASCII Directory for Archive Tape Weekly per Tape
XBD Exabyte Binary Directory for Archive Tape Weekly per Tape

Table B.3: Dates covered by Week IDs

01  1-Jan  5-Jan  1-Jan  4-Jan  1-Jan  2-Jan  1-Jan  1-Jan  1-Jan  7-Jan
02  6-Jan 12-Jan  5-Jan 11-Jan  3-Jan  9-Jan  2-Jan  8-Jan  8-Jan 14-Jan
03 13-Jan 19-Jan 12-Jan 18-Jan 10-Jan 16-Jan  9-Jan 15-Jan 15-Jan 21-Jan
04 20-Jan 26-Jan 19-Jan 25-Jan 17-Jan 23-Jan 16-Jan 22-Jan 22-Jan 28-Jan
05 27-Jan  2-Feb 26-Jan  1-Feb 24-Jan 30-Jan 23-Jan 29-Jan 29-Jan  4-Feb
06  3-Feb  9-Feb  2-Feb  8-Feb 31-Jan  6-Feb 30-Jan  5-Feb  5-Feb 11-Feb
07 10-Feb 16-Feb  9-Feb 15-Feb  7-Feb 13-Feb  6-Feb 12-Feb 12-Feb 18-Feb
08 17-Feb 23-Feb 16-Feb 22-Feb 14-Feb 20-Feb 13-Feb 19-Feb 19-Feb 25-Feb
09 24-Feb  2-Mar 23-Feb 29-Feb 21-Feb 27-Feb 20-Feb 26-Feb 26-Feb  4-Mar
10  3-Mar  9-Mar  1-Mar  7-Mar 28-Feb  6-Mar 27-Feb  5-Mar  5-Mar 11-Mar
11 10-Mar 16-Mar  8-Mar 14-Mar  7-Mar 13-Mar  6-Mar 12-Mar 12-Mar 18-Mar
12 17-Mar 23-Mar 15-Mar 21-Mar 14-Mar 20-Mar 13-Mar 19-Mar 19-Mar 25-Mar
13 24-Mar 30-Mar 22-Mar 28-Mar 21-Mar 27-Mar 20-Mar 26-Mar 26-Mar  1-Apr
14 31-Mar  6-Apr 29-Mar  4-Apr 28-Mar  3-Apr 27-Mar  2-Apr  2-Apr  8-Apr
15  7-Apr 13-Apr  5-Apr 11-Apr  4-Apr 10-Apr  3-Apr  9-Apr  9-Apr 15-Apr
16 14-Apr 20-Apr 12-Apr 18-Apr 11-Apr 17-Apr 10-Apr 16-Apr 16-Apr 22-Apr
17 21-Apr 27-Apr 19-Apr 25-Apr 18-Apr 24-Apr 17-Apr 23-Apr 23-Apr 29-Apr
18 28-Apr  4-May 26-Apr  2-May 25-Apr  1-May 24-Apr 30-Apr 30-Apr  6-May
19  5-May 11-May  3-May  9-May  2-May  8-May  1-May  7-May  7-May 13-May
20 12-May 18-May 10-May 16-May  9-May 15-May  8-May 14-May 14-May 20-May
21 19-May 25-May 17-May 23-May 16-May 22-May 15-May 21-May 21-May 27-May
22 26-May  1-Jun 24-May 30-May 23-May 29-May 22-May 28-May 28-May  3-Jun
23  2-Jun  8-Jun 31-May  6-Jun 30-May  5-Jun 29-May  4-Jun  4-Jun 10-Jun
24  9-Jun 15-Jun  7-Jun 13-Jun  6-Jun 12-Jun  5-Jun 11-Jun 11-Jun 17-Jun
25 16-Jun 22-Jun 14-Jun 20-Jun 13-Jun 19-Jun 12-Jun 18-Jun 18-Jun 24-Jun
26 23-Jun 29-Jun 21-Jun 27-Jun 20-Jun 26-Jun 19-Jun 25-Jun 25-Jun  1-Jul
27 30-Jun  6-Jul 28-Jun  4-Jul 27-Jun  3-Jul 26-Jun  2-Jul  2-Jul  8-Jul
28  7-Jul 13-Jul  5-Jul 11-Jul  4-Jul 10-Jul  3-Jul  9-Jul  9-Jul 15-Jul
29 14-Jul 20-Jul 12-Jul 18-Jul 11-Jul 17-Jul 10-Jul 16-Jul 16-Jul 22-Jul
30 21-Jul 27-Jul 19-Jul 25-Jul 18-Jul 24-Jul 17-Jul 23-Jul 23-Jul 29-Jul
31 28-Jul  3-Aug 26-Jul  1-Aug 25-Jul 31-Jul 24-Jul 30-Jul 30-Jul  5-Aug
32  4-Aug 10-Aug  2-Aug  8-Aug  1-Aug  7-Aug 31-Jul  6-Aug  6-Aug 12-Aug
33 11-Aug 17-Aug  9-Aug 15-Aug  8-Aug 14-Aug  7-Aug 13-Aug 13-Aug 19-Aug
34 18-Aug 24-Aug 16-Aug 22-Aug 15-Aug 21-Aug 14-Aug 20-Aug 20-Aug 26-Aug
35 25-Aug 31-Aug 23-Aug 29-Aug 22-Aug 28-Aug 21-Aug 27-Aug 27-Aug  2-Sep
36  1-Sep  7-Sep 30-Aug  5-Sep 29-Aug  4-Sep 28-Aug  3-Sep  3-Sep  9-Sep
37  8-Sep 14-Sep  6-Sep 12-Sep  5-Sep 11-Sep  4-Sep 10-Sep 10-Sep 16-Sep
38 15-Sep 21-Sep 13-Sep 19-Sep 12-Sep 18-Sep 11-Sep 17-Sep 17-Sep 23-Sep
39 22-Sep 28-Sep 20-Sep 26-Sep 19-Sep 25-Sep 18-Sep 24-Sep 24-Sep 30-Sep
40 29-Sep  5-Oct 27-Sep  3-Oct 26-Sep  2-Oct 25-Sep  1-Oct  1-Oct  7-Oct
41  6-Oct 12-Oct  4-Oct 10-Oct  3-Oct  9-Oct  2-Oct  8-Oct  8-Oct 14-Oct
42 13-Oct 19-Oct 11-Oct 17-Oct 10-Oct 16-Oct  9-Oct 15-Oct 15-Oct 21-Oct
43 20-Oct 26-Oct 18-Oct 24-Oct 17-Oct 23-Oct 16-Oct 22-Oct 22-Oct 28-Oct
44 27-Oct  2-Nov 25-Oct 31-Oct 24-Oct 30-Oct 23-Oct 29-Oct 29-Oct  4-Nov
45  3-Nov  9-Nov  1-Nov  7-Nov 31-Oct  6-Nov 30-Oct  5-Nov  5-Nov 11-Nov
46 10-Nov 16-Nov  8-Nov 14-Nov  7-Nov 13-Nov  6-Nov 12-Nov 12-Nov 18-Nov
47 17-Nov 23-Nov 15-Nov 21-Nov 14-Nov 20-Nov 13-Nov 19-Nov 19-Nov 25-Nov
48 24-Nov 30-Nov 22-Nov 28-Nov 21-Nov 27-Nov 20-Nov 26-Nov 26-Nov  2-Dec
49  1-Dec  7-Dec 29-Nov  5-Dec 28-Nov  4-Dec 27-Nov  3-Dec  3-Dec  9-Dec
50  8-Dec 14-Dec  6-Dec 12-Dec  5-Dec 11-Dec  4-Dec 10-Dec 10-Dec 16-Dec
51 15-Dec 21-Dec 13-Dec 19-Dec 12-Dec 18-Dec 11-Dec 17-Dec 17-Dec 23-Dec
52 22-Dec 28-Dec 20-Dec 26-Dec 19-Dec 25-Dec 18-Dec 24-Dec 24-Dec 30-Dec
53 29-Dec 31-Dec 27-Dec 31-Dec 26-Dec 31-Dec 25-Dec 31-Dec 31-Dec 31-Dec
01  1-Jan  6-Jan  1-Jan  4-Jan  1-Jan  3-Jan  1-Jan  2-Jan  1-Jan  6-Jan
02  7-Jan 13-Jan  5-Jan 11-Jan  4-Jan 10-Jan  3-Jan  9-Jan  7-Jan 13-Jan
03 14-Jan 20-Jan 12-Jan 18-Jan 11-Jan 17-Jan 10-Jan 16-Jan 14-Jan 20-Jan
04 21-Jan 27-Jan 19-Jan 25-Jan 18-Jan 24-Jan 17-Jan 23-Jan 21-Jan 27-Jan
05 28-Jan  3-Feb 26-Jan  1-Feb 25-Jan 31-Jan 24-Jan 30-Jan 28-Jan  3-Feb
06  4-Feb 10-Feb  2-Feb  8-Feb  1-Feb  7-Feb 31-Jan  6-Feb  4-Feb 10-Feb
07 11-Feb 17-Feb  9-Feb 15-Feb  8-Feb 14-Feb  7-Feb 13-Feb 11-Feb 17-Feb
08 18-Feb 24-Feb 16-Feb 22-Feb 15-Feb 21-Feb 14-Feb 20-Feb 18-Feb 24-Feb
09 25-Feb  2-Mar 23-Feb  1-Mar 22-Feb 28-Feb 21-Feb 27-Feb 25-Feb  2-Mar
10  3-Mar  9-Mar  2-Mar  8-Mar  1-Mar  7-Mar 28-Feb  6-Mar  3-Mar  9-Mar
11 10-Mar 16-Mar  9-Mar 15-Mar  8-Mar 14-Mar  7-Mar 13-Mar 10-Mar 16-Mar
12 17-Mar 23-Mar 16-Mar 22-Mar 15-Mar 21-Mar 14-Mar 20-Mar 17-Mar 23-Mar
13 24-Mar 30-Mar 23-Mar 29-Mar 22-Mar 28-Mar 21-Mar 27-Mar 24-Mar 30-Mar
14 31-Mar  6-Apr 30-Mar  5-Apr 29-Mar  4-Apr 28-Mar  3-Apr 31-Mar  6-Apr
15  7-Apr 13-Apr  6-Apr 12-Apr  5-Apr 11-Apr  4-Apr 10-Apr  7-Apr 13-Apr
16 14-Apr 20-Apr 13-Apr 19-Apr 12-Apr 18-Apr 11-Apr 17-Apr 14-Apr 20-Apr
17 21-Apr 27-Apr 20-Apr 26-Apr 19-Apr 25-Apr 18-Apr 24-Apr 21-Apr 27-Apr
18 28-Apr  4-May 27-Apr  3-May 26-Apr  2-May 25-Apr  1-May 28-Apr  4-May
19  5-May 11-May  4-May 10-May  3-May  9-May  2-May  8-May  5-May 11-May
20 12-May 18-May 11-May 17-May 10-May 16-May  9-May 15-May 12-May 18-May
21 19-May 25-May 18-May 24-May 17-May 23-May 16-May 22-May 19-May 25-May
22 26-May  1-Jun 25-May 31-May 24-May 30-May 23-May 29-May 26-May  1-Jun
23  2-Jun  8-Jun  1-Jun  7-Jun 31-May  6-Jun 30-May  5-Jun  2-Jun  8-Jun
24  9-Jun 15-Jun  8-Jun 14-Jun  7-Jun 13-Jun  6-Jun 12-Jun  9-Jun 15-Jun
25 16-Jun 22-Jun 15-Jun 21-Jun 14-Jun 20-Jun 13-Jun 19-Jun 16-Jun 22-Jun
26 23-Jun 29-Jun 22-Jun 28-Jun 21-Jun 27-Jun 20-Jun 26-Jun 23-Jun 29-Jun
27 30-Jun  6-Jul 29-Jun  5-Jul 28-Jun  4-Jul 27-Jun  3-Jul 30-Jun  6-Jul
28  7-Jul 13-Jul  6-Jul 12-Jul  5-Jul 11-Jul  4-Jul 10-Jul  7-Jul 13-Jul
29 14-Jul 20-Jul 13-Jul 19-Jul 12-Jul 18-Jul 11-Jul 17-Jul 14-Jul 20-Jul
30 21-Jul 27-Jul 20-Jul 26-Jul 19-Jul 25-Jul 18-Jul 24-Jul 21-Jul 27-Jul
31 28-Jul  3-Aug 27-Jul  2-Aug 26-Jul  1-Aug 25-Jul 31-Jul 28-Jul  3-Aug
32  4-Aug 10-Aug  3-Aug  9-Aug  2-Aug  8-Aug  1-Aug  7-Aug  4-Aug 10-Aug
33 11-Aug 17-Aug 10-Aug 16-Aug  9-Aug 15-Aug  8-Aug 14-Aug 11-Aug 17-Aug
34 18-Aug 24-Aug 17-Aug 23-Aug 16-Aug 22-Aug 15-Aug 21-Aug 18-Aug 24-Aug
35 25-Aug 31-Aug 24-Aug 30-Aug 23-Aug 29-Aug 22-Aug 28-Aug 25-Aug 31-Aug
36  1-Sep  7-Sep 31-Aug  6-Sep 30-Aug  5-Sep 29-Aug  4-Sep  1-Sep  7-Sep
37  8-Sep 14-Sep  7-Sep 13-Sep  6-Sep 12-Sep  5-Sep 11-Sep  8-Sep 14-Sep
38 15-Sep 21-Sep 14-Sep 20-Sep 13-Sep 19-Sep 12-Sep 18-Sep 15-Sep 21-Sep
39 22-Sep 28-Sep 21-Sep 27-Sep 20-Sep 26-Sep 19-Sep 25-Sep 22-Sep 28-Sep
40 29-Sep  5-Oct 28-Sep  4-Oct 27-Sep  3-Oct 26-Sep  2-Oct 29-Sep  5-Oct
41  6-Oct 12-Oct  5-Oct 11-Oct  4-Oct 10-Oct  3-Oct  9-Oct  6-Oct 12-Oct
42 13-Oct 19-Oct 12-Oct 18-Oct 11-Oct 17-Oct 10-Oct 16-Oct 13-Oct 19-Oct
43 20-Oct 26-Oct 19-Oct 25-Oct 18-Oct 24-Oct 17-Oct 23-Oct 20-Oct 26-Oct
44 27-Oct  2-Nov 26-Oct  1-Nov 25-Oct 31-Oct 24-Oct 30-Oct 27-Oct  2-Nov
45  3-Nov  9-Nov  2-Nov  8-Nov  1-Nov  7-Nov 31-Oct  6-Nov  3-Nov  9-Nov
46 10-Nov 16-Nov  9-Nov 15-Nov  8-Nov 14-Nov  7-Nov 13-Nov 10-Nov 16-Nov
47 17-Nov 23-Nov 16-Nov 22-Nov 15-Nov 21-Nov 14-Nov 20-Nov 17-Nov 23-Nov
48 24-Nov 30-Nov 23-Nov 29-Nov 22-Nov 28-Nov 21-Nov 27-Nov 24-Nov 30-Nov
49  1-Dec  7-Dec 30-Nov  6-Dec 29-Nov  5-Dec 28-Nov  4-Dec  1-Dec  7-Dec
50  8-Dec 14-Dec  7-Dec 13-Dec  6-Dec 12-Dec  5-Dec 11-Dec  8-Dec 14-Dec
51 15-Dec 21-Dec 14-Dec 20-Dec 13-Dec 19-Dec 12-Dec 18-Dec 15-Dec 21-Dec
52 22-Dec 28-Dec 21-Dec 27-Dec 20-Dec 26-Dec 19-Dec 25-Dec 22-Dec 28-Dec
53 29-Dec 31-Dec 28-Dec 31-Dec 27-Dec 31-Dec 26-Dec 31-Dec 29-Dec 31-Dec

Table B.4: Start Dates of Carrington Rotations

Carrington Starting Date Carrington Starting Date Carrington Starting Date
Rotation   Rotation   Rotation  
1846 21-Aug-91 1888 10-Oct-94 1930 29-Nov-97
1847 18-Sep-91 1889  6-Nov-94 1931 26-Dec-97
1848 15-Oct-91 1890  3-Dec-94 1932 22-Jan-98
1849 11-Nov-91 1891 31-Dec-94 1933 18-Feb-98
1850  8-Dec-91 1892 27-Jan-95 1934 18-Mar-98
1851  5-Jan-92 1893 23-Feb-95 1935 14-Apr-98
1852  1-Feb-92 1894 23-Mar-95 1936 11-May-98
1853 28-Feb-92 1895 19-Apr-95 1937  7-Jun-98
1854 26-Mar-92 1896 16-May-95 1938  5-Jul-98
1855 23-Apr-92 1897 12-Jun-95 1939  1-Aug-98
1856 20-May-92 1898 10-Jul-95 1940 28-Aug-98
1857 16-Jun-92 1899  6-Aug-95 1941 25-Sep-98
1858 14-Jul-92 1900  2-Sep-95 1942 22-Oct-98
1859 10-Aug-92 1901 29-Sep-95 1943 18-Nov-98
1860  6-Sep-92 1902 27-Oct-95 1944 15-Dec-98
1861  3-Oct-92 1903 23-Nov-95 1945 12-Jan-99
1862 31-Oct-92 1904 20-Dec-95 1946  8-Feb-99
1863 27-Nov-92 1905 17-Jan-96 1947  7-Mar-99
1864 24-Dec-92 1906 13-Feb-96 1948  3-Apr-99
1865 20-Jan-93 1907 11-Mar-96 1949  1-May-99
1866 17-Feb-93 1908  7-Apr-96 1950 28-May-99
1867 16-Mar-93 1909  5-May-96 1951 24-Jun-99
1868 12-Apr-93 1910  1-Jun-96 1952 22-Jul-99
1869 10-May-93 1911 28-Jun-96 1953 18-Aug-99
1870  6-Jun-93 1912 26-Jul-96 1954 14-Sep-99
1871  3-Jul-93 1913 22-Aug-96 1955 11-Oct-99
1872 30-Jul-93 1914 18-Sep-96 1956  8-Nov-99
1873 27-Aug-93 1915 15-Oct-96 1957  5-Dec-99
1874 23-Sep-93 1916 12-Nov-96 1958  1-Jan-00
1875 20-Oct-93 1917  9-Dec-96 1959 29-Jan-00
1876 17-Nov-93 1918  5-Jan-97 1960 25-Feb-00
1877 14-Dec-93 1919  1-Feb-97 1961 23-Mar-00
1878 10-Jan-94 1920  1-Mar-97 1962 19-Apr-00
1879  6-Feb-94 1921 28-Mar-97 1963 17-May-00
1880  6-Mar-94 1922 24-Apr-97 1964 13-Jun-00
1881  2-Apr-94 1923 22-May-97 1965 10-Jul-00
1882 29-Apr-94 1924 18-Jun-97 1966  6-Aug-00
1883 26-May-94 1925 15-Jul-97 1967  3-Sep-00
1884 23-Jun-94 1926 11-Aug-97 1968 30-Sep-00
1885 20-Jul-94 1927  8-Sep-97 1969 27-Oct-00
1886 16-Aug-94 1928  5-Oct-97 1970 24-Nov-00
1887 13-Sep-94 1929  1-Nov-97 1971 21-Dec-00

C  Accessing Yohkoh files

C.1   How to Read Yohkoh Archive Tapes (GO_RDTAP)

The routine GO_RDTAP allows access to the Yohkoh archive tapes. Normally the archive data are written on Exabyte (8 mm) or DAT (4 mm) tapes. There is one archive tape for each week of data. The first step to accessing archive data are to determine which tape it is on. Use the WeekID table shown in the Reference Guide to figure out what tape you need. For example, if you wish to look at data on 27-Mar-92 you first determine that it is week 13 in 1992, so the weekID is 92_13. You can use the routine TIM2ORBIT with the /print option to get the week number. Put that tape into the tape drive.

You need to move to the directory where you want the data to be written.

GO_RDTAP is a menu driven program to retrieve data from the archive tapes via a menu driven program. The ISAS and LPARL machines have a copy of the directory listing for each tape saved on the disk. This means that you can simply type:
IDL >  go_rdtap
and it will list all of the tapes that have been made. You need to select the tape that you are reading. If your system does not have the XBD files on-line, then type:
IDL >  go_rdtap, /tape
after you have loaded the tape, and the program will read the directory listing from the tape.

  1. A menu will appear with a series of weekly log files. If you do not need any of the weekly files, then just select QUIT/EXIT.
  2. The next menu will be the file prefixes that are available. Click on each file prefix that you wish to copy to the disk.
  3. When you have selected all of the prefixes you need, click on QUIT/EXIT.
  4. The final menu is the FileIDs that are on the tape. Select the fileIDs you need, and then click on QUIT/EXIT.
  5. You will be asked whether you are ready to read the tape. GO_RDTAP will also display the number of kilobytes that you have selected to read, so check the available space on the disk selected before continuing.

If the /ydb switch is used on the call to GO_RDTAP, then the weekly data files will be copied to their proper directories (the default is to copy them to the current directory).

See the Reference Guide appendix for more detailed information on the archive tapes.

C.2   How to Read Yohkoh Database Tapes (RD_YDBTAP)

RD_YDBTAP reads and installs Yohkoh Data Base (ydb) files from the distributed ``ydb'' tapes. A ``ydb'' tape contains data files which are used by the Yohkoh analysis system. These may include both Yohkoh specific data (e.g., Yohkoh pointing, ephemeris, observing logs, etc.) and supporting data sets (GOES, BATSE). Although some of the smaller database (ydb) sets are available as compressed tar7 files and are included in the installation and upgrade procedure, the ydb tapes are the recommended method for distribution of large database sets (such as pointing data and observing log files).

RD_YDBTAP Functions:

The following example will allow the user how to interactively select times and data sets for extraction and installation
IDL >  rd_ydbtap
Several options are available on input - if files are fully specified, no additional user interaction is required. The next example would extract and install all data base files for the specified week using tape drive one.
IDL >  rd_ydbtap, dev=1, weekid='92_45', /all
RD_YDBTAP may function to ``boot up'' a remote system prior to implementation of a ydb network upgrade system. Due to the potential of adversely impacting the network, a network-based ydb upgrade system should be coordinated with the Yohkoh SW managers. They can provide some Unix scripts which assist in this task and allow some scheduling control. For more information on network upgrades of the Yohkoh data base, send e-mail to:, SUBJ="ydb via network"

C.3  FTP Access to Yohkoh Archive, etc...

D  Using the Yohkoh Team Bulletin Board (TBB)

D.1  Overview

The Team Bulletin Board (TBB) was introduced as a mechanism to encourage the Yohkoh data users to openly exchange information on their research in the form of proposals. Once scientists think up a research plan using the Yohkoh data, they are requested to write a short proposal. The TBB keeps all the on-going research projects that utilize the Yohkoh data. By accessing the TBB, one finds what projects are now vigorously undertaken by who, and may either think of a project nobody is working on, or one that is similar to existing proposals. In the latter case, ideally, the Data Use Coordinators (DUCs, see below) may make certain suggestions in order not to jeopardize the proposals that have already been started. It is important that an on-going project initiated by a graduate student in particular should not be taken away by a more experienced scientist.

The lead authors of proposals are requested to report on what they have found every time major progress is made. Without such a report, the proposal will be regarded as not on-going and will automatically disappear six months after the submission. Now, as the data are put into public domain, the Yohkoh team invites every scientist who uses the Yohkoh data to participate in this system.

Every project that will become part of somebody's master's or PhD thesis is included in one sub-directory, that is separate from the general projects. The TBB also offers addresses of the scientists who have submitted proposals and meeting and travel reports.

D.2  Access to the TBB

The TBB may be accessed by typing:
IDL >  teambb
The banner page appears, showing the most recent proposals, updated and deleted ones. Then in the main menu, one can choose either scientific proposals or other information such as addresses. If ``sci" is selected, there are three ways of getting a proposal on the screen - search on the authors, on the category or on the summary file that shows the titles and lead authors.

One can also type:
IDL >  teambb,'sci'
to skip the banner page and the main menu and to enter the science menu. Such flexibilities will be enhanced in future updates of TEAMBB.

D.3  How to submit a new proposal

Although proposals in the past have had loose guidelines as to the format, it is encouraged that a new proposal conform to the following for a more efficient use of the TBB. A proposal should be concise but at the same time should contain the following information:

  1. Title
  2. Collaboration (list of scientists working on the problem)
  3. Primary science question being addressed
  4. Method
  5. Required data (i.e. date and time of the phenomenon)

All these should fit in to no more than a half page (roughly 80 characters and 20 lines).

Once completed, the proposal should be sent to the relevant DUCs. Currently, they are:

It is advisable to send the proposal to multiple DUCs in case of network trouble. Once the DUCs find that the proposal has no problem in terms of jeopardizing on-going proposals, it will be forwarded to TBB administrators (currently Kazunarai Shibata and Nariaki Nitta) who will post it on the TBB in a timely fashion and keep it there for six months.

D.4  How to Update a Proposal

Send the progress report to Do not send it to the DUCs. The reports will be posted in the TBB. However, if the proposal has expired before the update, send it to DUCs. They will decide whether the TBB administrators can reinstate the original proposal.

D.5  Where to Find TeamBB Files

All the TBB files are kept under $DIR_GEN_TBB (which is /ys/gen/tbb on Unix machines) and are FTP-able. There are four subdirectories. The most important to scientists is the proposal subdirectory, which in turn has several subdirectories. The current proposals are kept under current. They have file names like ar210.hudson33. This means that the proposal is the 210th one in the category of active regions and the 33rd by Hudson. Other subdirectories under proposal contain, among other things, information on completed projects, summary files and thesis topics.

In addition to the proposal subdirectory, there are three others, address, help and news. The last one has various information such as reports on meetings and campaign announcements.

E  Old Fortran 77 Analysis Software

E.1   Calibrating and Fitting BCS Spectra (the BSD software)

This software consists of three programs written in standard FORTRAN-77 that are used to reduce the BDA data to fitted spectral parameters, together with a number of IDL display routines. This software has been made largely obsolete by the development of the IDL-based BSC software discussed earlier. It is no longer being actively supported by BCS personnel. The FORTRAN programs are MKBSD, BSDCAL and BSDFIT:

MKBSD extracts the spectra, applies instrument corrections and writes a new file, the BSD file.

BSDCAL fits selected lines in the spectra of the BSD file with Voigt profiles to produce a calibrated wavelength scale and writes this fit information to a BPC file.

BSDFIT fits a full theory spectrum to the calibrated BSD data to give electron temperature, emission measure and plasma velocity; the BPC file provides the first guess for the fitting program. The resulting fit parameters are written to a BFT file; the output theory spectra are written to the BTH file.

These programs can be run at the operating-system level using control files created either by using the setup sections of the programs (in the case of MKBSD and BSDCAL), or with the editor. It should be noted, however, that the differences between VMS, Ultrix, SunOS, and the other Unix-based operating systems used at Yohkoh sites complicate matters and the user may find it easier to run the programs from IDL, using BCSPRO. To do this:

  1. Select a time interval by either:
    1. Using the cursors in a -44x option in YODAT
    2. Running SELECT_24HR_PLOT after running BCS_24HR_PLOT.
      IDL >  .run select_24hr_plot

  2. Execute BCSPRO to create the control files, and run the programs.
    IDL >  .run bcspro
  3. It is sometimes necessary to edit the BPC file because the fits made by BSDCAL sometimes ``fail'':
    1. Enter IDL and run ED_BPC to edit the required parts of the BPC file.
      IDL >  .run ed_bpc
    2. Again run the BSDFIT program

If more subtle variations of the code options are required, after creation the control files may be modified either using the setup sections of the programs or by using the editor - the programs should then be re-run. For more information on these programs, see the various documents on $DIR_BCS_DOC.

Under the different operating systems, different executables are needed. The BCSPRO routine takes care of this, but the user should be aware of the different names if running outside of IDL. The task names under the different operating systems are:

  Name             VMS             Unix
  MKBSD           MKBSD           $DIR_BCS_EXE/mkbsd_x
  BSDCAL          BSDCAL          $DIR_BCS_EXE/bsdcal_x
  BSDFIT          BSDFIT          $DIR_BCS_EXE/bsdfit_x

Note: Within Unix: the ``_x'' should be replaced by ``_u'' under Ultrix; ``_s'' under Sun/OS; and ``_m'' on the MIPS. Since MKBSD needs certain environment variables, this is normally run by executing ``$DIR_BCS_EXE/run_mkbsd'' which temporarily creates these, and automatically selects the correct task for the current machine.

A BSD file may be read into IDL with GET_BSD. After modification a new file may be written with WR_BSD - see section A.2. IT SHOULD BE NOTED that the BSD files are not transferrable between machines and operating systems. Even though it would be possible (using IDL) to make them transferrable, since the normal route for generating the files using the FORTRAN-77 code does not produce transferrable files, it has been decided that the IDL code would follow the same restriction. The BSC files (see section 3.3), which are generated under IDL, are transferrable.

E.1.1  Displaying Data from the BSD File

The light curve from the BSD file may be plotted with LCBSD.
IDL >  lcbsd,filename
The light curve and spectra from the BSD file may be plotted by PLOTBSD.
IDL >  plotbsd,filename

E.1.2  Displaying Intermediate Results (from BSDCAL)

The fit results written to the BPC file by BSDCAL, can be over-plotted on the BSD spectra using PLOTBPC.
IDL >  plotbpc [,bpc_file,chan,option,start]

E.1.3  Displaying Fitted Spectral Data (from BSDFIT)

The theoretical spectra written to the BTH file by BSDFIT, can be over-plotted on the BSD spectra using PLOTBTH (was PLOTSPC). This program is interactive.
IDL >  plotbth,filename

E.1.4  Displaying Processed Parameters (from BSDFIT)

The parameters stored in the BFT file (created by BSDFIT), such as emission measures and electron temperatures, may be plotted against time by PLOTBFT.
IDL >  plotbft,filename [,chan=n [,/plot_page, etc.]]

E.2   Synthesizing HXT Images (HXTPRO; Sakao)

Following is a description on the HXT image synthesis using the FORTRAN programs with an IDL user interface. The programs, which make use of the Maximum Entropy Image restoration procedure, were originally developed on FACOM mainframe computers at ISAS. At present, the image synthesis is available on SUN machines. Neither MIPS nor DEC machines are supported yet.

  1. After extracting HXT data using YODAT and obtaining the flare location, type in the following command:
    IDL >  .run hxtpro

  2. * Execute HXT MOVIE setup code: [Default: Y ] ?

    Choose `Y' for the above prompt. This step enables you to choose

    • HXT energy band in which images are synthesized (step (3)),
    • background data interval (step (4)), and
    • flare data interval (step (5))

    on your CRT display. If you choose `N', then steps (3), (4), and (5) are skipped.

  3. * Enter HXT Channel to use in Image synthesis: [Default: 0 ]

    Enter either of 0,1,2, or 3 (0=L, 1=M1, 2=M2, 3=H bands, respectively).

  4. There appears an HXT time profile in the energy band specified in the step (3). Choose background a data interval by clicking mouse buttons. See messages which appear in your IDL window for details. After choosing BGD interval, there is a message:
             Write Comments for this data structure >

    Simply press return if you do not have anything special to comment for the selected BGD data, which is stored in a variable named bkgd. The BGD data thus selected are also contained in a file named ``flare.bgd'' on the current directory. This file can be read using the following command even if you exit from IDL and re-enter:
    IDL >  rd_hxtdat,bkgd,'flare.bgd'

  5. There appears another HXT time profile. Choose flare data interval of which you want to make an image. The procedure is just the same as in step (4). The selected flare data are stored in a variable named flare. Background subtraction is conducted in this step. The BGD-subtracted data are stored in a variable hxt and is also stored in a file ``hxt_trn.dat'' on the current directory. This file can be read by the same command as above.

    When choosing a flare data interval, it is recommended not to accumulate too many X-ray counts; usually accumulated hard X-ray counts of e.g. 100-500 cts/SC are enough for synthesizing an image (depending on profiles of hard X-ray sources etc.). Suppose you are analyzing flare data in flare-high mode. Each data point in the time profile corresponds to 2-s of data. As the unit of Y axis is cts/s/SC, if you choose one data point which has a Y value of 100, it means that you have accumulated 100 cts/s/SC × 2 s = 200 cts/SC, which is already enough for making an image. Even if you accumulate larger counts than the above values, the image synthesis program can somehow make images, but with increased possibility that an iteration procedure in the program would not converge sufficiently. If the accumulated counts are high, there appears a warning message saying:

          % \$MAIN\$: ** Warning: Recommended count level is 100 < total , 200
          * Is this O.K.:  [Default: N ] ? 

  6. The Image Synthesis program uses a JCL-style control file
          * Create JCL file  [Default: Y ] ? 

    Simply type-in `Y' if it is the first time for you to synthesize an image of the flare which you are now working on.

  7. * Enter HXT Flare Coordinates, FOV Exp. Fact.: [Default: (None) ]

    Type-in HXT flare location (x0,y0) and the size of the HXT image synthesis field-of-view. The location (x0,y0) is given in section 4.3.1. The default size of the HXT FOV is 1.0, which provides us with a resultant image array of 64×64 pixels with the same pixel size as SXT, thus making it easy to compare HXT images with SXT images. If you type 2.0 for the HXT FOV size, it means that you expand the HXT image synthesis FOV by a factor of 2.0; you will obtain an HXT image of 64×64 pixels with its pixel size twice as large as the SXT one. For example, in the case of 15 November, 1991 flare, xy0 obtained in section 4.3.1 is xy0 = (-2.09,-4.84) and in the nominal case type

          -2.09, -4.84, 1.0
    for the above prompt.

  8. * Enter Comment:

    Write comments (if any) for the current image synthesis. After this step, a control file (JCL file) for the FORTRAN image synthesis programs ``hxtmve.jcl'' is written on the current directory.

  9. * Execute HXT MOVIE task: [Default: Y ] ?

    Type `Y' for starting image synthesis procedure. The procedure typically takes 30 s - 5 min to make an image. The synthesized HXT image as well as some other information such as start and end times of data accumulation are contained in a file named ``hxt_img.dat'' on the current directory. The image file can be read-in and the synthesized image is displayed by the following commands:
    IDL >  rd_hxtimg,img,hdr,inf,'hxt_img.dat'       ; (read-in image file)
    IDL >  disp_hxtimg,img,hdr,inf       ; (display)

  10. * Convert output to HXI file: [Default: N ] ?

    An HXI file is produced after typing-in `Y' for the above prompt.

  11. * Read and Display Image: [Default: Y ] ?

    If you type-in `Y', the synthesized image is displayed using DISP_HXTIMG.


1 Preliminary at the time of publication - expected working prototype for SXT searches in Feb, 1994

2 The BCS dp_sync data contain instrument data, including the detector event counters, in a form that is synchronous with the rest of the frames of the data from the spacecraft DP. The spectral data, because of the queue memory, are asynchronous to this data.

3 See the documentation of YODAT for details on the ss vector.

4 It is also possible at this point to use the BSD suite of FORTRAN-77 and IDL software. By using BSC2BSD, a BSC structure can be converted to a BSD structure (and optionally a BSD file) and following this, any of the routines that normally work off the BSD file (including the programs BSDCAL and BSDFIT) can be used. See section E.1 for details on BSD routines.
IDL >  bsc2bsd,bsc_index,bsc_data,index=bsd_index,data=bsd_data
IDL >  bsc2bsd,bsc_index,bsc_data,filename=filename

5 Not SXT CCD pixel coordinate system, which is reversed E/W from IDL pixel coordinate system. See the Appendix of the Instrument Guide

6 See the Appendix of the Instrument Guide for a discussion of SXT pixel coordinates

7 tar is the Unix backup utility

This version of the YAG was prepared at the YDAC (located at the Mullard Space Science Laboratory, University College London) by Bob Bentley. The Hypertext version was translated from LaTeX using TtH version 1.92, and further formatted using IDL. 4 Oct 2004.