Documentation for jbiu/

Generated by IDLdoc

Index

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

_

_extra keyword in routine yladder in file yladder.pro
_extra keyword in routine hist_nd_weight in file hist_nd_weight.pro

All extra keywords are passed through to HIST_ND.

_extra keyword in routine getpts in file getpts.pro
_extra keyword in routine jbsymbol in file jbsymbol.pro

All extra keywords (such as /FILL or THICK) are passed to VSYM or USERSYM as appropriate.

_EXTRA keyword in routine plot_binneddata in file plot_binneddata.pro

Extra keywords are passed through to CGPLOT.

_extra keyword in routine plotcumul in file plotcumul.pro

All extra keywords are passed through to CGPLOT.

_extra keyword in routine splineplot in file splineplot.pro
_extra keyword in routine xladder in file xladder.pro
_ref_extra keyword in routine histogram_weight in file histogram_weight.pro

All extra keywords are passed through to HISTOGRAM.

A

a parameter in routine dotp in file dotp.pro

First vector.

a parameter in routine extract_rows in file extract_rows.pro

A CSV structure, of the format read in using READ_CSV.

a parameter in routine sort_rows in file sort_rows.pro

A CSV structure, of the format read in using READ_CSV.

a parameter in routine sprsadd in file sprsadd.pro

Sparse matrix to be added.

a0 parameter in routine wsrad_map in file matchall_sph.pro
a1 parameter in routine wsrad_map in file matchall_sph.pro
a2 parameter in routine wsrad_map in file matchall_sph.pro
absolute keyword in routine plotcumul in file plotcumul.pro

If /ABSOLUTE is set then plot the true cumulative number distribution instead of the fractional cumulative distribution.

addcmd keyword in routine plotcumul in file plotcumul.pro

Sets the /ADDCMD keyword in Coyote Graphics.

ADDCMD keyword in routine plot_binneddata in file plot_binneddata.pro

Sets the /ADDCMD keyword in Coyote Graphics.

addcmd keyword in routine splineplot in file splineplot.pro

Uses the /ADDCMD flag for Coyote Graphics.

aind parameter in routine matchallmap in file matchall_nd.pro
argument parameter in routine between in file between.pro

Scalar or array of numerical argument.

array parameter in routine is_sorted in file is_sorted.pro

An array to check.

array parameter in routine uniqify in file uniqify.pro

An array whose elements are to be uniqued.

array parameter in routine push in file push.pro

An array to which the values are to be added.

astro keyword in routine force_newton in file force_newton.pro

If /ASTRO is set then LENGTHUNIT and MASSUNIT are given in kpc and solar masses respectively, otherwise they are in CGS (Lengthunit in cm, Massunit in grams).

astro keyword in routine potential_newton in file potential_newton.pro

If /ASTRO is set then LENGTHUNIT and MASSUNIT are given in kpc and solar masses respectively, otherwise they are in CGS (Lengthunit in cm, Massunit in grams).

astro/ directory
atanh routine in atanh.pro

Numerically calculate the inverse of the TANH function for real values.

atanh.pro .pro file in math/ directory
augment_inherited_keyword routine in augment_inherited_keyword.pro

Adds keywords to the _EXTRA structure.

augment_inherited_keyword.pro .pro file in misc/ directory
axes keyword in routine shape_iterative in file shape_iterative.pro

An output 3x3 array containing the principal axes.

axis parameter in routine croppedtickmarks in file croppedtickmarks.pro

B

b parameter in routine dotp in file dotp.pro

Second vector.

b parameter in routine rgbindex in file rgbindex.pro

A byte or array of bytes of blue values.

b parameter in routine sprsadd in file sprsadd.pro

Sparse matrix to be added.

between routine in between.pro

Determines if the argument lies between the bounds.

between.pro .pro file in math/ directory
biharmonic_interp routine in biharmonic_interp.pro

Performs biharmonic interpolation for a function defined on a 2D grid.

biharmonic_interp.pro .pro file in math/ directory
bilin_interp routine in bilin_interp.pro

Performs bilinear interpolation for a function defined on a 2D grid.

bilin_interp.pro .pro file in math/ directory
BIN parameter in routine plot_binneddata in file plot_binneddata.pro

Bin width, in x coordinates (if positive) or in data points per bin (if negative).

bin parameter in routine hist_nd_adaptive in file hist_nd_adaptive.pro

Size of highest-resolution pixels in output image.

bin keyword in routine histogram_weight in file histogram_weight.pro

Bin width.

BIN parameter in routine hist_nd_weight in file hist_nd_weight.pro

Bin size.

binsize keyword in routine point_convolve in file point_convolve.pro

Bin sizes for final output grid.

bootstrap_mean routine in bootstrap_mean.pro

Calculates the mean and a confidence limit on the mean based on bootstrap resampling.

bootstrap_mean.pro .pro file in math/ directory
bootstrap_median routine in bootstrap_median.pro

Calculates the median and a confidence limit on the median based on bootstrap resampling.

bootstrap_median.pro .pro file in math/ directory

C

center keyword in routine mean_by_radaz in file mean_by_radaz.pro

Pixel co-ordinate to consider the center.

chisqr keyword in routine jblinfit in file jblinfit.pro

Output variable containing the chi squared values.

COLOR keyword in routine plot_binneddata in file plot_binneddata.pro

Color of plotted points and error bars.

combigen routine in combigen.pro

Generates all possible combinations n-choose-k.

combigen.pro .pro file in math/ directory
CONFLIMIT keyword in routine plot_binneddata in file plot_binneddata.pro

