Home > mfitsio > fits_write_image_subset.m

fits_write_image_subset

PURPOSE ^

Function Name:

SYNOPSIS ^

function fits_write_image_subset(FILENAME, IMG, START, HEADER);

DESCRIPTION ^

 Function Name:
    fits_write_image_subset

 Description: Writes an image to a region of a FITS file image.

 Usage:
    [IMAGE] = fits_write_image_subset(FILENAME, IMG, START);
    [IMAGE] = fits_write_image_subset(FILENAME, IMG, START, HEADER);

 Arguments:
    FILENAME: A character array representing the filename.
    IMG:      The image to write to the region of the FITS image.
    START:    A vector representing the starting position of the region 
              to start writing the input image.
    HEADER:   Optional. A structure array containing keywords to be modified.

 Returns:
    IMAGE:    The image as a MATLAB array.

 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_image_subset
0003 %
0004 % Description: Writes an image to a region of a FITS file image.
0005 %
0006 % Usage:
0007 %    [IMAGE] = fits_write_image_subset(FILENAME, IMG, START);
0008 %    [IMAGE] = fits_write_image_subset(FILENAME, IMG, START, HEADER);
0009 %
0010 % Arguments:
0011 %    FILENAME: A character array representing the filename.
0012 %    IMG:      The image to write to the region of the FITS image.
0013 %    START:    A vector representing the starting position of the region
0014 %              to start writing the input image.
0015 %    HEADER:   Optional. A structure array containing keywords to be modified.
0016 %
0017 % Returns:
0018 %    IMAGE:    The image as a MATLAB array.
0019 %
0020 % Type 'mfitsio_license' to display the MFITSIO licensing agreement.
0021 
0022 function fits_write_image_subset(FILENAME, IMG, START, HEADER);
0023 
0024 % Author: Damian Eads <eads@lanl.gov>
0025 %
0026 % This software and ancillary information (herein called ``Software'')
0027 % called MFITSIO is made available under the terms described here. The
0028 % SOFTWARE has been approved for release with associated LA-CC number:
0029 % LA-CC-02-085.
0030 %
0031 % This SOFTWARE has been authored by an employee of the University of
0032 % California, operator of the Los Alamos National Laboratory under
0033 % Contract No. W-7405-ENG-36 with the U.S. Department of Energy. The
0034 % U.S. Government has rights to use, reproduce, and distribute this
0035 % SOFTWARE. Neither the Government nor the University makes any
0036 % warranty, express or implied, or assumes any liability or
0037 % responsibility for the use of this SOFTWARE.
0038 %
0039 % If SOFTWARE is modified to produce derivative works, such modified
0040 % SOFTWARE should be clearly marked, so as not to confuse it with the
0041 % version available from LANL.
0042

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