INSTALLATION (Jan00)             crutil             INSTALLATION (Jan00)



               CRUTIL: COSMIC RAY REMOVAL UTILITY PACKAGE
              Release Notes and Installation Instructions



SUMMARY
The CRUTIL external package contains  tasks  for  removing  cosmic  rays
from  images.   Some  are  for  single  images and some are for multiple
exposures.


RELEASE INFORMATION
The following summary only highlights the  major  changes.   There  will
also be minor changes and bug fixes.


V1.6: May 3, 2001
    The  "nrej"  option had a bug such that if the value was 1 or 2 then
    many cosmic rays would not be found.  There was also a  bug  in  the
    buffering resulting in a memory corruption error.

V1.5: Sep 13, 2000
    CRAVERAGE  would  not  work  well when strong cosmic rays are bigger
    than a single pixel.  The task was modified  to  add  the  parameter
    "nrej".   This  allows excluding the specified number of the highest
    pixels in the averaging box from the average.

V1.4: Jan 6, 2000
    New task CRAVERAGE detects cosmic rays as deviations  from  a  block
    average  excluding the candidate pixel.  The block averages are also
    used to detect objects against a  median  background.   Cosmic  rays
    are  excluded  from  the detected objects to avoid finding the cores
    of sharp objects such as stars.
    
    CRGROW has added parameters "inval" and  "outval"  to  select  which
    mask  values  to  grow  and what value to give them.  An INDEF value
    selects all non-zero values as input  and  uses  the  value  of  the
    pixel being grown as output.
    
    Fixed a bug (#457) in CRMEDIAN.

V1.3: Oct 19, 1999
    Fixed a bug (#447) in CRNEBULA where the "rin" and "rout" parameters
    were not being used.

V1.2: Sep 4, 1998
    Fixed a bug (#410) in CRMEDIAN that would leave  lines  of  zero  in
    the output for large images.

V1.1: May 1998
    Added  'e'  and  'v'  keys  to  COSMICRAYS  to  allow  deletion  and 
    undeletion of candidates in a rectangular region.
    
    Fixed typo in "crmasks" parameter in task COSMICRAYS.

V1.0: April 1998
    First release.


INSTALLATION INSTRUCTIONS
Installation of this external package consists of obtaining  the  files,
creating  a  directory containing the package, compiling the executables
or installing precompiled executables, and defining the  environment  to
load  and  run  the package.  The package may be installed for a site or
as a personal installation.  If you need help  with  these  installation
instructions   contact   iraf@noao.edu  or  call  the  IRAF  HOTLINE  at 
520-318-8160.

[1-site]
    If you are installing the package for site use  login  as  IRAF  and
    edit the IRAF file defining the packages.
    
        $ set def irafhlib  # VMS example
        % cd $hlib          # UNIX example
    
    Define  the  environment variable "crutil" to be the pathname to the
    crutil root directory.  The '$' character must be escaped in the VMS
    pathname  and  UNIX  pathnames  must be terminated with a '/'.  Edit
    extern.pkg to include the following.
    
        reset crutil = usr\$1:[crutil]      # VMS example
        reset crutil = /local/crutil/       # UNIX example
        task  crutil.pkg = crutil$crutil.cl
    
    Near the end of the hlib$extern.pkg file, update the  definition  of
    helpdb  so  it includes the crutil help database, copying the syntax
    already  used  in  the  string.   Add  this  line  before  the  line 
    containing a closing quote:
    
        ,crutil$lib/helpdb.mip\

[1-personal]
    If  you  are  installing  the package for personal use define a host
    environment variable with the pathname of the  directory  where  the
    package  will  be  located.   Note that Unix pathnames must end with
    '/'.  For example:
    
        % setenv crutil /local/crutil/
    
    In your login.cl or loginuser.cl file make the following definitions
    somewhere before the "keep" statement.
    
        reset crutil = /local/crutil/
        task  crutil.pkg = crutil$crutil.cl
        printf ("reset helpdb=%s,crutil$lib/helpdb.mip\nkeep\n",
            envget("helpdb")) | cl
        flpr

[2] Login  into  IRAF.  Create a directory to contain the package files.
    This directory should be outside the standard IRAF directory tree.
    
        cl> mkdir crutil$
        cl> cd crutil

[3] The package is distributed as a tar archive for the sources and,  as
    an  optional  convenience,  a  tar  archive  of  the executables for
    select host computers.  Note that IRAF includes a tar  reader.   The
    tar  file(s) are most commonly obtained via anonymous ftp.  Below is
    an example from a Unix machine.
    
        cl> ftp iraf.noao.edu (140.252.1.1)
        login: anonymous
        password: [your email address]
        ftp> cd iraf/extern
        ftp> get crutil.readme
        ftp> binary
        ftp> get crutil.tar.Z
        ftp> get crutil-bin.<arch>.Z
        ftp> quit
        cl> !uncompress crutil.tar
        cl> !uncompress crutil-bin.<arch>
    
    The readme file contains these  instructions.   The  <arch>  in  the
    optional  executable distribution is replaced by the standard system
    identification for your computer (sparc, ssun, alpha, linux, etc.).
    
    Upon request the tar file(s) may be otained on tape  for  a  service
    charge.   In  this  case  you  would  mount the tape and specify the
    device name in the next step.

[4] Extract the source files from the tar archive using 'rtar".
    
        cl> softools
        so> rtar -xrf crutil.tar
        so> bye
    
    On some systems, an error message will appear  ("Copy  'bin.generic'
    to  './bin  fails")  which can be ignored.  Also on VMS systems, the
    various bin.'mach' directories  created  by  rtar  can  be  deleted.
    UNIX  sites should leave the symbolic link 'bin' in the package root
    directory pointing to  'bin.generic'  but  can  delete  any  of  the
    bin.<arch>  directories  that  won't be used.  If there is no binary
    directory for the system you are installing it will be created  when
    the package is compiled later.
    
    If the binary executables have been obtained these are now extracted
    into the appropriate bin.<arch> directory.
    
        # Example of sparc installation.
        cl> cd crutil
        cl> rtar -xrf crutil-bin.sparc
    
    The archive file(s)  can  be  deleted  once  the  package  has  been
    successfully installed or the tape device can be freed.

[5] For  a  source  installation  you  now  have  to  build  the package
    executable(s).  First you configure the package for  the  particular
    architecture.   To  check the architecture names you can look at the
    mkpkg file.
    
        cl> cd crutil
        cl> mkpkg <arch>            # Substitute sparc, ssun, alpha, etc.
        cl> mkpkg -p crutil
        cl> mkpkg generic
    
    This will change the bin link from bin.generic to  bin.<arch>.   The
    binary   directory  will  be  created  if  not  present.   Then  any 
    executables are compiled and and  moved  to  the  binary  directory.
    Check  for  errors.   If the executables are not moved to the binary
    directory then step [1] was  not  done  correctly.   The  last  step
    restores  the  package  to  a  generic  configuration.   This is not
    necessary if you will only have one architecture for the package.

This should complete the installation.  You can  now  load  the  package
and begin testing and use.