Fraction of the data to enclose in the error bar if /MEDIAN is set.

conflimit keyword in routine bootstrap_mean in file bootstrap_mean.pro

Confidence limit.

conflimit keyword in routine bootstrap_median in file bootstrap_median.pro

Confidence limit.

conflimit keyword in routine percentiles in file percentiles.pro

The fraction of the distribution encompassed.

ConfRegion parameter in routine ML_DISTFIT in file ml_distfit.pro

Lower and upper error estimates of each parameter, marginalized over the other parameters.

CONSTRAINT keyword in routine ML_DISTFIT in file ml_distfit.pro

Name of a user-supplied function that takes a parameter vector as input and returns 1 if the point in parameter space is permitted and 0 if it is not permitted.

contourlevels routine in contourlevels.pro

Calculates the contour level that encloses a given fraction of the data in a multi-dimensional histogram.

contourlevels.pro .pro file in misc/ directory
coords parameter in routine velframe in file velframe.pro

2-element vector of coordinates at which transformation is computed.

correl parameter in routine hessian in file ml_distfit.pro
covar keyword in routine jblinfit in file jblinfit.pro

Output variable containing the covariance matrix.

cropcircle keyword in routine mean_by_radaz in file mean_by_radaz.pro

Set this keyword to crop out the corners of the image, i.e.

croppedtickmarks routine in croppedtickmarks.pro

This function is used as a plug-in to YTICKFORMAT that crops a number to the appropriate number of digits.

croppedtickmarks.pro .pro file in plot/ directory
csvstruct parameter in routine write_csv in file write_csv.pro

Structure containing data.

cutoff keyword in routine point_convolve in file point_convolve.pro

Assume that the kernel may be safely truncated after this many SIGMAs.

D

DATA parameter in routine histogram_weight in file histogram_weight.pro

Values whose histogram is to be taken.

data parameter in routine plotcumul in file plotcumul.pro

Data values.

DATA parameter in routine plot_binneddata in file plot_binneddata.pro

Array containing y coordinates of data points.

data keyword in routine getpts in file getpts.pro

Use data coordinates (default).

datfile parameter in routine jbimatch in file jbimatch.pro

Name of the datfile generated using MSCIMATCH with the "measured" keyword.

dec parameter in routine sky2xy in file sky2xy.pro

Vector of declinations.

dec1 parameter in routine matchall_sph in file matchall_sph.pro

Vector of latitude coordinates, in degrees.

dec1 parameter in routine match_sph in file match_sph.pro

Vector of latitude coordinates, in degrees.

dec2 parameter in routine matchall_sph in file matchall_sph.pro

Vector of latitude coordinates, in degrees.

dec2 parameter in routine match_sph in file match_sph.pro

Vector of latitude coordinates, in degrees.

derivee2xy routine in ml_distfit.pro
device keyword in routine getpts in file getpts.pro

Use device coordinates.

dimension keyword in routine jblinfit in file jblinfit.pro

If X and Y are multi-dimensional arrays, perform the fitting accross this dimension.

dimensions parameter in routine multi2index in file multi2index.pro

An array containing the length of each dimension in the multidimensional array.

dist keyword in routine mM_dist in file mm_dist.pro

Input distance in parsecs.

distance keyword in routine matchall_2d in file matchall_2d.pro

Optional output containing the distances between each pair.

distance keyword in routine matchall_nd in file matchall_nd.pro

Optional output containing the distances between each pair.

distance keyword in routine matchall_sph in file matchall_sph.pro

Optional output containing the distances between each pair.

dotp routine in dotp.pro

Calculates the scalar product of two vectors.

dotp.pro .pro file in math/ directory
double keyword in routine read_csv in file read_csv.pro
DX keyword in routine plot_binneddata in file plot_binneddata.pro

Shifts the x coordinates of the plot locations (only on the plot, not in OX).

E

enclosedfrac parameter in routine contourlevels in file contourlevels.pro

The fraction of data points

ERRORBAR keyword in routine plot_binneddata in file plot_binneddata.pro

If /ERRORBAR is set, then error bars are plotted in the y direction.

extra parameter in routine augment_inherited_keyword in file augment_inherited_keyword.pro

A structure of the form passed via the _EXTRA facility inside a procedure or function.

extract_rows routine in extract_rows.pro

This function extracts rows from a CSV structure (as read using READ_CSV) and returns a new CSV structure.

extract_rows.pro .pro file in io/ directory

F

fakestarlist parameter in routine readfakedolphot in file readfakedolphot.pro

Name of file containing list of fake stars

filename parameter in routine readdolphot in file readdolphot.pro

Name of DOLPHOT output file

filename parameter in routine readfakedolphot in file readfakedolphot.pro

Name of DOLPHOT output file

filename parameter in routine readparam in file readparam.pro

Name of parameter file.

filename parameter in routine write_csv in file write_csv.pro

Name of CSV file to write to.

filename parameter in routine read_csv in file read_csv.pro
FITA keyword in routine ML_DISTFIT in file ml_distfit.pro

Vector of which parameters should be fit (1 for each parameter to be fit, 0 for each parameter to be held constant).

fitsfile parameter in routine sky2xy in file sky2xy.pro

Name of FITS file that contains the WCS to use.

fitsfile parameter in routine xy2sky in file xy2sky.pro

Name of FITS file that contains the WCS to use.

force_newton routine in force_newton.pro

Calculates the gravitational force from a particle distribution at a list of positions.

force_newton.pro .pro file in astro/ directory
frame keyword in routine velframe in file velframe.pro

