Documentation for pp_lib

Generated by IDLdoc

Index

.     _     A     B     C     D     E     F     G     H     I     K     L     M     N     O     P     Q     R     S     T     U     V     W     X     Y     Z    

.

./ directory

_

__OBJ__ field in class IDL_OBJECT
_EXTRA keyword in routine pp_multiplot::plot in file pp_multiplot__define.pro

Any keywords not handled by this method are passed on to plot().

_EXTRA keyword in routine pp_multiplot::contour in file pp_multiplot__define.pro

Any keywords not handled by this method are passed on to plot().

_EXTRA keyword in routine pp_multiplot::image in file pp_multiplot__define.pro

Any keywords not handled by this method are passed on to plot().

_EXTRA keyword in routine pp_multiplot::do_graphic in file pp_multiplot__define.pro

Any keywords not handled by this method are passed on to plot().

_extra keyword in routine pp_multiplot::setproperty in file pp_multiplot__define.pro

Any keywords not handled by this method are passed on to the getproperty method of the window object.

_extra property in class pp_multiplot
_extra keyword in routine pp_plot in file pp_plot.pro

Any other keywords are just passed to plot, unaltered.

_EXTRA keyword in routine read_csv_pp_strings in file read_csv_pp_strings.pro
_ref_extra keyword in routine histogram_pp in file histogram_pp.pro

Any other keywords are passed on (strictly) to histogram(), and returned unaltered.

_ref_extra keyword in routine pp_colorbar_range in file pp_colorbar_range.pro

Any other properties of the colorbar to set (IDLitVisColorbar properties).

_ref_extra keyword in routine pp_contour_paths in file pp_contour_paths.pro

Passed unchanged to/from contour.

_ref_extra keyword in routine pp_ilegendedit in file pp_ilegendedit.pro
_ref_extra keyword in routine pp_ixyouts in file pp_ixyouts.pro

Any other properties of the text to set (IDLitVisText properties).

_REF_EXTRA keyword in routine pp_multiplot::init in file pp_multiplot__define.pro

Any extra properties are just passed to window() (the init method of the window class).

_REF_EXTRA property in class pp_multiplot
_ref_extra keyword in routine pp_multiplot::getproperty in file pp_multiplot__define.pro

Any keywords not handled by this method are passed on to the getproperty method of the window object.

_REF_EXTRA keyword in routine pp_multiplot::save in file pp_multiplot__define.pro

Any keywords are passed on, unaltered, to window::save.

_ref_extra keyword in routine pp_ocircle in file pp_ocircle.pro

Passed to IDLgrPolygon init routine.

_ref_extra keyword in routine pp_osquare in file pp_osquare.pro

Passed to IDLgrPolygon init routine.

_ref_extra keyword in routine read_csv_pp in file read_csv_pp.pro

Any other arguments are simply passed to/from read_csv_pp_strings, unaltered.

_ref_extra keyword in routine write_csv_pp in file write_csv_pp.pro

Any other parameters are passed, unaltered, to / from write_csv.

A

absolute_dims keyword in routine pp_multiplot::init in file pp_multiplot__define.pro

If set, causes columnwidths and lineheights to be interpreted as absolute, rather than relative values.

absolute_dims property in class pp_multiplot
al_legend_pp routine in al_legend_pp.pro

al_legend_pp.pro .pro file in ./ directory
all keyword in routine pp_buffered_vector::getdata in file pp_buffered_vector__define.pro

If set, all the elements stored in the buffered vector are returned.

all keyword in routine pp_getcurrentlights in file pp_getcurrentlights.pro

If set, both lights are retrieved, in a two-element array, with the ambient light first.

all keyword in routine pp_multiplot::sync_axes in file pp_multiplot__define.pro

If set, synchronization is carried out on all plots in the grid, instead of only to those at the same line and same column as the plot used as reference.

ambient keyword in routine pp_getcurrentlights in file pp_getcurrentlights.pro

If set, the ambient light is the one retrieved.

append keyword in routine write_csv_pp_original in file write_csv_pp.pro
arg1 parameter in routine pp_multiplot::plot in file pp_multiplot__define.pro

The first argument to be passed on to plot().

arg1 parameter in routine pp_multiplot::contour in file pp_multiplot__define.pro

The first argument to be passed on to plot().

arg1 parameter in routine pp_multiplot::image in file pp_multiplot__define.pro

The first argument to be passed on to plot().

arg1 parameter in routine pp_multiplot::do_graphic in file pp_multiplot__define.pro

The first argument to be passed on to plot().

arg2 parameter in routine pp_multiplot::plot in file pp_multiplot__define.pro

The second argument to be passed on to plot().

arg2 parameter in routine pp_multiplot::contour in file pp_multiplot__define.pro

The second argument to be passed on to plot().

arg2 parameter in routine pp_multiplot::image in file pp_multiplot__define.pro

The second argument to be passed on to plot().

arg2 parameter in routine pp_multiplot::do_graphic in file pp_multiplot__define.pro

The second argument to be passed on to plot().

arg3 parameter in routine pp_multiplot::plot in file pp_multiplot__define.pro

The third argument to be passed on to plot().

arg3 parameter in routine pp_multiplot::contour in file pp_multiplot__define.pro

The third argument to be passed on to plot().

arg3 parameter in routine pp_multiplot::image in file pp_multiplot__define.pro

The third argument to be passed on to plot().

arg3 parameter in routine pp_multiplot::do_graphic in file pp_multiplot__define.pro

The third argument to be passed on to plot().

array parameter in routine histogram_pp in file histogram_pp.pro

Passed on, unaltered, to histogram(), its only positional parameter.

array parameter in routine pp_locate in file pp_locate.pro

An array of any type that can be sorted (integers, reals, strings, etc).

as_struct keyword in routine pp_parsetext in file pp_parsetext.pro

B

background_color keyword in routine al_legend_pp in file al_legend_pp.pro
blank keyword in routine pp_isnumber in file pp_isnumber.pro

If set, blanks are allowed as numbers

blank keyword in routine pp_parsetext in file pp_parsetext.pro
blank keyword in routine read_csv_pp in file read_csv_pp.pro

If set, blank (empty / whitespace) strings are allowed in numeric columns: if a column contains numbers and blank values, its type will be numeric, and any blanks will be replaced with 0.

blank keyword in routine read_csv_pp_strings in file read_csv_pp_strings.pro
bottom keyword in routine pp_multiplot::getposition in file pp_multiplot__define.pro

Indicates whether this plot is in the bottom line of the grid.

BOTTOM_LEGEND keyword in routine al_legend_pp in file al_legend_pp.pro
BOX keyword in routine al_legend_pp in file al_legend_pp.pro
buffer keyword in routine pp_parsetext in file pp_parsetext.pro
BUFFERSIZE field in class pp_buffered_vector
buffersize keyword in routine pp_buffered_vector::init in file pp_buffered_vector__define.pro

Size of the step to use when incrementing the number of elements contained by the object.

buffersize property in class pp_buffered_vector

C

calculate_ticks keyword in routine pp_plot in file pp_plot.pro

If set and tick values are not provided, the tick values are defined here, instead of letting IDL's plot do it.

CENTER_LEGEND keyword in routine al_legend_pp in file al_legend_pp.pro
CHARSIZE keyword in routine al_legend_pp in file al_legend_pp.pro
CHARTHICK keyword in routine al_legend_pp in file al_legend_pp.pro
CLEAR keyword in routine al_legend_pp in file al_legend_pp.pro
cm parameter in routine pp_cmap_show in file pp_cmap_show.pro

The colormap to display, in a 3xn array of RGB values, with each row being the 3 values for each color index.

cmyk keyword in routine pp_itool_save in file pp_itool_save.pro

If set, the eps is saved in CMYK colorspace.

colname parameter in routine pp_appendcolumn in file pp_appendcolumn.pro
COLORS keyword in routine al_legend_pp in file al_legend_pp.pro
column keyword in routine pp_multiplot::getposition in file pp_multiplot__define.pro

The column where this plot lies on the grid (starting from 0).

columnwidths keyword in routine pp_multiplot::init in file pp_multiplot__define.pro

If set to an array with the same number of elements as the number of grid columns, specifies the width to use for each plot column.

columnwidths property in class pp_multiplot
comment_lines keyword in routine pp_readpars in file pp_readpars.pro

Provides a string array with all lines that were not put into the hash (comment lines, or lines that were not recognized as containing a valid key=value).

comment_marker keyword in routine pp_readpars in file pp_readpars.pro

The character to use to mark comments in the text to process.

CONT field in class pp_cmfr
CORNERS keyword in routine al_legend_pp in file al_legend_pp.pro
COUNT field in class pp_buffered_vector
count keyword in routine pp_buffered_vector::getdata in file pp_buffered_vector__define.pro

