Main Content

matlab.io.fits.readKeyUnit

キーワードからの物理単位文字列

構文

units = readKeyUnit(fptr,keyname)

説明

units = readKeyUnit(fptr,keyname) は、既存キーワードから、物理単位を返します。単位が定義されていない場合、units には空の文字ベクトルが返されます。

この関数は、CFITSIO ライブラリ C API の関数 fits_read_key_unit (ffgunt) に相当します。

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);