matlab.io.fits.readKeyDbl

Read key as double-precision value

Syntax

[value,comment] = matlab.io.fits.readKeyDbl(fptr,keyname)


Description

[value,comment] = matlab.io.fits.readKeyDbl(fptr,keyname) returns the specified key value and comment. Specify the keyname argument as a string scalar or character vector. The function returns value as a double scalar value and comment as a character vector.

Examples

Read Double-Precision Key Value

Read the key value and comment for the keyword CRPIX2 in a sample FITS file.

import matlab.io.*
fptr = fits.openFile("tst0012.fits");
[value,comment] = fits.readKeyDbl(fptr,"CRPIX2")

value = 
-2.0318e+03

comment = 
'Reference pixel in Y'

fits.closeFile(fptr)

Tips

• This function corresponds to the fits_read_key_dbl (ffgkyd) function in the CFITSIO library C API.

• To use this function, you must be familiar with the CFITSIO C interface. You can access the CFITSIO documentation at the CFITSIO website.

Extended Capabilities

Thread-Based Environment

Run code in the background using MATLAB® backgroundPool or accelerate code with Parallel Computing Toolbox™ ThreadPool. (since R2026a)

The matlab.io.fits.readKeyDbl function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

Version History

R2026a: Use function in thread-based environments

You can use this function in thread-based environments.