Returns the number of elements retrieved.

count parameter in routine pp_extractfields in file pp_extractfields.pro

The number of fields found.

COUNT keyword in routine read_csv_pp_strings in file read_csv_pp_strings.pro
counts keyword in routine pp_locate in file pp_locate.pro
cumulative keyword in routine pp_integral in file pp_integral.pro

If set, and xmin and xmax are not provided, the areas returned are the cumulative areas at the end of each x point, starting at the first x point.

CWIDTHS field in class pp_multiplot

D

DATA keyword in routine al_legend_pp in file al_legend_pp.pro
DATA field in class pp_buffered_vector
data parameter in routine pp_buffered_vector::append in file pp_buffered_vector__define.pro

The scalar or array to be put at the end of the buffered vector.

DATA field in class pp_readfits
data keyword in routine pp_readfits::getproperty in file pp_readfits__define.pro
data property in class pp_readfits
data parameter in routine write_csv_convert_pp_original in file write_csv_pp.pro
Data1 parameter in routine write_csv_pp_original in file write_csv_pp.pro

The data values to be written out to the CSV file.

data1 parameter in routine write_csv_pp in file write_csv_pp.pro

Passed to write_csv, after the variable has its structures flattened by a call to pp_struct_unravel.

Data2 parameter in routine write_csv_pp_original in file write_csv_pp.pro
data2 parameter in routine write_csv_pp in file write_csv_pp.pro

Passed unaltered to write_csv.

Data3 parameter in routine write_csv_pp_original in file write_csv_pp.pro
data3 parameter in routine write_csv_pp in file write_csv_pp.pro

Passed unaltered to write_csv.

Data4 parameter in routine write_csv_pp_original in file write_csv_pp.pro
data4 parameter in routine write_csv_pp in file write_csv_pp.pro

Passed unaltered to write_csv.

Data5 parameter in routine write_csv_pp_original in file write_csv_pp.pro
data5 parameter in routine write_csv_pp in file write_csv_pp.pro

Passed unaltered to write_csv.

Data6 parameter in routine write_csv_pp_original in file write_csv_pp.pro
data6 parameter in routine write_csv_pp in file write_csv_pp.pro

Passed unaltered to write_csv.

Data7 parameter in routine write_csv_pp_original in file write_csv_pp.pro
data7 parameter in routine write_csv_pp in file write_csv_pp.pro

Passed unaltered to write_csv.

Data8 parameter in routine write_csv_pp_original in file write_csv_pp.pro
data8 parameter in routine write_csv_pp in file write_csv_pp.pro

Passed unaltered to write_csv.

day keyword in routine pp_rise_set in file pp_rise_set.pro

Day of the month for the observation.

dec parameter in routine pp_rise_set in file pp_rise_set.pro

Declination(s) of the point(s) to calculate the visibility for.

decide keyword in routine pp_plot_decideintervals in file pp_plot.pro
default keyword in routine multiplot_pp in file multiplot_pp.pro
DELIMITER keyword in routine al_legend_pp in file al_legend_pp.pro
delimiter keyword in routine pp_parsetext in file pp_parsetext.pro
dema parameter in routine pp_azdif in file pp_azdif.pro

The angle between the other direction and the vertical (emission angle), in degrees.

DESC field in class pp_cmfr
desc keyword in routine pp_cmfr::getall in file pp_cmfr__define.pro

A string array with the pairs of tag names and their descriptors in the result.

desc keyword in routine pp_cmfr::getvariable in file pp_cmfr__define.pro

An array string with the pairs of tag names and their descriptors in the result.

DESCRIPTIONS field in class pp_readfits
descriptions keyword in routine pp_readfits::getproperty in file pp_readfits__define.pro
descriptions property in class pp_readfits
DEVICE keyword in routine al_legend_pp in file al_legend_pp.pro
DIELIMP field in class pp_cmfr
dielimp keyword in routine pp_cmfr::getvariable in file pp_cmfr__define.pro

Dielectronic and Implicit Recombination Line Emission.

dinc parameter in routine pp_azdif in file pp_azdif.pro

The angle between one of the directions and the vertical (incidence angle), in degrees.

DIND field in class pp_cmfr
dint parameter in routine pp_plot_decideintervals in file pp_plot.pro
directional keyword in routine pp_getcurrentlights in file pp_getcurrentlights.pro

If set, the directional light is the one retrieved.

divide keyword in routine write_csv_pp in file write_csv_pp.pro

Used to split the file writing into divide pieces.

dminor keyword in routine pp_plot_decideintervals in file pp_plot.pro
dphase parameter in routine pp_azdif in file pp_azdif.pro

The angle between the two directions (phase angle), in degrees.

dprange parameter in routine pp_plot_decideintervals in file pp_plot.pro
dticks parameter in routine pp_plot_decideintervals in file pp_plot.pro

E

epsfile keyword in routine pp_itool_save in file pp_itool_save.pro

Name of the eps file to make.

extra keyword in routine pp_rise_set in file pp_rise_set.pro

If set, extra data is output (sunrise/sunset times, target altitude at sunrise/sunet, etc).

F

field_names keyword in routine read_csv_pp in file read_csv_pp.pro

A string array with the name to assign to each field (column) in the output.

fieldCount parameter in routine read_csv_fieldnames in file read_csv_pp_strings.pro
fieldnames keyword in routine pp_parsetext in file pp_parsetext.pro
fields parameter in routine pp_structsubset in file pp_structsubset.pro

A string array with each element specifying the name of a field of structin to go into the output structure.

file parameter in routine pp_cmfr::init in file pp_cmfr__define.pro
file parameter in routine pp_cmfread in file pp_cmfread.pro

String with the name of the file to read.

file parameter in routine pp_dos2unix in file pp_dos2unix.pro
file parameter in routine pp_parsetext in file pp_parsetext.pro
FILE field in class pp_readfits
file parameter in routine pp_readfits::init in file pp_readfits__define.pro
file keyword in routine pp_readfits::getproperty in file pp_readfits__define.pro
file property in class pp_readfits
file parameter in routine pp_readtxt in file pp_readtxt.pro
file parameter in routine pp_writepars in file pp_writepars.pro

A string with the name of the file to create.

file parameter in routine write_csv_pp in file write_csv_pp.pro

Passed to write_csv, specifies the name of the file to write.

filename parameter in routine pp_multiplot::save in file pp_multiplot__define.pro

Passed on to window::save, the name for the file to create.

filename parameter in routine read_csv_pp in file read_csv_pp.pro

The name of the CSV file to read.

Filename parameter in routine read_csv_pp_strings in file read_csv_pp_strings.pro
Filename parameter in routine write_csv_pp_original in file write_csv_pp.pro

A string containing the name of the CSV file to write.

FILL keyword in routine al_legend_pp in file al_legend_pp.pro
fname parameter in routine pp_itool_save in file pp_itool_save.pro

Name of the file to make, to be used for the isv and the eps files.

FONT keyword in routine al_legend_pp in file al_legend_pp.pro
font_size keyword in routine pp_ixyouts in file pp_ixyouts.pro

Font size to use in the text.

format keyword in routine pp_colorbar_range in file pp_colorbar_range.pro

Format specification to use when making the new tick labels.

formats keyword in routine pp_writepars in file pp_writepars.pro

Either a scalar string, specifying the format to use for all file lines, or a hash of strings, with the same keys as the hash of values, each giving the format to use for the correponding line.

FREQ field in class pp_cmfr
freq keyword in routine pp_cmfr::getvariable in file pp_cmfr__define.pro

Continuum Frequencies.

fwhm keyword in routine pp_gauss_from_fwhm in file pp_gauss_from_fwhm.pro

Specifies the width of the Gaussian, as its Full Width Half Maximum (FWHM).

fwhm keyword in routine pp_lorentz_from_fwhm in file pp_lorentz_from_fwhm.pro

Specifies the width of the Gaussian, as its Full Width Half Maximum (FWHM).

G

gaussian keyword in routine pp_convol in file pp_convol.pro

If set, the convolution kernel is a Gaussian, of fwhm of the given width.

GLOBAL_MARGIN field in class pp_multiplot
global_margin keyword in routine pp_multiplot::init in file pp_multiplot__define.pro

The margins, in normalized units (range 0 to 1) to be given around the grid.

global_margin property in class pp_multiplot
global_margin keyword in routine pp_multiplot::getproperty in file pp_multiplot__define.pro

The margins, in normalized units (range 0 to 1) around the grid.

GLOBAL_TITLE field in class pp_multiplot
GLOBAL_XTITLE field in class pp_multiplot
global_xtitle keyword in routine pp_multiplot::init in file pp_multiplot__define.pro

