Next: HDR_IN[x]- Read a header item
Up: HDR Fortran subroutines
Previous: HDR_COPY - Copy header information from one image to another
HDR_DELET- Delete a header item
- Description:
- This subroutine deletes a header item.
- Invocation:
- CALL HDR_DELET( PARAM, XNAME, ITEM, COMP, STATUS )
- Arguments:
-
-
PARAM = CHARACTER * ( * ) (Given)
-
Parameter name of the image (case insensitive).
-
XNAME = CHARACTER * ( * ) (Given)
-
Source of the header information
('FITS' or ' ' for FITS headers).
-
ITEM = CHARACTER * ( * ) (Given)
-
Name of the header item.
-
COMP = INTEGER (Given)
-
The component of a multiple FITS header item which is to be
deleted, usually 1.
-
STATUS = INTEGER (Given and Returned)
-
The global status.
- Notes:
- Only header items in output images or those accessed for
modification will be deleted by this routine.
- This subroutine will directly access an image if an
association has not already been made.
- The FITS items 'HISTORY', 'COMMENT'
and ' ' can have more than one occurrence. These can be deleted
one-by-one by repetitive calls to this routine with a value of
1 for the COMP argument (since if you delete the first component
what was the second component now becomes the first). A specific
occurrence can be deleted by giving the correct component number.
The number of occurrences may be queried using the
HDR_NUMB subroutine.
- Item names from any source may be hierarchical
(i.e. ING.DETHEAD deletes the FITS header item "ING
DETHEAD"; BOUNDS.MAXX deletes the MAXX component of BOUNDS in
a non-FITS source).
- This subroutine may be used to delete an item in the same
source of more than one image dataset at a time by using
multiple parameter names. Multiple parameter names are
provided as a comma separated list (i.e. 'IN1,IN2,IN3').
Next: HDR_IN[x]- Read a header item
Up: HDR Fortran subroutines
Previous: HDR_COPY - Copy header information from one image to another
IMG Simple Image Data Access
Starlink User Note 160
P.W. Draper
R.F. Warren-Smith
3 March 2003
E-mail:P.W.Draper@durham.ac.uk
Copyright © 2000-2003 Council for the Central Laboratory of the Research Councils