NRAO Home > CASA > CASA Task Reference Manual

0.1.40 imhistory

Requires:

Synopsis
Retrieve and modify image history

Arguments





Inputs

imagename

Name of the input image

allowed:

string

Default:

mode

Mode to run in, ”list” to retrieve history, ”append” to append a record to history.

allowed:

string

Default:

list

verbose

Write history to logger if mode=”list”?

allowed:

bool

Default:

True

origin

Origin of appended message. Only used for mode=”append”.

allowed:

string

Default:

imhistory

message

Message to append. Only used of mode=”append”.

allowed:

string

Default:

Returns
variant

Example

 
PARAMETER SUMMARY  
imagename        Name of the input (CASA, FITS, MIRIAD) image  
mode             Operating mode. Either "list" or "append" is accepted.  
verbose          Log history if mode="list"?  
origin           Origin of appended message if 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. Default value is imhistory.  
message          Message to append if mode="append".  
 
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 successful.  
 
# get image history, print to log window, and store as an array of  
# strings in variable x  
x = imhistory("my.im", mode="list", verbose=True)  
 
# append a message  
imhistory("my.im", origin="myorigin", message="ETI signal found in this image!")  
 


More information about CASA may be found at the CASA web page

Copyright 2016 Associated Universities Inc., Washington, D.C.

This code is available under the terms of the GNU General Public Lincense


Home | Contact Us | Directories | Site Map | Help | Privacy Policy | Search