matlab.io.fits.writeKeyUnit

Write physical units string

Syntax

writeKeyUnit(fptr,keyname,unit)

Description

writeKeyUnit(fptr,keyname,unit) writes the physical units into an existing keyword. fptr is created using the fits.createFile function. Specify keyname and unit as a character vector or string scalar.

This function corresponds to the fits_write_key_unit (ffpunt) function in the CFITSIO library C API.

Examples

import matlab.io.*
fptr = fits.createFile('myFitsFile.fits');
fits.createImg(fptr,'long_img',[10 20]);
fits.writeKey(fptr,'VELOCITY',12.3,'orbital speed');
fits.writeKeyUnit(fptr,'VELOCITY','km/s');
fits.closeFile(fptr);

See Also