Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
mjfitzpatrick committed Apr 26, 2017
0 parents commit 63c5edf
Show file tree
Hide file tree
Showing 745 changed files with 181,322 additions and 0 deletions.
190 changes: 190 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
MSCRED: CCD MOSAIC REDUCTION PACKAGE
Release Notes and Installation Instructions

SUMMARY

The MSCRED external package is used to reduce CCD mosaic data in which
the data is in the mosaic MEF data format.



RELEASE INFORMATION

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

V5.05: August 9, 2012
Fixed a problem in mscfinder.msctpeak which complained about not being
able to open a temporary file.

V5.04: August 17, 2011
Relinked against IRAF 2.15.1a to pick up core library changes.

V5.04: February 18, 2011
Fixed a bug with a missing argument to a procedure which caused a crash
with combine in the macintel architecture.

V5.03: February 3, 2011
Fixed 64-bit bug in xtalkcor.

V5.02: January 20, 2011
Fixed bug in ccdproc.

V5.01: January 10, 2011
Fixed bug in mscdisplay.

V5.0: December 16, 2010



INSTALLATION INSTRUCTIONS

Installation of this external package consists of obtaining the files,
unpacking them, optionally compiling the executables if not included in
the distribution, and defining the environment to load and run the
package. Note that starting with IRAF V2.15 there are installation
utilities which automate this process. So these installation
instructions here are for primarily for earlier versions of IRAF or
those wishing to use the older method.

The package may be installed for a site or as a personal installation.
If you need help with these installation instructions post a request at
the iraf.net website.

The first step is determining your host IRAF architecture. If you are
not sure but have a running IRAF installation then, after starting the
command language, type

cl> show arch
.redhat

This is the value you need to know without the leading '.'; i.e. the
IRAF architecture is "redhat" in the example.

The distributions files may be found in various places. If you got this
document from an ftp directory the files should also be in that
directory with names of the form "mscred-<arch>.tar.gz. These are gzip
compressed tar files. The files for each architecture include the
binaries except for "src" which is only the source.

Unlike earlier distributions (prior to Dec 2010) the tar files are
created so that they are unpacked in the external package directory of
your choosing and the "mscred" subdirectory will be created.

% cd <path> # e.g. /iraf/extern or <mydir>/extern
% tar xzf <file.gz>
% ls -d mscred
mscred

If you want to have multiple binaries, such as for a server, the
simplest thing is to untar each architecture version. This will
redundantly install the same source files which is harmless.

If you already have an older mscred directory you should first remove
it. If you want to have multiple versions you can rename it as an
older version, make a directory for the new version, for instance
"mscredV5.0", and unpack in that directory.

% cd <path> # e.g. /iraf/extern
% mv mscred <mscredOld> # if this is a directory
% mkdir <mscredV> # e.g. mscredV5.0
% cd <mscredV>
% tar xzf <gzfile>
% cd ..
% rm mscred # if this is a previous link
% ln -s <mscredV>/mscred .

Instead of using a link, as shown above, you can also specify paths and
directories as you wish in the $iraf/unix/hlib/extern.pkg file, your
loginuser.cl file, or interactively as follows.

To define the package you need to an IRAF logical path to the mscred
directory and a "task" declaration. As noted above, this is often done
in the $iraf/unix/hlib/extern.pkg file but it can also be done in your
irafuser.csh file or even interactively. The statements you need are
something like:

reset mscred = /local/mscred/
task mscred.pkg = mscred$mscred.cl

Be sure to end the directory path with '/'.

For the help files you must include

mscred$lib/helpdb.mip

in the "helpdb" path. A template of this is found in the extern.pkg
file or something like

printf ("reset helpdb=%s,mscred$lib/helpdb.mip\nkeep\n",
envget("helpdb")) | cl
flpr

in your login.cl or loginuser.cl file. Make sure there is "keep"
statement at the end of the file.



MSCDB