The common title for all the x axes, so that a same title does not have to be shown repeatedly below every column.

global_xtitle property in class pp_multiplot
global_xtitle keyword in routine pp_multiplot::getproperty in file pp_multiplot__define.pro

The common title for all the x axes.

global_xtitle keyword in routine pp_multiplot::setproperty in file pp_multiplot__define.pro

The common title for all the x axes.

GLOBAL_YTITLE field in class pp_multiplot
global_ytitle keyword in routine pp_multiplot::init in file pp_multiplot__define.pro

The common title for all the y axes, so that a same title does not have to be shown repeatedly on the left of every line.

global_ytitle property in class pp_multiplot
global_ytitle keyword in routine pp_multiplot::getproperty in file pp_multiplot__define.pro

The common title for all the y axes.

global_ytitle keyword in routine pp_multiplot::setproperty in file pp_multiplot__define.pro

The common title for all the y axes.

graphic_to_do keyword in routine pp_multiplot::do_graphic in file pp_multiplot__define.pro
grey keyword in routine pp_cmap in file pp_cmap.pro

The intensity of the grey color to make.

grid_tolerance keyword in routine pp_convol in file pp_convol.pro

Not yet implemented.

H

header keyword in routine pp_parsetext in file pp_parsetext.pro
HEADER field in class pp_readfits
header keyword in routine pp_readfits::getproperty in file pp_readfits__define.pro
header property in class pp_readfits
header keyword in routine pp_writepars in file pp_writepars.pro

If given, its contents are printed on the top of the file.

header keyword in routine read_csv_pp in file read_csv_pp.pro
HEADER keyword in routine read_csv_pp_strings in file read_csv_pp_strings.pro
HEADER keyword in routine write_csv_pp_original in file write_csv_pp.pro

Set this keyword equal to a string array containing the column header names.

HELP keyword in routine al_legend_pp in file al_legend_pp.pro
help keyword in routine multiplot_pp in file multiplot_pp.pro
hidebox keyword in routine pp_ilegendeditor::changeproperty in file pp_ilegendedit.pro
histogram keyword in routine pp_locate in file pp_locate.pro

A hash where the keys are the unique values present in array, and the values

histogram_counts parameter in routine pp_histogramlines in file pp_histogramlines.pro

The count for each bin.

histogram_pp routine in histogram_pp.pro

A simple wrapper to histogram(), to create a new output keyword, reverse_list, which provides equivalent data as reverse_indices, but parsed into a list (with !null for empty bins).

histogram_pp.pro .pro file in ./ directory
hls keyword in routine pp_cmap in file pp_cmap.pro

If set, the colors returned are in HLS space, instead of RGB space.

HORIZONTAL keyword in routine al_legend_pp in file al_legend_pp.pro

I

iclose keyword in routine pp_itool_save in file pp_itool_save.pro

If set, the itool is closed after saving.

icolvalues parameter in routine pp_appendcolumn in file pp_appendcolumn.pro
id keyword in routine pp_colorbar_range in file pp_colorbar_range.pro

Itool id to use.

id keyword in routine pp_getcurrentlights in file pp_getcurrentlights.pro

The tool id of the graphic to operate on.

id parameter in routine pp_gettoolid in file pp_gettoolid.pro

The ID to try to use to retrieve the actual tool ID.

id keyword in routine pp_itool_save in file pp_itool_save.pro

Itool id to use.

id keyword in routine pp_ixyouts in file pp_ixyouts.pro

Itool id to use.

IDL_OBJECT_BOTTOM field in class IDL_OBJECT
IDL_OBJECT_TOP field in class IDL_OBJECT
infinity keyword in routine pp_isnumber in file pp_isnumber.pro

If set, Infinity is allowed as a number (any of inf,infi,infin,infini,infinit,infinity).

infinity keyword in routine pp_readpars in file pp_readpars.pro

Passed on to pp_isnumber.

infinity keyword in routine read_csv_pp_strings in file read_csv_pp_strings.pro
initialize keyword in routine multiplot_pp in file multiplot_pp.pro
initvec parameter in routine pp_buffered_vector::init in file pp_buffered_vector__define.pro

An array whose elements are to be placed in the object on creation.

input parameter in routine pp_readpars in file pp_readpars.pro

If input_is_strings is not set, this is a string with the name of a text file to read and parse.

input_is_strings keyword in routine pp_readpars in file pp_readpars.pro

If set, input is treated as a string array, where each element is a line to parse.

integer keyword in routine pp_isnumber in file pp_isnumber.pro

If set, will test for integer numbers, instead of real numbers.

integer keyword in routine read_csv_pp_strings in file read_csv_pp_strings.pro
INTENS field in class pp_cmfr
intens keyword in routine pp_cmfr::getvariable in file pp_cmfr__define.pro

Observed intensity (Janskys).

inverse keyword in routine pp_dos2unix in file pp_dos2unix.pro
ipars parameter in routine pp_writepars in file pp_writepars.pro

A hash with the values to write in the file.

isfloat keyword in routine pp_parsetext in file pp_parsetext.pro
isinteger keyword in routine pp_parsetext in file pp_parsetext.pro
isRange parameter in routine pp_readfits::_overloadBracketsRightSide in file pp_readfits__define.pro
istr parameter in routine pp_isnumber in file pp_isnumber.pro

String or string array to test.

isvfile keyword in routine pp_itool_save in file pp_itool_save.pro

Name of the isv file to make.

items parameter in routine al_legend_pp in file al_legend_pp.pro
ITEMS field in class pp_ilegend

K

kernelx keyword in routine pp_convol in file pp_convol.pro

Not yet implemented.

kernely keyword in routine pp_convol in file pp_convol.pro

Not yet implemented.

key_case keyword in routine pp_readpars in file pp_readpars.pro

If set to 1, keys are converted to all uppercase.

L

lat keyword in routine pp_rise_set in file pp_rise_set.pro

Latitude of the observing location, in degrees (positive is north).

layout keyword in routine pp_multiplot::sync_axes in file pp_multiplot__define.pro

If set, not only the ranges are synchronized, but also the x/y axes layouts, from those properties that have been set (in xproperties and xyproperties).

lct keyword in routine pp_cmap in file pp_cmap.pro

If set, the colormap created is loaded with tvlct.

left keyword in routine pp_multiplot::getposition in file pp_multiplot__define.pro

Indicates whether this plot is in the left column of the grid.

LEFT_LEGEND keyword in routine al_legend_pp in file al_legend_pp.pro
LEG field in class pp_ilegend
LEG field in class pp_ilegendeditor
legend parameter in routine pp_ilegendeditor::changeproperty in file pp_ilegendedit.pro
legend parameter in routine pp_ilegendedit in file pp_ilegendedit.pro
LHEIGHTS field in class pp_multiplot
LINE field in class pp_cmfr
line keyword in routine pp_cmfr::getvariable in file pp_cmfr__define.pro

Line Emission.

line keyword in routine pp_multiplot::getposition in file pp_multiplot__define.pro

The line where this plot lies on the grid (starting from 0).

lineheights keyword in routine pp_multiplot::init in file pp_multiplot__define.pro

If set to an array with the same number of elements as the number of grid lines, specifies the height to use for each plot column.

lineheights property in class pp_multiplot
lines keyword in routine pp_parsetext in file pp_parsetext.pro
LINESTYLE keyword in routine al_legend_pp in file al_legend_pp.pro
loc parameter in routine pp_ilegend::init in file pp_ilegend__define.pro
local keyword in routine pp_convol in file pp_convol.pro

If not set, the y values are interpreted as a measured sample, that is, as the average of the "flux" falling inside the region centered at the corresponding x values: x locations are interpreted as the centers of bins.

local keyword in routine pp_integral in file pp_integral.pro

Determines how the input function is interpreted, which determines how the areas are calculated.

local keyword in routine pp_resample in file pp_resample.pro

If not set, the y values are interpreted as a measured sample, that is, as the average of the "flux" falling inside the region centered at the corresponding x values: x locations are interpreted as the centers of bins.

location parameter in routine pp_ixyouts in file pp_ixyouts.pro

Two element array with the x,y coordinates where to place the text, in normalized units ([0.,0.], is in the middle of the itool).

locations keyword in routine histogram_pp in file histogram_pp.pro
locations parameter in routine pp_histogramlines in file pp_histogramlines.pro

