The ADC factor which converts the ADUs of the input data frames into detected electrons, for which Poissonian statistics are valid
The bias strip placements
The readout direction
The typical readout noise
The useful CCD area
The definition of the BAD areas of the chip
The routine also initialises the CCDPACK logging system.
All parameters may be supplied as ! (the parameter-system null value) this indicates that the current value is to be left unchanged if one exists (this will be shown as the default and can also be accepted by pressing return) or that a value is not to be assigned for this global parameter. If a value is not assigned it will be defaulted or prompted as appropriate when other CCDPACK applications are run.
If you are using CCDPACK Sets, then some of the parameters describing device characteristics may differ according to which member of each Set is being described. By setting the BYSET parameter to true, and supplying a value for the INDEX parameter, you can indicate that the global values you supply apply to the members of each Set with that Set Index. In this case it will be necessary to run CCDSETUP once for each Set Index to be used (for instance, once for each chip in a mosaic camera), giving a different INDEX value each time. This applies to the global parameters ADC, BOUNDS, DEFERRED, DIRECTION, EXTENT, MASK, RNOISE and SATURATION.
The removal of global parameters is performed by the CCDCLEAR application.
"zero (just for confusion). This is actually the charge which is not transferred from a CCD pixel when the device is read out. Usually this is zero or negligible and is only included for completeness and for processing very old data. [!]
TERMINAL – Send output to the terminal only
LOGFILE – Send output to the logfile only (see the LOGFILE parameter)
BOTH – Send output to both the terminal and the logfile
NEITHER – Produce no output at all [BOTH]
By giving the name of an image that has the areas which are to be masked set BAD or to a suitable quality value (see DEBIAS). This can be achieved by displaying a typical image using KAPPA, getting logs of the positions of an outline enclosing the BAD area and using the KAPPA application SEGMENT, by using the ZAPLIN facility or by using the ARDGEN application together with ARDMASK ( but see the next option instead).
By giving the name of an ordinary text file that contains an ARD (ASCII Region Definition)
description. ARD is a textual language for describing regions of a data array. The language is based on
a set of keywords that identify simple shapes (such as Column, Row, Line, Box and Circle). ARD
files can be generated by the KAPPA application ARDGEN, or can be created by hand. A
description of ARD is given in the section
"ASCII region definition files
" in the DEBIAS
If no mask file is available simply return an !
When position lists (which are just text files of positions with either an index, an X and a Y value, or or
just X and Y values) are used the option exists to associate them with a particular image. This is
achieved by entering the name of the position list file into an image’s CCDPACK extension under
". Associating position lists with images has the advantage
of allowing wildcards to be used for the input names and makes sure that positions are
always used in the correct context (this is particularly useful when determining inter-image
"file. If TRUE then you’ll need to specify the name of the file using the RESTOREFILE parameter. A description of the contents of restoration files is given in the notes section. [FALSE]
"file. If TRUE then you’ll need to specify the name of the file using the SAVEFILE parameter. A description of the contents of restoration files is given in the notes section. [FALSE]
This header information will only be present if it has been added (to the image itself or to one earlier in the reduction chain from which it was produced) by running the MAKESET program. If it is not present, the programs will behave as if USESET was false anyway, so it is normally quite safe for USESET to be TRUE. However, in some cases (especially if intermediate files are stored in foreign, i.e. non-NDF data formats) it may be more efficient to set this parameter false. You should also set it false if you wanted CCDPACK programs to ignore existing Set information for some reason.
If BYSET is true, this parameter will default to true also. [FALSE]
Pixel indices. The bounds supplied to DEBIAS should be given as pixel indices. These usually start at 1,1 for the pixel at the lower left-hand corner of the data array component (this may be not true if the images have been sectioned, in which case the lower left hand pixel will have pixel indices equal to the data component origin values). Pixel indices are different from pixel coordinates in that they are non-continuous, i.e. can only have integer values, and start at 1,1 not 0,0. To change pixel coordinates to pixel indices add 0.5 and round to the nearest integer.
Restoration files. CCDSETUP has the ability to store and restore its parameter values from a
description stored in a text file. This is intended for use in retaining a particular instrumental
setups for long periods of time (so that it is easy to create a database of common setups).
The format of these files is very simple and consists of lines containing #
" is the name of the CCDSETUP parameter and
value. Comments can be included using the character
" at the start of a line or an
inline. Continuation lines are indicated by a
" as the last character. An example of the
contents of a restoration file is shown next (this is an actual file created by CCDSETUP):
# CCDPACK - Restoration file
# Written by pdraper on Wed Sep 6 17:41:54 1995.
ADC = 1 ! electrons/ADU
RNOISE = 9.95 ! Nominal readout noise in ADUs
EXTENT = 6, 119, 1, 128 ! Extent of useful CCD area
BOUNDS = 1, 5, 120, 128 ! Bounds of bias strips
DIRECTION = X ! Readout direction
DEFERRED = 0 ! Deferred charge in ADUs
MASK = ccdtest_ard.dat ! Defect mask
SATURATE = TRUE ! Look for saturated pixels
SATURATION = 180000 ! Saturation value
SETSAT = FALSE ! Set saturated pixels to saturation value
PRESERVE = TRUE ! Preserve data types
GENVAR = TRUE ! Generate data variances
NDFNAMES = TRUE ! Position lists associated with images
LOGTO = BOTH ! Log file information to
LOGFILE = CCDPACK.LOG ! Name of logfile
If you are using CCDPACK Sets, then some lines of this file may be of the form "setindex,keyword=value";
so this sequence: 1,RNOISE = 9.80 ! Nominal readout noise in ADUs (Set Index 1)
2,RNOISE = 8.65 ! Nominal readout noise in ADUs (Set Index 2)
3,RNOISE = 9.10 ! Nominal readout noise in ADUs (Set Index 3)
1,RNOISE = 9.80 ! Nominal readout noise in ADUs (Set Index 1)
would give the different values for each member of each Set of images.
"defaults are shown. The intrinsic defaults may be obtained at any time (in the absence of global values) by using the RESET keyword on the command line.