matlab.io.fits.getBColParms

Get binary table information

Syntax

[ttype,tunit,typechar,repeat,scale,zero,nulval,tdisp] = matlab.io.fits.getBColParms(fptr,colnum)

Description

[ttype,tunit,typechar,repeat,scale,zero,nulval,tdisp] = matlab.io.fits.getBColParms(fptr,colnum) gets information about an existing binary table column.

Examples

collapse all

Get Information About Binary Table Column

Open Live Script

Open a sample FITS file that has a binary table in the second HDU. Get information about the third column of the table. Then close the sample file.

import matlab.io.*
fptr = fits.openFile("tst0012.fits");
fits.movAbsHDU(fptr,2);
[ttype,tunit,typechar,repeat,scale,zero,nulval,tdisp] = fits.getBColParms(fptr,3)

ttype = 
'COUNTS'

tunit =

  0×0 empty char array

typechar = 
'B'

repeat = 
3

scale = 
123.1000

zero = 
-12.6500

nulval = int64

237

tdisp =

  0×0 empty char array

fits.closeFile(fptr)

Tips

This function corresponds to the fits_get_bcolparms (ffgbcl) 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

expand all

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.getBColParms function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

Version History