matlab.io.fits.isCompressedImg

Determine if current image is compressed

Syntax

tf = matlab.io.fits.isCompressedImg(fptr)


Description

tf = matlab.io.fits.isCompressedImg(fptr) returns true if the image in the current HDU is compressed and false if it is not compressed.

Examples

Determine If Image Is Compressed

import matlab.io.*
fptr = fits.openFile("tst0012.fits");
tf = fits.isCompressedImg(fptr)

tf = logical
   0

fits.closeFile(fptr)

Tips

• This function corresponds to the fits_is_compressed_image 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.isCompressedImg 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.