Output frame.

Function_Name parameter in routine ML_DISTFIT in file ml_distfit.pro

Name of user-supplied function defining the distribution.

fval keyword in routine shape_iterative in file shape_iterative.pro

Iterate until the axis ratios and directions of the axes vary by less than FVAL.

G

g parameter in routine rgbindex in file rgbindex.pro

A byte or array of bytes of green values.

galactic keyword in routine velframe in file velframe.pro

Input coordinates are in galactic coordinates rather than RA and Dec.

getpts routine in getpts.pro

Find the locations of a number of points on an existing plot using CURSOR.

getpts.pro .pro file in plot/ directory
gtstrict keyword in routine between in file between.pro

Argument must be strictly greater than Lowerbound, rather than greater or equal to.

H

hessian routine in ml_distfit.pro
hist_nd_adaptive routine in hist_nd_adaptive.pro

Given a list of particle positions (and optional particle weights), bin sizes, and ranges, creates a density image where the regions with fewer particles are sampled at larger bin sizes.

hist_nd_adaptive.pro .pro file in plot/ directory
hist_nd_weight routine in hist_nd_weight.pro

Wrapper to the dfanning HIST_ND function that calculates a weighted multi-dimensional histogram.

hist_nd_weight.pro .pro file in math/ directory
histeq routine in histeq.pro

Performs histogram equalization scaling of a 2D image.

histeq.pro .pro file in plot/ directory
HISTOGRAM keyword in routine plot_binneddata in file plot_binneddata.pro

Outputs the histogram of number of Data values that contributed to each bin.

histogram_weight routine in histogram_weight.pro

Wrapper to the built-in HISTOGRAM function that calculates a weighted histogram.

histogram_weight.pro .pro file in math/ directory
HORIZONTALBAR keyword in routine plot_binneddata in file plot_binneddata.pro

If /HORIZONTALBAR is set then the routine plots a horizontal line that spans each bin.

I

image parameter in routine mean_by_radaz in file mean_by_radaz.pro

2D image array.

image parameter in routine contourlevels in file contourlevels.pro

A histogram in arbitrary dimensions, e.g.

image parameter in routine histeq in file histeq.pro

Input image (for example, as generated with HIST_2D) containing integer or byte values.

image parameter in routine trueify in file trueify.pro

A 2d byte array image.

index parameter in routine minfinite in file minfinite.pro

The index of the minimum value.

index parameter in routine croppedtickmarks in file croppedtickmarks.pro
inertiatens routine in inertiatens.pro

Calculates the 2nd moment tensor (sometimes incorrectly referred to as the moment of inertia tensor) of a mass distribution specified by a list of particle positions.

inertiatens.pro .pro file in astro/ directory
io/ directory
is_sorted routine in is_sorted.pro

Checks whether an array is already sorted.

is_sorted.pro .pro file in misc/ directory
isotropic keyword in routine xyladder in file xyladder.pro

If set, each panel is a square.

J

jbcrossp routine in jbcrossp.pro

Calculate the cross products between two arrays of 3-vectors.

jbcrossp.pro .pro file in math/ directory
jbimatch routine in jbimatch.pro

jbimatch.pro .pro file in astro/ directory

Determines the relative scaling of different images based on the measured output of the IRAF task MSCIMATCH.

jblinfit routine in jblinfit.pro

Performs least squares fitting to a straight line, but can perform it over one particular dimension for a multi-dimensional data set.

jblinfit.pro .pro file in math/ directory
jbsymbol routine in jbsymbol.pro

Loads one of a series of useful user-defined symbols.

jbsymbol.pro .pro file in plot/ directory

K

k parameter in routine combigen in file combigen.pro

Number of elements in each combination.

L

label parameter in routine augment_inherited_keyword in file augment_inherited_keyword.pro

String containing a new keyword to be added to Extra.

lengthunit keyword in routine potential_newton in file potential_newton.pro

Length unit, in cm (or kpc if /ASTRO is set).

lengthunit keyword in routine force_newton in file force_newton.pro

Length unit, in cm (or kpc if /ASTRO is set).

levelmax keyword in routine hist_nd_adaptive in file hist_nd_adaptive.pro

Maximum number of lower-density levels to use (0=no smoothing).

LIKELIHOOD keyword in routine ML_DISTFIT in file ml_distfit.pro

Outputs an M-dimensional array with the likelihood values over the range of parameter space probed.

LIKERANGE keyword in routine ML_DISTFIT in file ml_distfit.pro

2xM dimensional array containing the bounds of the LIKELIHOOD array.

lomem keyword in routine potential_newton in file potential_newton.pro

If /LOMEM is set then sacrifice efficiency for lower memory usage

lowerbound parameter in routine between in file between.pro

Scalar or array of lower bounds.

ltstrict keyword in routine between in file between.pro

Argument must be strictly less than Upperbound, rather than less or equal to.

M

map parameter in routine wsrad_map in file matchall_sph.pro
mapping keyword in routine histeq in file histeq.pro

Optional output keyword containing a 256-element array with the original values corresponding to each output value.

mass parameter in routine potential_newton in file potential_newton.pro

Mass of each particle.

mass parameter in routine force_newton in file force_newton.pro

Mass of each particle.

masses keyword in routine inertiatens in file inertiatens.pro

An N-element vector of the mass of each point.

masses keyword in routine shape_iterative in file shape_iterative.pro

An N-element vector of the mass of each point.

massunit keyword in routine potential_newton in file potential_newton.pro

Mass unit, in grams (or solar masses if /ASTRO is set).

