<casaxml xsi:schemaLocation="http://casa.nrao.edu/schema/casa.xsd file:///opt/casa/code/xmlcasa/xml/casa.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://casa.nrao.edu/schema/psetTypes.html">
<task category="information,analysis" name="imhistory" type="function">
<shortdescription>Retrieve and modify image history</shortdescription>
Retrieve and modify image history.
This task provides access to the logtable of an image, where generally
history information is stored. Two operation modes are supported. When
mode="list", the history messages are returned as an array of
strings. If verbose=True, this information is also written to the
logger. When mode="append", a specified message (along with its
specified origin) are appended to the logtable and True is returned if
<param mustexist="true" name="imagename" type="path">
<shortdescription>Name of the input spectral line image</shortdescription>
<description>Name of the input (CASA or FITS) image
Example: imagename='ngc5921.im'
<example>imagename='ngc5921.im'</example>
<param name="mode" type="string">
<shortdescription>Mode to run in, "list" to retrieve history, "append" to append a record to history.</shortdescription>
<description>Operating mode.
Default: 'list' (retrieve history)
Options: 'list|append' ('append' to append a
<param subparam="true" name="verbose" type="bool">
<shortdescription>Write history to logger if mode="list"?</shortdescription>
<description>Write history to logger if mode="list"?
Subparameter of mode='list'
<param subparam="true" name="origin" type="string">
<shortdescription>Origin of appended message. Only used for mode="append".</shortdescription>
<description>Origin of appended message.
Subparameter of mode='append'
The user can specify any string. This string will
appear as a tag at the start of the appended line
in the image history. Only used for mode="append".