[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

Waldhäuser Str. 64, D-72076 Tübingen, Germany
[Uni logo]


STSUBIM Source code in stsubim.pro

STSUBIM

Name
       STSUBIM
Purpose
       Open an STSDAS file and read a portion of the file into an array.
Explanation
       An enhanced version of STRD.  Program will prompt for the file name
       and subimage bounds.
Calling Sequence
       STSUBIM, im, hdr, [ filename, x1, x2, y1, y2, step, /SILENT ]
Optional Input Parameters
       FILENAME -  Character string giving the name of the SDAS file
               to be read.  If omitted, then program will prompt
               for the file name.  If an extension is given, then
               it must terminate in a 'h'.  A default extension of '.hhh'
               is assumed, if one is not supplied.  In VMS, version numbers
               are ignored, and the most recent version is always used.
       X1      -  Starting x value (def=0), integer scalar
       X2      -  Ending x value (def=total record size), integer scalar
       Y1      -  Starting y value (def = 0), integer scalar
       Y2      -  Ending y value (def = total no. of records), integer scalar
     STEP    -  The number of pixels between extracted pixels.  This allows
                the user to read every Nth pixel from the image.  STEP=1
                indicates full resolution, STEP=2 indicates every other pixel,
                etc.
Output Parameters
       IM - array containing image data
       HDR - string array containing STSDAS header
Keyword Parameters
       SILENT  -  If this keyword is present, the size of the image
               will not be printed.
Common Blocks
       STCOMMN - Created by SXOPEN.  STSUBIM uses STCOMMN to check
       for an open unit, and to get image dimensions.
Side Effects
       STSDAS image array and header are read into IM and HD
       IF FILENAME is not supplied, then the program will check that
       the image and header variable do not already contain data.
Restrictions
       For use only on data without Groups!!
       For use only on 2 dimensional data files.
Procedure
       Program checks that STSDAS file exists and that IDL variables do
       not already contain data, before calling SXOPEN and STSUB to
       read in data.  The header keywords NAXIS* and CRPIX*
       are updated to account for the actual image size.
Procedures Used
       FDECOMP, ORDINAL(), SPEC_DIR(), STSUB, SXOPEN, SXADDPAR, SXADDHIST
Revision History
       Written B. Pfarr, STX, September 1987 from STRD
       Modifed to IDL Version 2, M. Greason, STX, May 1990.
       Prints 1st, 2nd, etc., instead of 1th, 2th... R. S.Hill, STX, Aug 1991
       CRPIX transformation corrected.  RSH, HSTX, 27-May-1992.
       Use new astrometry structure   W. Landsman   Feb 1994
       Converted to IDL V5.0   W. Landsman   September 1997

Last modified by pro2html on 2001 April 26 at 03:14 UTC

[Home Page] [Software, Documentation] [IDL Documentation] [Quick Reference] [Feedback]

Jörn Wilms (wilms@astro.uni-tuebingen.de)
Updated automatically