massunit keyword in routine force_newton in file force_newton.pro

Mass unit, in grams (or solar masses if /ASTRO is set).

match_nd routine in match_nd.pro

For each arbitrarily-dimensioned point in one vector, determines the closest point in a second vector.

match_nd.pro .pro file in astro/ directory
match_sph routine in match_sph.pro

For each angular point in one vector, determines the closest angular match from another vector.

match_sph.pro .pro file in astro/ directory
matchall_2d routine in matchall_2d.pro

Determines which of a set of 2D coordinates are within a given distance from each of a vector of points.

matchall_2d.pro .pro file in astro/ directory
matchall_nd routine in matchall_nd.pro

Determines which of a set of coordinates of arbitratry dimension are a given distance from each of a vector of points.

matchall_nd.pro .pro file in astro/ directory
matchall_sph routine in matchall_sph.pro

Determines which of a set of angular coordinates on the sky (or on a sphere) are within a given angular distance from each of a vector of points.

matchall_sph.pro .pro file in astro/ directory
matchallmap routine in matchall_nd.pro
math/ directory
matrix2quaternion routine in matrix2quaternion.pro

Transforms a rotation matrix into a quaternion.

matrix2quaternion.pro .pro file in math/ directory
max keyword in routine hist_nd_adaptive in file hist_nd_adaptive.pro

ND-element array of maximum positions in final map.

MAX keyword in routine plot_binneddata in file plot_binneddata.pro

Maximum value for bins.

maxdistance parameter in routine match_nd in file match_nd.pro

Maximum D-dimensional distance.

maxdistance parameter in routine matchall_nd in file matchall_nd.pro

Maximum D-dimensional distance.

maxdistance parameter in routine matchall_2d in file matchall_2d.pro

Maximum distance.

maxit keyword in routine shape_iterative in file shape_iterative.pro

Maximum number of iterations to allow.

mean_by_radaz routine in mean_by_radaz.pro

Calculates the mean value of an image in bins of both radius and pie slices of azimuthal angle.

mean_by_radaz.pro .pro file in astro/ directory
measure_errors keyword in routine jblinfit in file jblinfit.pro

Array containing the measurement errors in Y.

MEDIAN keyword in routine plot_binneddata in file plot_binneddata.pro

If /MEDIAN is set then plot the median Y value instead of the mean.

min keyword in routine hist_nd_adaptive in file hist_nd_adaptive.pro

ND-element array of minimum positions in final map.

MIN keyword in routine plot_binneddata in file plot_binneddata.pro

Minimum value for bins.

mindist keyword in routine match_nd in file match_nd.pro

Optional output containing an array of the actual distance to the closest match for each element of P1.

mindist keyword in routine match_sph in file match_sph.pro

Optional output containing an array of the actual distance to the closest match for each element of Ra1, Dec1.

minfinite routine in minfinite.pro

Calculate the minimum non-zero value of an array.

minfinite.pro .pro file in math/ directory
misc/ directory
ML_DISTFIT routine in ml_distfit.pro

Performs maximum likelihood fitting of a distribution.

ml_distfit.pro .pro file in math/ directory
ML_NNL routine in ml_distfit.pro
mM keyword in routine mM_dist in file mm_dist.pro

Input distance modulus m-M.

mM_dist routine in mm_dist.pro

Converts between distance modulus m-M and distance in parsecs.

mm_dist.pro .pro file in astro/ directory
multi2index routine in multi2index.pro

Translates multidimensional indices into flat indices (the inverse of ARRAY_INDICES).

multi2index.pro .pro file in misc/ directory

N

n parameter in routine combigen in file combigen.pro

Maximum number.

n parameter in routine vecrep in file vecrep.pro

Number of times to replicate

name parameter in routine hessian in file ml_distfit.pro
name parameter in routine derivee2xy in file ml_distfit.pro
nan keyword in routine mean_by_radaz in file mean_by_radaz.pro

Set this keyword to check for NaN or Infinity when calculating the means.

nboot keyword in routine bootstrap_mean in file bootstrap_mean.pro

Number of bootstrap resamplings.

nboot keyword in routine bootstrap_median in file bootstrap_median.pro

Number of bootstrap resamplings.

ngrid parameter in routine wsrad_map in file matchall_sph.pro
ngrid parameter in routine matchallmap in file matchall_nd.pro
nhstfilters keyword in routine readfakedolphot in file readfakedolphot.pro

If this is set to a number greater than 0, the output is assumed to have been generated using DOLPHOT/ACS or DOLPHOT/WFC3, and to have NHSTFILTERS photometry blocks at the beginning that give the combined results of each filter (unless Nimg is 1).

nhstfilters keyword in routine readdolphot in file readdolphot.pro

If this is set to a number greater than 0, the output is assumed to have been generated using DOLPHOT/ACS or DOLPHOT/WFC3, and to have NHSTFILTERS photometry blocks at the beginning that give the combined results of each filter.

nimg parameter in routine readfakedolphot in file readfakedolphot.pro

Number of images

nimg parameter in routine readdolphot in file readdolphot.pro

Number of images

noconvol keyword in routine point_convolve in file point_convolve.pro

If /NOCONVOL is set than use manual summation rather than an FFT.

nofft keyword in routine point_convolve in file point_convolve.pro

If /NOFFT is set then use the built-in CONVOL routine rather than an FFT.

NOPLOT keyword in routine plot_binneddata in file plot_binneddata.pro

If /NOPLOT is set then do not create a plot.

normal keyword in routine getpts in file getpts.pro

Use normalized coordinates.

