matlab.io.fits.writeDate

Write DATE keyword to current HDU

collapse all in page

Syntax

matlab.io.fits.writeDate(fptr)

Description

matlab.io.fits.writeDate(fptr) writes the DATE keyword to the current HDU.

Examples

collapse all

Write Date to Current HDU

Open Live Script

Create a new FITS file and add an image to it.

import matlab.io.*
fptr = fits.createFile("myfile.fits");
fits.createImg(fptr,"byte_img",[100 200])

Write the date to the current HDU. Then close the file.

fits.writeDate(fptr)
fits.closeFile(fptr)

Examine the file metadata and then delete the file.

fitsdisp("myfile.fits",Mode="full")

HDU:  1 (Primary HDU)
	SIMPLE  =                    T / file does conform to FITS standard
	BITPIX  =                    8 / number of bits per data pixel
	NAXIS   =                    2 / number of data axes
	NAXIS1  =                  200 / length of data axis 1
	NAXIS2  =                  100 / length of data axis 2
	EXTEND  =                    T / FITS dataset may contain extensions
	COMMENT   FITS (Flexible Image Transport System) format is defined in 'Astronomy
	COMMENT   and Astrophysics', volume 376, page 359; bibcode: 2001A&A...376..359H
	DATE    = '2026-01-25T00:49:43' / file creation date (YYYY-MM-DDThh:mm:ss UT)

delete myfile.fits

Tips

This function corresponds to the fits_write_date (ffpdat) 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.writeDate function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

Version History