Next: Abstract
KAPLIBS - Internal subroutines used within
the KAPPA package.
Version 3.0
Programmer's Reference
Starlink User Note 238.6
D.S. Berry
Malcolm J. Currie
9th March 2009
Retrieve hardcopy
Contents
- Abstract
- Introduction
- Naming Conventions
- Compiling and Linking
- Changes in Version 3.1
- Changes in Version 3.0
- Changes in Version 2.8
- Changes in Version 2.7
- Changes in Version 2.6
- Changes in Version 2.5
- Changes in Version 2.4
- Changes in Version 2.3
- Changes in Version 2.2
- Changes in Version 2.1
- Changes in Version 2.0
- Routine Descriptions
- AIF_ANTMP
- Annul a locator to a temporary object, thereby erasing the object
- AIF_ASFIO
- Opens a sequential file via a parameter
- AIF_FLNAM
- Returns the name of a file as a character string given its
parameter name
- AIF_GETVM
- Obtains a pointer and a locator to mapped HDS workspace
- AIF_OPFIO
- Opens a Fortran sequential file by name
- AIF_PTFNM
- Writes the name of an HDS file to a parameter
- AIF_TEMP
- Create a temporary HDS object
- CCG_ORVAR
- Returns the variances and covariances of the order statistics
from n to 1, assuming an initially normal distribution
- CCG1_AD1x
- Combines data lines using absolute deviations from an unweighted
mean
- CCG_AD3x
- Combines data lines using absolute deviations from an unweighted
mean
- CCG_BM1x
- Combines data lines using a broadened median
- CCG_BM3x
- Combines data lines using a broadened median
- CCG_CLIPx
- Sets any data outside a given value range BAD
- CCG_COMB1x
- Combines a stack of array lines into one line, using a variety of
methods
- CCG_COMB3x
- Combines a stack of array lines into one line, using a variety
of methods
- CCG_CS1x
- Combines data lines using a sigma-clipped standard deviation
- CCG_CS3x
- Combines data lines using a sigma-clipped standard deviation
- CCG_FLX1x
- Combines data lines using the integrated value
- CCG_FLX3x
- Combines data lines using the integrated value
- CCG_FM1x
- Combines data lines using a fast median
- CCG_FM3x
- Combines data lines using a fast median
- CCG_I2WCx
- Assigns world co-ordinates to an output array from an input list
of indices
- CCG_IS2x
- Sorts a list of data into increasing order, and applies the
corresponding shuffle to an ancillary list
- CCG_IS3x
- Sorts a list of data into increasing order, and applies the
corresponding shuffle to two ancillary lists
- CCG_IWC1
T
- Combines data lines using the intensity-weighted co-ordinate
- CCG_IWC3x
- Combines data lines using the intensity-weighted co-ordinate
- CCG_IWD1x
- Combines data lines using the dispersion of the intensity-weighted
co-ordinate
- CCG_IWD3x
- Combines data lines using the dispersion of the intensity-weighted
co-ordinate
- CCG_KTHx
- Returns the Kth smallest value in an array
- CCG_MD1x
- Combines data lines using a weighted median
- CCG_MDR3x
- Combines data lines using a weighted median
- CCG_ME1x
- Combines data lines using a weighted mean
- CCG_ME3x
- Combines data lines using a weighted mean
- CCG_MM1x
- Combines data lines using a min-max exclusion trimmed mean
- CCG_MM3x
- Combines data lines using a min-max exclusion trimmed mean
- CCG_MN1x
- Combines data lines using the minimum value
- CCG_MN3x
- Combines data lines using the minimum value
- CCG_MO1x
- Combines data lines using a mode
- CCG_MOR3x
- Combines data lines using a mode
- CCG_MX1x
- Combines data lines using the maximum value
- CCG_MX3x
- Combines data lines using the maximum value
- CCG_RMS1x
- Combines data lines using the root mean square
- CCG_RMS3x
- Combines data lines using the root mean square
- CCG_SCR1
- Combines data lines using a sigma-clipped mean
- CCG_SC3x
- Combines data lines using a sigma clipped mean
- CCG_SD1x
- Combines data lines using an unweighted standard deviation
- CCG_SD3x
- Combines data lines using an unweighted standard deviation
- CCG_SM1x
- Combines data lines using a sigma-clipped median
- CCG_SM3x
- Combines data lines using a sigma clipped median
- CCG_SUM1x
- Combines data lines using the sum of values
- CCG_SUM3x
- Combines data lines using the sum of values
- CCG_TC1x
- Combines data lines using a threshold clipped mean
- CCG_TCR3x
- Combines data lines using a threshold clipped mean
- CCG_TM1x
- Combines data lines using a trimmed mean
- CCG_TM3x
- Combines data lines using a trimmed mean
- CCG_TMN2x
- Forms the n-trimmed mean of the given set of ordered data
- CCG_TMN3x
- Forms the n-trimmed mean of the given set of ordered data.
This variant does not process variances
- CCG_TRM2x
- Forms the trimmed mean of the given set of ordered data,
returning flags showing which values are used
- CCG_TRM3x
- To form the trimmed mean of the given set of ordered data,
returning flags showing which values are used. This variant does
not process variances
- CCG_UM1x
- Combines data lines using an unweighted mean
- CCG_UM3x
- Combines data lines using an unweighted mean
- CCG_WCWIx
- Creates a channel-width array from the channel co-ordinates
- CCG_WMD2x
- Estimates the mean of a number of normally distributed data
values, some of which may be corrupt
- CCG_WMD3x
- Estimates the mean of a number of normally distributed data
values, some of which may be corrupt
- CCG_WTM2x
- Forms the weighted median of a list of ordered data values.
Incrementing the contributing pixel buffers
- CCG_WTM3x
- Forms the weighted median of a list of ordered data values.
Incrementing the contributing pixel buffers and estimating the
variance change
- CCG_WTM4x
- Forms the weighted median of a list of ordered data values.
Incrementing the contributing pixel buffers and estimating the
variance change
- FTS1_ASTWN
- Displays any AST warning messages stored in the supplied FitsChan
- FTS1_AXIS
- Create an axis structure within an NDF from FITS header
information
- FTS1_BLCAR
- Determines whether or not the first card in a FITS record has a
blank keyword
- FTS1_BLVAL
- Blanks out the value from a FITS-header card
- FTS1_BSWAP
- Swaps adjacent bytes in an array of bytes
- FTS1_COMNT
- Get the value of a FITS COMMENT card from a buffer of cards
- FTS1_CRNDF
- For a FITS data array create an NDF, generating the NDF's name in
some circumstances
- FTS1_DREAD
- Obtains a FITS record from a disk file
- FTS1_DTYPE
- Obtain the input data type, scales and offsets for a FITS file
- FTS1_EDFEX
- Edits non-reserved keyword cards in a FITS extension of an NDF
- FTS1_EDKEY
- Edits keywords in a FITS card array
- FTS1_EVKEY
- Extracts a keyword and occurrence, and validates the keyword
- FTS1_FNDFS
- Read the first FrameSet from the supplied FitsChan
- FTS1_FRMT
- Obtain the input and output data format for a FITS file
- FTS1_FTWCS
- Uses coordinate system information in the supplied FITS headers
to create WCS and AXIS components in an NDF
- FTS1_GKEYC
- Gets the value and comment of a named header of type CHARACTER
from a buffer of FITS-header card images
- FTS1_GPARM
- Add the group parameters to the FITS header records
- FTS1_GVALC
- Extracts a string value from a FITS header
- FTS1_HDLOG
- Outputs the FITS header cards to an ASCII file
- FTS1_I2VXD
- Converts a vector of 64-bit IEEE floating-point numbers to Vax-D
format
- FTS1_I2VXR
- Converts a vector of 32-bit IEEE floating-point numbers to Vax-F
format
- FTS1_INKEY
- Insert keywords to a FITS card array
- FTS1_ISKEY
- Inquires whether or not a string is a valid FITS keyword
- FTS1_LOKEY
- Locates an occurrence of a keyword in a FITS header
- FTS1_MANDH
- Obtain the values of the mandatory headers in a FITS file
- FTS1_NDFCM
- Create the title, units, axes, wcs, and FITS extension in an NDF
from the FITS headers
- FTS1_NDF
- Makes an NDF from a simple or group-format FITS file
- FTS1_PHEAD
- Process the headers in a FITS file on tape or disk
- FTS1_PRVAL
- Prints the value of a specified card in an array of FITS headers
- FTS1_PTKEY
- Puts non-reserved keyword cards into the FITS extension of an NDF
file
- FTS1_QTYPE
- Determines the data type of a FITS header value
- FTS1_RDATA
- Read the data of a FITS file on disk or tape
- FTS1_RFMOD
- Reads a text file containing instructions for editing an NDF's
FITS extension
- FTS1_RGRDA
- Read the data of a FITS file in group format from disk or tape
- FTS1_ROOTN
- Creates the rootname for an NDF
- FTS1_RSTAB
- Read the table format from a FITS file and write to an ASCII file
- FTS1_SCOFB
- Applies scale and zero to a REAL data vector, and substitutes
magic values for blank FITS data
- FTS1_SCTAB
- Create an ASCII catalogue and description file in SCAR format
from a FITS tape or disk file
- FTS1_SDSCF
- Create a SCAR description file from a FITS table-format headers
- FTS1_SKIP
- Skip over the data of a FITS file
- FTS1_UKEYC
- Writes the value of type CHARACTER to a keyword from a buffer
of FITS-header card images
- FTS1_VHEAD
- Validates a FITS header card and reconstitutes to the standard
- FTS1_WCSAX
- Re-creates AXIS structures from a WCS component FrameSet
- FTS1_WCSDF
- Sees if two FrameSets are different after being written to a
FitsChan
- FTS1_WCSIM
- Imports WCS information from the supplied FitsChan into the supplied
NDF
- FTS1_WCSUT
- Remove the spurious copy of the AXIS Frame which is left in
WCS component when using non-Native encodings
- FTS1_WKEYC
- Writes a FITS-header card for a CHARACTER value or a comment
- FTS1_CHVAx
- Replaces all occurrences of a value in an array with another
value
- FTS1_GKEYx
- Gets the value and comment of a named header of type
COMM
from
a buffer of FITS-header card images
- FTS1_UKEYx
- Writes the value of type
COMM
to the specified keyword from a
buffer of FITS-header card images
- FTS1_WKEYx
- Writes a FITS-header card for a value of type
COMM
- FTS1_RNAND
- Replaces NaN values with bad values in a vector of 64-bit IEEE
floating-point numbers
- FTS1_RNANR
- Replaces NaN values with bad values in a vector of 32-bit IEEE
floating-point numbers
- IRA_ANNUL
- Annul an IRA identifier
- IRA_CLOSE
- Close down the IRA astrometry package
- IRA_CONVT
- Convert sky coordinates from one system to another
- IRA_CREAT
- Create an identifier for specified astrometry information
- IRA_CTOD1
- Converts a single formatted sky coordinate value into a double
precision value
- IRA_CTOD
- Converts formatted sky coordinate values into double precision
values
- IRA_DTOC1
- Convert a single floating point sky coordinate value to
character form
- IRA_DTOC
- Convert a pair of double precision sky coordinate values to
character form
- IRA_EXPRT
- Store astrometry information in an NDF
- IRA_FIND
- Find an astrometry structure within an NDF
- IRA_GETCO
- Obtain a pair of sky coordinates from the ADAM environment
- IRA_GETEQ
- Extract the epoch of the reference equinox from a string
specifying a Sky Coordinate System
- IRA_GTCO1
- Obtain a single sky coordinate value from the ADAM environment
- IRA_GTSCS
- Get the full name of a Sky Coordinate System (with equinox
specifier) from the environment
- IRA_IDEPOCH
- Get the epoch associated with an IRA identifier
- IRA_IDPROJN
- Get the projection name associated with an IRA identifier
- IRA_IDPROJP
- Get a projection parameter value associated with an IRA identifier
- IRA_IDSCS
- Get the Sky Coordinate System associated with an IRA identifier
- IRA_INIT
- Initialise the IRA astrometry package
- IRA_IPROJ
- Return a list of supported projection names
- IRA_ISCS
- Return a list of supported sky coordinate systems
- IRA_LOCAT
- Set the location for new IRA astrometry structures
- IRA_NORM
- Convert sky coordinate values to the equivalent first order
values
- IRA_READ
- Gets an identifier for astrometry information stored in an HDS
astrometry structure
- IRA_SETEQ
- Encode the epoch of a reference equinox within an SCS name
- IRA_TRANS
- Transform coordinate data
- IRA_WRITE
- Write astrometry information into an HDS object
- COPY1D
- copy one 1-D array to another
- COPY2D
- copy one 2-D array into another
- COPY3D
- copy one 3-D array into another
- CPSECR
- Copy region of 2-D image
- CREOUT
- creates and returns a locator to an IMAGE type structure
- DIMLST
- Writes the dimensions of an array in a shorthand form
- EXPARR
- take the exponential of an array, pixel by pixel
- ICMMM
- Iteratively finds the mean, median and mode using the
- INSET
- will be .TRUE. if STRING is a member of the "set" SET
- KPG1_ABSET
- Separates a list of items into a character array
- KPG1_AGATC
- Reports the character attributes of the current picture in the
graphics database
- KPG1_AGFND
- Selects the highest picture of a given name within the current AGI
picture
- KPG1_AGREF
- Obtains a name of or a locator to an object referenced in the
graphics database
- KPG1_ALSYS
- Allow the user to change the AlignSystem attribute in a Frame/
- KPG1_ARCOG
- Allow the user to select an array component in a supplied NDF
- KPG1_ARCOL
- Forms a list of the available array components in an NDF
- KPG1_ASAGD
- Transform AGI world co-ordinates to AGI data co-ordinates
- KPG1_ASAPA
- Determines which pixel axis is most closely aligned with a WCS
axis
- KPG1_ASCRV
- Draw a polyline using AST
- KPG1_ASDIS
- Find the distance between two points
- KPG1_ASDSV
- Find the distances between a set of points
- KPG1_ASFFR
- Finds an Frame with a given Domain within a FrameSet
- KPG1_ASFGT
- Create a new Frame specified through the environment
- KPG1_ASFIL
- Read spatial positions from a text file
- KPG1_ASFIX
- Modify the WCS FrameSet of an NDF to take account of
re-gridding the pixel array
- KPG1_ASFRM
- Sets the current Frame in a FrameSet to a Frame specified through
the environment
- KPG1_ASGDP
- Find a position with good output co-ordinates within a given input
region of a supplied Mapping
- KPG1_ASGET
- Gets an AST FrameSet from the WCS component of an NDF
- KPG1_ASGFR
- Reads a line of an AST Object description from a GRP group
- KPG1_ASGFW
- Writes a line of an AST Object description to a GRP group
- KPG1_ASGRD
- Draw a border or an annotated coordinate grid over an AST Plot
- KPG1_ASGRP
- Read spatial positions from a GRP group
- KPG1_ASIRA
- Creates an AST FrameSet from an IRAS90 astrometry structure
- KPG1_ASLOG
- Take log base 10 of each axis value (an AST IntraMap routine)
- KPG1_ASMRG
- Merges two FrameSets by aligning them in a common Frame
- KPG1_ASOFF
- Find a position offset by a given distance from one position
towards another position
- KPG1_ASPCL
- Apply clipping to a Plot so that border and coordinate grid are
restricted to the well bahaved regions
- KPG1_ASPLG
- Store a given KeyMap for future use by KPG1_ASPLN
- KPG1_ASPLN
- Draw a line for an AST Plot and log it at the same time
- KPG1_ASPLT
- Create an AST Plot covering the current PGPLOT viewport
- KPG1_ASPRP
- Propagates the WCS component from one NDF to another with the same
number of axes, allowing for a linear mapping of the pixel
co-ordinates
- KPG1_ASPSY
- Establish synonyms for AST attribute names
- KPG1_ASPTP
- Put a formatted AST position into a string
- KPG1_ASREF
- Associates an NDF optionally from a reference name or locator
- KPG1_ASREG
- Registers all AST IntraMaps known by KAPPA
- KPG1_ASRGG
- Register all graphical AST IntraMaps known by KAPPA
- KPG1_ASRGN
- Register all non-graphical AST IntraMaps known by KAPPA
- KPG1_ASSET
- Allow the user to spcify attribute values for an AST Object
- KPG1_ASSHR
- Shrink a Plot so that it covers an area which allows all annotation
to fit within the specified area
- KPG1_ASSIG
- Ensure that the Current Frame from an NDF WCS FrameSet has no
insignificant axes
- KPG1_ASSIM
- Simplify a FrameSet
- KPG1_ASSIR
- Set the attributes of a SkyFrame to match an IRAS90 SCS
- KPG1_ASSMP
- Returns co-ordinates at evenly spaces positions along a given
poly-line
- KPG1_ASSPL
- Get a set of 1-d Mappings for each axis in a FrameSet
- KPG1_ASSTS
- Apply an attribute setting to a Plot
- KPG1_ASSTY
- Checks for synonyms and colour names in AST attribute settings
- KPG1_AST2H
- Copy AST_ data to an HDS object
- KPG_ASTCMN
- Define functional accessor/setter interface to KPG_AST common block
- KPG1_ASTRM
- Trims axes from the current Frame of a FrameSet
- KPG1_ASTTL
- Set the Title attribute of a Plot
- KPG1_AVLUT
- Associates, validates and maps an lookup table stored in an NDF
- KPG1_AXANO
- Generates an axis annotation from the NDF's axis label and units
- KPG1_AXRNG
- Calculate the extent of an NDF along an axis
- KPG1_AXTYP
- Determines the implementation type for NDF axis arrays
- KPG1_BADBX
- Obtain an NDF section containing all good data in the supplied NDF
- KPG1_BILNR
- Perform bi-linear interpolation checking for bad values
- KPG1_CCPRO
- Gets a character component for an output NDF with optional
propagation from another NDF
- KPG1_CEIL
- Return the smallest integer larger than or equal to a supplied value
- KPG1_CGET
- Obtain an NDF character component, removing escape sequences
- KPG1_CMULD
- Multiply each element of a vectorised double precision array by a
constant
- KPG1_CNLIM
- Parse a character string into integer bounds
- KPG1_COLNM
- Finds the named colour nearest to an RGB triple
- KPG1_COPYC
- Copy a 1D array of character strings
- KPG1_COPY
- To copy an array of a given type to another array of the same
type
- KPG1_CPSTY
- Copy the plotting style for an AST element to another AST element
- KPG1_CROUT
- Creates and returns locators to the top-level and data-array of
an NDF-type structure
- KPG1_CSHFT
- Shift the characters left or right in a string
- KPG1_CTCPC
- Copies string values from a catalogue column to a GRP group
- KPG1_CTCPx
- Copies values from catalogue columns to an AST KeyMap
- KPG1_DANOT
- Generates an annotation from the NDF's label and units
- KPG1_DATCP
- Get an AST FrameSet from an NDF
- KPG1_DAUNI
- Generates a string containing the units of an NDF's data or
variance component allowing for truncation
- KPG1_DEBUG
- Should the speified package report debug diagnostics?
- KPG1_DNAG2R
- Converts an NAG Hermitian Fourier transform array into an array
usable by FFTPACK routine KPG1_DRFFTB
- KPG1_DR2NAG
- Converts an FFTPACK Hermitian Fourier transform array into
the equivalent NAG array
- KPG1_DSFR1
- Displays a textual description of the Current Frame in a FrameSet
- KPG1_DSFRM
- Display a textual description of the Current Frame in a FrameSet
- KPG1_ELGAU
- Calculates the axis ratio, inclination and minor-axis width of a
star image, given the Gaussian widths of marginal profiles at
45-degree intervals
- KPG1_ENV0R
- Reads a floating point value from an environment variable
- KPG1_ENVDF
- See if an environment variable is defined
- KPG1_FFTBD
- Takes the inverse (Backward) FFT of a real image
- KPG1_FFTBR
- Takes the inverse (Backward) FFT of a real image
- KPG1_FHDAT
- Converts the NDF history date into a more-pleasing format
- KPG1_FLOOR
- Return the largest integer smaller than or equal to a supplied value
- KPG1_FLPTH
- Get the full path to a file given relative to a specified root directory
- KPG1_GAXLB
- Obtains an axis annotation for an NDF axis
- KPG1_GTCHV
- Obtains a vector of choices from the environment
- KPG1_GDARE
- Defines a region within the current PGPLOT window
- KPG1_GDBND
- Get the bounds of a new PGPLOT window from the environment
- KPG1_GDFND
- Selects the highest picture of a given name with WCS within the
current AGI picture
- KPG1_GDFNP
- Selects the highest picture of a given name that embraces a
position and has WCS
- KPG1_GDGET
- Get the AST Plot associated with an AGI picture
- KPG1_GDNEW
- Creates a new DATA picture with ancillary pictures
- KPG1_GDOLD
- Create a new DATA picture with ancillary pictures aligned with
an existing DATA picture
- KPG1_GDPUT
- Save an AST Plot with a graphics database picture
- KPG1_GDQPC
- Return the extent of the current picture
- KPG1_GDWIN
- Set PGPLOT world co-ordinates to be the world co-ordinates
of the specified AGI picture
- KPG1_GETIM
- Get locators to an IMAGE-type structure and structure holding the
data array for data input
- KPG1_GETYP
- Obtains a valid HDS primitive data type via a parameter
- KPG1_GILST
- Selects integers within a range of values
- KPG1_GNDFP
- Gets an NDF or NDF section with a specified number of significant
dimensions, but also may select one further significant iteration
dimension
- KPG1_GNLBU
- Obtains an axis annotation for NDF data or variance
- KPG1_GNTIT
- Obtains a title using the NDF title as the suggested default
- KPG1_GPCOL
- Obtains the red, green and blue intensities of a colour by value
or by name for the standard colour set
- KPG1_GRAPH
- Draws a line graph
- KPG1_GRLM1
- Find the default limits for a graph axis
- KPG1_GRLM2
- Find the default limits for a graph axis
- KPG1_GRLM3
- Find the default limits for a graph axis
- KPG1_GRPHW
- Draws a line graph, using supplied work arrays
- KPG1_GTAXI
- Select Frame axes using an environment parameter
- KPG1_GTAXI
- Selects Frame axes using an environment parameter
- KPG1_GTAXV
- Gets one or more formatted axis values from the environment
- KPG1_GTCHV
- Obtain a vector of choices from the environment
- KPG1_GTGRP
- Obtain a group of strings from the environment
- KPG1_GTMOR
- Create an HDS structure holding a user-supplied set of keyword=value
strings
- KPG1_GTNDF
- Gets an NDF or NDF section with a specified number of significant
dimensions
- KPG1_GTOBJ
- Gets an AST Object using an environment parameter
- KPG1_GTPLR
- Gets a spatial position from the environment as polar co-ordinates
- KPG1_GTPOS
- Get a spatial position from the environment
- KPG1_GTWCS
- Get an AST FrameSet from an NDF
- KPG1_H2AST
- Copy AST_ data from an HDS object
- KPG1_HMSG
- Assign the name of an HDS object to a message token
- KPG1_HRCPx
- Finds the reciprocal of a purely real Hermitian image
- KPG1_HSSTP
- Calculates statistics from an histogram
- KPG1_HSTLO
- Computes the values to display for a histogram
- KPG1_IMPRG
- Propagates NDF information for IMAGE-format applications
- KPG1_ISSCS
- Extract the epoch of the reference equinox from a string
specifying an IRAS90 Sky Coordinate System
- KPG1_KGODx
- Sorts through a dataset and throw away bad values
- KPG1_LGTRN
- Saves a transformation for a base-10 logarithmic plot in the AGI
database
- KPG1_LIKE
- Create a section from an NDF that matches the area of another NDF
- KPG1_LINTD
- Obtains a linear transformation between 2 sets of x,y positions
with least squared error
- KPG1_LISTC
- Lists a character array to an ASCII file or reports it to the
user
- KPG1_LSTAR
- Write a section of a 2D array to a text file
- KPG1_LTGET
- Obtain a locator to an array holding a colour table for the currently
opened graphics device
- KPG1_LTLOD
- Load the colour table for the currently open graphics device
- KPG1_LTSAV
- Save the colour table for the currently open graphics device
- KPG1_LUTIN
- Transfers a lookup table between arrays that have different
numbers of colour indices
- KPG1_LUTK2
- Set up the pixel colour indices which form a LUT key
- KPG1_LUTK3
- Produce a GRAPH colour table key for KPG1_LUTKY
- KPG1_LUTK4
- Produce an AST Mapping from pen number to RGB intensity
- KPG1_LUTKY
- Draws a key showing a colour table
- KPG1_MAP
- Obtain mapped access to an array component of an NDF
- KPG1_MKLUT
- Create a Mapping to connect two 1D array of values
- KPG1_MKPOS
- Mark a position on a graphics device
- KPG1_MXMNX
- Returns the maximum and minimum values of an array
- KPG1_NACVT
- Convert an HDS object hierarchy to native data representation
- KPG1_NAG2R
- Converts an NAG Hermitian Fourier transform array into an array
usable by FFTPACK routine KPG1_RFFTB
- KPG1_NAGTC
- Swaps argument order when getting a mapped character array from
an HDS object
- KPG1_NAPTC
- Swaps argument order when putting a mapped character array into
an HDS object
- KPG1_NDFNM
- Return the name of an NDF without a directory path (Unix only)
- KPG1_NMCOL
- Finds the RGB intensities of a named colour
- KPG1_NUMFL
- This counts the number of lines in a text file
- KPG1_OPGRD
- Gets the parameters of an optimal projection for a given set of
sky positions
- KPG1_ORVAR
- To return the variances and covariances of the order statistics
from n to 1, assuming an initially normal distribution
- KPG1_PACOL
- Obtain a marker colour
- KPG1_PGCLR
- Clear current PGPLOT viewport
- KPG1_PGCLS
- Close down the AGI database and PGPLOT workstation
- KPG1_PGCOL
- Obtain a marker colour, given a colour specification
- KPG1_PGCUR
- Uses the cursor to get a set of points
- KPG1_PGCUT
- Cut a section out of the current PGPLOT window
- KPG1_PGESC
- Remove PGPLOT escape sequences from a text string
- KPG1_PGHNM
- Return an HDS name describing the current PGPLOT graphics device
- KPG1_PGLOC
- Locates a component of an HDS structure relating to the currently
opened PGPLOT device
- KPG1_PGLUT
- Use an array of colour representations to set up the PGPLOT colour
table
- KPG1_PGOPN
- Opens the AGI database and activate a PGPLOT workstation
- KPG1_PGPIX
- Display an image using PGPLOT
- KPG1_PGSHT
- Set the PGPLOT character size in world coordinates
- KPG1_PGSTY
- Establish values for graphics attributes
- KPG1_PGTXT
- Draw text using PGPLOT and return concatenation point
- KPG1_PIXSC
- Determines pixel scales at a given grid position
- KPG1_PL2GE
- Reads two-dimensional polynomial information from a POLYNOMIAL
structure
- KPG1_PL2PU
- Writes 2-dimensional polynomial information to a POLYNOMIAL
structure
- KPG1_PLCIP
- Finds the nearest colour in the palette to a named colour
(PGPLOT version of KPG1_PALCI)
- KPG1_PLGET
- Get the colour palette for the currently open graphics device from
a supplied array
- KPG1_PLLOD
- Load the colour palette for the currently open graphics device
- KPG1_PLOTA
- Opens the graphics device and see if there is an existing DATA
picture with which the new DATA picture could be aligned
- KPG1_PLOT
- Prepares for graphics output
- KPG1_PLOTN
- Create a new DATA picture and ensure there is an AST Plot for it
- KPG1_PLOTP
- Creates a new DATA picture, with optionally ancillary pictures
- KPG1_PLOTS
- Save an AST Plot with an AGI DATA picture
- KPG1_PLPUT
- Put a section of the current colour palette into the supplied array
- KPG1_PLSAV
- Save the colour palette for the currently open graphics device
- KPG1_PLTLN
- Produces a graphical representation of a set of points in 2-D
- KPG1_PQVID
- Tests whether the current graphics device has suitable
image-display characteristics
- KPG1_PRCVT
- Convert an HDS primitive to a native data representation
- KPG1_PRNTH
- Locates the outer-most pair of parenthesis in a string
- KPG1_PSEED
- Set the PDA Random number seed
- KPG1_PVERS
- Parse a package version string
- KPG1_PX2AX
- Convert a pixel's indices into WCS or axis coordinates
- KPG1_R2NAG
- Converts an FFTPACK Hermitian Fourier transform array into
the equivalent NAG array
- KPG1_RCATW
- Attempt to read an AST Object from a catalogue
- KPG1_RDAST
- Read AST_ data as text from an HDS object
- KPG1_RDCAT
- Reads a set of positions with labels from a CAT catalogue
- KPG1_RDLST
- Reads a set of positions from a CAT catalogue
- KPG1_RDTAB
- Reads a set of positions with labels from a CAT catalogue
- KPG1_REPRT
- Reports a MSG message to user and also optionally write it to a file
- KPG1_RGLMT
- Get the range limits of a range specification
- KPG1_RGNDF
- Get a group of existing NDFs
- KPG1_SATKC
- Substitutes alphabetic (TRANSFORM) character tokens into a string
- KPG1_SATKD
- Substitutes alphabetic (TRANSFORM) numeric tokens into a string
- KPG1_SAXAT
- Set attributes of a Frame axis to describe an NDF array component
- KPG1_SCALX
- Copies array values into another array, scaling them in the process
- KPG1_SCLOF
- Applies a simple scaling and base-line shift to the values
contained in the input vector
- KPG1_SDIMP
- Obtains up to a number of significant dimensions of an NDF
- KPG1_SECSH
- Shifts bounds of upper dimensions that have one element to index
one
- KPG1_SEED
- Obtain a semi-random seed for random-number generation
- KPG1_SGDIG
- Determines the number of significant digits in a number
- KPG1_SGDIM
- Determines the number of significant dimensions in an NDF
- KPG1_SHORT
- Check whether a string matches a supplied abbreviation template
- KPG1_SLICE
- Find and remove any NDF slice specification from a name
- KPG1_SNKTA
- Write AST_ data as text to a GRP group
- KPG1_SRCTA
- Reads AST_ data as text from a GRP group
- KPG1_SSCOF
- Applies a simple scaling and base-line shift to create the
output vector
- KPG1_VEC2N
- Convert vectorised array indices into N-dimensional form
- KPG1_VERB
- Should the speified package report verbose messages?
- KPG1_MKCAT
- Write an AST Object to a catalogue
- KPG1_WCAXC
- Obtains co-ordinates for an axis from a WCS component FrameSet
- KPG1_WCFAX
- Obtains the co-ordinate of an axis in the current WCS Frame at
every pixel centre in an NDF
- KPG1_WGNDF
- Get a group of output NDF names
- KPG1_WRAST
- Write AST_ data as text to an HDS object
- KPG1_WRCAT
- Writes a set of positions to a text file as a CAT catalogue
- KPG1_WREAD
- Read an AST Object from an HDS object
- KPG1_WRLST
- Writes a set of positions to a text file as a CAT catalogue
- KPG1_WRTA2
- Puts a set of positions into a text file as a CAT catalogue
- KPG1_WRTAB
- Writes a set of positions to a text file as a CAT catalogue
- KPG1_WTM3D
- To form the weighted median of a list of ordered data values.
Incrementing the contributing pixel buffers and estimating the
variance change
- KPG1_WTM3R
- To form the weighted median of a list of ordered data values
- KPG1_WWRT
- Write WCS information to an HDS object
- KPG1_XYD2W
- Converts linear data co-ordinates to world co-ordinates
- KPG_ENV0C
- Reads a string value from an environment variable, using a
default value if the variable is undefined
- KPG_NXWRD
- To find the next word in a string
- LD2AR
- Converts a sparse form of a 2-D array stored in DOUBLE PRECISION
into its REAL 2-D counterpart
- LOGARR
- take the logarithm of an array, pixel by pixel
- NORMAL
- takes a value and returns a normally distributed noisy
- NXTNAM
- increments Fnnnn type filename by one
- POWARR
- raise an array, pixel by pixel, to a given power
- ZERO1D
- sets all elements of the 1-dimensional array to zero
- ZERO2D
- sets all elements of a 2-dimensional array to zero
- BAD2D
T
- Substitutes the bad value in a defined sub-section of a 2-d array
- CHVAL
T
- Replaces a specified pixel value
- COPA
T
- Copy a one-dimensional array
- KPG1_ELNMB
T
- Write a range of element numbers into an array
- KPG1_AINBx
- Obtains for an axis the equivalent index co-ordinates given axis
values
- KPG1_AINDx
- Obtains for an axis the equivalent index co-ordinates given axis
values
- KPG1_AKERx
- Smooth a 2-dimensional array using an arbitrary rectangular
kernel
- KPG1_AXBNx
- Find the bounds of an NDF's axis centre co-ordinates
- KPG1_AXCOx
- Obtains for an axis the axis indices given their values
- KPG1_AXEXx
- Calculates the extent of an NDF along an axis
- KPG1_AXGVx
- Find the first axis centre co-ordinate of an NDF above a
threshold
- KPG1_AXLIx
- Determines whether an array's values are equally spaced
- KPG1_AXLVx
- Find the first axis centre co-ordinate of an NDF below a
threshold
- KPG1_AXVLx
- Obtains the axis-array values given their corresponding pixel
co-ordinates
- KPG1_BBOXx
- Determines the bounding box of selected pixels in an n-dimensional
array
- KPG1_BL1Dx
- Smooth a 1D vector using a block average filter
- KPG1_BLOCx
- Smooth a 2-dimensional image using a rectangular box filter
- KPG1_BOR2x
- Places a border of constant values at the edges of a
two-dimensional array
- KPG1_CADDx
- Add a constant to each element of a vectorised array
- KPG1_CHAXx
- Check for usable AXIS structures
- KPG1_CHE2X
- Evaluates a 2-dimensional Chebyshev polynomial
- KPG1_CHELx
- Replaces the value of an array element with a specified value
- KPG1_CHEPx
- Evaluates a Chebyshev polynomial
- KPG1_CHEVx
- Evaluates a one-dimensional Chebyshev polynomial
- KPG1_CHVAx
- Replaces all occurrences of a value in an array with another
value
- KPG1_CMADx
- Compresses an n-dimensional array by summing in `rectangular'
boxes
- KPG1_CMAVx
- Compresses an n-dimensional array by averaging in `rectangular'
boxes
- KPG1_CMPKx
- Compresses an n-dimensional array by picking value at equally
spaced intervals
- KPG1_CMULx
- Multiply each element of a vectorised array by a constant
- KPG1_CMVDx
- Compresses n-dimensional data and variance arrays by summing in
`rectangular' boxes
- KPG1_CMVVx
- Compresses n-dimensional data and variance arrays by averaging in
`rectangular' boxes
- KPG1_CPBDx
- Copies bad pixels
- KPG1_CPNDx
- Copies a section of an n-dimensional array
- KPG1_CPNTx
- Creates a primitive NDF with a title via the parameter system
- KPG1_CSUBx
- Subtract a constant from each element of a vectorised array
- KPG1_CTCPx
- Copies values from catalogue columns to an array
- KPG1_D2W2x
- Converts linear data co-ordinates to world co-ordinates
- KPG1_DARA
T
- Determine the data limits for an array using a variety of methods
- KPG1_DCLIx
- Determines a linear transformation from pixel to NDF-axis
co-ordinates
- KPG1_DIVx
- Divide two vectorised arrays with optional variance information
- KPG1_DWSOx
- Obtains for the scale and offset for a linear transformation from
world to data co-ordinates
- KPG1_ELNMx
- Writes a range of element numbers into an array
- KPG1_EXPOx
- Takes the exponential to an arbitrary base of an array and its
variance
- KPG1_FFRx
- Reads free-format floating-point data from a string
- KPG1_FFTF
T
- Takes the forward FFT of a real image
- KPG1_FIGRx
- Sets each element in a N-dimensional array to its grid
co-ordinate
- KPG1_FILLx
- Sets all elements in a vectorised array to a specified value
- KPG1_FLASx
- Flashes image into a cell array
- KPG1_FLCOx
- Obtains a list of co-ordinates from a text file
- KPG1_FLIPx
- Reverse the pixels in an N-dimensional array along a specified
dimension
- KPG1_FRACx
- Finds values corresponding to specified fractions of an array's
ordered distribution
- KPG1_GAUFx
- To fit a Gaussian to a one-dimensional array of data
- KPG1_GAUSx
- Smooths a two-dimensional array using a symmetrical Gaussian PSF
- KPG1_GHSTx
- Calculates the histogram of an array of data
- KPG1_HCONx
- Take the complex conjugate of an Hermitian image
- KPG1_HMLTx
- Multiply two Hermitian images
- KPG1_HSDSx
- Tabulates an histogram
- KPG1_HSFLx
- Writes an histogram to a Fortran formatted file
- KPG1_HSTAx
- Compute simple ordered statistics for an array via an histogram
- KPG1_HSTFx
- Finds values corresponding to specified fractions of an histogram
- KPG1_HSTQx
- Equalises the histogram of an array
- KPG1_INCOx
- Obtains a list of co-ordinates from the environment
- KPG1_IS3x
- Sorts an array of data into increasing order, also shuffling
two ancillary arrays correspondingly
- KPG1_ISCLx
- Scale image between limits
- KPG1_KER1x
- Smooths an N-dimensional array using a specified 1D kernel
- KPG1_LITNx
- Creates linear transformation expressions between two
n-dimensional co-ordinate systems
- KPG1_LITRx
- Saves a transformation for a linear plot in the AGI database
- KPG1_LLTRx
- Saves a transformation for a data co-ordinate linear or
logarithmic plot in the AGI database
- KPG1_LOCTx
- Locates the centroid of a blob image feature in an n-dimensional
array
- KPG1_LOGAx
- Takes the logarithm to an arbitrary base of an array and its
variance
- KPG1_LUDCx
- Performs an LU decomposition of a square matrix
- KPG1_MANI
T
- Copy a data array with axis permutation and expansion
- KPG1_MDETx
- Computes the determinant of a matrix
- KPG1_MEANx
- Finds the mean of the good data values in an array
- KPG1_MEDUx
- Derives the unweighted median of a vector
- KPG1_MIXVx
- Obtains from a parameter character values from either a menu of
options or within a numeric range
- KPG1_MMTHx
- Returns the maximum and minimum values of an array within
thresholds
- KPG1_MODEx
- To estimate the mean of a number of normally distributed data
values, some of which may be corrupt
- KPG1_MONOx
- Determines whether an array's values increase or decrease
monotonically
- KPG1_MTHEx
- Evaluate a mathematical expression for a set of data and variance
arrays
- KPG1_MULx
- Multiply two vectorised arrays with optional variance information
- KPG1_MVBDx
- Move bad data values to the end of an index of array values
- KPG1_MXMEx
- Returns the maximum and minimum values between thresholds of an
array including its errors
- KPG1_MXMNx
- Returns the maximum and minimum values of an array
- KPG1_NBADx
- Finds the number of bad values in an array
- KPG1_NOISx
- Adds random Normal noise to a one-dimensional array
- KPG_NTHMx
- Returns the n smallest values in a
COMM
array
- KPG1_NUMBx
- Counts the number of elements with values or absolute values
above or below a limit
- KPG1_PASTx
- Pastes an array on to another
- KPG1_POISx
- Takes values and returns them with Poisson noise added
- KPG1_POW
T
- Raise each element of a vectorised array to a specified power
- KPG1_PROWx
- Put values into a row of a 2-dimensional array
- KPG1_PRSAx
- Extracts a list of numerical values from a string
- KPG1_PSFSx
- Finds the approximate size of a 2-dimensional PSF
- KPG1_PTNDx
- Pastes a section of an n-dimensional array into another array
- KPG1_PXDPx
- Expands an n-dimensional array by pixel duplication
- KPG1_QNTLx
- Finds a quantile in a (possibly weighted) set of data
- KPG1_QSRTX
- Sorts a vector via the Quicksort algorithm
- KPG1_RETRx
- Retrieves a value from an array
- KPG1_RETVx
- Retrieves values specified by index from a vector
- KPG1_RFCOx
- Reads co-ordinate data from a text free-format file
- KPG1_RMAPx
- Remaps an array's values according to an histogram key
- KPG1_SCLBx
- Copy array values into a BYTE array, scaling them in the process
- KPG1_SCLIx
- Copy array values into a INTEGER array, scaling them in the process
- KPG1_SCLUBx
- Copy array values into a BYTE array, scaling them in the process
- KPG1_SCLUWx
- Copy array values into a INTEGER
2 array, scaling them in the process
- KPG1_SCLWx
- Copy array values into a INTEGER
2 array, scaling them in the process
- KPG1_SQSUx
- Finds the sum of the squares of an array
- KPG1_SSAZx
- Applies a simple scaling and base-line shift to create the
output vector
- KPG1_STATX
- Compute simple statistics for an array
- KPG1_STDSx
- Displays statistics generated by KPG1_STATx, KPG_OSTAx, and
KPG1_HSTAx
- KPG1_STFLx
- Write statistics generated by KPG1_STATx, KPG_OSTAx, and
KPG1_HSTAx to a text file
- KPG1_STORx
- Stores a value in an array
- KPG1_TDLIx
- Applies a constant-determinant transformation to an array by
linear interpolation
- KPG1_THRSx
- Sets pixels in array to defined new values outside limits
- KPG1_TRALx
- Finds the extreme co-ordinates of an n-d array after being
transformed
- KPG1_TRBOx
- Finds the extreme co-ordinates of an n-d array after being
transformed
- KPG1_TRIG
T
- Apply a trig function to each element of a vectorised array
- KPG1_TRLIx
- Applies a constant-determinant transformation to an array by
linear interpolation
- KPG1_TRPIx
- Finds vectorised pixel indices after applying a transformation to
an array's pixel co-ordinates
- KPG1_TRSPx
- Transposes a two-dimensional array
- KPG1_UNZ2x
- Unzips a 2-dimensional co-ordinate array into two 1-dimensional
arrays
- KPG1_VASVx
- Assigns values to an output array from an input array using a list
of indices
- KPG1_WMODx
- To estimate the mean of a number of normally distributed data
values, some of which may be corrupt
- KPG1_XYZWx
- Converts a 2-dimensional array into a list of x-y co-ordinates,
values and weights
- KPG_BLONx
- Smooths an n-dimensional image using box filter
- KPG_OSTAx
- Compute simple statistics for an array
- KPG_STOSx
- Calculates accurate order statistics by sorting an array
- KPG1_ASNDF
- Create a FrameSet containing NDF-special Frames with given bounds
- KPG1_CH2PM
- Create an AST PolyMap describing a Starlink POLYNOMIAL HDS structure
- KPG1_HDSKY
- Append a primitive HDS object to an AST KeyMap
- KPG1_KY2HD
- Convert an AST KeyMap into an HDS structure
- KPG1_KYGRP
- Create an GRP group holding keyword/value pairs read from an AST
KeyMap
- KPG1_KYHDS
- Copy values from an AST KeyMap to a primitive HDS object
- KPG1_KYMAP
- Create an AST KeyMap holding keyword/value pairs read from a GRP
group
- kpg1_memry
- Return memory currently being used by the current process
- KPG_GTFTS
- Obtain FITS header information from an NDF
- KPG_PTFTS
- Store FITS header information into an NDF
- About this document ...
Next: Abstract
KAPLIBS -- Internal subroutines used within the KAPPA package.
Starlink User Note 238
D.S. Berry
Malcolm J. Currie
9th March 2009
E-mail:ussc@star.rl.ac.uk
Copyright © 2010 Science and Technology Facilities Council