nspline keyword in routine splineplot in file splineplot.pro

Number of points to use to draw the curve.

ntheta keyword in routine mean_by_radaz in file mean_by_radaz.pro

Number of azimuthal bins.

nthreshold keyword in routine hist_nd_adaptive in file hist_nd_adaptive.pro

Minimum number of particles within a pixel before going to the next level.

null keyword in routine read_csv in file read_csv.pro
nwithin parameter in routine matchall_2d in file matchall_2d.pro

A vector containing the number of matches for each of X1,Y1.

nwithin parameter in routine matchall_nd in file matchall_nd.pro

A vector containing the number of matches for each entry in P1.

nwithin parameter in routine matchall_sph in file matchall_sph.pro

A vector containing the number of matches for each of Ra1,Dec1.

nx parameter in routine derivee2xy in file ml_distfit.pro
nx parameter in routine xladder in file xladder.pro

Number of plots.

nx parameter in routine xyladder in file xyladder.pro

Number of plots in the horizontal direction.

ny parameter in routine derivee2xy in file ml_distfit.pro
ny parameter in routine xyladder in file xyladder.pro

Number of plots in the vertical direction.

ny parameter in routine yladder in file yladder.pro

Number of plots.

O

ODATA keyword in routine plot_binneddata in file plot_binneddata.pro

Optional output of plotted y values.

OERR keyword in routine plot_binneddata in file plot_binneddata.pro

Optional output 2xNbin array containg the ends of the error bars.

one_to_one keyword in routine match_nd in file match_nd.pro

Enforces one-to-one matching.

one_to_one keyword in routine match_sph in file match_sph.pro

Enforces one-to-one matching.

ord routine in ord.pro

Calculates the ordinal of each value of an array in terms of the sorted values.

ord.pro .pro file in math/ directory
order keyword in routine sort_rows in file sort_rows.pro

A vector of indices of the new sorted order.

outnames parameter in routine pnginterp in file pnginterp.pro

An array of file names to write the output images to.

overplot keyword in routine splineplot in file splineplot.pro

Plots over existing plot.

OVERPLOT keyword in routine plot_binneddata in file plot_binneddata.pro

If /OVERPLOT is set then overplot binned data points on an existing plot.

overplot keyword in routine plotcumul in file plotcumul.pro

If /OVERPLOT is set then overplot the cumulative distribution over top of the existing plot coordinates.

OX keyword in routine plot_binneddata in file plot_binneddata.pro

Optional output of x coordinates of bins.

P

P parameter in routine ML_NNL in file ml_distfit.pro
p1 parameter in routine match_nd in file match_nd.pro

N1 x D array of D-dimensional coordinates.

p1 parameter in routine matchall_nd in file matchall_nd.pro

N1xD array of D-dimensional coordinates.

p2 parameter in routine match_nd in file match_nd.pro

N2 x D array of D-dimensional coordinates.

p2 parameter in routine matchall_nd in file matchall_nd.pro

N2xD array of D-dimensional coordinates.

param parameter in routine hessian in file ml_distfit.pro
Parm parameter in routine ML_DISTFIT in file ml_distfit.pro

Variable containing initial guesses for parameters on input and best fit values on output.

percentiles routine in percentiles.pro

Determines what range of a distribution lies within a percentile range.

percentiles.pro .pro file in math/ directory
plot/ directory
plot_binneddata routine in plot_binneddata.pro

Takes a set of X,Y data and plots the mean y value for points binned by their x coordinate.

plot_binneddata.pro .pro file in plot/ directory
plotcumul routine in plotcumul.pro

Plots the cumulative distribution of a set of data.

plotcumul.pro .pro file in plot/ directory
png1 parameter in routine pnginterp in file pnginterp.pro

String containing the name of the first (t=0) image.

png2 parameter in routine pnginterp in file pnginterp.pro

String containing the name of the second (t=1) image.

pnginterp routine in pnginterp.pro

Interpolates between two grayscale .PNG images.

pnginterp.pro .pro file in misc/ directory
point_convolve routine in point_convolve.pro

Convolves a list of N-dimensional points with a Gaussian kernel.

point_convolve.pro .pro file in math/ directory
points keyword in routine point_convolve in file point_convolve.pro

Array of MxN points for M dimensions and N particles (required).

pos parameter in routine shape_iterative in file shape_iterative.pro

An Nx3 array specifying the 3d positions of the N particles that make up the mass distribution.

pos parameter in routine inertiatens in file inertiatens.pro

An Nx3 array specifying the 3d positions of the N particles that make up the mass distribution.

potential_newton routine in potential_newton.pro

Calculates the gravitational potential from a particle distribution at a list of positions.

potential_newton.pro .pro file in astro/ directory
prob keyword in routine jblinfit in file jblinfit.pro

Output variable containing the probability of obtaining a fit with at least this chi squared value.

push routine in push.pro

Adds an element to the end of a (possibly non-existent) array.

push.pro .pro file in misc/ directory

Q

quat parameter in routine quat2rotaxis in file quat2rotaxis.pro

A quaternion specifying a rotation.

quat2rotaxis routine in quat2rotaxis.pro

Returns the net axis and angle of the rotation specified by the input quaternion.

quat2rotaxis.pro .pro file in math/ directory

R

r parameter in routine rgbindex in file rgbindex.pro

A byte or array of bytes of red values.

r2weight keyword in routine inertiatens in file inertiatens.pro

If /R2WEIGHT is specified then particles are downweighted by a factor of 1/r^2 so that all particles have equal effect regardless of radius.