For NOAO Mosaic Imager data a separate instrument database distribution
should also be installed. The distribution file is
"mscdb-univeral.tar.gz. This is unpacked in some directory such as the
directory containing the mscred package. Then in extern.pkg,
loginuser.cl, or login.cl add

set mscdb = <path>/ # ending with '/'

This is usually done in the same way and place that you define the
mscred package.



COMPILING

If you will be compiling the package, as opposed to installing a binary
distribution, then you need to define various environment variables.
The following is for Unix/csh which is the main supported environment.

% setenv iraf /iraf/iraf/ # Path to IRAF root (example)
% source $iraf/unix/hlib/irafuser.csh # Define rest of environment
% setenv IRAFARCH redhat # IRAF architecture
% setenv mscred <path>/ # Path to package

where you need to supply the appropriate path to the IRAF installation
root in the first step and the IRAF architecture identifier for your
machine in the last step.

If you are updating to a newer version and you earlier built the
libraries and executables it is necessary to delete these. Otherwise,
depending on the dates of files in the new version and the locally
built libraries, it may cause the new version to be ignored. To do
this the package is configured "generic" which puts all the binary
files in one binary directory, the files are deleted and then you
continue in the same way as a completely new installation.

cl> mkpkg generic
cl> delete bin.<arch>/* # Substitute redhat, etc.

Configure the package for the particular architecture to be built.

cl> mkpkg <arch> # Substitute redhat, etc.

This will change the bin link from bin.generic to bin.<arch>. The
binary directory will be created if not present. If an error occurs in
setting the architecture then you may need to add an entry to the file
"mkpkg". Just follow the examples in the file.

To create the executables and move them to the binary directory

cl> mkpkg -p mscred # build executables
cl> mkpkg generic # optionally restore generic setting

Check for errors. If the executables are not moved to the binary
directory then the $mscred path package was not done correctly (such as
not having a trailing '/'. 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.
1 change: 1 addition & 0 deletions bin
159 changes: 159 additions & 0 deletions doc/ccdlist.hlp
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
.help ccdlist Jul01 mscred
.ih
NAME
ccdlist -- List CCD processing information
.ih
USAGE
ccdlist images
.ih
PARAMETERS
.ls images
List of mosaic exposures to be listed. A subset of the these may be
selected using the CCD image type parameter.
.le
.ls ccdtype = ""
CCD type to be listed. If no type is specified then all the types are
listed. If a CCD type is specified then only images of that type are
listed. See \fBccdtypes\fR for a list of the package image types.
.le
.ls extname = ""
Comma delimited list of patterns matching the extension names to be listed.
The null string, "", selects all extension names. Otherwise a pattern
must match the full name. For example the pattern "[1-8]" matches
"5" but not "im5". One form of pattern is an exact match so that
a parameter value of "im1,im12" matches both "im1" and "im12", but not
"im11". Typically the parameter would be "" to select all extensions or
just the name of the first extension since all extensions should have the
same filter, type, title, and processing status.
.le
.ls names = no
List the image names only? Used with the CCD image type parameter to make
a list of the images of the specified type.
.le
.ls long = no
Long format listing? The images are listed in a long format containing some
image parameters and the processing history.
.le
.ls ccdproc (pset)
CCD processing parameter set.
.le
.ih
DESCRIPTION
Information from the specified input mosaic exposures is listed on the standard
output. A specific CCD type may be selected from the input exposures by
the parameter \fIccdtype\fR. There are three list formats; the default one
line per image format, an image name only format, and a multi-line long
format. The default one line format consists of the image name, image
size, image pixel type, CCD image type, amplifier ID (if defined), subset
ID (if defined), processing flags, and title. This format contains the
same information as that produced by \fBimheader\fR as well as CCD specific
information. The processing flags identifying the processing operations
performed on the image are given by the following single letter codes.

.nf
X - Crosstalk correction
B - Bad pixel replacement
O - Overscan bias subtraction
T - Trimming
Z - Zero level subtraction
D - Dark count subtraction
F - Flat field calibration
.fi

The long format has the same first line as the default format plus additional
instrument information such as the exposure time and the full processing
history. In addition to listing the completed processing, the operations
not yet done (as specified by the \fBccdproc\fR parameters) are also
listed.

The image name only format is intended to be used to generate lists of
images of the same CCD image type. These lists may be used as "@" file
lists in IRAF tasks.
.ih
EXAMPLES
1. To list the default format for extension im1 of all images:

.nf
cl> ccdlist *.fits extname=im1
ccd001.fits[im1][544,512][short][unknown][1][V]:FOCUS L98-193
ccd007.fits[im1][544,512][short][object][1][V]:N2968 V 600s
ccd015.fits[im1][544,512][short][object][1][B]:N3098 B 500s
ccd024.fits[im1][544,512][short][object][1][R]:N4036 R 600s
ccd045.fits[im1][544,512][short][flat][1][V]:dflat 6v+blue 5s
ccd066.fits[im1][544,512][short][flat][1][B]:dflat 6v+blue 5s
ccd103.fits[im1][544,512][short][flat][1][R]:dflat 6v+blue 5s
ccd104.fits[im1][544,512][short][zero][1][]:bias
ccd105.fits[im1][544,512][short][dark][1][]:dark 3600s
.fi

2. To list all extensions of one mosaic exposure which has been processed:

.nf
cl> ccdlist obj092
obj092[im1][128,256][real][object][1][R][XBOTZF]:NGC1569
obj092[im2][128,256][real][object][2][R][XBOTZF]:NGC1569
obj092[im3][128,256][real][object][3][R][XBOTZF]:NGC1569
obj092[im4][128,256][real][object][4][R][XBOTZF]:NGC1569
obj092[im5][127,256][real][object][5][R][XBOTZF]:NGC1569
obj092[im6][127,256][real][object][6][R][XBOTZF]:NGC1569
obj092[im7][127,256][real][object][7][R][XBOTZF]:NGC1569
obj092[im8][127,256][real][object][8][R][XBOTZF]:NGC1569
.fi


These exposures have not been processed.

3. To restrict the listing to just the object images:

.nf
cl> ccdlist *.fits extname=im1 ccdtype=object
ccd007.fits[im1][544,512][short][object][1][V]:N2968 V 600s
ccd015.fits[im1][544,512][short][object][1][B]:N3098 B 500s
ccd024.fits[im1][544,512][short][object][1][R]:N4036 R 600s
.fi

4. The long list for image "ccd007" is obtained by:

.nf
cl> ccdlist ccd007 extname=im1 l+
ccd007[im1][544,512][short][object][1][V]:N2968 R 600s
exptime = 200. darktime = 200.
[TO BE DONE] Overscan strip is [520:540,*]
[TO BE DONE] Trim image section is [3:510,3:510]
[TO BE DONE] Flat field correction
.fi

5. After processing the images have the short listing:

.nf
cl> ccdlist *.fits extname=im1 ccdtype=object
ccd007.fits[im1][508,508][real][object][1][V][OTF]:N2968 V 600s
ccd015.fits[im1][508,508][real][object][1][B][OTF]:N3098 B 500s
ccd024.fits[im1][544,512][short][object][1][R][OTF]:N4036 R 600s
.fi

The processing indicated is overscan subtraction, trimming, and flat fielding.

6. The long listing for "ccd007" after processing is:

.nf
cl> ccdlist ccd007 extname=im1 l+
ccd007[im1][508,508][real][object][1][V][OTF]:N2968 R 600s
exptime = 200. darktime = 200.
Jun 2 18:18 Overscan section is [520:540,*] with mean=481.8784
Jun 2 18:18 Trim data section is [3:510,3:510]
Jun 2 18:19 Flat field image is FlatV with scale=138.2713
.fi

.ih
REVISIONS
.ls CCDLIST - MSCRED
Modified to work with multiextension mosaic exposures.
.le
.ls CCDLIST V2.11
Added amplifier field in listing.
.le
.ih
SEE ALSO
ccdtypes ccdgroups
.endhelp
Loading

0 comments on commit 63c5edf

Please sign in to comment.