Home > mfitsio > fits_write_header.m

fits_write_header

PURPOSE ^

Function Name:

SYNOPSIS ^

function fits_write_header(FILENAME, HEADER);

DESCRIPTION ^

 Function Name:
    fits_write_header

 Description: Write a header to a FITS file. Any 'BITPIX', 'NAXIS', or
 'SIMPLE' field is ignored. The function does not rewrite the entire header.
 Instead, it only rewrites fields present in the HEADER structure.

 Usage:
    fits_write_header(FILENAME, HEADER);

 Arguments:
    FILENAME: A character array representing the filename.
    HEADER: A structure array containing the header keywords to modify.

 Returns:
    Nothing.

 Type 'mfitsio_license' to display the MFITSIO licensing agreement.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 % Function Name:
0002 %    fits_write_header
0003 %
0004 % Description: Write a header to a FITS file. Any 'BITPIX', 'NAXIS', or
0005 % 'SIMPLE' field is ignored. The function does not rewrite the entire header.
0006 % Instead, it only rewrites fields present in the HEADER structure.
0007 %
0008 % Usage:
0009 %    fits_write_header(FILENAME, HEADER);
0010 %
0011 % Arguments:
0012 %    FILENAME: A character array representing the filename.
0013 %    HEADER: A structure array containing the header keywords to modify.
0014 %
0015 % Returns:
0016 %    Nothing.
0017 %
0018 % Type 'mfitsio_license' to display the MFITSIO licensing agreement.
0019 
0020 function fits_write_header(FILENAME, HEADER);
0021 
0022 % Author: Damian Eads <eads@lanl.gov>
0023 %
0024 % This software and ancillary information (herein called ``Software'')
0025 % called MFITSIO is made available under the terms described here. The
0026 % SOFTWARE has been approved for release with associated LA-CC number:
0027 % LA-CC-02-085.
0028 %
0029 % This SOFTWARE has been authored by an employee or employees of the
0030 % University of California, operator of the Los Alamos National Laboratory
0031 % under Contract No. W-7405-ENG-36 with the U.S. Department of Energy.
0032 % The U.S. Government has rights to use, reproduce, and distribute this
0033 % SOFTWARE.  The public may copy, distribute, prepare derivative works and
0034 % publicly display this SOFTWARE without charge, provided that this Notice
0035 % and any statement of authorship are reproduced on all copies.  Neither
0036 % the Government nor the University makes any warranty, express or
0037 % implied, or assumes any liability or responsibility for the use of this
0038 % SOFTWARE.  If SOFTWARE is modified to produce derivative works, such
0039 % modified SOFTWARE should be clearly marked, so as not to confuse it with
0040 % the version available from LANL.
0041 %
0042 % Consult the COPYING file for more details on licensing.

Generated on Sun 14-Jun-2015 17:12:45 by m2html © 2005