r2weight keyword in routine shape_iterative in file shape_iterative.pro

If /R2WEIGHT is specified then particles are downweighted by a factor of 1/r^2 so that all particles have equal effect regardless of radius.

ra parameter in routine sky2xy in file sky2xy.pro

Vector of right ascensions.

ra1 parameter in routine match_sph in file match_sph.pro

Vector of longitude coordinates, in degrees.

ra1 parameter in routine matchall_sph in file matchall_sph.pro

Vector of longitude coordinates, in degrees.

ra2 parameter in routine match_sph in file match_sph.pro

Vector of longitude coordinates, in degrees.

ra2 parameter in routine matchall_sph in file matchall_sph.pro

Vector of longitude coordinates, in degrees.

radius parameter in routine shape_iterative in file shape_iterative.pro

Radius at which to compute the shape.

range keyword in routine point_convolve in file point_convolve.pro

Array of Mx2, containning the extent of output grid in each dimension.

rbin keyword in routine mean_by_radaz in file mean_by_radaz.pro

Size of radial bins (in pixels).

read_csv routine in read_csv.pro
read_csv.pro .pro file in io/ directory

Reads a comma-separated-variables (CSV) file into a structure.

readdolphot routine in readdolphot.pro

Read the output of the DOLPHOT photometry package into easier-to- use data structures.

readdolphot.pro .pro file in astro/ directory
readfakedolphot routine in readfakedolphot.pro

Read the output of the DOLPHOT photometry package when run in artificial star mode into easier-to-use data structures.

readfakedolphot.pro .pro file in astro/ directory
readparam routine in readparam.pro

Reads in a parameter file containing "key = value" pairs.

readparam.pro .pro file in io/ directory
restore_plotsysvars routine in restore_plotsysvars.pro

Restore important plotting system variables that were saved using SAVE_PLOTSYSVARS.

restore_plotsysvars.pro .pro file in plot/ directory
reverse_indices keyword in routine hist_nd_weight in file hist_nd_weight.pro

Outputs the reverse index array.

reverse_indices keyword in routine histogram_weight in file histogram_weight.pro

Outputs the reverse index array.

REVERSE_INDICES keyword in routine plot_binneddata in file plot_binneddata.pro

Outputs the reverse indices of the histogram.

rgbindex routine in rgbindex.pro

Translates RGB triplets into colour indices for 24-bit decomposed mode.

rgbindex.pro .pro file in plot/ directory
rms routine in rms.pro

Calculates the root-mean-square of a set of values.

rms.pro .pro file in math/ directory
ROBUST keyword in routine plot_binneddata in file plot_binneddata.pro

If /ROBUST is set then use ROBUST_MEAN to calculate the mean Y value.

rotation keyword in routine mean_by_radaz in file mean_by_radaz.pro

Start the first azimuthal bin at an angle ROTATION (in radians) from the x-axis.

rotmatrix parameter in routine matrix2quaternion in file matrix2quaternion.pro

A 3x3 rotation matrix.

S

save_plotsysvars routine in save_plotsysvars.pro

Save important plotting system variables so that they can be restored later using RESTORE_PLOTSYSVARS.

save_plotsysvars.pro .pro file in plot/ directory
sech routine in sech.pro

Calculates the hyperbolic inverse cosine function (sech).

sech.pro .pro file in math/ directory
shape_iterative routine in shape_iterative.pro

Given a 3-dimensional distribution of points, determines the best ellipsoidal shape using particles in an interatively-defined ellipsoid (or ellipsoidal shell) of the same shape.

shape_iterative.pro .pro file in astro/ directory
shell keyword in routine shape_iterative in file shape_iterative.pro

Use an ellipsoidal shell rather than a filled ellipsoid.

sigma keyword in routine point_convolve in file point_convolve.pro

Width of Gaussian kernel.

sigma keyword in routine jblinfit in file jblinfit.pro

Output variable containing uncertainties in fit parameters.

sign routine in sign.pro

Returns the sign of the argument.

sign.pro .pro file in math/ directory
sixtyv routine in sixtyv.pro

Converts a vector of decimal numbers to sexigesimal (vector version of SIXTY in the astronomy library).

sixtyv.pro .pro file in astro/ directory
sky2xy routine in sky2xy.pro

Converts between sky coordinates and pixel coordinates of a FITS image using the WCSTOOLS sky2xy routine.

sky2xy.pro .pro file in astro/ directory
softening keyword in routine potential_newton in file potential_newton.pro

Plummer softening length.

softening keyword in routine force_newton in file force_newton.pro

Plummer softening length.

sort_rows routine in sort_rows.pro

This function re-sorts the rows in a CSV structure (as read using READ_CSV).

sort_rows.pro .pro file in io/ directory
sphrad parameter in routine matchall_sph in file matchall_sph.pro

Maximum angular distance, in degrees.

sphrad parameter in routine match_sph in file match_sph.pro

Maximum angular distance, in degrees.

splineplot routine in splineplot.pro

Plots a 2D spline curve using a set of given coordinates.

splineplot.pro .pro file in plot/ directory
sprsadd routine in sprsadd.pro

Adds two sparse matrices (as generated by SPRSIN).

sprsadd.pro .pro file in math/ directory
string keyword in routine read_csv in file read_csv.pro
string keyword in routine sky2xy in file sky2xy.pro

If set, Ra and Dec are strings in HH:MM:SS, DD:MM:SS format.

string keyword in routine xy2sky in file xy2sky.pro

Output strings of HH:MM:SS and DD:MM:SS format.

subscripts parameter in routine multi2index in file multi2index.pro

