Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

matlab.io.fits.readKeyUnit

Physical units string from keyword

Syntax

units = readKeyUnit(fptr,keyname)

Description

units = readKeyUnit(fptr,keyname) returns the physical units string from an existing keyword. If no units are defined, units is returned as an empty character vector.

This function corresponds to the fits_read_key_unit" (ffgunt) function in the CFITSIO library C API.

Examples

import matlab.io.*
fptr = fits.createFile('myfile.fits');
fits.createImg(fptr,'long_img',[10 20]);
fits.writeKey(fptr,'VELOCITY',12.3,'orbital speed');
fits.writeKeyUnit(fptr,'VELOCITY','km/s');
units = fits.readKeyUnit(fptr,'VELOCITY');
fits.closeFile(fptr);
Was this topic helpful?