Next: astSet - Set attribute values for an Object
Up: AST A Library for Handling World Coordinate Systems in Astronomy
Previous: The AST Class Hierarchy

AST Function Descriptions

Subsections

astSet - Set attribute values for an Object
astAddColumn - Add a new column definition to a table
astAddFrame - Add a Frame to a FrameSet to define a new coordinate system
astAddParameter - Add a new global parameter definition to a table
astAngle - Calculate the angle subtended by two points at a third point
astAnnul - Annul a pointer to an Object
astAxAngle - Returns the angle from an axis, to a line through two points
astAxDistance - Find the distance between two axis values
astAxOffset - Add an increment onto a supplied axis value
astBBuf - Begin a new graphical buffering context
astBegin - Begin a new AST context
astBorder - Draw a border around valid regions of a Plot
astBoundingBox - Return a bounding box for previously drawn graphics
astBox - Create a Box
astChannel - Create a Channel
astChannelData - Return a pointer to user-supplied data stored with a Channel
astCircle - Create a Circle
astCirclePars - Returns the geometric parameters of an Circle
astClear - Clear attribute values for an Object
astClearStatus - Clear the AST error status
astClip - Set up or remove clipping for a Plot
astClone - Clone (duplicate) an Object pointer
astCmpFrame - Create a CmpFrame
astCmpMap - Create a CmpMap
astCmpRegion - Create a CmpRegion
astColumnName - Get the name of the column at a given index within the Table
astColumnNull - Get or set the null value for an integer column of a FITS table
astColumnShape - Returns the shape of the values in a named column
astColumnSize - Get the number of bytes needed to hold a full column of data
astConvert - Determine how to convert between two coordinate systems
astCopy - Copy an Object
astCurrentTime - Return the current system time
astCurve - Draw a geodesic curve
astDSBSpecFrame - Create a DSBSpecFrame
astDecompose - Decompose a Mapping into two component Mappings
astDelFits - Delete the current FITS card in a FitsChan
astDelete - Delete an Object
astDistance - Calculate the distance between two points in a Frame
astDownsize - Reduce the number of vertices in a Polygon
astEBuf - End the current graphical buffering context
astEllipse - Create a Ellipse
astEllipsePars - Returns the geometric parameters of an Ellipse
astEmptyFits - Delete all cards in a FitsChan
astEnd - End an AST context
astEscapes - Control whether graphical escape sequences are included in strings
astExempt - Exempt an Object pointer from AST context handling
astExport - Export an Object pointer to an outer context
astFindFits - Find a FITS card in a FitsChan by keyword
astFindFrame - Find a coordinate system with specified characteristics
astFitsChan - Create a FitsChan
astFitsTable - Create a FitsTable
astFluxFrame - Create a FluxFrame
astFormat - Format a coordinate value for a Frame axis
astFrame - Create a Frame
astFrameSet - Create a FrameSet
astFromString - Re-create an Object from an in-memory serialisation
astGenCurve - Draw a generalized curve
astGetX - Get an attribute value for an Object
astGetActiveUnit - Determines how the Unit attribute will be used
astGetColumnData - Retrieve all the data values stored in a column
astGetFitsX - Get a named keyword value from a FitsChan
astGetFrame - Obtain a pointer to a specified Frame in a FrameSet
astGetGrfContext - Return the KeyMap that describes a Plot's graphics context
astGetMapping - Obtain a Mapping that converts between two Frames in a FrameSet
astGetRefPos - Return the reference position in a specified celestial coordinate system
astGetRegionBounds - Returns the bounding box of Region
astGetRegionFrame - Obtain a pointer to the encapsulated Frame within a Region
astGetRegionMesh - Return a mesh of points covering the surface or volume of a Region
astGetRegionPoints - Returns the positions that define the given Region
astGetStcCoord - Return information about an AstroCoords element stored in an Stc
astGetStcNCoord - Return the number of AstroCoords elements stored in an Stc
astGetStcRegion - Obtain a copy of the encapsulated Region within a Stc
astGetTableHeader - Get the FITS headers from a FitsTable
astGetTables - Retrieve any FitsTables currently in a FitsChan
astGetUnc - Obtain uncertainty information from a Region
astGrfPop - Restore previously saved graphics functions used by a Plot
astGrfPush - Save the current graphics functions used by a Plot
astGrfSet - Register a graphics function for use by a Plot
astGrid - Draw a set of labelled coordinate axes
astGridLine - Draw a grid line (or axis) for a Plot
astGrismMap - Create a GrismMap
astHasAttribute - Test if an Object has a named attribute
astHasColumn - Returns a flag indicating if a column is present in a Table
astHasParameter - Returns a flag indicating if a named global parameter is present in a Table
astImport - Import an Object pointer to the current context
astIntersect - Find the point of intersection between two geodesic curves
astInterval - Create a Interval
astIntraMap - Create an IntraMap
astIntraReg - Register a transformation function for use by an IntraMap
astInvert - Invert a Mapping
astIsAClass - Test membership of a class by an Object
astKeyMap - Create a KeyMap
astLinearApprox - Obtain a linear approximation to a Mapping, if appropriate
astLock - Lock an Object for exclusive use by the calling thread
astLutMap - Create a LutMap
astMapBox - Find a bounding box for a Mapping
astMapCopy - Copy entries from one KeyMap into another
astMapGet0X - Get a scalar value from a KeyMap
astMapGet1X - Get a vector value from a KeyMap
astMapGetElemX - Get a single element of a vector value from a KeyMap
astMapHasKey - Check if an entry with a given key exists in a KeyMap
astMapKey - Get the key at a given index within the KeyMap
astMapLenC - Get the number of characters in a character entry in a KeyMap
astMapLength - Get the vector length of an entry in a KeyMap
astMapPut0X - Add a scalar value to a KeyMap
astMapPut1X - Add a vector value to a KeyMap
astMapPutElemX - Put a value into an element of a vector value in a KeyMap
astMapPutU - Add an entry to a KeyMap with an undefined value
astMapRegion - Transform a Region into a new Frame using a given Mapping
astMapRemove - Removed a named entry from a KeyMap
astMapRename - Rename an existing KeyMap entry
astMapSize - Get the number of entries in a KeyMap
astMapSplit - Split a Mapping up into parallel component Mappings
astMapType - Get the data type of an entry in a KeyMap
astMark - Draw a set of markers for a Plot
astMaskX - Mask a region of a data grid
astMatchAxes - Find any corresponding axes in two Frames
astMathMap - Create a MathMap
astMatrixMap - Create a MatrixMap
astNegate - Negate the area represented by a Region
astNorm - Normalise a set of Frame coordinates
astNormMap - Create a NormMap
astNullRegion - Create a NullRegion
astOK - Test whether AST functions have been successful
astOffset - Calculate an offset along a geodesic curve
astOffset2 - Calculate an offset along a geodesic curve in a 2D Frame
astOutlineX - Create a new Polygon outling values in a 2D data grid
astOverlap - Test if two regions overlap each other
astParameterName - Get the name of the global parameter at a given index within the Table
astPcdMap - Create a PcdMap
astPermAxes - Permute the axis order in a Frame
astPermMap - Create a PermMap
astPickAxes - Create a new Frame by picking axes from an existing one
astPlot - Create a Plot
astPlot3D - Create a Plot3D
astPointList - Create a PointList
astPolyCurve - Draw a series of connected geodesic curves
astPolyMap - Create a PolyMap
astPolyTran - Fit a PolyMap inverse or forward transformation
astPolygon - Create a Polygon
astPrism - Create a Prism
astPurgeRows - Remove all empty rows from a table
astPurgeWCS - Delete all cards in the FitsChan describing WCS information
astPutCards - Store a set of FITS header cards in a FitsChan
astPutChannelData - Store arbitrary data to be passed to a source or sink function
astPutColumnData - Store new data values for all rows of a column
astPutFits - Store a FITS header card in a FitsChan
astPutTable - Store a single FitsTable in a FitsChan
astPutTableHeader - Store new FITS headers in a FitsTable
astPutTables - Store one or more FitsTables in a FitsChan
astQuadApprox - Obtain a quadratic approximation to a 2D Mapping
astRate - Calculate the rate of change of a Mapping output
astRateMap - Create a RateMap
astRead - Read an Object from a Channel
astReadFits - Read cards into a FitsChan from the source function
astRebinX - Rebin a region of a data grid
astRebinSeqX - Rebin a region of a sequence of data grids
astRemapFrame - Modify a Frame's relationship to other Frames in a FrameSet
astRemoveColumn - Remove a column from a table
astRemoveFrame - Remove a Frame from a FrameSet
astRemoveParameter - Remove a global parameter from a table
astRemoveRegions - Remove any Regions from a Mapping
astRemoveRow - Remove a row from a table
astRemoveTables - Remove one or more tables from a FitsChan
astResampleX - Resample a region of a data grid
astResolve - Resolve a vector into two orthogonal components
astRetainFits - Indicate that the current card in a FitsChan should be retained
astSame - Test if two AST pointers refer to the same Object
astSelectorMap - Create a SelectorMap
astSet - Set attribute values for an Object
astSetX - Set an attribute value for an Object
astSetActiveUnit - Specify how the Unit attribute should be used
astSetFitsX - Store a keyword value in a FitsChan
astSetFitsCM - Store a comment card in a FitsChan
astSetFitsU - Store an undefined keyword value in a FitsChan
astSetRefPos - Set the reference position in a specified celestial coordinate system
astSetStatus - Set the AST error status to an explicit value
astSetUnc - Store uncertainty information in a Region
astShiftMap - Create a ShiftMap
astShow - Display a textual representation of an Object on standard output
astShowMesh - Display a mesh of points covering the surface of a Region
astSimplify - Simplify a Mapping
astSkyFrame - Create a SkyFrame
astSkyOffsetMap - Returns a Mapping which goes from absolute coordinates to offset coordinates
astSlaAdd - Add a celestial coordinate conversion to an SlaMap
astSlaMap - Create an SlaMap
astSpecAdd - Add a spectral coordinate conversion to a SpecMap
astSpecFluxFrame - Create a SpecFluxFrame
astSpecFrame - Create a SpecFrame
astSpecMap - Create a SpecMap
astSphMap - Create a SphMap
astStatus - Obtain the current AST error status value
astStcCatalogEntryLocation - Create a StcCatalogEntryLocation
astStcObsDataLocation - Create a StcObsDataLocation
astStcResourceProfile - Create a StcResourceProfile
astStcSearchLocation - Create a StcSearchLocation
astStcsChan - Create an StcsChan
astStripEscapes - Remove AST escape sequences from a string
astSwitchMap - Create a SwitchMap
astTable - Create a Table
astTableSource - Register a source function for accessing tables in FITS files
astTest - Test if an Object attribute value is set
astTestFits - See if a named keyword has a defined value in a FitsChan
astText - Draw a text string for a Plot
astThread - Determine the thread that owns an Object
astTimeAdd - Add a time coordinate conversion to a TimeMap
astTimeFrame - Create a TimeFrame
astTimeMap - Create a TimeMap
astToString - Create an in-memory serialisation of an Object
astTran1 - Transform 1-dimensional coordinates
astTran2 - Transform 2-dimensional coordinates
astTranGrid - Transform a grid of positions
astTranMap - Create a TranMap
astTranN - Transform N-dimensional coordinates
astTranP - Transform N-dimensional coordinates held in separate arrays
astTune - Set or get an integer-valued AST global tuning parameter
astTuneC - Set or get a character-valued AST global tuning parameter
astUinterp - Perform sub-pixel interpolation on a grid of data
astUkern1 - 1-dimensional sub-pixel interpolation kernel
astUnformat - Read a formatted coordinate value for a Frame axis
astUnitMap - Create a UnitMap
astUnlock - Unlock an Object for use by other threads
astVersion - Return the version of the AST library being used
astWarnings - Returns any warnings issued by the previous read or write operation
astWatch - Identify a new error status variable for the AST library
astWcsMap - Create a WcsMap
astWinMap - Create a WinMap
astWrite - Write an Object to a Channel
astWriteFits - Write out all cards in a FitsChan to the sink function
astXmlChan - Create an XmlChan
astZoomMap - Create a ZoomMap

Next: astSet - Set attribute values for an Object
Up: AST A Library for Handling World Coordinate Systems in Astronomy
Previous: The AST Class Hierarchy

AST A Library for Handling World Coordinate Systems in Astronomy
Starlink User Note 211
R.F. Warren-Smith & D.S. Berry
7th December 2012
E-mail:starlink@jiscmail.ac.uk

Copyright (C) 2012 Science \& Technology Facilities Council