This page was created by the IDL library routine
mk_html_help. For more information on
this routine, refer to the IDL Online Help Navigator
or type:
? mk_html_help
at the IDL command line prompt.
Last modified: Wed Nov 7 14:37:39 2001.
NAME:
PAPCO_ANNOTATE
PURPOSE:
This procedure is a general purpose drawing program/widget to
annotate displays. Drawing objects include text, lines, arrows,
polygons, rectangles, circles, and ellipses.
CATEGORY:
Widgets. Will also work with plain windows.
CALLING SEQUENCE:
PAPCO_ANNOTATE
INPUTS:
No required inputs.
KEYWORD PARAMETERS:
COLOR_INDICES: an array of color indices from which the user
can choose colors. For example, to allow the user
to choose 10 colors, spread evenly over the
available indices, set the keyword as folows:
COLOR_INDICES = INDGEN(10) * (!D.N_COLORS-1) / 9
DRAWABLE: the widget ID of the draw widget for the annotations.
This is mutually exclusive with WINDOW.
LOAD_FILE: the name of an annotation format file to load after
initialization.
TEK_COLORS: if set, the Tektronix color table is loaded
starting at color index TEK_COLORS(0), with
TEK_COLORS(1) color indices. The Tektronix color
table contains up to 32 distinct colors suitable
for graphics.
WINDOW: the window index number of the window to receive the
annotations.
EXIT: papco: only active if LOAD_FILE is set. Draw
annotation from file only, then exit
PAPCO_PS papco: only active if LOAD_FILE is set. Draw
annotation from file to postscript only, then exit
OUTPUTS:
This procedure has no explicit outputs. Menu choices exist to
write TIFF, GIF, or PostScript bitmap files. Encapsulated
or standalone PostScript files may also be created.
SIDE EFFECTS:
Annotations are made in the designated window or draw widget.
RESTRICTIONS:
This is a simple drawing program.
PROCEDURE:
If neither TEK_COLORS or COLOR_INDICES are specified, the default
is to load 10 colors, evenly distributed over those available.
If neither WINDOW or DRAWABLE are specified, the current window
is used.
EXAMPLE:
TVSCL, HANNING(300,200) ;Output an image in the current window
PAPCO_ANNOTATE ;Annotate it
MODIFICATION HISTORY:
DMS, RSI, July, 1993. Original version.
(See /u/friedel/idl/papco/papco_lib/papco_annotate.pro)
NAME:
PAPCO_CW_BGROUP
PURPOSE:
PAPCO_CW_BGROUP is a compound widget that simplifies creating
a base of buttons.
This is a modification of the IDL 5.4 CW_BGROUP function
To allow individual button ID's to be returned. None of the
default behaviour of the original CW_BGROUP is changed.
See the IDL documentation for a full description of the
CW_BGROUP routine.
Only modifications / additions are described here.
CATEGORY:
Compound widgets.
CALLING SEQUENCE:
Widget = PAPCO_CW_BGROUP(Parent, Names)
KEYWORD PARAMETERS:
BUTTON_IDS: Set to a variable to Return widget ID's of the
individual buttons created
MODIFICATION HISTORY:
Aug. 2001, RF Added BUTTON_IDS keyword to return button Id's
(See /u/friedel/idl/papco/papco_lib/papco_cw_bgroup.pro)
NAME:
PAPCO_MK_HTML_HELP
PURPOSE:
This procedure makes a set of html web documentation files
for the PAPCO software package.
CATEGORY:
Documentation
CALLING SEQUENCE:
Write the calling sequence here. Include only positional parameters
(i.e., NO KEYWORDS). For procedures, use the form:
ROUTINE_NAME, Parameter1, Parameter2, Foobar
Note that the routine name is ALL CAPS and arguments have Initial
Caps. For functions, use the form:
Result = FUNCTION_NAME(Parameter1, Parameter2, Foobar)
Always use the "Result = " part to begin. This makes it super-obvious
to the user that this routine is a function!
INPUTS:
Parm1: Describe the positional input parameters here. Note again
that positional parameters are shown with Initial Caps.
OPTIONAL INPUTS:
Parm2: Describe optional inputs here. If you don't have any, just
delete this section.
KEYWORD PARAMETERS:
INFO: Calls doc_library to display this header documentation.
1: print to terminal, 2: print to default printer
VERB: Set to display informational messages.
KEY1: Document keyword parameters like this. Note that the keyword
is shown in ALL CAPS!
KEY2: Yet another keyword. Try to use the active, present tense
when describing your keywords. For example, if this keyword
is just a set or unset flag, say something like:
"Set this keyword to use foobar subfloatation. The default
is foobar superfloatation."
OUTPUTS:
Describe any outputs here. For example, "This function returns the
foobar superflimpt version of the input array." This is where you
should also document the return value for functions.
OPTIONAL OUTPUTS:
Describe optional outputs here. If the routine doesn't have any,
just delete this section.
COMMON BLOCKS:
BLOCK1: Describe any common blocks here. If there are no COMMON
blocks, just delete this entry.
SIDE EFFECTS:
Describe "side effects" here. There aren't any? Well, just delete
this entry.
RESTRICTIONS:
Describe any "restrictions" here. Delete this section if there are
no important restrictions.
PROCEDURE:
You can describe the foobar superfloatation method being used here.
You might not need this section for your routine.
EXAMPLE:
Please provide a simple example here. An example from the PICKFILE
documentation is shown below. Please try to include examples that
do not rely on variables or data files that are not defined in
the example code. Your example should execute properly if typed
in at the IDL command line with no other preparation.
Create a PICKFILE widget that lets users select only files with
the extensions 'pro' and 'dat'. Use the 'Select File to Read' title
and store the name of the selected file in the variable F. Enter:
F = PICKFILE(/READ, FILTER = ['pro', 'dat'])
MODIFICATION HISTORY:
Written by: Reiner Friedel, November 2001
(See /u/friedel/idl/papco/papco_lib/papco_mk_html_help.pro)
NAME:
PAPCO_ROUTINE_HEADER
PURPOSE:
Tell what your routine does here. I like to start with the words:
"This function (or procedure) ..."
Try to use the active, present tense.
CATEGORY:
Put a category (or categories) here. For example:
Widgets.
CALLING SEQUENCE:
Write the calling sequence here. Include only positional parameters
(i.e., NO KEYWORDS). For procedures, use the form:
ROUTINE_NAME, Parameter1, Parameter2, Foobar
Note that the routine name is ALL CAPS and arguments have Initial
Caps. For functions, use the form:
Result = FUNCTION_NAME(Parameter1, Parameter2, Foobar)
Always use the "Result = " part to begin. This makes it super-obvious
to the user that this routine is a function!
INPUTS:
Parm1: Describe the positional input parameters here. Note again
that positional parameters are shown with Initial Caps.
OPTIONAL INPUTS:
Parm2: Describe optional inputs here. If you don't have any, just
delete this section.
KEYWORD PARAMETERS:
INFO: Calls doc_library to display this header documentation.
1: print to terminal, 2: print to default printer
KEY1: Document keyword parameters like this. Note that the keyword
is shown in ALL CAPS!
KEY2: Yet another keyword. Try to use the active, present tense
when describing your keywords. For example, if this keyword
is just a set or unset flag, say something like:
"Set this keyword to use foobar subfloatation. The default
is foobar superfloatation."
OUTPUTS:
Describe any outputs here. For example, "This function returns the
foobar superflimpt version of the input array." This is where you
should also document the return value for functions.
OPTIONAL OUTPUTS:
Describe optional outputs here. If the routine doesn't have any,
just delete this section.
COMMON BLOCKS:
BLOCK1: Describe any common blocks here. If there are no COMMON
blocks, just delete this entry.
SIDE EFFECTS:
Describe "side effects" here. There aren't any? Well, just delete
this entry.
RESTRICTIONS:
Describe any "restrictions" here. Delete this section if there are
no important restrictions.
PROCEDURE:
You can describe the foobar superfloatation method being used here.
You might not need this section for your routine.
EXAMPLE:
Please provide a simple example here. An example from the PICKFILE
documentation is shown below. Please try to include examples that
do not rely on variables or data files that are not defined in
the example code. Your example should execute properly if typed
in at the IDL command line with no other preparation.
Create a PICKFILE widget that lets users select only files with
the extensions 'pro' and 'dat'. Use the 'Select File to Read' title
and store the name of the selected file in the variable F. Enter:
F = PICKFILE(/READ, FILTER = ['pro', 'dat'])
MODIFICATION HISTORY:
Written by: Your name here, Date.
July, 1994 Any additional mods get described here. Remember to
change the stuff above if you add a new keyword or
something!
(See /u/friedel/idl/papco/papco_lib/papco_routine_header.pro)