Main Content

matlab.io.fits.writeComment

Write or append COMMENT keyword to CHU

Syntax

writeComment(fptr,comment)

Description

writeComment(fptr,comment) writes (appends) a COMMENT keyword to the CHU. The comment keyword, specified as a character vector or string scalar, will be continued over multiple keywords if it is longer than 70 characters.

This function corresponds to the fits_write_comment (ffpcom) function in the CFITSIO library C API.

Examples

import matlab.io.*
fptr = fits.createFile('myfile.fits');
fits.createImg(fptr,'byte_img',[100 200]);
fits.writeComment(fptr,'this is a comment');
fits.writeComment(fptr,'this is another comment');
fits.closeFile(fptr);
fitsdisp('myfile.fits','mode','full');