next up previous 524
Next: ERRCLIP - Removes pixels with large errors from an NDF
Up: Specifications of KAPPA applications
Previous: ELPROF - Creates a radial or azimuthal profile of a two-dimensional image


ERASE - Erases an HDS object

Description:
This routine erases a specified HDS  object or container file. If the object is a structure, then all the structure's components (and sub-components, etc.) are also erased. If a slice or cell of an array is specified, then the entire array is erased.
Usage:
erase object

Parameters:
OBJECT = UNIV (Write)
The HDS object or container file to be erased.
OK = _LOGICAL (Read)
This parameter is used to seek confirmation before an object is erased. If a TRUE value is given, then the HDS object will be erased. If a FALSE value is given, then the object will not be erased and a message will be issued to this effect.
Examples:
erase horse
This erases the HDS container file called horse.sdf.

erase fig123.axis
This erases the AXIS  component of the HDS file called fig123.sdf. If AXIS is a structure, all its components are erased too.

erase fig123.axis(1).label
This erases the LABEL  component within the first element of the AXIS structure of the HDS file called fig123.sdf.

erase $AGI_USER/agi_restar.agi_3200_1
This erases the AGIDEV_3200_1 structure of the HDS file called
$AGI_USER/agi_restar.sdf.

Related Applications
FIGARO: CREOBJ, DELOBJ, RENOBJ.


next up previous 524
Next: ERRCLIP - Removes pixels with large errors from an NDF
Up: Specifications of KAPPA applications
Previous: ELPROF - Creates a radial or azimuthal profile of a two-dimensional image

KAPPA --- Kernel Application Package
Starlink User Note 95
Malcolm J. Currie & David S. Berry
2008 July 24
E-mail:ussc@star.rl.ac.uk

Copyright © 2008 Science and Technology Facilities Council