[Previous]
[Next]
energy_loss = e_l( energy_pha )
correct for the non-linearity in the light/energy_loss
The pha is calibrated assuming a constant ratio in the
light produced per unit energy-loss. This isn't true for\
NaI(Tl) scintillators like the HXT. This procedure takes the
given pha_energy and recalculates it to give the true energy
loss. The pha has been calibrated using lines at 59.7 and 22
keV so this routine must return those same values if they are
input.
Input- Energy_pha - energy in keV given by the HXT channel to
energy conversion w/o this correction.
Output- True energy loss in keV.
RAS - 93/03/26
[Previous]
[Next]
NAME:
ea_view_angle
PURPOSE:
Calculate the view angle of a spot on the sun,
given the heliocentric corrdinates, i.e.,'N22W85'.
Uses get_sun.pro to obtain the ephemeris info.
CALLING SEQUENCE:
theta=ea_view_angle(helio,date)
INPUT:
helio - is a vector of heliocentric coordinates. It should be 2xN.
(0,*) = longitude (degrees) W positive
(1,*) = latitude (degrees) N positive
They can also be strings in the form 'N30W23'.
date - Unless the date is supplied, today's date is used.
This will affect the Solar axial tilt, B0.
OUTPUT:
theta= the view angle; i.e., the angle between the line
perpendicular to the solar surface and the line
to the spacecraft.
CALLS: ***
CONV_HS2H [1], CONV_HS2H [2], GET_SUN [1], GET_SUN [2], anytim2ints [1]
anytim2ints [2]
HISTORY:
10-Mar-94, JMM
[Previous]
[Next]
NAME:
early_mid_late
PURPOSE
To prepare indice arrays of data taken during the
three different entrance filter failure eras.
Program returns a -1 if there are no records in
the given time interval.
CALLING SEQUENCE
early_mid_late,index,early,mid,late
INPUT
index, index array
OUTPUT
early, indices of records taken before 13-NOV-92 16:50
mid, indices of records taken between 13-NOV-92 16:50
and 16-AUG-95 08:21:02
late, indices of records taken after 16-AUG-95 08:21:02
DATES
print,get_yo_dates(/entrance,/verbose,/header)
Date Open Fraction of SXT Entrance Filter
30-AUG-91 10:30:00 0.0000 13-NOV-92 16:50:00 0.0833
16-AUG-95 08:21:02 0.1667
HISTORY
LWA 9-Mar-96, header installed.
CALLS:
[Previous]
[Next]
NAME:
EARTH
EXAMPLES:
earth ; Draw an earth at (.1,.1) (normalized coordinates),
assuming sec_per_pix=gt_pix_size() and ref_time=!stime
earth, xpos=.4, ypos=.6, sec_per_pix=1., ref_time='1-jan-97'
PURPOSE:
Draw an earth with continents at a specifiable location and with
a specified scale
CATEGORY: Image display.
CALLING SEQUENCE: earth, xpos=xpos, ypos=ypos, sec_per_pix=sec_per_pix, $
ref_time=ref_time
REQUIRED INPUTS:
None.
OPTIONAL INPUTS:
KEYWORDS PARAMETERS:
xpos ; x normalized coord of ll corner of enclosing square
(default = .1)
ypos ; y normalized coord of ll corner of enclosing square
(default = .1)
sec_per_pix ; Arcsec per pixel (default = 2.45)
ref_time ; Reference time for converting sec_per_pix to
km_per_pix (default = !stime)
OUTPUTS: None.
CALLS: ***
MAP_SET, get_rb0p [1], get_rb0p [2], gt_pix_size
SIDE EFFECTS: None that I'm aware of.
RESTRICTIONS: Not yet PostScript compatible.
PROCEDURE: Temporarily resets !p.position, then calls map_set
MODIFICATION HISTORY:
97-Jan-23 - Written by GLS, LMSC.
[Previous]
[Next]
NAME:
EARTH_CURSOR
PURPOSE:
Interactively position an earth
EXAMPLE CALLS:
earth_cursor ; Draw an earth at (.1,.1) (normalized coordinates),
assuming sec_per_pix=gt_pix_size()
and ref_time=!stime
earth_cursor, xpos=.4, ypos=.6, sec_per_pix=1., ref_time='1-jan-97'
CATEGORY: Interactive graphics.
CALLING SEQUENCE:
earth_cursor [,xpos=xpos, ypos=ypos, sec_per_pix=sec_per_pix, $
ref_time=ref_time]
REQUIRED INPUTS:
None.
OPTIONAL INPUTS:
KEYWORDS PARAMETERS:
xpos ; Initial x normalized coord of ll corner of enclosing square
(default = .1)
ypos ; Initial y normalized coord of ll corner of enclosing square
(default = .1)
sec_per_pix ; Arcsec per pixel (default = 2.45)
ref_time ; Reference time for converting sec_per_pix to
km_per_pix (default = !stime)
OUTPUTS: None.
CALLS: ***
CIRCLE_CURSOR, MAP_SET, get_rb0p [1], get_rb0p [2], gt_pix_size
SIDE EFFECTS: None that I'm aware of.
RESTRICTIONS: Not yet PostScript compatible.
PROCEDURE:
The graphics function is set to 6 for eXclusive OR. This
allows the circle to be drawn and erased without disturbing the
contents of the window.
Operation is as follows:
Left mouse button: Move the circle by dragging.
Middle mouse button: Resize the circle by dragging.
Right mouse button: Exit procedure, returning the
current circle parameters.
PROCEDURE: Temporarily resets !p.position, then calls map_set.
MODIFICATION HISTORY:
97-Jan-23 - Written by GLS, LMSC.
[Previous]
[Next]
NAME:
ebplpl
CALLING SEQUENCE:
ebplpl,a,sa,ebr,sebr
PURPOSE:
Calculate the break energy for the Double P.L.
INPUT:
a= fit parameters , a(0)=K1, a(1)=gamma1, a(2)=K2, a(3)=gamma2
sa= Unc. in a
OUTPUT:
ebr= Break energy, where K1*Ebr^(-gamma1)=K2*Ebr^(-gamma2)
sebr= Unc. in Ebr
CALLED BY:
fsp_outplot, fsp_output
HISTORY:
JMcT Spring '92
[Previous]
[Next]
NAME:
ebthpl
CALLING SEQUENCE:
ebthpl,a,sa,ebr,sebr,lines=lines
PURPOSE:
Calculate the break energy for the thermal + p.l. fit
INPUT:
a= fit parameters , a(0)=E47, a(1)=T6, a(2)=K, a(3)=gamma
sa= Unc. in a
OUTPUT:
ebr= Break energy
sebr= Unc. in Ebr
KEYWORD INPUT:
lines= if set, use thermal emission including SXR lines
CALLS: ***
fx_1pl, fx_1th, fx_1th_l
CALLED BY:
fsp_outplot, fsp_output
HISTORY:
JMcT Spring '92, copied out of specfit.f
Redone to use better IDL, and include lines, JM 26-JUL-93
[Previous]
[Next]
NAME:
ebthth
CALLING SEQUENCE:
ebthth,a,sa,ebr,sebr
PURPOSE:
Calculate the break energy for the Double thermal fit
INPUT:
a= fit parameters , a(0)=E471, a(1)=T61, a(2)=e472, a(3)=t62
sa= Unc. in a
OUTPUT:
ebr= Break energy
sebr= Unc. in Ebr
CALLED BY:
fsp_output
HISTORY:
JMcT Spring '92, copied out of specfit.f
[Previous]
[Next]
NAME:
ECL_CIRCLES
PURPOSE:
display information on the Feb. 26, 1998 eclipse, calling
SXT_OBS_COORD to help with PFI planning. It shows the
current last sfd, with a sequential overlay of the three
episodes in this eclipse.
OUTPUTS
plots. The structure ECL is a regular Yohoh structure
containing all the eclipse circumstances. See the input
file directly for a numerical summary.
CALLING SEQUENCE:
main program
MODIFICATION HISTORY:
20-Feb-98, written (HSH)
[Previous]
[Next]
NAME:
ECL_FRAC
PURPOSE:
Compute the eclipse fraction of total sunlight. This datum will be used
to scale the stray-light corrections for SXT data
CATEGORY:
Yohkoh
CALLING SEQUENCE:
frac = ecl_frac(ecl,time,param)
frac = ecl_frac(ecl,time,time_off=time_off)
INPUTS:
ecl = output structure from SXT_ECLIPSE (computes it on the
first call if not available; dummy variable)
time = time for evaluation (scalar only)
param = limb-darkening parameter (see DARK_FACTOR)
OPTIONAL (KEYWORD) INPUT PARAMETERS:
time_off is an offset time, in seconds, added to the input time
ROUTINES CALLED
OUTPUTS:
CALLS: ***
DARK_FACTOR, SPLINE, SXT_ECLIPSE, anytim [1], anytim [2], anytim [3], anytim [4]
anytim [5], int2secarr [1], int2secarr [2], tim2dset [1], tim2dset [2]
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
assumes equal radii to avoid geometrical headaches
MODIFICATION HISTORY:
HSH, written 19-Oct-95
HSH, 21-Oct-95, installed limb darkening via DARK_FACTOR
and vectorized the time input
[Previous]
[Next]
NAME:
ECLIPSE_PLOTTER
PURPOSE:
plot outputs from SXT_ECLIPSE
CATEGORY:
Yohkoh
CALLING SEQUENCE:
eclipse_plotter, eclipse
INPUTS:
eclipse is the SXT_ECLIPSE output structure
OPTIONAL (KEYWORD) INPUT PARAMETERS:
OUTPUTS:
WARNINGS
Zaps your windows
CALLS: ***
OUTPLOT [1], OUTPLOT [2], OUTPLOT [3], UTPLOT [1], UTPLOT [2], UTPLOT [3]
UTPLOT [4], UTPLOT [5], UTPLOT [6], WDEF [1], WDEF [2], fem_grid [1], fem_grid [2]
CALLED BY:
SXT_ECLIPSE
MODIFICATION HISTORY:
21-Sep-95, written (HSH)
11-Feb-98, added daylight points to plots
[Previous]
[Next]
NAME:
EDIT_FULL_LOAD
PURPOSE:
Applies patches to loaded image of BCS micro and calculates
the checksum
CALLING SEQUENCE:
.run edit_full_load
INPUTS:
loads FULL_LOAD.DAT as requested
OPTIONAL INPUTS:
patch file names
OUTPUTS:
Lists contents of patch
Identifies differences following the patch
Calculates checksum
OPTIONAL OUTPUTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
RDB Nov 91 Written
RDB 29-Jul-92 Cosmetic stuff
RDB 17-May-94 Split out the mem_checksum function
Used call to rd_full_load; $BCS_PATCH logical
rdb 28-Nov-97 Allows other name for FULL_LOAD; lists files available
Allows full spec. of filename of patch file
[Previous]
[Next]
NAME:
EDIT_FULL_LOAD
PURPOSE:
Applies patches to loaded image of BCS micro and calculates
the checksum
CALLING SEQUENCE:
.run edit_full_load
INPUTS:
loads FULL_LOAD.DAT as requested
OPTIONAL INPUTS:
patch file names
OUTPUTS:
Lists contents of patch
Identifies differences following the patch
Calculates checksum
OPTIONAL OUTPUTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
RDB Nov 91 Written
RDB 29-Jul-92 Cosmetic stuff
RDB 17-May-94 Split out the mem_checksum function
Used call to rd_full_load; $BCS_PATCH logical
[Previous]
[Next]
NAME:
EDIT_GRPDTB
PURPOSE:
Allows creation of new BCS RAM gouper plans
CATEGORY:
CALLING SEQUENCE:
. .run edit_grpdtb
INPUTS:
OPTIONAL INPUT PARAMETERS:
KEYWORD PARAMETERS:
OUTPUTS:
If requested, creates file "grpdtb.lis" on current directory.
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
RDB Autumn-91
RDB 17-May-94 call to rd_cpu_dtb, wr_cpu_dtb
changed .grpid to .planid for reformatter compatability
[Previous]
[Next]
NAME:
EDIT_PLAN_AREA
PURPOSE:
Adds new lists (seqn, flop and grouper plans) to BCS parameter area
CATEGORY:
CALLING SEQUENCE:
.run edit_plan_area
INPUTS:
OPTIONAL INPUT PARAMETERS:
KEYWORD PARAMETERS:
OUTPUTS:
Updated image can be written to file
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
RDB Autumn-91 written
RDB 17-May-94 Updated, documented
[Previous]
[Next]
NAME: edit_pnts
PURPOSE: Let user edit a list of limb points.
METHOD: Use the mouse to deselect points to be omitted.
CALLING SEQUENCE: nlimb=edit_pnts(limb)
PARAMETERS: limb initial list of limb points in [x,y] form
nlimb reduced set of limb points, in same form
KEYWORDS: index return the index into the original data
mode this indicates the coordinate system to use
when reading from the screen. The default is
DEVICE.
CALLED BY:
DSK_LOCG
HISTORY: Copied from SXT_CENTER, AMcA, May 1994.
Added INDEX keyword, AMcA, Nov. 23, 1994.
Added the MODE keyword and scaling for the "data"
mode, AMcA, Nov. 28, 1994.
[Previous]
[Next]
NAME:
EDIT_SQFL
PURPOSE:
Create new BCS Sequence and Flare option lists
CATEGORY:
CALLING SEQUENCE:
.run edit_sqfl
INPUTS:
OPTIONAL INPUT PARAMETERS:
KEYWORD PARAMETERS:
OUTPUTS:
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
RDB Autumn-91 called sqfl
RDB 5-May-94 Allowed sequneces to be deleted from memory
RDB 17-May-94 Introduced calls to wr_cpu_dtb
[Previous]
[Next]
NAME:
EDT
PURPOSE:
Calls the shared image of EDT
CALLING SEQUENCE:
EDT,file_name
INPUTS:
file_name Name of file to be edited as a string
This is checked for certain typos
OUTPUTS:
OPTIONAL OUTPUTS:
RESTRICTIONS:
Although the routine checks for typos, if an error occurs in
EDT, then it is impossible to call this routine because of
an error in EDT. IDL must be exited to correct this situation.
Spawning the command "$EDT file_name" may be better.
PROCEDURE:
Calls the sharable image
MODIFICATION HISTORY:
RDB 1991
[Previous]
[Next]
NAME:
ee_pl_jcb
CALLING SEQUENCE:
energy = ee_pl_jcb( k, m, e0, e1=e1)
PURPOSE:
Returns total electron energy (ergs) assuming thick-target model
(J.C. Brown, 1971, solar physics, 18, 489) integrated above e0 to infinity.
INPUT:
m; spectral index
k; emission at 1keV
OUTPUT:
energy = energy in injected electrons
KEYWORDS:
e1 = the high energy limit of the calculation
CALLS: ***
beta_fn
HISTORY:
JMcT, Feb '93
Found an error, changed a factor of m1^2 to m1^3, see Eqn. 15 of
JCB paper, jmm, 26-apr-95
[Previous]
[Next]
value = EFF_OF_E(Energy)
return the value of the row (designated by INDEX) of the matrix SM_HXT
evaluated at ENERGY with the elements of each row given at EM
Interpolation is linear unless INTERP_TYPE is set.
CALLS: ***
INTERPOL
Common:
common effcom, sm_hxt, em, index, interp_type
[Previous]
[Next]
NAME: ELL2CIR
PURPOSE: To reshape an image from an elipse to a circle.
METHOD: Return is not a round number, but is square.
CALLING SEQUENCE: circular = ell2cir(image,a,trgt,/inter)
PARAMETERS: image elliptical image
abk average background value
a ellipse fit parameters
trgt target to match too.
KEYWORDS: inter pass-through to DSK_LOCG
CALLS: ***
CONGRID [1], CONGRID [2], CONGRID [3], DSK_LOCG, ROTT
HISTORY: Drafted AMcA, August 1994.
adjusted the background treatment, AMcA, 24 Aug. 1994.
again, AMcA, 26 Aug. 1994
added '/interp' to the ROTT calls, AMcA, 2 Sep. 1994.
fixed definitions of NEWX and NEWY, AMcA, 7 Nov. 1994.
[Previous]
[Next]
NAME: ellipse_fit
PURPOSE: To fit an ellipse to a set of data points.
METHOD: Estimate parameters from data points using a two step process.
First average in x & y directions, then run the points through
the circle fitter. This slows things up but should greatly improve
the ability of the ellipse fitter to handle flattened data etc.
The ellipse fitter is a chi squared search routine. Itterate
until covergence.
CALLING SEQUENCE: trgt=ellipse_fit(limb,fit,mode,/major)
PARAMETERS: limb points to fit, in [x,y] form
fit fitted points, return
mode mode [-1,0,+1] switch for chi square
trgt return fit parameters
centroid: [x,y]
minor axis
eccentricity
major axis angle: x-axis is 0.
KEYWORDS: major when major axis rather than minor axis
is available
CALLS: ***
circle_fit [1], circle_fit [2], circle_trgt, ellipse_fn, gradls, rect2pol
CALLED BY:
DSK_LOCG
HISTORY: Drafted AMcA, August 1994.
Added QUIET keyword,AMcA, Sept. 1994
Improved the initial quess by adding a circle fit call, AMcA, Mar. 1995
[Previous]
[Next]
NAME: ellipse_fn
PURPOSE: Ellipse function, to generate a set of points at
angles matching the input points, which line on an
ellipse with given parameters.
METHOD: Given the centroid and major and minor axis', calculate
x = a cos( theta )
y = b sin( theta' ) theta' = atan(a/b*tan(theta))
CALLING SEQUENCE: nfits = functn(a,x,y)
PARAMETERS: a fit parameters, centroid,
minor axis', eccentricity,
and rotation angle.
x,y data points
nfits fit points [xfit,yfit]
CALLS: ***
rect2pol
CALLED BY:
DSK_LOCG, ellipse_fit, gradls
HISTORY: Drafted AMcA, August 1994.
[Previous]
[Next]
NAME:
enhancer
PURPOSE:
A function to enhance the sharpness of features, of single frames.
The data is not decompressed or otherwise preprocessed. Any such
processing should be done prior to calling enhancer.
A difference (delta) field is created by subtracting a smoothed
image from the input image. This delta field is then cropped (if
so desired), multiplied by a constant and added back to the
original field. Lower and upper cutoffs can also be set to limit
the enhancement to a specified range of initial field intensity.
CALLING SEQUENCE:
imageout=enhancer(imagein,index,keyword=##,keyword=##,..)
where imagein & imageout are 2d arrays, and index is the
index entry that corresponds to imagein.
Optional Keyword Parameters:
smooth Size of smoothing box, integer.
lowdelt Lower delta cutoff, a percentage of minimum, decimal 0.xx.
updelt Upper delta cutoff, a percentage of maximum, decimal 0.xx.
lowint Saturation cutoff, don't add back when signal is BELOW a
given percentage of the saturation value, decimal 0.xx.
upint Saturation cutoff, don't add back when signal is ABOVE a
given percentage of the saturation value, decimal 0.xx.
deltcoef Multiplier for Delta field, float x.x.
If a keyword is not specified then a default value is used, based on
the resolution of the input data array.
CALLS: ***
gt_res
CALLED BY:
lwa_plot_arc, plot_arc [1], plot_arc [2], plot_arc [3]
HISTORY:
drafted by A. McAllister and K. Strong, Apr. 1992
[Previous]
[Next]
'Corrected' 13-jun-85 by J.R.L and J.G.D.
This IDL subroutine computes the +/- values of the given points and
calls an IDL library routine to overplot the error bars. The error
bars are plotted only for Y-axis deviations. Future: generalize this
routine and the IDL library routine to do error bars for deviations
in both the X and Y parameters and which are specified by the
value of the formal parameter axis: X for X-axis error bars and Y for
Y-axis error bars.
CALLS: ***
ERRPLOT [1], ERRPLOT [2]
Restrictions: xpoints, ypoints, and yerr are assumed to be vectors.
[Previous]
[Next]
NAME:
ERRPLOT
PURPOSE:
Overplot error bars over a previously drawn plot.
CATEGORY:
J6 - plotting, graphics, one dimensional.
CALLING SEQUENCE:
ERRPLOT, Low, High ;X axis = point number
ERRPLOT, X, Low, High ;to specify abscissae
INPUTS:
Low = vector of lower estimates, = to data - error.
High = upper estimate, = to data + error.
OPTIONAL INPUT PARAMETERS:
X = vector containing abscissae.
KEYWORD Parameters:
Width = width of bars, default = 1% of plot width.
OUTPUTS:
None.
CALLED BY:
APCAL_ADD_27MANT [1], APCAL_ADD_2MANT, APCAL_ADD_2M_RL, CHIANTI_DEM
DATAGET3_GRS, DATAGET3_HXS, EUTPLOT, FLUX_3C84, GRS_SPEFF, PLOT_GRSPCH, PLOT_GRSPCL
PLOT_GRSPHH, PLOT_GRSPHL, PLOT_HXSPC, PLOT_HXSPH, PNTFIT, SPFDPLOT_GRS, SPFDPLOT_HXS
SPPLOT_GRS, SPPLOT_HXS, azimuth_teem [2], dataget_grs, errbar, go_teem_plots
hsi_visibility_fit, lcur_plot [1], lcur_plot [2], make_avg_daily_roll
ph_eff_grs1, ph_eff_grs2, ph_pow_grs1, ph_pow_grs2, plot_eit_entrance, plotbft [1]
plotbft [2]
COMMON BLOCKS:
None.
SIDE EFFECTS:
Overplot is produced.
RESTRICTIONS:
Logarithmic restriction removed.
PROCEDURE:
Error bars are drawn for each element.
For example: Y = data values, ERR = symmetrical error estimates:
PLOT,Y ;Plot data
ERRPLOT, Y-ERR, Y+ERR ;Overplot error bars.
If error estimates are non-symetrical:
PLOT,Y
ERRPLOT, Upper, Lower ;Where upper & lower are bounds.
To plot versus a vector of abscissae:
PLOT,X,Y ;Plot data.
ERRPLOT,X,Y-ERR,Y+ERR ;Overplot error estimates.
MODIFICATION HISTORY:
DMS, RSI, June, 1983.
Joe Zawodney, LASP, Univ of Colo., March, 1986. Removed logarithmic
restriction.
DMS, March, 1989. Modified for Unix IDL.
RDB, October 1992. Added NOCLIP=!P.NOCLIP to plot statement
[Previous]
[Next]
NAME:
ERRPLOT_X
PURPOSE:
Overplot error bars over a previously drawn plot.
CATEGORY:
J6 - plotting, graphics, one dimensional.
CALLING SEQUENCE:
ERRPLOT_X, Low, High ;Y axis = point number
ERRPLOT_X, Y, Low, High ;to specify abscissae
INPUTS:
Low = vector of lower estimates, = to data - error.
High = upper estimate, = to data + error.
OPTIONAL INPUT PARAMETERS:
Y = vector containing abscissae.
KEYWORD Parameters:
Width = width of bars, default = 1% of plot width.
OUTPUTS:
None.
CALLED BY:
azimuth_teem [2]
COMMON BLOCKS:
None.
SIDE EFFECTS:
Overplot is produced.
RESTRICTIONS:
Logarithmic restriction removed.
PROCEDURE:
Error bars are drawn for each element.
To plot versus a vector of abscissae:
PLOT,X,Y ;Plot data.
ERRPLOT_Y,Y,X-ERR,X+ERR ;Overplot error estimates.
MODIFICATION HISTORY:
DMS, RSI, June, 1983.
Joe Zawodney, LASP, Univ of Colo., March, 1986. Removed logarithmic
restriction.
DMS, March, 1989. Modified for Unix IDL.
RDB, October 1992. Added NOCLIP=!P.NOCLIP to plot statement
...........................................
CRF, November 1995. Hacked errplot to create this errplot_x
[Previous]
[Next]
NAME:
EVN_STRUCT
PURPOSE:
Define the following event log (EVN) specific database structures
* EVN_Common_Rec
* EVN_PFI_Rec
CALLING SEQUENCE:
EVN_STRUCT
CALLED BY:
mk_evn [1], mk_evn [2], rd_week_file [1], rd_week_file [2], rd_week_file [3]
rd_week_file [4], weekid [2], ydb_exist [2]
HISTORY:
written by Mons Morrison, Fall 90.
[Previous]
[Next]
Name: evt_demo
Purpose: demo some evt_grid and get_event calls
also, jog memory on colors and options...
Callling Sequence:
evt_demo
CALLS: ***
GET_EVENT, PLOT_GOES, evt_grid, get_user [1], get_user [2], linecolors [1]
linecolors [2], rd_obs, tbeep [1], tbeep [2], tbeep [3], timegrid, utcursor [1]
utcursor [2]
Side Effects:
calls linecolors, so will corrupt color table (use loadct,N to recover)
History:
22-sep-1994 (SLF) from journal file...
[Previous]
[Next]
NAME:
EX2AOS
PURPOSE:
convert external time format to AOSLOS time format
CATEGORY:
Yohkoh
CALLING SEQUENCE:
ex2aos, t
INPUTS:
time in external format: hh,mm,ss,msec,dd,mm,yy (integer)
OPTIONAL (KEYWORD) INPUT PARAMETERS:
OUTPUTS:
time in AOSLOS format (string 'yy mm dd hh mm ss')
CALLED BY:
ORBIT_DN, YOHKOH_TERM_PREDICT
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
MODIFICATION HISTORY:
HSH, written 16-jun-97
[Previous]
[Next]
NAME: exp_file
PURPOSE: Handle a general input of file names, with twiddles
and wildcards.
METHOD: First check for twiddles, then use FINDFILE to expand
each entry
CALLING SEQUENCE: files=exp_file(filestr)
NOTES: Probably needs to be modified for VMS systems.
PARAMETERS: filestr input file string, can be a vector
files expanded list of files, with paths
CALLS: ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], concat_dir [4]
CALLED BY:
ffi_prep, rt_sxtdt
HISTORY: Drafted by A.McAllister, 2-jul-93.
[Previous]
[Next]
NAME:
exp_norm
PURPOSE:
Create time-series images with exposure duration taken into
account. A decompression is performed if the data is byte
type. Output is uncompressed DN/sec.
CATEGORY:
Yohkoh/SXT analysis
CALLING SEQUENCE:
img = exp_norm(data, index)
img = exp_norm(data, index, background)
INPUT:
data - data cube (from RD_SDA)
index - index structure
OPTIONAL INPUT:
back - estimate of background (compressed pixel value)
If not specified, then the offset is gotten from the
routine "get_res_offset"
CALLS: ***
get_res_offset, gt_expdur [1], gt_expdur [2], gt_res, his_index, sxt_decomp [1]
sxt_decomp [2]
CALLED BY:
SXT_PREP0, lc_array formerly actonpro, lc_array1 formerly actonpro
sxt_prep [1], sxt_prep [2], sxt_prep [3]
OPTIONAL KEYWORD INPUT:
original - If set, use the original resolution when normalizing
to DN/Sec/FR pixel
OUTPUT:
returns - normalized data (floating point data type) in
DN/sec/full_res_pixels
MODIFICATION HISTORY:
HSH, Nov 1991
15-Nov-91 (MDM) - Changed name from "time_series" to "exp_norm"
and "beefed" it up some.
8-Jul-92 (MDM) - Modified to normalize to full resolution pixels
Also, earlier version was normalized and then had
the zero offset added back onto the image. The
array returned now has the zero signal level at
value = 0.
19-Apr-93 (MDM) - Modified the documentation header
20-apr-93 (JRL) - Fixed for the case of one image with back=0
7-May-93 (MDM) - Adjusted 20-Apr-93 modification
23-Jun-93 (MDM) - Added a call to HIS_INDEX
11-Jul-93 (MDM) - Added ORIGINAL switch
9-Jul-2004 - S.L.Freeland - add /SSC_NORM keyword and function
Record Normalization type in .HIS record
[Previous]
[Next]
NAME:
exp_norm
PURPOSE:
Create time-series images with exposure duration taken into
account. A decompression is performed if the data is byte
type. Output is uncompressed DN/sec.
CATEGORY:
Yohkoh/SXT analysis
CALLING SEQUENCE:
img = exp_norm(data, index)
img = exp_norm(data, index, background)
INPUT:
data - data cube (from RD_SDA)
index - index structure
OPTIONAL INPUT:
back - estimate of background (compressed pixel value)
If not specified, then the offset is gotten from the
routine "get_res_offset"
CALLS: ***
get_res_offset, gt_expdur [1], gt_expdur [2], gt_res, his_index, sxt_decomp [1]
sxt_decomp [2]
CALLED BY:
SXT_PREP0, lc_array formerly actonpro, lc_array1 formerly actonpro
sxt_prep [1], sxt_prep [2], sxt_prep [3]
OPTIONAL KEYWORD INPUT:
original - If set, use the original resolution when normalizing
to DN/Sec/FR pixel
OUTPUT:
returns - normalized data (floating point data type) in
DN/sec/full_res_pixels
MODIFICATION HISTORY:
HSH, Nov 1991
15-Nov-91 (MDM) - Changed name from "time_series" to "exp_norm"
and "beefed" it up some.
8-Jul-92 (MDM) - Modified to normalize to full resolution pixels
Also, earlier version was normalized and then had
the zero offset added back onto the image. The
array returned now has the zero signal level at
value = 0.
19-Apr-93 (MDM) - Modified the documentation header
20-apr-93 (JRL) - Fixed for the case of one image with back=0
7-May-93 (MDM) - Adjusted 20-Apr-93 modification
23-Jun-93 (MDM) - Added a call to HIS_INDEX
11-Jul-93 (MDM) - Added ORIGINAL switch
[Previous]
[Next]
NAME:
exp_norm2
PURPOSE:
Create normalized data(1sec) with exposure duration.
Substract dark frame from data before creating normalized
data, if the parameter "backgraund" exists.
A decompression is performed if the data is byte type.
CATEGORY:
Yohkoh/SXT analysis
CALLING SEQUENCE:
img = exp_norm2(data, index)
img = exp_norm2(data, index, background)
INPUT:
data - data cube
index - index structure from reformatted data
OPTIONAL INPUT:
background - dark frame data array.
If not specified, then the offset is gotten from the
routine "get_res_offset" and is extracted from the
data.
OUTPUT:
returns - normalized data (floating point data type)
CALLS: ***
get_res_offset, gt_expdur [1], gt_expdur [2], gt_res, sxt_decomp [1]
sxt_decomp [2]
CALLED BY:
COMPOSE, GET_LC
MODIFICATION HISTORY:
Dec 24, 1991 by Toshifumi Shimizu(Univ. of Tokyo)
Nov 20, 1993 modified to normalize to full resolution pixels.
[Previous]
[Next]
pro experimental
NAME:
EXPERIMENTAL
PURPOSE:
Writes 'EXPERIMENTAL' on the user's screen in bold letters.
CATEGORY:
CALLING SEQUENCE:
experimental
INPUTS:
OPTIONAL INPUT PARAMETERS:
KEYWORD PARAMETERS
OUTPUTS:
CALLED BY:
PSFPIXON
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
PROCEDURE:
MODIFICATION HISTORY:
T. Metcalf 1994-06-27
[Previous]
[Next]
Name:
ExpLevMode
Purpose:
decode the ExpLevMode byte and return exposure mode and
mailbox exposure level.
CALLING SEQUENCE:
ExpLevMode, [val=val, mode=mode, mbExplevel=mbExplevel]
Input/Keyword:
val is the ExpLevMode byte value.
Output/Keyword:
mode is the exposure mode:(0=normal,1=dark,2=LTF)
mbExpLevel is the mailbox exposure level
Notes:
The actual bit positions are reversed from documented
parameter bit positions. (e.g. bit 7 is bit 0).
Comments for each bit operation note the actual bit
mask #s and the (documented bit #).
CALLED BY:
GetStrExpLev
History:
written 27-Mar-91 by GAL
12-Aug-91, changed all formal parameters to keywords.
[Previous]
[Next]
NAME:
EXPTIM2DPE
PURPOSE:
Convert a DPE to an exposure time in milliseconds
CATEGORY:
Yohkoh
CALLING SEQUENCE:
INPUTS:
DPE_in
OPTIONAL (KEYWORD) INPUT PARAMETERS:
OUTPUTS: Returns effective exposure time.
CALLS: ***
DPE2EXPTIM
CALLED BY:
DPE_GUESS, SXT_CADENCES
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS:
MODIFICATION HISTORY:
11-may-98, DMcK, written in ad-hoc, brute force, form as EXPTIM2DPE
29-may-98, DMcK, mutated to do the reverse of original program, and
converted from procedure to function.
[Previous]
[Next]
NAME:
EXPTIM2DPE
PURPOSE:
Convert an exposure time in milliseconds to DPE
CATEGORY:
Yohkoh
CALLING SEQUENCE:
INPUTS:
EXPTIME, the input exposure time in milliseconds
OPTIONAL (KEYWORD) INPUT PARAMETERS:
OUTPUTS: Prints out nearest DPE below the input exposure time.
CALLED BY:
DPE_GUESS, SXT_CADENCES
COMMON BLOCKS:
SIDE EFFECTS:
RESTRICTIONS: Rounds down to nearest DPE value, to avoid
over-exposures
MODIFICATION HISTORY:
11-may-98, DMcK, written in ad-hoc, brute force, form
01-jun-98, DMcK, changed from procedure to function
[Previous]
[Next]
NAME:
ext1ada
PURPOSE:
Extract the S/C Attitude data from one raw telemetry
major frame. Only called by REFORMAT
INPUT:
rec1
gen_index
OUTPUT:
att
hxa_scan_arr
ihxa_scan
CALLS: ***
ATT_STRUCT [1], ATT_STRUCT [2], BTEST0, ERR_LOG, EXT1HXA, MASK
HISTORY:
Written Fall '91 by M.Morrison
10-Mar-92 (MDM) Made changes so that when HXA scan dump was
being started in the middle of a scan dump
because of telemetry loss, it will put the
time tag in the data - it was putting all
zero's before.
[Previous]
[Next]
NAME:
ext1pfi
PURPOSE:
Extract the SXT-PFI portion of the telemetry stream
CALLS: ***
BTEST0, ERR_LOG, MASK
HISTORY:
Written Fall '91 by M.Morrison
30-Nov-92 (MDM) - Added check for insertion of telemetry buffer into
the image array in the Y dimension as well as the
X dimension.
12-Apr-95 (MDM) - Added check that the portion was not
already inserted (due to SIRIUS duplication)
when updating number of pixels extracted
[Previous]
[Next]
NAME:
ext_bcschan
PURPOSE:
Extract the bins associated with a given channel
from the data matrix
CALLING SEQUENCE:
dd = ext_bcschan(index, data, chan)
dd = ext_bcschan(index, data, chan, n)
dd = ext_bcschan(index, data, chan, /lastbin)
INPUT:
index
data
chan - Channel number (1,2,3,4) where
1 = Fe XXVI
2 = Fe XXV
3 = Ca XIX
4 = S XV
OPTIONAL INPUT:
lastbin - If present, return the last bin. Default
is not to return the last bin since it is
the "catch-all" for all events of unknown
energy
OPTIONAL OUTPUT:
nbins - the number of bins in the extracted spectra
OUTPUT:
Returns a matrix (or 1-D vector) of the bins
Returns -1 if requested channel is not present
CALLS: ***
ALL_VALS [1], ALL_VALS [2]
CALLED BY:
BCS_ACCUM [1], BCS_ACCUM [2], BCS_CONT [1], BCS_CONT [2], BCS_DSPEC [1]
BCS_DSPEC [2], BCS_MULTI [1], BCS_MULTI [2], BCS_SPMOVIE [1], BCS_SPMOVIE [2]
WBDA [1], WBDA [2], disp_bda, plots_bda
RESTRICTIONS:
None
HISTORY:
Written by M.Morrison 7-Mar-92
RDB 16-May-94 Extended to allow different modes
RDB 14-Nov-97 Return -1 if channel not present in the dataset
[Previous]
[Next]
NAME:
ext_bcschan
PURPOSE:
Extract the bins associated with a given channel
from the data matrix
CALLING SEQUENCE:
dd = ext_bcschan(index, data, chan)
dd = ext_bcschan(index, data, chan, n)
dd = ext_bcschan(index, data, chan, /lastbin)
INPUT:
index
data
chan - Channel number (1,2,3,4) where
1 = Fe XXVI
2 = Fe XXV
3 = Ca XIX
4 = S XV
OPTIONAL INPUT:
lastbin - If present, return the last bin. Default
is not to return the last bin since it is
the "catch-all" for all events of unknown
energy
OPTIONAL OUTPUT:
nbins - the number of bins in the extracted spectra
OUTPUT:
Returns a matrix (or 1-D vector) of the bins
CALLS: ***
ALL_VALS [1], ALL_VALS [2]
CALLED BY:
BCS_ACCUM [1], BCS_ACCUM [2], BCS_CONT [1], BCS_CONT [2], BCS_DSPEC [1]
BCS_DSPEC [2], BCS_MULTI [1], BCS_MULTI [2], BCS_SPMOVIE [1], BCS_SPMOVIE [2]
WBDA [1], WBDA [2], disp_bda, plots_bda
RESTRICTIONS:
None
HISTORY:
Written by M.Morrison 7-Mar-92
RDB 16-May-94 Extended to allow different modes
[Previous]
[Next]
NAME:
ext_subimg
PURPOSE:
Given an SXT full frame image, extract the portion of the PFI image
described in the second parameter.
CALLING SEQUENCE:
subimg = ext_subimg(index1, data1, index2)
INPUT:
index1 - The FFI index structure
data1 - The FFI data array (NX x NY)
index2 - The PFI index structure
OUTPUT:
returns the PFI portion of the FFI image
CALLS: ***
gt_pfi_ffi, gt_res
OPTIONAL KEYWORD INPUT:
use_avg - If set and the overlap of the PFI and the FFI is not
complete, then find the average of the signal level in the
edge portion of the FFI image, and set all non-overlapping
portions in the PFI image to that value. Used for dark
current subtraction method.
qdebug - If set, print some debugging messages
OPTIONAL KEYWORD OUTPUT:
line_map - A byte array of length equal to the number of lines in the
PFI. A value of 1 is set for every line that has overlap
with the FFI.
HISTORY:
Written 7-Apr-93 by M.Morrison (taking DARK_SUB work as the beginning)
[Previous]
[Next]
NAME:
ext_subimg2
PURPOSE:
To extract a sub image out of a full frame image
INPUT:
index_in - The index for the FFI image
data_in - The data array of the FFI image
OUTPUT:
index_out- The index for the output.
data_out- The data array extracted from the FFI
CALLS: ***
gt_corner, gt_res, gt_shape_cmd, his_index, mod_res
OPTIONAL KEYWORD INPUT:
fri - The Full Resolution IDL coordinate of the lower left sub-pixel
in the lower left of the observing region to extract. [x0,y0]
nfri_pix- The number of full resolution pixels to extract [nx,ny]
center - If set, then the "FRI" coordinates are for the center of the
field of view to extract
index_ref- It is possible to pass a PFI index structure and have the
corresponding portion extracted.
HISTORY:
Written 6-Jun-93 by M.Morrison
20-Jun-93 (MDM) - Added more header information
- Inserted call to GT_CORNER
[Previous]
[Next]
NAME:
ext_subimg3
PURPOSE:
To extract a sub image out of an image. The resolution of the image
is not changed.
METHOD:
There are two ways to extract.
1. When asking for NxM, always return NxM no matter if the
input image does not fall within the coordinates requested
(or partially overlaps the coordinates requested)
This option is default.
2. When asking for NxM, and only M1 lines of the input image
overlap the requested coordinates, then return an NxM1 sized
image. This option is enabled by using /TRIM option
SAMPLE CALLING SEQUENCE:
ext_subimg3, index, data, index2, data2, ref_image=pfi_index
INPUT:
index_in - The index for the FFI image
data_in - The data array of the FFI image
OUTPUT:
index_out- The index for the output.
data_out- The data array extracted from the FFI
CALLS: ***
gt_corner, gt_res, gt_shape, his_index
CALLED BY:
align1img [1], align1img [2], get_dc_image [2], get_dc_image [3]
OPTIONAL KEYWORD INPUT:
fri - The Full Resolution IDL coordinate of the lower left sub-pixel
in the lower left of the observing region to extract. [x0,y0]
NOTE: It is possible that the corner return will not be
this exact value because HR and QR images exist only on
every other (and every fourth) pixel. The history record
will reflect the actual portion extracted.
nx - The number of full resolution pixels to extract in X
ny - The number of full resolution pixels to extract in Y
center - If set, then the "FRI" coordinates are for the center of the
field of view to extract
ref_image- It is possible to pass a PFI index structure and have the
corresponding portion extracted.
use_avg - If set, and if the requested image falls outside of the
input image, then set the portion outside to the average
value of the input image (using the 50 lines closest to
the output image). Used for dark subtraction stuff.
margin - Can be used in conjuntion with "ref_image". A extra
number of pixels will be extracted from around the image
described by "ref_image". The units are in the summed
pixels. It should be a scalar.
trim - If set, then trim the image to only return the portion that
overlaps the requested portion.
RESTRICTIONS:
The routine assumes that it is working on raw FFI images, so that
they are complete in the E/W direction, but that the FR images
might be strips so they will not be complete in the N/S direction.
HISTORY:
Written 6-Jun-93 by M.Morrison
20-Jun-93 (MDM) - Added more header information
- Inserted call to GT_CORNER
25-Aug-93 (MDM) - Whole series of major changes
26-Aug-93 (MDM) - More changes
7-Oct-93 (MDM) - Patched bug causing array out of bounds
12-Oct-93 (MDM) - Patch for the case where trying to extract too far
to the left of the image
18-Oct-93 (MDM) - Added FRI=FIX(FRI) statement
- Corrected a roundoff problem (integer versus real)
V1.02 24-Nov-93 (MDM) - Corrected an error. It was returning a full 64x64
image even when the overlap between the input image
and the requested portion was something like 64x48
lines. The other 16 lines had zeros and was causing
problems with SXT_PREP2. Added /TRIM option.
- Also modified the SHAPE_SAV technique
V1.03 29-Nov-93 (MDM) - Finished 24-Nov correction - it was causing a problem
when the region requested was way off (x1>0, y1>0
was coded)
V1.04 16-Dec-93 (MDM) - Recent mods caused a certain condition not to be
recognized. Corrected it (added yy1 variable)
[Previous]
[Next]
NAME:
ext_subset
PURPOSE:
To extract a subset of a datacube and to update the output
index to reflect the change
CALLS: ***
GET_BOXCORN, SELECTOR, STEPPER [1], STEPPER [2], STEPPER [3], STEPPER [4]
STEPPER [5], STEPPER [6], STEPPER [7], draw_boxcorn [1], draw_boxcorn [2]
yesnox [1], yesnox [2]
NOTE: Index update is not implemented yet
CALLING SEQUENCE:
ext_subset, index, data, index2, data2
INPUT:
index_in-
data_in -
OUTPUT:
index_out-
data_out-
HISTORY:
Written 11-Nov-91 by M.Morrison
14-Nov-91 (MDM) - Changed to update the "shape_cmd" field with the
new image shape.
20-Nov-91 (MDM) - Minor patch for cases where box marked is outside
the top or bottom
[Previous]
[Next]
NAME:
ext_subset
PURPOSE:
To extract a subset of a datacube and to update the output
index to reflect the change
CALLS: ***
GET_BOXCORN, STEPPER [1], STEPPER [2], STEPPER [3], STEPPER [4], STEPPER [5]
STEPPER [6], STEPPER [7], draw_boxcorn [1], draw_boxcorn [2], gt_corner, gt_res
his_index, yesnox [1], yesnox [2]
NOTE: Index update is not implemented yet
CALLING SEQUENCE:
ext_subset, index, data, index2, data2
INPUT:
index_in-
data_in -
OUTPUT:
index_out-
data_out-
HISTORY:
Written 11-Nov-91 by M.Morrison
14-Nov-91 (MDM) - Changed to update the "shape_cmd" field with the
new image shape.
20-Nov-91 (MDM) - Minor patch for cases where box marked is outside
the top or bottom
25-Feb-94 (MDM) - Modified to update the index record