Home > mfitsio > fits_read_image_subset.m

fits_read_image_subset

PURPOSE ^

Function Name:

SYNOPSIS ^

function [IMAGE]=fits_read_image_subset(FILENAME, START, END);

DESCRIPTION ^

 Function Name:
    fits_read_image_subset

 Description: Reads a region of an image from a FITS file. This function
              is particularly useful for programs which must process
              large images.

 Usage:
    [IMAGE] = fits_read_image_subset(FILENAME, START, END);

 Arguments:
    FILENAME: A character array representing the filename.
    START:    A vector representing the starting position of the image region.
    END:      A vector representing the ending position of the image region.

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

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