Multidimensional indices.

sym parameter in routine jbsymbol in file jbsymbol.pro

Symbol number, chosen from: :

T

tanh routine in tanh.pro

Calculates the hyperbolic tan function (tanh).

tanh.pro .pro file in math/ directory
times parameter in routine pnginterp in file pnginterp.pro

One or more times at which to write interpolated images.

tmp_name parameter in routine valid_tag_name in file read_csv.pro
trueify routine in trueify.pro

Turn an indexed image into an RGB-decomposed image based on the current colour table.

trueify.pro .pro file in plot/ directory

U

ulon64 keyword in routine read_csv in file read_csv.pro
uniqify routine in uniqify.pro

Returns the unique elements of an array.

uniqify.pro .pro file in misc/ directory
uniqlist keyword in routine bootstrap_median in file bootstrap_median.pro

If independent points are associated with more than one element of Values, then they should all be included or excluded together in the bootstrap resampling.

uniqlist keyword in routine bootstrap_mean in file bootstrap_mean.pro

If independent points are associated with more than one element of Values, then they should all be included or excluded together in the bootstrap resampling.

unweighted keyword in routine hist_nd_weight in file hist_nd_weight.pro

Outputs the unweighted histogram.

unweighted keyword in routine histogram_weight in file histogram_weight.pro

Outputs the unweighted histogram.

upperbound parameter in routine between in file between.pro

Scalar or array of upper bounds.

usemap keyword in routine matchallmap in file matchall_nd.pro
usemap parameter in routine wsrad_map in file matchall_sph.pro

V

v parameter in routine extract_rows in file extract_rows.pro

A vector of indices of the rows to extract.

v parameter in routine hist_nd_adaptive in file hist_nd_adaptive.pro

An NDxN element array of the ND-dimensional positions of the N particles.

V parameter in routine hist_nd_weight in file hist_nd_weight.pro

Values whose histogram is to be taken.

v1 parameter in routine jbcrossp in file jbcrossp.pro

First 3xN array.

v2 keyword in routine readdolphot in file readdolphot.pro

If /V2 set, then read in DOLPHOT 2 output (slightly changed from version 1)

v2 parameter in routine jbcrossp in file jbcrossp.pro

Second 3xN array.

valid_tag_name routine in read_csv.pro
value parameter in routine augment_inherited_keyword in file augment_inherited_keyword.pro

Value to assign to the keyword.

value parameter in routine push in file push.pro

A value to be added to the end of Array.

value parameter in routine croppedtickmarks in file croppedtickmarks.pro
values parameter in routine percentiles in file percentiles.pro

Array containing the distribution.

values parameter in routine bootstrap_mean in file bootstrap_mean.pro

A vector of values whose mean and error is to be calculated.

values parameter in routine bootstrap_median in file bootstrap_median.pro

A vector of values whose median and error is to be calculated.

values parameter in routine ord in file ord.pro

A vector of values.

vec parameter in routine vecrep in file vecrep.pro

1D vector to replicate

vecrep routine in vecrep.pro

Replicates a vector a given number of times.

vecrep.pro .pro file in misc/ directory
velframe routine in velframe.pro

Converts radial velocities between Local Standard of Rest, Heliocentric and Galactocentric velocity frames.

velframe.pro .pro file in astro/ directory
verbose keyword in routine shape_iterative in file shape_iterative.pro

Print information about each iteration.

verbose keyword in routine getpts in file getpts.pro

Print out each data point as it is selected.

vgsr keyword in routine velframe in file velframe.pro

Input velocity in Galactic standard of rest frame.

vhelio keyword in routine velframe in file velframe.pro

Input velocity in heliocentric frame.

vlsr keyword in routine velframe in file velframe.pro

Input velocity in LSR frame.

W

wcstoolsdir keyword in routine sky2xy in file sky2xy.pro

Path to the location of the binary sky2xy files in wcstools.

wcstoolsdir keyword in routine xy2sky in file xy2sky.pro

Path to the location of the binary xy2sky in wcstools.

weight keyword in routine histogram_weight in file histogram_weight.pro

A vector of the same length as Data with the weights for each data value.

weight keyword in routine hist_nd_adaptive in file hist_nd_adaptive.pro

Array of weights for each particle.

weight keyword in routine point_convolve in file point_convolve.pro

An array of length N containing the weight to assign to each point.

weight keyword in routine hist_nd_weight in file hist_nd_weight.pro

A vector of the same dimensions as V with the weights for each data value.

window keyword in routine splineplot in file splineplot.pro

Uses the /WINDOW flag for Coyote Graphics.

WINDOW keyword in routine plot_binneddata in file plot_binneddata.pro

Sets the /WINDOW keyword in Coyote Graphics.

window keyword in routine plotcumul in file plotcumul.pro

Sets the /WINDOW keyword in Coyote Graphics.

write_csv routine in write_csv.pro

Writes a comma-separated-variables (CSV) file from a CSV-style structure as read in by READ_CSV.

write_csv.pro .pro file in io/ directory
wsrad_map routine in matchall_sph.pro

X

x parameter in routine force_newton in file force_newton.pro

X coordinates at which to calculate forces.

x parameter in routine potential_newton in file potential_newton.pro

X coordinates at which to calculate potential.

x parameter in routine sixtyv in file sixtyv.pro

One or more decimal values, in degrees or hours.

x parameter in routine xy2sky in file xy2sky.pro

Vector of x coordinates.

x parameter in routine atanh in file atanh.pro

Argument to atanh.

x parameter in routine biharmonic_interp in file biharmonic_interp.pro

