[Previous]
[Next]
Name: zbuff2file
Purpose:
write the image current Z-buffer image to an image file (gif,tiff,jpeg)
Input Parameters:
filename - filename for (output) image file
r,g,b - optional color table (gif and tiff only) - default is current
Keyword Parameters:
gif - switch, if set, use write_gif (file gets .gif extension)
tiff - switch, if set, use tiff_write (file gets .tiff extention)
jpeg - switch, if set, use write_jpeg (file gets .jpg extentsion)
outdir - output directory (may also be supplied as part of FILENAME)
quality - passed to write_jpeg
Calling Sequence:
zbuff2file, filename [,r,g,b, /gif, /jpeg, /tiff, outdir=outdir]
CALLED BY:
LATEST_SFDS_GIF, ROLL_PLOT, data2files, disp_gen [1], disp_gen [2]
disp_sci160k [1], disp_sci160k [2], eit_proton_summary, fits_disp_month [1]
fits_disp_month [2], full_graph_gif, image2movie, jitter_gif_xyimg
mon_health [1], mon_health [2], new_disp_sci5k [1], new_disp_sci5k [2]
new_edac_summary, new_mon_health [1], new_mon_health [2], plot_door_open
plot_loi_summary [1], plot_loi_summary [2], plot_shutter_perf, show_contacts
soon_cadence, soon_catstat, sooncat_cadence, ssw_findstuff2html, timeline
trace_cosmic2hist_accum, write_trace, wrt_sci160k_img, xdisp_fits
Restrictions:
image must currently reside in Z-buffer
History:
17-jul-1995 (S.L.Freeland)
[Previous]
[Next]
NAME:
zformat
PURPOSE:
To format some output as hex. It's needed because of
handling of negative integer numbers and because of
a problem with the alpha's
SAMPLE CALLING SEQUENCE:
out = zformat(888)
out = zformat(in, n)
CALLS: ***
ARR2STR [1], Arr2Str [2]
CALLED BY:
mk_ff_patch, timeline, topsdb [1], topsdb [2], web_seq
OPTIONAL KEYWORD INPUT:
caps - If set, make the alphabetic characters upper
case
mdi_leading - If set, prepend a "0x" to the output.
string - If set, then make the output a single string
HISTORY:
Written 11-Jul-96 by M.Morrison
[Previous]
[Next]
Project : SOHO - CDS
Name : ZONE_DEF_ID()
Purpose : Associates zone ID's with widget event values.
Explanation : When used in conjunction with the pulldown menu defined by the
data file newdata_selection.pdm, this function can be used to
determine the unique zone ID.
Use : ZONE_ID = ZONE_DEF_ID( MODE [, LABEL ] )
Inputs : MODE = Four character code for the zone. This is the first
four characters after the NDATA_ in the user value
defined in the pulldown menu file newdata_selection.pdm.
Arrays are allowed.
This routine also uses the input file zone_definitions.dat in
the same directory as newdata_selection.pdm ($CDS_PLAN_TECH).
This is a text file, with each line having the following
format:
Zone ID: I3, 1X (3 chars & a space)
Mode: A4, 1X (4 chars & a space)
Label: A (unlimited # of chars)
The modes in this file must match those in the file
newdata_selection.pdm. For every item in newdata_selection.pdm
there must be a corresponding item in zone_definitions.dat,
although the converse does not necessarily have to be true.
It is not necessary that the zone IDs match the order of the
line in either zone_definitions.dat or newdata_selection.pdm.
However, the zone ID must be uniquely associated with a given
zone over the lifetime of the mission; i.e. zone ID number 5
will always be associated with active regions no matter how the
list of zones is reorganized.
Opt. Inputs : None.
Outputs : The result of the function is the unique zone ID associated
with the zone. If no match is found, the number 0 is returned
instead.
Opt. Outputs: LABEL = The label associated with the ID number.
Keywords : None.
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], LOC_FILE [1], LOC_FILE [2], LOC_FILE [3], concat_dir [4]
CALLED BY:
MK_CDS_PLAN, MK_STUDY
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, technical.
Prev. Hist. : None.
Written : William Thompson, GSFC, 28 March 1995
Modified : Version 1, William Thompson, GSFC, 28 March 1995
Version 1.1, Dominic Zarro, GSFC, 25 October 1995
- Added check for scalar input ID. IDL version 4 seems
to have an erratic problem with statements like A(W)=C,
when A is initialized to a scalar string and W is a vector.
Version 2, Zarro (SAC/GSFC) - added check for ZONE Def file
Version : Version 2
[Previous]
[Next]
Project : SOHO - CDS
Name : ZONE_DEF_LABEL
Purpose : Associates zone labels with ID numbers.
Explanation : Reads in the file zone_definitions.dat to retrieve labels.
Use : ZONE_ID = ZONE_DEF_LABEL(ID)
Inputs : ID = Unique ID number for the zone.
This routine also uses the input file zone_definitions.dat in
the same directory as newdata_selection.pdm ($CDS_PLAN_TECH).
This is a text file, with each line having the following
format:
Zone ID: I3, 1X (3 chars & a space)
Mode: A4, 1X (4 chars & a space)
Label: A (unlimited # of chars)
The modes in this file must match those in the file
newdata_selection.pdm. For every item in newdata_selection.pdm
there must be a corresponding item in zone_definitions.dat,
although the converse does not necessarily have to be true.
It is not necessary that the zone IDs match the order of the
line in either zone_definitions.dat or newdata_selection.pdm.
However, the zone ID must be uniquely associated with a given
zone over the lifetime of the mission; i.e. the zone ID 5 will
always be associated with active regions no matter how the list
of zones is reorganized.
Opt. Inputs : None.
Outputs : The result of the function is the label associated with the
unique zone ID. If no match is found, the null string is
returned instead.
Opt. Outputs: None.
Keywords : None.
Calls : ***
CONCAT_DIR [1], CONCAT_DIR [2], CONCAT_DIR [3], DATATYPE [1], DATATYPE [2]
DATATYPE [3], LOC_FILE [1], LOC_FILE [2], LOC_FILE [3], concat_dir [4]
CALLED BY:
GET_CDS_POINT, MK_CDS_PLAN, MK_STUDY, XSTUDY
Common : None.
Restrictions: None.
Side effects: None.
Category : Planning, technical.
Prev. Hist. : None.
Written : William Thompson, GSFC, 28 March 1995
Modified : Version 1, William Thompson, GSFC, 28 March 1995
Version 1.1, Dominic Zarro, GSFC, 25 October 1995
- Added check for scalar input ID. IDL version 4 seems
to have an erratic problem with statements like A(W)=C,
when A is initialized to a scalar string and W is a vector.
Version 2, Zarro (SAC/GSFC) - added check for ZONE Def file
Version : Version 2
[Previous]
[Next]
NAME:
zoom_blink
PURPOSE:
To super-impose two images and blink between them.
SAMPLE CALLING SEQUENCE:
zoom_blink img1, img2
zoom_blink img1, img2, delay
CALLS: ***
BOX_RESTORE, EXPAND, GRID_OVER
HISTORY:
Received from Alan Title (Karl Schriver) 7-May-96
and put online by M.Morrison
7-May-96 (MDM) - Replaced all "nint" references with "round"
[Previous]
[Next]
Project : SOHO - LASCO
Name :
Purpose :
Category :
Explanation :
Syntax :
CALLED BY:
WFLIMB
Examples :
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Common :
Restrictions:
Side effects: Not known
History : Version 1, 02-Sep-1995, B Podlipnik. Written
Contact : BP, borut@lasco1.mpae.gwdg.de
[Previous]
[Next]
NAME:
ZOOM_SINGLE
PURPOSE:
Display part of an image (or graphics) from the current window
expanded in another window and exit - version for event driven
CATEGORY:
Display.
CALLING SEQUENCE:
Zoom, .... Keyword parameters.
INPUTS:
All input parameters are keywords.
Fact = zoom expansion factor, default = 4.
Interp = 1 or set to interpolate, otherwise pixel replication is used.
xsize = X size of new window, if omitted, 512.
ysize = Y size of new window, default = 512.
Continuous = keyword param which obviates the need to press the
left mouse button. The zoom window tracks the mouse.
Only works well on fast computers.
OUTPUTS:
No explicit outputs. A new window is created and destroyed when
the procedure is exited.
CALLED BY:
update_image, xspr [1], xspr [2], xstepper_event
COMMON BLOCKS:
None.
SIDE EFFECTS:
A window is created / destroyed.
RESTRICTIONS:
Only works with color systems.
PROCEDURE:
Straightforward.
MODIFICATION HISTORY:
SLF, revision of ZOOM which exits immediately - used for widget
event drivers (loop removed)
[Previous]
[Next]
NAME:
ZOOM_SINGLE
PURPOSE:
Display part of an image (or graphics) from the current window
expanded in another window and exit - version for event driven
CATEGORY:
Display.
CALLING SEQUENCE:
Zoom, .... Keyword parameters.
INPUTS:
All input parameters are keywords.
Fact = zoom expansion factor, default = 4.
Interp = 1 or set to interpolate, otherwise pixel replication is used.
xsize = X size of new window, if omitted, 512.
ysize = Y size of new window, default = 512.
scale - if set, tvscl
Continuous = keyword param which obviates the need to press the
left mouse button. The zoom window tracks the mouse.
Only works well on fast computers.
CALLED BY:
update_image, xspr [1], xspr [2], xstepper_event
COMMON BLOCKS:
None.
SIDE EFFECTS:
A window is created / destroyed.
RESTRICTIONS:
Only works with color systems.
PROCEDURE:
Straightforward.
MODIFICATION HISTORY:
SLF, revision of ZOOM which exits immediately - used for widget
event drivers (loop removed)
[Previous]
[Next]
Project : SOHO - CDS
Name :
ZPARCHECK
Purpose :
Routine to check user parameters to a procedure
Explanation :
Routine to check user parameters to a procedure
Use :
zparcheck, progname, parameter, parnum, types, dimens, [ message ]
CALLED BY:
ABSCAL, ARROWS, CMOUSE, DBCREATE [1], DBCREATE [2], DBCREATE [3], DBDELETE [1]
DBDELETE [2], DBDELETE [3], DBEDIT [1], DBEDIT [2], DBEDIT [3], DBEDIT_BASIC [1]
DBEDIT_BASIC [2], DBEDIT_BASIC [3], DBEXT [1], DBEXT [2], DBEXT [3], DBEXT [4]
DBFIND [1], DBFIND [2], DBFIND [3], DBOPEN [1], DBOPEN [2], DBOPEN [3], DBPRINT [1]
DBPRINT [2], DBPRINT [3], DBSORT [1], DBSORT [2], DBSORT [3], DBUPDATE [1]
DB_OR [1], DB_OR [2], DB_OR [3], EXTAST, FINDPRO, FTHELP, GETPRO, GET_EQUINOX, HASTROM
HCONGRID, HELIO_JD, HESSI SOHDATA CLASS DEFINITION, HPRECESS, HREBIN, LINTERP, NSTAR
PUTAST, QSIMP, QTRAP, QUADTERP, READCOL [3], READFMT, SXHWRITE, TBHELP, TVBOX, TVLASER
T_GETPSF
EXAMPLE:
IDL> zparcheck, 'HREBIN', hdr, 2, 7, 1, 'FITS Image Header'
This example checks whether the parameter 'hdr' is of type string (=7)
and is a vector (1 dimension). If either of these tests fail, a
message will be printed
"Parameter 2 (FITS Image Header) is undefined"
"Valid dimensions are 1"
"Valid types are string"
Inputs :
progname - scalar string name of calling procedure
parameter - parameter passed to the routine
parnum - integer parameter number
types - integer scalar or vector of valid types
1 - byte 2 - integer 3 - int*4
4 - real*4 5 - real*8 6 - complex
7 - string 8 - structure
dimens - integer scalar or vector giving number
of allowed dimensions.
Opt. Inputs :
message - string message describing the parameter to be printed if an
error is found
Outputs : None.
Opt. Outputs: None.
Keywords : None.
Calls : None.
Common : None.
Restrictions: None.
Side effects:
If an error in the parameter is a message is printed
a RETALL issued
Category : Utilities, Miscellaneous
Prev. Hist. :
version 1 D. Lindler Dec. 86
documentation updated. M. Greason, May 1990.
Written : D. Lindler, GSFC/HRS, December 1986
Modified : Version 1, William Thompson, GSFC, 29 March 1994
Incorporated into CDS library
Version : Version 1, 29 March 1994
[Previous]
[Next]
PROGRAM: zpb0r
Caching wrapper for pb0r. Caches P, B, and R values by day;
doesn't call pb0r for days that are already "known".
USAGE: See pb0r
METHOD: Caches stuff in the common block "zpb0r_cache" so that,
once you've found the value for a particular day, you don't have to do
the compute-intensive pb0r call again. There are four different sets
of values cached, based on soho/not-soho and arcsec/arcmin. (The
Right Way to do the arcsec/arcmin distinction is to multiply, but
I was too lazy to implement it that way.)
HISTORY
Written in the distant past by Craig DeForest
Hacked for kludgey vectorization, 24-Oct-97
Added arcsec/arcmin split in the caching, Jul 1997 CED
CALLS:
CALLED BY
CALC_LOI_ROLL, SUNEARTHDIST, V4XS2SRS [2], V4XSC2HC [1], V4XSC2HC [2], V4XSC2HEC
ZHDRUNIT, zdeheliographinize
[Previous]
[Next]
Project : SOHO - CDS
Name : ZSIZE()
Purpose : Return no. of "pixels along slit" in a QLDS
Explanation : "Pixels along slit" is another term for the size of
the SOLAR_Y (!!) dimension in the FITS files.
This routine should really be named YSIZE()!.
Use : N_SLIT_PIXELS = ZSIZE(QLDS)
Inputs : QLDS: A "CDS QL data structure"
Opt. Inputs : None.
Outputs : Return value.
Opt. Outputs: None.
Keywords : NOCHECK:Set to avoid call to QLMGR.
Calls : ***
QLMGR, QL_DIMENSIONS
CALLED BY:
DSPEXP, DSPWAV
Common : None.
Restrictions: QLDS == CDS QL data structure.
Side effects: None.
Category : CDS, QuickLook
Prev. Hist. : None.
Written : Stein Vidar Hagfors Haugan, October 1993
Modified : SVHH, 21 November - Documentation added.
SVHH, 6-March-1995, Introduced the use of QL_DIMENSIONS().
Version : 1.1, 6-March-1995
[Previous]
ZSTR2UTC - wrapper around Bill Thompson's "STR2UTC" to fixify
TAI times...
CAVEAT: Only works properly with vectorized arrays if all the times
in the vectorized array are in the same format.
CALLS: ***
STR2UTC [1], STR2UTC [2], STR2UTC [3], data_chk [1], data_chk [2]
CALLED BY:
fixinate_eit, zcheck_hdr, zhelio2xy, zintervals, zstructify, ztrack, zxy2helio
NOTE: This routine is Wrong as it assumes TAI=UTC. Sloppy, but OK
for the moment...
HISTORY: Slapped together in the mists of time pre-1998, CED