Documentation for pp_lib

Generated by IDLdoc

Directory: ./

Contents

.pro files

al_legend_pp.pro

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).

multiplot_pp.pro

pp_appendcolumn.pro
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_buffered_vector__define.pro

pp_cmap.pro

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

pp_cmap_show.pro

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

pp_cmfr__define.pro

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

pp_cmfread.pro

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

pp_colorbar_range.pro

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

pp_contour_paths.pro

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

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_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_extractfields.pro

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

pp_gauss_from_fwhm.pro

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

pp_getcurrentlights.pro

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

pp_gettoolid.pro

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

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_ilegend__define.pro

This object allows adding separate legend boxes to an iTool.

pp_ilegendedit.pro

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

pp_integral.pro

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

pp_isnumber.pro

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

pp_itool_save.pro

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

pp_ixyouts.pro

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

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_lorentz_from_fwhm.pro

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

pp_multiplot__define.pro

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.pro

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

pp_osquare.pro

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

pp_parsetext.pro
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_readfits__define.pro
pp_readpars.pro

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

pp_readtxt.pro
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_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_struct_unravel.pro

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

pp_structsubset.pro

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

pp_structtransp.pro

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

pp_writepars.pro

Writes a text parameter file from the given hash.

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_strings.pro

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

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.