Getting Started Documentation Glish Learn More Programming Contact Us
Version 1.9 Build 1488
News FAQ
Search Home


next up previous contents index
Next: image.replacemaskedpixels - Function Up: image - Tool Previous: image.rotate - Function


image.rename - Function



Package general
Module images
Tool image


Rename the image file associated with this image tool


Synopsis
rename(name, overwrite)


Arguments

name in The new image file name
    Allowed: String
overwrite in Overwrite target file if it already exists
    Allowed: T or F
    Default: F


Returns
T or fail


Description

This function renames the image file associated with the image tool. If a file with name name already exists, you can overwrite it with the argument overwrite; otherwise a fail will result.



Example
- im := image('myimage')  
- im.name(strippath=T)
myimage
- im.rename('newimage', overwrite=T)
- im.name(strippath=T)
newimage





next up previous contents index
Next: image.replacemaskedpixels - Function Up: image - Tool Previous: image.rotate - Function   Contents   Index
Please send questions or comments about AIPS++ to aips2-request@nrao.edu.
Copyright © 1995-2000 Associated Universities Inc., Washington, D.C.

Return to AIPS++ Home Page
2006-08-01