fitsdisp

Display FITS metadata

collapse all in page

    Syntax

    fitsdisp(filename)
    fitsdisp(filename,Name=Value)

    Description

    fitsdisp(filename) displays metadata for all the Header/Data Units (HDUs) in the specified FITS file.

    example

    fitsdisp(filename,Name=Value) specifies options using one or more name-value arguments. For example, fitsdisp(filename,Mode="full") displays all HDU keywords.

    example

    Examples

    collapse all

    fitsdisp("tst0012.fits")

    HDU:  1 (Primary HDU)
	SIMPLE  =                    T / Standard FITS file
	BITPIX  =                  -32 / No. of bits per pixel
	NAXIS   =                    2 / No. of axes in matrix
	NAXIS1  =                  102 / No. of pixels in X
	NAXIS2  =                  109 / No. of pixels in Y
	EXTEND  =                    T / There may be FITS extensions
	CDELT1  =                  3.1 / Coordinate increment
	CRVAL1  =               1299.1 / Coordinate of reference pixel
	CRPIX1  =                 12.3 / Reference pixel in X
...

    fitsdisp("tst0012.fits",Index=[4 5])

    HDU:  4 
	XTENSION= 'IMAGE   '           / FITS IMAGE Extension
	BITPIX  =                   16 / No. of bits per pixel
	NAXIS   =                    3 / Three axes
	NAXIS1  =                   73 / No. of pixels in X
	NAXIS2  =                   31 / No. of pixels in Y
	NAXIS3  =                    5 / No. of pixels in Z
	PCOUNT  =                    0 / No group parameters
	GCOUNT  =                    1 / One data group only
	EXTNAME = 'quality '           / Extension name
	EXTVER  =                    1 / Extension version is 1
	OBJECT  = 'Ramp 16-bit'        / Name of image
	ORIGIN  = 'ESO     '           / File was prepared at ESO-Garching
	DATE    = '20/08/92'           / Creation date of this file
	COMMENT  This test file was created by P.Grosbol, ESO (pgrosbol@eso.org)
	COMMENT  Simple 16-bit ramp wave pattern for testing of FITS readers
	CDELT1  =                 -2.3 / Coordinate increment
	CRVAL1  =                -73.0 / Coordinate of reference pixel
	CRPIX1  =                 12.1 / Reference pixel in X
	CDELT2  =                  7.1 / Coordinate increment
	CRVAL2  =                300.6 / Coordinate of reference pixel
	CRPIX2  =                -11.3 / Reference pixel in Y
	CDELT3  =                 .003 / Coordinate increment
	CRVAL3  =                 21.2 / Coordinate of reference pixel
	CRPIX3  =                199.0 / Reference pixel in Y

HDU:  5 
	XTENSION= 'TABLE   '           / FITS ASCII table extension
	BITPIX  =                    8 / Character data 8 bits per pixel
	NAXIS   =                    2 / ASCII tables has 2 axes
	NAXIS1  =                   59 / Characters in row
...

    fitsdisp("tst0012.fits",Index=5,Mode="full")

    HDU:  5 
	XTENSION= 'TABLE   '           / FITS ASCII table extension
	BITPIX  =                    8 / Character data 8 bits per pixel
	NAXIS   =                    2 / ASCII tables has 2 axes
	NAXIS1  =                   59 / Characters in row
	NAXIS2  =                   53 / No. or rows in table
	PCOUNT  =                    0 / No group parameters
	GCOUNT  =                    1 / only one group
	TFIELDS =                    8 / No. of table fields
	
	EXTNAME = 'Asciitable'         / Extension name
	EXTVER  =                    1 / Extension version is 1
	EXTLEVEL=                    1 / Extension level is 1
...

    Input Arguments

    collapse all

    Name of FITS file, specified as a string scalar or character vector.

    • If the file is in the current folder or in a folder on the MATLAB® path, then specify the name of the file in filename.

    • If the file is neither in the current folder nor in a folder on the MATLAB path, then specify the full or relative path in filename.

    Example: "myFile.fits"

    Example: "C:\myFolder\myFile.fits"

    Example: "myFolder\myFile.fits"

    Name-Value Arguments

    collapse all

    Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

    Example: fitsdisp("myFile.fits",Mode="min")

    Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

    Example: fitsdisp("myFile.fits","Mode","min")

    HDUs to display, specified as a positive integer scalar or row vector of positive integers.

    Example: Index=1

    Example: Index=[2 3]

    Data Types: double

    Display type, specified as "standard", "min", or "full".

    • "standard" — Display standard keywords.

    • "min" — Display only types and sizes.

    • "full" — Display all keywords.

    Data Types: string | char

    Version History

    Introduced in R2012a

    See Also

    Functions

    Topics

    External Websites