Vector containing the x-locations of the grid points at which the function is defined.

x parameter in routine bilin_interp in file bilin_interp.pro

Vector containing the x-locations of the grid points at which the function is defined.

x parameter in routine jblinfit in file jblinfit.pro

Array containing the independent variable values.

x parameter in routine minfinite in file minfinite.pro

Array

X parameter in routine ML_DISTFIT in file ml_distfit.pro

Array of input data values.

X parameter in routine rms in file rms.pro

Array of values.

x parameter in routine sech in file sech.pro

Argument to sech (may be an array).

x parameter in routine sign in file sign.pro

Numerical argument (may be an array).

x parameter in routine tanh in file tanh.pro

Argument to tanh (may be an array).

x parameter in routine getpts in file getpts.pro

Array of x coordinates.

X parameter in routine plot_binneddata in file plot_binneddata.pro

Array containing x coordinates of data points.

x1 parameter in routine matchall_2d in file matchall_2d.pro

Vector of X coordinates.

x2 parameter in routine matchall_2d in file matchall_2d.pro

Vector of X coordinates.

xcoords parameter in routine splineplot in file splineplot.pro

Array of x coordinates of curve.

xladder routine in xladder.pro

Creates horizontally-stacked ladder plots.

xladder.pro .pro file in plot/ directory
xout parameter in routine bilin_interp in file bilin_interp.pro

A vector of x-locations at which the function is to be interpolated.

xout parameter in routine biharmonic_interp in file biharmonic_interp.pro

A vector of x-locations at which the function is to be interpolated.

xparam parameter in routine derivee2xy in file ml_distfit.pro
xpart parameter in routine potential_newton in file potential_newton.pro

X coordinates of particle positions defining the mass distribution.

xpart parameter in routine force_newton in file force_newton.pro

X coordinates of particle positions defining the mass distribution.

xrange keyword in routine yladder in file yladder.pro

The x-range of the plots in normalized units.

xrange keyword in routine xladder in file xladder.pro

The x-range of the plots in normalized units.

xrange keyword in routine xyladder in file xyladder.pro

The x-range of the plots in normalized units.

xy2sky routine in xy2sky.pro

Converts between pixel coordinates of a FITS image and sky coordinates using the WCSTOOLS xy2sky routine.

xy2sky.pro .pro file in astro/ directory
xyladder routine in xyladder.pro

Creates horizontally- and vertically-stacked ladder plots.

xyladder.pro .pro file in plot/ directory

Y

y parameter in routine getpts in file getpts.pro

Array of y coordinates.

y parameter in routine potential_newton in file potential_newton.pro

Y coordinates at which to calculate potential.

y parameter in routine xy2sky in file xy2sky.pro

Vector of y coordinates.

y parameter in routine biharmonic_interp in file biharmonic_interp.pro

Vector containing the y-locations of the grid points at which the function is defined.

y parameter in routine bilin_interp in file bilin_interp.pro

Vector containing the y-locations of the grid points at which the function is defined.

y parameter in routine force_newton in file force_newton.pro

Y coordinates at which to calculate forces.

y parameter in routine jblinfit in file jblinfit.pro

Array containing the dependent variable values.

y1 parameter in routine matchall_2d in file matchall_2d.pro

Vector of Y coordinates.

y2 parameter in routine matchall_2d in file matchall_2d.pro

Vector of Y coordinates.

ycoords parameter in routine splineplot in file splineplot.pro

Array of y coordinates of curve.

yfit keyword in routine jblinfit in file jblinfit.pro

Output variable containing the values of the dependent variable at the X locations, according to the fit.

yladder routine in yladder.pro

Creates vertically-stacked ladder plots.

yladder.pro .pro file in plot/ directory
yout parameter in routine bilin_interp in file bilin_interp.pro

A vector of y-locations at which the function is to be interpolated.

yout parameter in routine biharmonic_interp in file biharmonic_interp.pro

A vector of y-locations at which the function is to be interpolated.

ypart parameter in routine potential_newton in file potential_newton.pro

Y coordinates of particle positions defining the mass distribution.

ypart parameter in routine force_newton in file force_newton.pro

Y coordinates of particle positions defining the mass distribution.

yrange keyword in routine xladder in file xladder.pro

The y-range of the plots in normalized units.

yrange keyword in routine xyladder in file xyladder.pro

The y-range of the plots in normalized units.

yrange keyword in routine yladder in file yladder.pro

The y-range of the plots in normalized units.

Z

z parameter in routine force_newton in file force_newton.pro

Z coordinates at which to calculate forces.

z parameter in routine potential_newton in file potential_newton.pro

Z coordinates at which to calculate potential.

z parameter in routine biharmonic_interp in file biharmonic_interp.pro

2D array containing the values of the function defined at each X,Y grid point.

z parameter in routine bilin_interp in file bilin_interp.pro

2D array containing the values of the function defined at each X,Y grid point.

z parameter in routine zphase in file zphase.pro

Complex number or array.

zero keyword in routine jbimatch in file jbimatch.pro

Fit zero points if /ZERO is set.

zeroeq keyword in routine histeq in file histeq.pro

Set this keyword to perform equalization using all pixels, even those with a value of zero.

zpart parameter in routine force_newton in file force_newton.pro

Z coordinates of particle positions defining the mass distribution.

zpart parameter in routine potential_newton in file potential_newton.pro

Z coordinates of particle positions defining the mass distribution.

zphase routine in zphase.pro

Calculates the phase angle of a complex number.

zphase.pro .pro file in math/ directory