starlink.kappa

Runs commands from the Starlink KAPPA package.

Autogenerated from the starlink .hlp and .ifl files, by starlink-pywrapper/helperscripts/generate_functions.py.

Starlink version: 2018A b6ca36bf8884802759017298539489d11795861e (2018-07-06 09:36:39)

Functions

add(in1, in2, out, **kwargs)	Adds two NDF data structures.
align2d(in_, ref, **kwargs)	Aligns a pair of two-dimensional NDFs by minimising the residuals
aperadd(ndf, centre, diam, **kwargs)	Integrates pixel values within an aperture of an NDF.
ardgen(ardout, shape, option, **kwargs)	Creates a text file describing selected regions of an image.
ardmask(in_, ardfile, out, **kwargs)	Uses an ARD file to set some pixels of an NDF to be bad.
ardplot(ardfile, **kwargs)	Plot regions described in an ARD file.
axconv(ndf, **kwargs)	Expands spaced axes in an NDF into the primitive form.
axlabel(ndf, label, dim, **kwargs)	Sets a new label value for an axis within an NDF data structure.
axunits(ndf, units, dim, **kwargs)	Sets a new units value for an axis within an NDF data structure.
beamfit(ndf, **kwargs)	Fits beam features in a two-dimensional NDF.
block(in_, out, box, **kwargs)	Smooths an NDF using an n-dimensional rectangular box filter.
cadd(in_, scalar, out, **kwargs)	Adds a scalar to an NDF data structure.
calc(exp, **kwargs)	Evaluates a mathematical expression.
calpol(in1, in2, in3, in4, p, theta, i, **kwargs)	Calculates polarisation parameters.
carpet(in_, out, **kwargs)	Creates a cube representing a carpet plot of an image.
cdiv(in_, scalar, out, **kwargs)	Divides an NDF by a scalar.
centroid(ndf, **kwargs)	Finds the centroids of star-like features in an NDF.
chain(in_, c1, **kwargs)	Concatenates a series of vectorized NDFs.
chanmap(in_, out, axis, nchan, shape, **kwargs)	Creates a channel map from a cube NDF by compressing slices along
chpix(in_, out, section, newval, **kwargs)	Replaces the values of selected pixels in an NDF.
clinplot(ndf, **kwargs)	Draws a spatial grid of line plots for an axis of a cube NDF.
cmult(in_, scalar, out, **kwargs)	Multiplies an NDF by a scalar.
colcomp(inr, ing, inb, out, lut, **kwargs)	Produces a colour composite of up to three 2-dimensional NDFs.
collapse(in_, out, axis, **kwargs)	Reduce the number of axes in an N-dimensional NDF by compressing
compadd(in_, out, compress, **kwargs)	Reduces the size of an NDF by adding values in rectangular boxes.
compave(in_, out, compress, **kwargs)	Reduces the size of an NDF by averaging values in rectangular
compick(in_, out, compress, **kwargs)	Reduces the size of an NDF by picking equally spaced pixels.
configecho(name, config, **kwargs)	Displays one or more configuration parameters.
contour(ndf, **kwargs)	Contours a 2-d NDF.
convolve(in_, psf, out, xcentre, ycentre, …)	Convolves a pair of NDFs where the smoothing NDF is one- or
copybad(in_, ref, out, **kwargs)	Copies bad pixels from one NDF file to another.
creframe(out, **kwargs)	Generates a test two-dimensional NDF with a selection of several
csub(in_, scalar, out, **kwargs)	Subtracts a scalar from an NDF data structure.
cumulvec(in_, out, **kwargs)	Sums the values cumulatively in a one-dimensional NDF.
cursor(*args, **kwargs)	Reports the co-ordinates of positions selected using the cursor.
display(in_, **kwargs)	Displays a one- or two-dimensional NDF.
div(in1, in2, out, **kwargs)	Divides one NDF data structure by another.
drawnorth(*args, **kwargs)	Draws arrows parallel to the axes.
drawsig(ndf, nsigma, **kwargs)	Draws +/-n standard-deviation lines on a line plot.
elprof(in_, out, **kwargs)	Creates a radial or azimuthal profile of a 2-dimensional image.
erase(object, **kwargs)	Erases an HDS object.
errclip(in_, out, limit, **kwargs)	Removes pixels with large errors from an NDF.
excludebad(in_, out, **kwargs)	Excludes bad rows or columns from a two-dimensional NDF.
expon(in_, out, base, **kwargs)	Takes the exponential (specified base) of an NDF data structure.
ffclean(in_, out, clip, box, **kwargs)	Removes defects from a substantially flat one-, two- or
fillbad(in_, out, **kwargs)	Removes regions of bad values from an NDF.
fitsdin(files, out, **kwargs)	Reads a FITS disc file composed of simple, group or table objects.
fitsedit(*args, **kwargs)	Edits the FITS extension of an NDF.
fitsexist(ndf, keyword, **kwargs)	Inquires whether or not a keyword exists in a FITS extension.
fitsexp(ndf, table, **kwargs)	Exports NDF-extension information into an NDF FITS extension.
fitshead(*args, **kwargs)	Lists the headers of FITS files.
fitsimp(ndf, table, xname, xtype, **kwargs)	Imports FITS information into an NDF extension.
fitslist(in_, **kwargs)	Lists the FITS extension of an NDF.
fitsmod(ndf, keyword, edit, value, comment, …)	Edits an NDF FITS extension via a text file or parameters.
fitstext(ndf, file, **kwargs)	Creates an NDF FITS extension from a text file.
fitsurface(ndf, **kwargs)	Fits a polynomial surface to two-dimensional data array.
fitsval(ndf, keyword, **kwargs)	Reports the value of a keyword in the FITS airlock.
fitswrite(*args, **kwargs)	Writes a new keyword to the FITS extension.
flip(in_, out, dim, **kwargs)	Reverses an NDF’s pixels along a specified dimension.
fourier(in_, hermout, **kwargs)	Performs forward and inverse Fourier transforms of 1- or
gausmooth(in_, out, fwhm, **kwargs)	Smooths a one- to three-dimensional NDF using a Gaussian filter.
gdclear(*args, **kwargs)	Clears a graphics device and purges its database entries.
gdnames(*args, **kwargs)	Shows which graphics devices are available.
gdset(device, **kwargs)	Selects a current graphics device.
gdstate(*args, **kwargs)	Shows the current status of a graphics device.
glitch(in_, out, **kwargs)	Replaces bad pixels in a 2-d NDF with the local median
globals(*args, **kwargs)	Displays the values of the KAPPA global parameters.
hiscom(ndf, **kwargs)	Adds commentary to the history of an NDF.
hislist(ndf, **kwargs)	Lists NDF history records.
hisset(ndf, **kwargs)	Sets the NDF history update mode.
histat(ndf, **kwargs)	Computes ordered statistics for an NDF’s pixels using an
histeq(in_, out, **kwargs)	Performs an histogram equalisation on an NDF.
histogram(in_, numbin, range, **kwargs)	Computes an histogram of an NDF’s values.
interleave(in_, out, expand, **kwargs)	Forms a higher-resolution NDF by interleaving a set of NDFs.
kapversion(*args, **kwargs)	Checks the package version number.
kstest(in_, out, **kwargs)	Compares data sets using the Kolmogorov-Smirnov test.
laplace(in_, out, **kwargs)	Performs a Laplacian convolution as an edge detector in a 2-d NDF
linplot(ndf, **kwargs)	Draws a line plot of the data values in a one-dimensional NDF.
listmake(outcat, **kwargs)	Creates a catalogue holding a positions list.
listshow(incat, **kwargs)	Reports the positions stored in a positions list.
logar(in_, out, base, **kwargs)	Takes the logarithm (specified base) of an NDF data structure.
look(ndf, centre, **kwargs)	Lists pixel values in a one- or two-dimensional NDF.
lucy(in_, psf, out, **kwargs)	Performs a Richardson-Lucy deconvolution of a 1- or 2-dimensional
lutable(mapping, coltab, lut, **kwargs)	Manipulates an image-display colour table.
lutbgyrw(*args, **kwargs)	Loads the BGYRW lookup table.
lutcol(*args, **kwargs)	Loads the standard colour lookup table.
lutcold(*args, **kwargs)	Loads the cold lookup table.
lutcont(*args, **kwargs)	Loads a lookup table to give the display the appearance of a
lutedit(*args, **kwargs)	Create or edit an image-display colour lookup table.
lutfc(*args, **kwargs)	Loads the standard false-colour lookup table.
lutgrey(*args, **kwargs)	Loads the standard greyscale lookup table.
lutheat(*args, **kwargs)	Loads the heat lookup table.
lutikon(*args, **kwargs)	Loads the default Ikon lookup table.
lutneg(*args, **kwargs)	Loads the standard negative greyscale lookup table.
lutramps(*args, **kwargs)	Loads the coloured-ramps lookup table.
lutread(*args, **kwargs)	Loads an image-display lookup table from an NDF.
lutsave(lut, **kwargs)	Saves the current colour table of an image-display device in an
lutspec(*args, **kwargs)	Loads a spectrum-like lookup table.
lutview(*args, **kwargs)	Draws a colour-table key.
lutwarm(*args, **kwargs)	Loads the warm lookup table.
lutzebra(*args, **kwargs)	Loads a pseudo-contour lookup table.
makesnr(in_, out, **kwargs)	Creates a signal-to-noise array from an NDF with defined variances.
makesurface(in_, out, **kwargs)	Creates a two-dimensional NDF from the coefficients of a
manic(in_, out, axes, **kwargs)	Change the dimensionality of all or part of an NDF.
maths(exp, out, **kwargs)	Evaluates mathematical expressions applied to NDF data structures.
median(in_, out, **kwargs)	Smooths a 2-dimensional data array using a weighted median filter.
mfittrend(in_, axis, ranges, out, order, …)	Fits independent trends to data lines that are parallel to an
mlinplot(ndf, **kwargs)	Draws a multi-line plot of the data values in a two-dimensional
mstats(in_, out, **kwargs)	Calculate statistics over a group of data arrays or points.
mult(in1, in2, out, **kwargs)	Multiplies two NDF data structures.
native(object, **kwargs)	Converts an HDS object to native machine data representation.
ndfcompare(in1, in2, **kwargs)	Compares a pair of NDFs for equivalence.
ndfcompress(in_, out, **kwargs)	Compresses an NDF so that it occupies less disk space.
ndfcopy(in_, out, **kwargs)	Copies an NDF (or NDF section) to a new location.
ndfecho(ndf, **kwargs)	Displays a group of NDF names.
ndftrace(ndf, **kwargs)	Displays the attributes of an NDF data structure.
noglobals(*args, **kwargs)	Resets the KAPPA global parameters.
nomagic(in_, out, repval, **kwargs)	Replaces all occurrences of magic value pixels in an NDF array
normalize(in1, in2, out, **kwargs)	Normalises one NDF to a similar NDF by calculating a scale factor
numb(in_, value, **kwargs)	Counts the number of elements of an NDF with values or absolute
oddeven(in_, out, **kwargs)	Removes odd-even defects from a one-dimensional NDF.
outline(*args, **kwargs)	Draws an outline of a 2-d NDF.
outset(in_, out, centre, diam, **kwargs)	Mask pixels inside or outside a specified circle in a
paldef(*args, **kwargs)	Loads the default palette to a colour table.
palentry(palnum, colour, **kwargs)	Enters a colour into an image display’s palette.
palread(palette, **kwargs)	Fills the palette of a colour table from an NDF.
palsave(palette, **kwargs)	Saves the current palette of a colour table to an NDF.
parget(parname, applic, **kwargs)	Obtains the value or values of an application parameter.
paste(in_, p1, **kwargs)	Pastes a series of NDFs upon each other.
permaxes(in_, out, perm, **kwargs)	Permute an NDF’s pixel axes.
picbase(*args, **kwargs)	Selects the BASE picture from the graphics database.
piccur(*args, **kwargs)	Uses a graphics cursor to change the current picture.
picdata(*args, **kwargs)	Selects the last DATA picture from the graphics database.
picdef(*args, **kwargs)	Defines a new graphics-database FRAME picture or an array of
picempty(*args, **kwargs)	Finds the first empty FRAME picture in the graphics database.
picentire(*args, **kwargs)	Finds the first unobscured and unobscuring FRAME picture in the
picframe(*args, **kwargs)	Selects the last FRAME picture from the graphics database.
picgrid(*args, **kwargs)	Creates an array of FRAME pictures
picin(*args, **kwargs)	Finds the attributes of a picture interior to the current picture.
piclabel(label, **kwargs)	Labels the current graphics-database picture.
piclast(*args, **kwargs)	Selects the last picture from the graphics datalast.
piclist(*args, **kwargs)	Lists the pictures in the graphics database for a device.
picsel(label, **kwargs)	Selects a graphics-database picture by its label.
pictrans(posin, **kwargs)	Transforms a graphics position from one picture co-ordinate Frame
picvis(*args, **kwargs)	Finds the first unobscured FRAME picture in the graphics database.
picxy(*args, **kwargs)	Creates a new FRAME picture defined by co-ordinate bounds
pixdupe(in_, out, expand, **kwargs)	Expands an NDF by pixel duplication.
pluck(in_, axes, out, **kwargs)	Plucks slices from an NDF at arbitrary positions.
profile(in_, out, start, finish, **kwargs)	Creates a 1-dimensional profile through an N-dimensional NDF.
provadd(ndf, parent, **kwargs)	Stores provenance information in an NDF.
provmod(ndf, **kwargs)	Modifies provenance information for an NDF.
provrem(ndf, pattern, **kwargs)	Removes selected provenance information from an NDF.
provshow(ndf, **kwargs)	Displays provenance information for an NDF.
psf(in_, incat, **kwargs)	Determines the parameters of a model star profile by fitting star
qualtobad(in_, out, **kwargs)	Sets selected NDF pixels bad on the basis of Quality.
regionmask(in_, region, out, **kwargs)	Applies a mask to a region of an NDF.
regrid(in_, out, **kwargs)	Applies a geometrical transformation to an NDF.
remqual(ndf, qnames, **kwargs)	Remove specified quality definitions from an NDF.
reshape(in_, out, shape, **kwargs)	Reshapes an NDF, treating its arrays as vectors.
rift(in_, scalar, out, section, **kwargs)	Adds a scalar to a section of an NDF data structure to correct
rotate(in_, out, angle, **kwargs)	Rotates a two-dimensional NDF about its centre through any angle.
scatter(in1, in2, **kwargs)	Displays a scatter plot between data in two NDFs.
segment(in1, in2, out, **kwargs)	Copies polygonal segments from one NDF into another.
setaxis(ndf, dim, mode, **kwargs)	Sets values for an axis array component within an NDF data
setbad(ndf, **kwargs)	Sets new bad-pixel flag values for an NDF.
setbb(ndf, bb, **kwargs)	Sets a new value for the quality bad-bits mask of an NDF.
setbound(ndf, **kwargs)	Sets new bounds for an NDF.
setext(ndf, xname, option, cname, **kwargs)	Manipulates the contents of a specified NDF extension.
setlabel(ndf, label, **kwargs)	Sets a new label for an NDF data structure.
setmagic(in_, out, repval, **kwargs)	Replaces all occurrences of a given value in an NDF array with
setnorm(ndf, dim, **kwargs)	Sets a new value for one or all of an NDF’s axis-normalisation
setorigin(ndf, origin, **kwargs)	Sets a new pixel origin for an NDF.
setqual(ndf, qname, comment, mask, **kwargs)	Assign a specified quality to selected pixels within an NDF.
setsky(ndf, positions, coords, epoch, **kwargs)	Stores new WCS information within an NDF.
settitle(ndf, title, **kwargs)	Sets a new title for an NDF data structure.
settype(ndf, type, **kwargs)	Sets a new numeric type for the data and variance components of
setunits(ndf, units, **kwargs)	Sets a new units value for an NDF data structure.
setvar(ndf, variance, **kwargs)	Set new values for the VARIANCE component of an NDF data
shadow(in_, out, **kwargs)	Enhances edges in a 2-dimensional NDF using a shadow effect.
showqual(ndf, **kwargs)	Displays the quality names defined in an NDF.
slide(in_, out, abs, **kwargs)	Realigns an NDF using a translation.
sqorst(in_, out, factors, **kwargs)	Squashes or stretches an NDF.
stats(ndf, **kwargs)	Computes simple statistics for an NDF’s pixels.
sub(in1, in2, out, **kwargs)	Subtracts one NDF data structure from another.
substitute(in_, out, oldval, newval, **kwargs)	Replaces all occurrences of a given value in an NDF array with
surfit(in_, out, **kwargs)	Fits a polynomial or bi-cubic spline surface to two-dimensional
thresh(in_, out, thrlo, thrhi, newlo, newhi, …)	Edits an NDF to replace values between or outside given limits
trandat(freename, ndf, **kwargs)	Converts free-format text data into an NDF.
trig(in_, trigfunc, out, **kwargs)	Performs a trigonometric transformation on a NDF.
vecplot(ndf1, ndf2, **kwargs)	Plots a two-dimensional vector map.
wcsadd(ndf, **kwargs)	Creates a Mapping and optionally adds a new co-ordinate Frame into
wcsalign(in_, out, lbnd, ubnd, **kwargs)	Aligns a group of NDFs using World Co-ordinate System information.
wcsattrib(ndf, **kwargs)	Manages attribute values associated with the WCS component of an
wcscopy(ndf, like, **kwargs)	Copies WCS information from one NDF to another.
wcsframe(ndf, **kwargs)	Change the current co-ordinate Frame in the WCS component of an NDF.
wcsmosaic(in_, out, **kwargs)	Tiles a group of NDFs using World Co-ordinate System information.
wcsremove(ndf, frames, **kwargs)	Remove co-ordinate Frames from the WCS component of an NDF.
wcsshow(ndf, object, **kwargs)	Examines the internal structure of an AST Object.
wcsslide(ndf, abs, **kwargs)	Applies a translational correction to the WCS in an NDF.
wcstran(ndf, posin, **kwargs)	Transform a position from one NDF co-ordinate Frame to another.
wiener(in_, psf, out, xcentre, ycentre, **kwargs)	Applies a Wiener filter to a 1- or 2-dimensional array.
zaplin(in_, out, **kwargs)	Replaces regions in a two-dimensional NDF by bad values or by