<casaxml xsi:schemaLocation="http://casa.nrao.edu/schema/casa.xsd file:///opt/casa/code/xmlcasa/xml/casa.xsd" xmlns="http://casa.nrao.edu/schema/psetTypes.html" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<task type="function" name="imhead" category="information, analysis, manipulation">
<shortdescription>List, get and put image header parameters</shortdescription>
List, get and put image header parameters.
This task allows the user to manipulate metadata associated with a
CASA image. Both float and complex valued images are fully supported.
For measurement sets, the task vishead should be used.
<param type="path" name="imagename" mustexist="true">
<shortdescription>Name of the input spectral line image</shortdescription>
<description>Input image cube.
Example: imagename='ngc5921_task.image'
<example>imagename='ngc5921_task.image'</example>
<param type="string" name="mode">
<description>Mode of operation.
Options: "add", "del", "get", "history", "list",
"put", or "summary".
* add: Add a new metadata value to the image. The
behavior of mode="add" depends on the
keyword. In general, the return value will be
True if the operation succeeds, or False if it
fails or is not supported. If unsuccessful or
not supported, a message is normally logged
which describes the failure. In most cases, you
probably want to use mode='put' rather than
mode='add'. We continue to support mode='add'
mainly for backward compatibility.
* del: Delete a key or reset its value to a
fidicual value if possible. Ignores all but
imagename, mode, and hdkey parameters. In
general, the return value will be True if the
operation succeeds, or False if it fails or is
not supported. If unsuccessful or not
supported, a warning message is normally logged
which describes the failure.
* get: Return the specified keyword
value. Ignores all but imagename, mode, and
* history: Log image history. Ignores all but
imagename and mode parameters.
* list: Show supported keywords and their
values. Ignores all but imagename and mode
put: Modify the specified value associated with
the keyword. True is returned if the metadatum
was successfully modified, False
otherwise. Normally, a diagnostic message is
logged if there is a failure. Only the