next up previous 530
Next: SETMAGIC - Replaces all occurrences of a given value in an NDF array with the bad value
Up: Specifications of KAPPA applications
Previous: SETEXT - Manipulates the contents of a specified NDF extension


SETLABEL - Sets a new label for an NDF data structure

Description:
This routine sets a new value for the LABEL component  of an existing NDF  data structure. The NDF is accessed in update mode and any pre-existing label is over-written with a new value. Alternatively, if a `null' value (!) is given for the LABEL parameter, then the NDF's label will be erased.

Usage:
setlabel ndf label

Parameters:
LABEL = LITERAL (Read)
The value to be assigned to the NDF's LABEL component. This should describe the type of quantity represented in the NDF's data array (e.g. "Surface Brightness" or "Flux Density"). The value may later be used by other applications, for instance to label the axes of graphs where the NDF's data values are plotted. The suggested default is the current value.
NDF = NDF (Read and Write)
The NDF data structure whose label is to be modified.

Examples:
setlabel ngc1068 "Surface Brightness"
Sets the LABEL component of the NDF structure ngc1068 to be "Surface Brightness".
setlabel ndf=datastruct label="Flux Density"
Sets the LABEL component of the NDF structure datastruct to be "Flux Density".
setlabel raw_data label=!
By specifying a null value (!), this example erases any previous value of the LABEL component in the NDF structure raw_data.

Related Applications :
KAPPA: AXLABEL, SETTITLE, SETUNITS.



next up previous 530
Next: SETMAGIC - Replaces all occurrences of a given value in an NDF array with the bad value
Up: Specifications of KAPPA applications
Previous: SETEXT - Manipulates the contents of a specified NDF extension

KAPPA --- Kernel Application Package
Starlink User Note 95
Malcolm J. Currie & David S. Berry
2013 February 14
E-mail:starlink@jiscmail.ac.uk

Copyright © 2013 Science and Technology Facilities Council