        XCCDRED -- Experimental version of CCDRED Package

This external package is an experimental version of the CCDRED package
which supports the ARCON multiple readout image format.  The only task
which has been modified from the V2.10.3beta version is CCDPROC.  Note that
to make preparing and using this experimental version as easy as possible
the task names are unchanged.  Therefore, you should avoid loading both
XCCDRED and CCDRED at the same time.

CCDPROC will use the following keywords where the example is for a
two amplifier readout:

AMPLIST = '11 12   '           / Readout order in y,x
ASEC11  = '[1:1056,1:2048]'    / Section read with Amp11
CSEC11  = '[1:1024,1:2048]'    / Section in full CCD for DSEC11
DSEC11  = '[1:1024,1:2048]'    / Image area in raw frame for Amp11
TSEC11  = '[1:1024,1:2048]'    / Trim section definition for Amp11
BSEC11  = '[1025:1056,1:2048]' / Bias section definition for Amp11
ASEC12  = '[1057:2112,1:2048]' / Section read with Amp12
CSEC12  = '[1025:2048,1:2048]' / Section in full CCD for DSEC12
DSEC12  = '[1089:2112,1:2048]' / Image area in raw frame for Amp12
TSEC12  = '[1089:2112,1:2048]' / Trim section definition for Amp12
BSEC12  = '[1057:1088,1:2048]' / Bias section definition for Amp12

CCDPROC identifies the ARCON format by the presence of the AMPLIST
keyword.  If this keyword is not found then the behavior will be as
before.  The AMPLIST words, which are whitespace delimited, are appended to
roots ASEC, BSEC, CSEC, DSEC, and TSEC.  Note that this means the names
need not be as shown but could be things like A, B, 1, 2, X1Y1 though
limited to four characters.

The geometry looks at the data sections, DSEC, to define the input regions,
and pieces them together on output according to the CCD sections, CSEC,
except that origin is shifted to pixel (1,1).  The origin shifting would
only be needed if a subsection of the detector is readout.  The bias
sections, BSEC, are used as one would expect.  After trim and overscan
processing all the keywords are removed yeilding an image which looks like
a normal single amplifier readout.  Note that the trim sections given by
TSEC are not used but are deleted after processing.  In order to provide
the option of leaving the bias regions in the data (with or without bias
subtraction) if the trim option is not set then the ASEC descriptions are
used for both input and output and the keywords are not deleted

A requirement is that data sections form a regular grid though there is no
requirement that the size all be the same.  In other words, all data
regions along a column have the same width and all data regions along a
line have the same height.  The example below (with more than two
across to indicate the extension to a mosiac) is acceptable.

        +----+--------+--------------+
        |    |        |              |
        |    |        |              |
        +----+--------+--------------+
        |    |        |              |
        |    |        |              |
        |    |        |              |
        |    |        |              |
        +----+--------+--------------+

The following example is not acceptable.

        +----+
        |    |--------+-----------+
        |    |        |           |
        +----+--------+           |
        |    |        |--------------+
        |    |        |              |
        |    |        |              |
        +----|        |              |
             +--------+--------------+

REVISIONS

April 19, 2001
    1. SETINSTRUMENT was fixed and the default site is ctio.
    2. The CCDDB files were updated.
February 17, 2000
    Fixed a bug with the overscan sections using uninitialized memory.
    Fixed a bug with SETINSTRUMENT doing "epar ccdred" instead of xccdred.
    Otherwise this is the same as the version from 1994.

INSTALLATION INSTRUCTIONS FOR THE XCCDRED PACKAGE

If you have any questions, please contact the IRAF group at
iraf$noao.edu  call the IRAF HOTLINE at 602-323-4160.

[1] The package is distributed as a tar archive; IRAF is distributed
    with a tar reader if needed.  The tar archive may be obtained
    anonymous ftp as follows.

        % ftp iraf.noao.edu (or 140.252.1.1)
        login: anonymous
        password: [your email address]
        ftp> cd pub/valdes
        ftp> get xccdred.readme
        ftp> binary
        ftp> get xccdred.tar.Z
        ftp> quit
        % uncompress xccdred.tar

    The xccdred.readme file contains these instructions.

[2] Create a directory to contain the XCCDRED external package files.  This
    directory should be outside the IRAF directory tree.  In the following
    examples, this root directory is named /iraf/extern/xccdred/.  Make the
    appropriate file name substitutions for your site.

-------------------------------------------------------------------------------

A: INSTALLTION AS AN INSTALLED PACKAGE

[3A] Log in as IRAF and edit the extern.pkg file in the $iraf/unix/hlib
    directory to define the package to the CL.  From within the CL
    you can use hlib$.

        % cd $iraf/unix/hlib	# Unix
	cl> cd hlib$		# CL

    Define the environment variable xccdred to be the pathname to the
    xccdred root directory.  Pathnames must be terminated with a '/'.
    Edit extern.pkg to include:

        reset xccdred  = /iraf/extern/xccdred/
        task  $xccdred.pkg = xccdred$xccdred.cl

    Near the end of the hlib$extern.pkg file, update the definition of helpdb
    so it includes the xccdred help database, copying the syntax already used
    in the string.  Add this line before the line containing a closing quote:
        
                ,xccdred$lib/helpdb.mip\

B: INSTALLTION AS A PERSONAL PACKAGE

[3B] Set an environment variable defining the path to package directory:

	% setenv xccdred = /iraf/extern/xccdred/

    In your login.cl file before the keep add:

	task xccdred=xccdred$xccdred.cl

-------------------------------------------------------------------------------

[4] Log into the CL (from the IRAF account if this is a system installation
    otherwise as yourself) and unpack the archive file.  Change
    directories to the xccdred root directory created above and use 'rtar':

        cl> cd xccdred
        cl> softools
        cl> rtar -xrf <archive>  where <archive> is the tar filename

   The archive file can be deleted once the package has been successfully
   installed.


[5] When the archive has been unpacked, build the XCCDRED package executable.  
    The compilation and linking of the XCCDRED package is done using the
    following command:

        cl> mkpkg -p xccdred update >& xccdred.spool &

    NOTE: On systems that concurrently support different architectures
    (e.g., Suns, Convex), you must configure the system for the desired
    architecture before issuing the above command.  SUN/IRAF sites must
    execute a pair of 'mkpkg' commands for each supported architecture type.
    The Unix environment variable IRAFARCH must be set as well before
    compiling.  If the bin.<arch> directory does not exist it must
    be created first.  For example:

        # Assuming IRAFARCH is set to ssun
        cl> mkpkg -p xccdred ssun
        cl> mkpkg -p xccdred update >& xccdred.ssun &
        cl> mkpkg -p xccdred generic

    The spool file(s) should be reviewed upon completion to make sure there
    were no errors.  

    Look in the mkpkg file for the current architectures and to add new
    ones if necessary.

    If desired rather than building the binaries yourself you can
    get a tar file with the binaries named as xccdred.bin-<arch>.Z
    where <arch> is the architecture name (such as "ssun" for Solaris).
    To install go to the xccdred root directory

	% cd /iraf/extern/xccdred			# Example
	% zcat <path>/xccdred-bin.ssun | rtar -xv	# Example

    If a binary distribution does not exist in the distribution directory
    write to iraf@noao.edu to request it be built.