The coordinate of the start of each bin (like what is returned by IDL's histogram().

locs parameter in routine pp_cmap_show in file pp_cmap_show.pro

If given an array of n values, those are used for the locations of each color plotted, instead of their indexes.

lon keyword in routine pp_rise_set in file pp_rise_set.pro

Longitude of the observing location, in degrees (positive is east, contrary to that returned by observatory).

lsquadratic keyword in routine pp_convol in file pp_convol.pro

Passed on to pp_integral.

lsquadratic keyword in routine pp_integral in file pp_integral.pro

If the method requires interpolation, this is passed on to interpol, to select 4 point quadratic interpolation.

lsquadratic keyword in routine pp_resample in file pp_resample.pro

Passed on to pp_integral.

LUM field in class pp_cmfr
lum keyword in routine pp_cmfr::getvariable in file pp_cmfr__define.pro

Luminosity.

M

MARGIN keyword in routine al_legend_pp in file al_legend_pp.pro
MECH field in class pp_cmfr
mech keyword in routine pp_cmfr::getvariable in file pp_cmfr__define.pro

Mechanical Luminosity.

MINDEX field in class pp_multiplot
mindex parameter in routine pp_multiplot::getposition in file pp_multiplot__define.pro

The grid index of the plot being created, from 0 to ncolumns*nlines-1.

mindex parameter in routine pp_multiplot::sync_axes in file pp_multiplot__define.pro

If provided, uses the plot at position mindex (count starts from 0) as the reference for the axes.

MISSING_VALUE keyword in routine read_csv_pp_strings in file read_csv_pp_strings.pro
missingfloat keyword in routine pp_parsetext in file pp_parsetext.pro
missingint keyword in routine pp_parsetext in file pp_parsetext.pro
MLAYOUT field in class pp_multiplot
month keyword in routine pp_rise_set in file pp_rise_set.pro

Month for the observation.

multi_index keyword in routine pp_multiplot::plot in file pp_multiplot__define.pro

The index of the position to place the plot in the grid.

multi_index keyword in routine pp_multiplot::contour in file pp_multiplot__define.pro

The index of the position to place the plot in the grid.

multi_index keyword in routine pp_multiplot::image in file pp_multiplot__define.pro

The index of the position to place the plot in the grid.

multi_index keyword in routine pp_multiplot::do_graphic in file pp_multiplot__define.pro

The index of the position to place the plot in the grid.

multi_layout keyword in routine pp_multiplot::init in file pp_multiplot__define.pro

The layout of the grid to create, as a 2-element array [ncolumns, nlines], with the number of columns and the number of lines for the grid.

multi_layout property in class pp_multiplot
multi_layout keyword in routine pp_multiplot::getproperty in file pp_multiplot__define.pro

The layout of the grid, as a 2-element array with the number of columns and the number of lines for the grid.

multiplot_pp routine in multiplot_pp.pro

multiplot_pp.pro .pro file in ./ directory

N

N_TABLE_HEADER keyword in routine read_csv_pp_strings in file read_csv_pp_strings.pro
nan keyword in routine pp_isnumber in file pp_isnumber.pro

If set, NaN is allowed as a number.

nan keyword in routine pp_readpars in file pp_readpars.pro

Passed on to pp_isnumber.

nan keyword in routine read_csv_pp_strings in file read_csv_pp_strings.pro
nc parameter in routine pp_cmap in file pp_cmap.pro

Number of equally spaced saturated colors to make.

NCOLUMNS field in class pp_multiplot
newdticks keyword in routine pp_plot_decideintervals in file pp_plot.pro
newrange keyword in routine pp_plot_decideintervals in file pp_plot.pro
newton keyword in routine pp_convol in file pp_convol.pro

Passed on to pp_integral.

newton keyword in routine pp_integral in file pp_integral.pro

If local is set and newton is set, the function integrations are done with int_tabulated, which uses a 5 point Newton-Cotes formula.

newton keyword in routine pp_resample in file pp_resample.pro

Passed on to pp_integral.

nget parameter in routine pp_buffered_vector::getdata in file pp_buffered_vector__define.pro

The number of elements to retrieve.

NLINES field in class pp_multiplot
no_sort keyword in routine pp_locate in file pp_locate.pro

If set, pp_locate assumes array is ordered.

NORMAL keyword in routine al_legend_pp in file al_legend_pp.pro
novec keyword in routine pp_itool_save in file pp_itool_save.pro

If set, the eps file is made a bitmap, instead of vector.

np parameter in routine pp_colorbar_range in file pp_colorbar_range.pro

Number of tick marks to use.

np keyword in routine pp_ocircle in file pp_ocircle.pro

The number of points used in making the circle (defaults to 21), since it is actually a polygon (similar to IDL's orb, which is a polyhedron "sphere").

nr parameter in routine pp_resample_test in file pp_resample.pro

The number of locations where the function is to be resampled at.

NUM_RECORDS keyword in routine read_csv_pp_strings in file read_csv_pp_strings.pro
NUMBER keyword in routine al_legend_pp in file al_legend_pp.pro
numbers keyword in routine pp_readpars in file pp_readpars.pro

Sets the type of conversion for values which are numbers, if any.

O

obsname keyword in routine pp_rise_set in file pp_rise_set.pro

String with the observatory name, as understood by idlastro's observatory procedure.

OPLOTS field in class pp_multiplot
order keyword in routine pp_writepars in file pp_writepars.pro

An array or list of keys to the parameter hash, sepcifying the order in which the elements whould be written to the file.

OUTLINE_COLOR keyword in routine al_legend_pp in file al_legend_pp.pro
OWINDOW field in class pp_multiplot

P

p0 keyword in routine pp_resample in file pp_resample.pro

Parameter for the local mode.

pmulti parameter in routine multiplot_pp in file multiplot_pp.pro
POSITION keyword in routine al_legend_pp in file al_legend_pp.pro
pp_appendcolumn routine in pp_appendcolumn.pro
pp_appendcolumn.pro .pro file in ./ directory
pp_azdif routine in pp_azdif.pro

Given the angle between two directions (dphase) with angle from vertical given by dinc, dema, returns the azimuth difference between them.

pp_azdif.pro .pro file in ./ directory
pp_buffered_vector class
pp_buffered_vector::append routine in pp_buffered_vector__define.pro

Adds the given data (scalar or array) to the end of the buffered vector, expanding its allocated size if necessary.

pp_buffered_vector::getbuffersize routine in pp_buffered_vector__define.pro

Returns the step by which the buffered vector is incremented when necessary.

pp_buffered_vector::getcount routine in pp_buffered_vector__define.pro

Returns the number of elements currently stored in the buffered vector.

pp_buffered_vector::getdata routine in pp_buffered_vector__define.pro

Retrieves one or more data elements currently stored in the buffered vector.

pp_buffered_vector::getsize routine in pp_buffered_vector__define.pro

Returns the currently allocated length for the buffered vector.

pp_buffered_vector::init routine in pp_buffered_vector__define.pro

Creates a pp_buffered_vector object, with the contents of the given array, or empty if it is not provided.

pp_buffered_vector__define routine in pp_buffered_vector__define.pro

Object to keep an adjustable length vector, using a buffer to decrease the frequency of resizing

pp_buffered_vector__define.pro .pro file in ./ directory

pp_cmap routine in pp_cmap.pro

Returns a colormap with nc saturated colors equally spaced in hue, plus black, white and one grey.

pp_cmap.pro .pro file in ./ directory
pp_cmap_show routine in pp_cmap_show.pro

Produces an iplot showing the color of each index in the given colormap array.

pp_cmap_show.pro .pro file in ./ directory
pp_cmfr class
pp_cmfr::cleanup routine in pp_cmfr__define.pro
pp_cmfr::getall routine in pp_cmfr__define.pro

Returns a structure containing all the 6 scalars and 9 vectors read from the object (NaN for those not found).

pp_cmfr::getvariable routine in pp_cmfr__define.pro

Returns the variables selected from the corresponding keywords (see description below)

pp_cmfr::init routine in pp_cmfr__define.pro
pp_cmfr__define routine in pp_cmfr__define.pro

Object to read and interpret OBSFLUX-type files created by cmfgen:

pp_cmfr__define.pro .pro file in ./ directory

Object to read and interpret OBSFLUX-type files created by cmfgen:

pp_cmfread routine in pp_cmfread.pro

Reads an OBSFLUX-type file generated by cmfgen and parses its content to extract each variable in it.

pp_cmfread.pro .pro file in ./ directory
pp_colorbar_range routine in pp_colorbar_range.pro

Changes the range of values spanned by the labels in an existing colorbar.

pp_colorbar_range.pro .pro file in ./ directory
pp_contour_paths routine in pp_contour_paths.pro

Simple wrapper for the contour procedure, used to extract the contour path points, and pack them into a list.

pp_contour_paths.pro .pro file in ./ directory
pp_convol routine in pp_convol.pro

Convolves the provided y(x) function with either a rectangular or Gaussian kernel of the given width, or the provided arbitrary kernel (not yet implemented).

pp_convol.pro .pro file in ./ directory
pp_convol_test routine in pp_convol.pro

Examples to test and illustrate the different behaviors of pp_convol.

pp_dos2unix routine in pp_dos2unix.pro

pro pp_dos2unix,file,inv=invSimilar to the console application dos2unix, converts the newlines of a text file betweenCR+LF (Windows) and LF (Linux).

pp_dos2unix.pro .pro file in ./ directory
pp_extractfields routine in pp_extractfields.pro

Given a string containing a comma-separated sequence of values, returns a string array with each value.

pp_extractfields.pro .pro file in ./ directory
pp_gauss_from_fwhm routine in pp_gauss_from_fwhm.pro

Evaluates a normalized Gaussian distribution of mean zero and the provided width at the provided locations (x).

pp_gauss_from_fwhm.pro .pro file in ./ directory
pp_getcurrentlights routine in pp_getcurrentlights.pro

Retrieves one or both of the default lights made when a surface is created in iTools or Graphics.

pp_getcurrentlights.pro .pro file in ./ directory
pp_gettoolid routine in pp_gettoolid.pro

Returns a valid (if any) tool ID, from the supplied (if any) id.

pp_gettoolid.pro .pro file in ./ directory
pp_histogramlines routine in pp_histogramlines.pro

Makes x and y coordinates to make a histogram plot that looks the usual way, with lines connecting the histogram counts to y=0 at each side of each bin.

pp_histogramlines.pro .pro file in ./ directory
pp_ilegend class
pp_ilegend::additem routine in pp_ilegend__define.pro
pp_ilegend::init routine in pp_ilegend__define.pro
pp_ilegend__define routine in pp_ilegend__define.pro
pp_ilegend__define.pro .pro file in ./ directory

This object allows adding separate legend boxes to an iTool.

pp_ilegendedit routine in pp_ilegendedit.pro
pp_ilegendedit.pro .pro file in ./ directory

This procedure allows editing some properties of an iTool legend that are not easiy accessible programatically.

pp_ilegendeditor class
pp_ilegendeditor::changeproperty routine in pp_ilegendedit.pro
pp_ilegendeditor::init routine in pp_ilegendedit.pro
pp_ilegendeditor__define routine in pp_ilegendedit.pro
pp_integral routine in pp_integral.pro

Calculates the area under the y(x) curve provided.

pp_integral.pro .pro file in ./ directory
pp_isnumber routine in pp_isnumber.pro

Tests a string to determine if it can be converted to a floating point number.

pp_isnumber.pro .pro file in ./ directory
pp_itool_save routine in pp_itool_save.pro

Saves an itool to and isv and/or an eps file, optionally closing the itool afterwards.

pp_itool_save.pro .pro file in ./ directory
pp_ixyouts routine in pp_ixyouts.pro

Similar to xyouts, puts a text into the current itool.

pp_ixyouts.pro .pro file in ./ directory
pp_locate routine in pp_locate.pro

Locates all the occurrences of all different (unique) values in the input array, similarly to what would be produced by running a where() on each unique value of array, but this is much more efficient, since only one pass is done through the array.

pp_locate.pro .pro file in ./ directory
pp_lorentz_from_fwhm routine in pp_lorentz_from_fwhm.pro

Evaluates a normalized Lorentzian distribution of mean zero and the provided width at the provided locations (x).

pp_lorentz_from_fwhm.pro .pro file in ./ directory
pp_multiplot class
pp_multiplot::close routine in pp_multiplot__define.pro

Simple wrapper for window::close, to make pp_multiplot objects look almost like they inherited the window class they use.

pp_multiplot::contour routine in pp_multiplot__define.pro

A wrapper for contour(), which creates the image in the proper place and with the right properties (particularly x/y ranges) in the multiplot grid, adding the object to the list of plots contained by the pp_multiplot object.

pp_multiplot::do_graphic routine in pp_multiplot__define.pro

A wrapper for plot(), image() and contour(), which creates the plot in the proper place and with the right properties (particularly x/y ranges) in the multiplot grid, adding the object to the list of plots contained by the pp_multiplot object.

pp_multiplot::getposition routine in pp_multiplot__define.pro

Calculates the position parameters for a plot in the grid, given its index, and the parameters set in the fields of self.

pp_multiplot::getproperty routine in pp_multiplot__define.pro

Retrieves properties from pp_multiplot objects.

pp_multiplot::image routine in pp_multiplot__define.pro

A wrapper for image(), which creates the image in the proper place and with the right properties (particularly x/y ranges) in the multiplot grid, adding the object to the list of plots contained by the pp_multiplot object.

pp_multiplot::init routine in pp_multiplot__define.pro

Creates an object to hold a grid of plots (from the plot function, of IDL Graphics, not the plot procedure from direct graphics) with no empty space between lines and columns, to use a single vertical/horizontal axis for each line/column of plots.

pp_multiplot::plot routine in pp_multiplot__define.pro

A wrapper for plot(), which creates the plot in the proper place and with the right properties (particularly x/y ranges) in the multiplot grid, adding the object to the list of plots contained by the pp_multiplot object.

pp_multiplot::save routine in pp_multiplot__define.pro

Simple wrapper for window::save, to make pp_multiplot objects look almost like they inherited the window class they use.

pp_multiplot::setproperty routine in pp_multiplot__define.pro

Sets properties for pp_multiplot objects.

pp_multiplot::sync_axes routine in pp_multiplot__define.pro

Synchronizes the axes, across a line and column, or over the whole grid, so that they have the same x/y ranges, and, optionally, the same set x/y axes properties.

pp_multiplot__define routine in pp_multiplot__define.pro

Class definition for pp_multiplot.

pp_multiplot__define.pro .pro file in ./ directory

pp_multiplot objects hold a grid of plots (from the plot function, of IDL Graphics, not the plot procedure from direct graphics) with no empty space between lines and columns, to use a single vertical/horizontal axis for each line/column of plots.

pp_ocircle routine in pp_ocircle.pro

Returns a filled/open/dotted circle object to use as a symbol in an itool.

pp_ocircle.pro .pro file in ./ directory
pp_osquare routine in pp_osquare.pro

Returns a filled/open/dotted square object to use as a symbol in an itool.

pp_osquare.pro .pro file in ./ directory
pp_parsetext routine in pp_parsetext.pro
pp_parsetext.pro .pro file in ./ directory
pp_plot routine in pp_plot.pro

Wrapper to IDL's plot procedure, to allow supressing the first and/or last tick values, so that they do not overlap with neighbouring plots (particularly if using multiplot_pp).

pp_plot.pro .pro file in ./ directory
pp_plot_decideintervals routine in pp_plot.pro
pp_readfits class
pp_readfits::_overloadBracketsRightSide routine in pp_readfits__define.pro
pp_readfits::getproperty routine in pp_readfits__define.pro
pp_readfits::init routine in pp_readfits__define.pro
pp_readfits__define routine in pp_readfits__define.pro
pp_readfits__define.pro .pro file in ./ directory
pp_readpars routine in pp_readpars.pro

Parses a text file or a string array into a hash.

pp_readpars.pro .pro file in ./ directory
pp_readtxt routine in pp_readtxt.pro
pp_readtxt.pro .pro file in ./ directory
pp_resample routine in pp_resample.pro

Resamples the given y(x) function, preserving its area (not just a simple interpolation of the function points, as interpol would do).

pp_resample.pro .pro file in ./ directory
pp_resample_test routine in pp_resample.pro

Examples to test and illustrate the different behaviors of pp_resample.

pp_rise_set routine in pp_rise_set.pro

Calculates rise, transit and set times, plus the time above the horizon (sky time) for the given equatorial coordinates, location and date.

pp_rise_set.pro .pro file in ./ directory
pp_struct_unravel routine in pp_struct_unravel.pro

This function is used to obtain a flat structure from a nested structure.

pp_struct_unravel.pro .pro file in ./ directory
pp_structsubset routine in pp_structsubset.pro

Creates a structure that has a subset of the fields from the input structure.

pp_structsubset.pro .pro file in ./ directory
pp_structtransp routine in pp_structtransp.pro

Given a structure of arrays, creates its transpose (an array of structures).

pp_structtransp.pro .pro file in ./ directory
pp_writepars routine in pp_writepars.pro

Writes a text parameter file from the given hash.

pp_writepars.pro .pro file in ./ directory
prev_day keyword in routine pp_rise_set in file pp_rise_set.pro

By default, returned times of day (for transit, rise and set) are relative to local midnight, so times before midnight are negative.

propagate keyword in routine pp_multiplot::plot in file pp_multiplot__define.pro

Determines the mode of propagating the axes properties (range and endticks not included) of this plot.

propagate keyword in routine pp_multiplot::contour in file pp_multiplot__define.pro

Determines the mode of propagating the axes properties (range and endticks not included) of this plot.

propagate keyword in routine pp_multiplot::image in file pp_multiplot__define.pro

Determines the mode of propagating the axes properties (range and endticks not included) of this plot.

propagate keyword in routine pp_multiplot::do_graphic in file pp_multiplot__define.pro

Determines the mode of propagating the axes properties (range and endticks not included) of this plot.

PSPACING keyword in routine al_legend_pp in file al_legend_pp.pro
PSYM keyword in routine al_legend_pp in file al_legend_pp.pro

Q

quadratic keyword in routine pp_convol in file pp_convol.pro

Passed on to pp_integral.

quadratic keyword in routine pp_integral in file pp_integral.pro

If the method requires interpolation, this is passed on to interpol, to select 3 point quadratic interpolation.

quadratic keyword in routine pp_resample in file pp_resample.pro

Passed on to pp_integral.

R

ra parameter in routine pp_rise_set in file pp_rise_set.pro

Right ascension(s) of the point(s) to calculate the visibility for.

RAD field in class pp_cmfr
rad keyword in routine pp_cmfr::getvariable in file pp_cmfr__define.pro

Total Radiative Luminosity.

RADMECH field in class pp_cmfr
radmech keyword in routine pp_cmfr::getvariable in file pp_cmfr__define.pro

Total (Rad.

range parameter in routine pp_colorbar_range in file pp_colorbar_range.pro

Two-element array with the range to be spanned by the colorbar.

read_csv_fieldnames routine in read_csv_pp_strings.pro
read_csv_pp routine in read_csv_pp.pro

A simple wrapper for read_csv_pp_strings, to assign field names based on either the file's column headers, or a user-supplied string array.

read_csv_pp.pro .pro file in ./ directory
read_csv_pp_strings routine in read_csv_pp_strings.pro

:Description: The READ_CSV function reads data from a "comma-separated value" (comma-delimited) text file into an IDL structure variable.

read_csv_pp_strings.pro .pro file in ./ directory
RECORD_START keyword in routine read_csv_pp_strings in file read_csv_pp_strings.pro
reset keyword in routine multiplot_pp in file multiplot_pp.pro
reverse_hash keyword in routine histogram_pp in file histogram_pp.pro

A hash of reverse indices: has the same number of elements as the output of histogram(), where each element contains an array containing the indices of the elements of the input array that fall into the corresponding bin.

reverse_indices keyword in routine histogram_pp in file histogram_pp.pro

The reverse indices, as an array, unaltered from the output of histogram().

reverse_list keyword in routine histogram_pp in file histogram_pp.pro

A list of reverse indices: has the same number of elements as the output of histogram(), where each element is an array containing the indices of the elements of the input array that fall into the corresponding bin.

reverse_sort keyword in routine pp_locate in file pp_locate.pro

An array with indices into the sorted version of array, to map the elements back into the original order: while sorted_values=array[sort_indices], sorted_values[reverse_sort]=array.

right keyword in routine pp_multiplot::getposition in file pp_multiplot__define.pro

Indicates whether this plot is in the right column of the grid.

RIGHT_LEGEND keyword in routine al_legend_pp in file al_legend_pp.pro
rowmajor keyword in routine multiplot_pp in file multiplot_pp.pro
rows_for_testing keyword in routine read_csv_pp_strings in file read_csv_pp_strings.pro

S

S_DIELIMP field in class pp_cmfr
s_dielimp keyword in routine pp_cmfr::getvariable in file pp_cmfr__define.pro

Total Dielectronic and Implicit Recombination Luminosity.

S_LINE field in class pp_cmfr
s_line keyword in routine pp_cmfr::getvariable in file pp_cmfr__define.pro

Total Line luminosity.

S_MECH field in class pp_cmfr
s_mech keyword in routine pp_cmfr::getvariable in file pp_cmfr__define.pro

Total Mechanical Luminosity.

S_SHOCK field in class pp_cmfr
s_shock keyword in routine pp_cmfr::getvariable in file pp_cmfr__define.pro

Total Shock Luminosity.

S_XRAYH field in class pp_cmfr
s_xrayh keyword in routine pp_cmfr::getvariable in file pp_cmfr__define.pro

X-ray Luminosity (> 1 keV).

S_XRAYL field in class pp_cmfr
s_xrayl keyword in routine pp_cmfr::getvariable in file pp_cmfr__define.pro

X-ray Luminosity (> 0.1 keV).

SHOCK field in class pp_cmfr
shock keyword in routine pp_cmfr::getvariable in file pp_cmfr__define.pro

Total Schock Luminosity.

sigma keyword in routine pp_gauss_from_fwhm in file pp_gauss_from_fwhm.pro

Specifies the width of the Gaussian, as its Full Width Half Maximum (FWHM).

SIZE field in class pp_buffered_vector
skipblank keyword in routine pp_parsetext in file pp_parsetext.pro
sort_indices keyword in routine pp_locate in file pp_locate.pro

The array of indices into array to make it ordered: sort_indices=sort(array).

sorted_values keyword in routine pp_locate in file pp_locate.pro

A sorted copy of array.

spacedelimited keyword in routine pp_parsetext in file pp_parsetext.pro
SPACING keyword in routine al_legend_pp in file al_legend_pp.pro
spline keyword in routine pp_convol in file pp_convol.pro

Passed on to pp_integral.

spline keyword in routine pp_integral in file pp_integral.pro

If the method requires interpolation, this is passed on to interpol, to select spline interpolation.

spline keyword in routine pp_resample in file pp_resample.pro

Passed on to pp_integral.

splitlines keyword in routine pp_parsetext in file pp_parsetext.pro
step keyword in routine pp_convol in file pp_convol.pro

If set, the convolution kernel is a rectangular function of the given width.

str parameter in routine pp_extractfields in file pp_extractfields.pro

The string containing the comma-separated fields.

str parameter in routine pp_ixyouts in file pp_ixyouts.pro

String with the text to put into the itool.

str parameter in routine pp_struct_unravel in file pp_struct_unravel.pro

The structure to be flattened.

strin parameter in routine pp_appendcolumn in file pp_appendcolumn.pro
strin parameter in routine pp_structtransp in file pp_structtransp.pro

The structure to be transposed.

stripquotes keyword in routine pp_parsetext in file pp_parsetext.pro
structin parameter in routine pp_structsubset in file pp_structsubset.pro

The input structure, from which a subset will be taken.

sub1 parameter in routine pp_readfits::_overloadBracketsRightSide in file pp_readfits__define.pro
sub2 parameter in routine pp_readfits::_overloadBracketsRightSide in file pp_readfits__define.pro
sub3 parameter in routine pp_readfits::_overloadBracketsRightSide in file pp_readfits__define.pro
sub4 parameter in routine pp_readfits::_overloadBracketsRightSide in file pp_readfits__define.pro
sub5 parameter in routine pp_readfits::_overloadBracketsRightSide in file pp_readfits__define.pro
sub6 parameter in routine pp_readfits::_overloadBracketsRightSide in file pp_readfits__define.pro
sub7 parameter in routine pp_readfits::_overloadBracketsRightSide in file pp_readfits__define.pro
sub8 parameter in routine pp_readfits::_overloadBracketsRightSide in file pp_readfits__define.pro
SYMSIZE keyword in routine al_legend_pp in file al_legend_pp.pro
sz parameter in routine pp_ocircle in file pp_ocircle.pro

Symbol size.

sz parameter in routine pp_osquare in file pp_osquare.pro

Symbol size.

T

TABLE_HEADER keyword in routine read_csv_pp_strings in file read_csv_pp_strings.pro
TABLE_HEADER keyword in routine write_csv_pp_original in file write_csv_pp.pro
TEST keyword in routine pp_multiplot::plot in file pp_multiplot__define.pro

Passed on to plot(), to make plot() used the test data instead.

TEST keyword in routine pp_multiplot::contour in file pp_multiplot__define.pro

Passed on to plot(), to make plot() used the test data instead.

TEST keyword in routine pp_multiplot::image in file pp_multiplot__define.pro

Passed on to plot(), to make plot() used the test data instead.

TEST keyword in routine pp_multiplot::do_graphic in file pp_multiplot__define.pro

Passed on to plot(), to make plot() used the test data instead.

testonly keyword in routine pp_struct_unravel in file pp_struct_unravel.pro

If set, instead of returning a copy of the structure, only a test is performed, to determine whether the given variable is a nested structure.

TEXTCOLORS keyword in routine al_legend_pp in file al_legend_pp.pro
THICK keyword in routine al_legend_pp in file al_legend_pp.pro
title keyword in routine pp_multiplot::init in file pp_multiplot__define.pro

The title for the entire plot (passed on to the window object).

title property in class pp_multiplot
title keyword in routine pp_multiplot::getproperty in file pp_multiplot__define.pro

The title for the entire plot (which resides in the window object).

title keyword in routine pp_multiplot::setproperty in file pp_multiplot__define.pro

The title for the entire plot (which resides in the window object).

titlesfromfields keyword in routine write_csv_pp in file write_csv_pp.pro

If set, the column titles in the csv file are made by the field names in data1.

tool keyword in routine pp_getcurrentlights in file pp_getcurrentlights.pro

Returns the object associated with the graphic.

tool keyword in routine pp_gettoolid in file pp_gettoolid.pro

Returns the tool object associated with that id.

TOOL field in class pp_ilegend
TOOL field in class pp_ilegendeditor
top keyword in routine pp_multiplot::getposition in file pp_multiplot__define.pro

Indicates whether this plot is in the top line of the grid.

TOP_LEGEND keyword in routine al_legend_pp in file al_legend_pp.pro
trim keyword in routine pp_isnumber in file pp_isnumber.pro

If set, blanks on the string (on both sides) are ignored (a call is made to strtrim).

trim keyword in routine pp_parsetext in file pp_parsetext.pro
trim keyword in routine read_csv_pp_strings in file read_csv_pp_strings.pro
types keyword in routine pp_parsetext in file pp_parsetext.pro
types keyword in routine read_csv_pp_strings in file read_csv_pp_strings.pro
tz keyword in routine pp_rise_set in file pp_rise_set.pro

Time zone of the observing location, in hours (positive is east, contrary to that returned by observatory).

U

unique_indices keyword in routine pp_locate in file pp_locate.pro

The array of indices into the original array of the unique elements.

unique_values keyword in routine pp_locate in file pp_locate.pro

An array containing the unique values present in array.

use_multiplot keyword in routine pp_plot in file pp_plot.pro

If set, xendticks and yendticks are determined by the plot's position in the grid set by multiplot_pp: Plots not on the top row get the top y tick suppressed (yendticks=1), plots not on the right column get the right x tick suppressed (xendticks=1).

use_pointers keyword in routine pp_locate in file pp_locate.pro
USERSYM keyword in routine al_legend_pp in file al_legend_pp.pro

V

value_separator keyword in routine pp_readpars in file pp_readpars.pro

The character to use to separate keys from values.

VARIABLES field in class pp_readfits
variables keyword in routine pp_readfits::getproperty in file pp_readfits__define.pro
variables property in class pp_readfits
VECTORFONT keyword in routine al_legend_pp in file al_legend_pp.pro
verbose keyword in routine multiplot_pp in file multiplot_pp.pro
VERBOSE field in class pp_ilegend
verbose keyword in routine pp_ilegend::init in file pp_ilegend__define.pro
verbose property in class pp_ilegend
verbose keyword in routine write_csv_pp in file write_csv_pp.pro

If set, write_csv_pp will inform which piece of the file it is currently writing

VERTICAL keyword in routine al_legend_pp in file al_legend_pp.pro
vnumber keyword in routine pp_colorbar_range in file pp_colorbar_range.pro

View number (panel number) in the itool where the text should be placed.

vnumber keyword in routine pp_ixyouts in file pp_ixyouts.pro

View number (panel number) in the itool where the text should be placed.

W

width parameter in routine pp_convol_test in file pp_convol.pro

The width for the convolution kernels.

width keyword in routine pp_convol in file pp_convol.pro

The width of the convolution kernel (for step or gaussian).

window keyword in routine pp_multiplot::getproperty in file pp_multiplot__define.pro

The window object, which contains the plots.

window property in class pp_multiplot
write_csv_convert_pp_original routine in write_csv_pp.pro
write_csv_pp routine in write_csv_pp.pro

A simple wrapper for write_csv, to write csv files using a structure's field names as column titles (setting titlesfromfields), ccepting nested structures, and with the option of writing the file by pieces.

write_csv_pp.pro .pro file in ./ directory
write_csv_pp_original routine in write_csv_pp.pro

The WRITE_CSV procedure writes data to a "comma-separated value" (comma-delimited) text file.

X

x parameter in routine pp_contour_paths in file pp_contour_paths.pro

Passed unchanged to contour.

x parameter in routine pp_convol in file pp_convol.pro

An array of locations where the function is sampled.

x parameter in routine pp_gauss_from_fwhm in file pp_gauss_from_fwhm.pro

The locations where the Gaussian is to be evaluated.

x keyword in routine pp_histogramlines in file pp_histogramlines.pro

The x coordinate to use in the plot.

x parameter in routine pp_integral in file pp_integral.pro

An array of locations where the function is sampled.

x parameter in routine pp_lorentz_from_fwhm in file pp_lorentz_from_fwhm.pro

The locations where the Gaussian is to be evaluated.

x parameter in routine pp_plot in file pp_plot.pro

Passed to IDL's plot, see its help.

x parameter in routine pp_resample in file pp_resample.pro

An array of locations where the function is sampled.

xbox keyword in routine pp_convol in file pp_convol.pro

Used when not in local mode, to return the input x values in pairs of equal values, so that plotting xbox,ybox shows the rectangles that are how the input values were interpreted.

xbox keyword in routine pp_integral in file pp_integral.pro

Used when not in local mode, to return the input x values in pairs of equal values, so that plotting xbox,ybox shows the rectangles that are how the input values were interpreted.

xbox keyword in routine pp_resample in file pp_resample.pro

Used when not in local mode, to return the input x values in pairs of equal values, so that plotting xbox,ybox shows the rectangles that are how the input values were interpreted.

xend keyword in routine pp_convol in file pp_convol.pro

If local is not set, returns the location where each input pixel ends.

xend keyword in routine pp_integral in file pp_integral.pro

If local is not set, returns the location where each input pixel ends.

xend keyword in routine pp_resample in file pp_resample.pro

Used when not in local mode, to return the end locations of the bins with center in xout.

XENDTICKS field in class pp_multiplot
xendticks keyword in routine pp_multiplot::plot in file pp_multiplot__define.pro

The mode set for suppressing the first/last x tick labels of the plot: 0 means that both the first and last labels are suppressed, 1 means that only the last label is suppressed, 2 means that only the first label is suppressed, and 3 means that neither is suppressed.

xendticks keyword in routine pp_multiplot::contour in file pp_multiplot__define.pro

The mode set for suppressing the first/last x tick labels of the plot: 0 means that both the first and last labels are suppressed, 1 means that only the last label is suppressed, 2 means that only the first label is suppressed, and 3 means that neither is suppressed.

xendticks keyword in routine pp_multiplot::image in file pp_multiplot__define.pro

The mode set for suppressing the first/last x tick labels of the plot: 0 means that both the first and last labels are suppressed, 1 means that only the last label is suppressed, 2 means that only the first label is suppressed, and 3 means that neither is suppressed.

xendticks keyword in routine pp_multiplot::do_graphic in file pp_multiplot__define.pro

The mode set for suppressing the first/last x tick labels of the plot: 0 means that both the first and last labels are suppressed, 1 means that only the last label is suppressed, 2 means that only the first label is suppressed, and 3 means that neither is suppressed.

xendticks keyword in routine pp_multiplot::getproperty in file pp_multiplot__define.pro

A list, with one element for each column, each being the mode set for suppressing the first/last x tick labels of the corresponding plot: 0 means that both the first and last labels are suppressed, 1 means that only the last label is suppressed, 2 means that only the first label is suppressed, and 3 means that neither is suppressed.

xendticks property in class pp_multiplot
xendticks keyword in routine pp_multiplot::setproperty in file pp_multiplot__define.pro

The modes for suppressing the first/last x tick labels of the corresponding plots: 0 means that both the first and last labels are suppressed, 1 means that only the last label is suppressed, 2 means that only the first label is suppressed, and 3 means that neither is suppressed.

xendticks keyword in routine pp_plot in file pp_plot.pro

Its value determines the kind of supression of the end ticks for the x axis:

xinc keyword in routine pp_convol in file pp_convol.pro

Returns the x values, in increasing order.

xinc keyword in routine pp_integral in file pp_integral.pro

Returns the x values, in increasing order.

xmax keyword in routine pp_integral in file pp_integral.pro

A scalar or array with the end of the range(s) where the area is to be calculated.

xmin keyword in routine pp_integral in file pp_integral.pro

A scalar or array with the start of the range(s) where the area is to be calculated.

xminor keyword in routine pp_plot in file pp_plot.pro
xout parameter in routine pp_resample in file pp_resample.pro

An array of the locations where the y(x) function is to be resampled.

xoutbox keyword in routine pp_resample in file pp_resample.pro

Used when not in local mode, to return the resampled x values in pairs of equal values, so that plotting xoutbox,youtbox shows the rectangles that are how the resampled values are to be interpreted.

XPROPERTIES field in class pp_multiplot
xproperties keyword in routine pp_multiplot::getproperty in file pp_multiplot__define.pro

A list, with one element for each column, each being a hash with the x axes' properties that have been set for the plots on each column.

xproperties property in class pp_multiplot
xproperties keyword in routine pp_multiplot::setproperty in file pp_multiplot__define.pro

The x axes' properties that are set for the plots on each column.

xrange keyword in routine pp_multiplot::plot in file pp_multiplot__define.pro

A 2-element array with the minimum and maximum to use for the x axis.

xrange keyword in routine pp_multiplot::contour in file pp_multiplot__define.pro

A 2-element array with the minimum and maximum to use for the x axis.

xrange keyword in routine pp_multiplot::image in file pp_multiplot__define.pro

A 2-element array with the minimum and maximum to use for the x axis.

xrange keyword in routine pp_multiplot::do_graphic in file pp_multiplot__define.pro

A 2-element array with the minimum and maximum to use for the x axis.

xrange keyword in routine pp_plot in file pp_plot.pro

Passed to IDL's plot, see its help.

XRANGES field in class pp_multiplot
xranges keyword in routine pp_multiplot::getproperty in file pp_multiplot__define.pro

A list, with one element for each column, each being a 2-element array with the minimum and maximum of the x axes for the plots on each column.

xranges property in class pp_multiplot
xranges keyword in routine pp_multiplot::setproperty in file pp_multiplot__define.pro

The minimum and maximum of the x axes for the plots on each column.

xstart keyword in routine pp_convol in file pp_convol.pro

If local is not set, returns the location where each input pixel starts.

xstart keyword in routine pp_integral in file pp_integral.pro

If local is not set, returns the location where each input pixel starts.

xstart keyword in routine pp_resample in file pp_resample.pro

Used when not in local mode, to return the start locations of the bins with center in xout.

xstyle keyword in routine pp_plot in file pp_plot.pro

Passed to IDL's plot, see its help.

xtick_get keyword in routine pp_plot in file pp_plot.pro

Passed to IDL's plot, see its help.

xtickinterval keyword in routine pp_plot in file pp_plot.pro

Passed to IDL's plot, see its help.

xticks keyword in routine pp_plot in file pp_plot.pro

Passed to IDL's plot, see its help.

xtickv keyword in routine pp_plot in file pp_plot.pro

Passed to IDL's plot, see its help.

Y

y parameter in routine pp_contour_paths in file pp_contour_paths.pro

Passed unchanged to contour.

y parameter in routine pp_convol in file pp_convol.pro

An array with the function values corresponding to the locations in x.

y keyword in routine pp_histogramlines in file pp_histogramlines.pro

The y coordinate to use in the plot.

y parameter in routine pp_integral in file pp_integral.pro

An array with the function values corresponding to the locations in x.

y parameter in routine pp_plot in file pp_plot.pro

Passed to IDL's plot, see its help.

y parameter in routine pp_resample in file pp_resample.pro

An array with the function values corresponding to the locations in x.

ybox keyword in routine pp_convol in file pp_convol.pro

Used when not in local mode, to return the input y values in pairs of equal values, so that plotting xbox,ybox shows the rectangles that are how the input values were interpreted.

ybox keyword in routine pp_integral in file pp_integral.pro

Used when not in local mode, to return the input y values in pairs of equal values, so that plotting xbox,ybox shows the rectangles that are how the input values were interpreted.

ybox keyword in routine pp_resample in file pp_resample.pro

Used when not in local mode, to return the input y values in pairs of equal values, so that plotting xbox,ybox shows the rectangles that are how the input values were interpreted.

year keyword in routine pp_rise_set in file pp_rise_set.pro

Year for the observation.

YENDTICKS field in class pp_multiplot
yendticks keyword in routine pp_multiplot::plot in file pp_multiplot__define.pro

The mode set for suppressing the first/last y tick labels of the plot: 0 means that both the first and last labels are suppressed, 1 means that only the last label is suppressed, 2 means that only the first label is suppressed, and 3 means that neither is suppressed.

yendticks keyword in routine pp_multiplot::contour in file pp_multiplot__define.pro

The mode set for suppressing the first/last y tick labels of the plot: 0 means that both the first and last labels are suppressed, 1 means that only the last label is suppressed, 2 means that only the first label is suppressed, and 3 means that neither is suppressed.

yendticks keyword in routine pp_multiplot::image in file pp_multiplot__define.pro

The mode set for suppressing the first/last y tick labels of the plot: 0 means that both the first and last labels are suppressed, 1 means that only the last label is suppressed, 2 means that only the first label is suppressed, and 3 means that neither is suppressed.

yendticks keyword in routine pp_multiplot::do_graphic in file pp_multiplot__define.pro

The mode set for suppressing the first/last y tick labels of the plot: 0 means that both the first and last labels are suppressed, 1 means that only the last label is suppressed, 2 means that only the first label is suppressed, and 3 means that neither is suppressed.

yendticks keyword in routine pp_multiplot::getproperty in file pp_multiplot__define.pro

A list, with one element for each column, each being the mode set for suppressing the first/last y tick labels of the corresponding plot: 0 means that both the first and last labels are suppressed, 1 means that only the last label is suppressed, 2 means that only the first label is suppressed, and 3 means that neither is suppressed.

yendticks property in class pp_multiplot
yendticks keyword in routine pp_multiplot::setproperty in file pp_multiplot__define.pro

The modes for suppressing the first/last y tick labels of the corresponding plots: 0 means that both the first and last labels are suppressed, 1 means that only the last label is suppressed, 2 means that only the first label is suppressed, and 3 means that neither is suppressed.

yendticks keyword in routine pp_plot in file pp_plot.pro

Its value determines the kind of supression of the end ticks for the y axis:

yinc keyword in routine pp_convol in file pp_convol.pro

Returns the y values, in order of increasing x.

yinc keyword in routine pp_integral in file pp_integral.pro

Returns the y values, in order of increasing x.

yminor keyword in routine pp_plot in file pp_plot.pro
youtbox keyword in routine pp_resample in file pp_resample.pro

Used when not in local mode, to return the resampled y values in pairs of equal values, so that plotting xoutbox,youtbox shows the rectangles that are how the resampled values are to be interpreted.

YPROPERTIES field in class pp_multiplot
yproperties keyword in routine pp_multiplot::getproperty in file pp_multiplot__define.pro

A list, with one element for each line, each being a hash with the y axes' properties that have been set for the plots on each line.

yproperties property in class pp_multiplot
yproperties keyword in routine pp_multiplot::setproperty in file pp_multiplot__define.pro

The y axes' properties that are set for the plots on each line.

yrange keyword in routine pp_multiplot::plot in file pp_multiplot__define.pro

A 2-element array with the minimum and maximum to use for the y axis.

yrange keyword in routine pp_multiplot::contour in file pp_multiplot__define.pro

A 2-element array with the minimum and maximum to use for the y axis.

yrange keyword in routine pp_multiplot::image in file pp_multiplot__define.pro

A 2-element array with the minimum and maximum to use for the y axis.

yrange keyword in routine pp_multiplot::do_graphic in file pp_multiplot__define.pro

A 2-element array with the minimum and maximum to use for the y axis.

yrange keyword in routine pp_plot in file pp_plot.pro

Passed to IDL's plot, see its help.

YRANGES field in class pp_multiplot
yranges keyword in routine pp_multiplot::getproperty in file pp_multiplot__define.pro

A list, with one element for each line, each being a 2-element array with the minimum and maximum of the y axes for the plots on each line.

yranges property in class pp_multiplot
yranges keyword in routine pp_multiplot::setproperty in file pp_multiplot__define.pro

The minimum and maximum of the y axes for the plots on each line.

ystyle keyword in routine pp_plot in file pp_plot.pro

Passed to IDL's plot, see its help.

ytick_get keyword in routine pp_plot in file pp_plot.pro

Passed to IDL's plot, see its help.

ytickinterval keyword in routine pp_plot in file pp_plot.pro

Passed to IDL's plot, see its help.

yticks keyword in routine pp_plot in file pp_plot.pro

Passed to IDL's plot, see its help.

ytickv keyword in routine pp_plot in file pp_plot.pro

Passed to IDL's plot, see its help.

Z

z parameter in routine pp_contour_paths in file pp_contour_paths.pro

Passed unchanged to contour.