Skip to content. | Skip to navigation

Personal tools
You are here: Home Telescopes Irenee du Pont Instruments Website WFCCD FCCD Reduction Software (IDL) IDL Help for WFCCD

IDL Help for WFCCD

This page was created by the IDL library routine make_html_help. For more information on this routine, refer to the IDL Online Help Navigator or type:

? make_html_help

at the IDL command line prompt.

Last modified: Tue Jan 17 06:39:38 2006.


List of WFCCD/*/


Routine Descriptions

WFCCD_ALLARCSOL

[Next Routine] [List of Routines]

NAME:
wfccd_allarcsol
Version 1.0

PURPOSE:
Solves arc solutions for a given mask
Designed to do only 1 at a time

CALLING SEQUENCE:

wfccd_allarcsol, wfccd

INPUTS:
wfccd - WFCCD structure

RETURNS:

OUTPUTS:

OPTIONAL INPUTS:
w0off - half-range of lambda zeropoint to check on initial guess

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_allarcsol, wfstrct


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
20-Feb-2002 Written by JXP

(See WFCCD/Arcs/wfccd_allarcsol.pro)


WFCCD_ANALYSE

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_analyse
Version 1.0

PURPOSE:
Calls various routines to analyse the data

CALLING SEQUENCE:

wfccd_analyse, wfccd, maskid, expsr, XSIZE=, YSIZE=

INPUTS:

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_analyse, wfccd


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
19-May-2002 Written by JXP

(See WFCCD/Analysis/wfccd_analyse.pro)


WFCCD_AR

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_ar
Version 1.0

PURPOSE:
Reads in the first file in the directory with 'wfccd*fits'

CALLING SEQUENCE:

wfccd = wfccd_ar()

INPUTS:

RETURNS:
wfccd - WFCCD structure

OUTPUTS:

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd = wfccd_ar()


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
13-Nov-2001 Written by JXP

(See WFCCD/General/wfccd_ar.pro)


WFCCD_ARCIMG

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_arcimg
Version 1.0

PURPOSE:
Creates an arc image given the wfccd structure

CALLING SEQUENCE:

wfccd_arcimg, wfccdstr, WFAIMG=

INPUTS:
wfccdstr - WFCCD structure
mskid - Long defining the mask to process

RETURNS:

OUTPUTS:
wfaimg - WFCCD arc image (fits file)

OPTIONAL KEYWORDS:
SLITSTR - slit structure
WFASTR - WFCCD arc structure
NOFITS - Suppress fits output
OUTFIL - Suppress fits output

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_arcimg, wfccdstr


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
18-Feb-2002 Written by JXP
16-Jul-2002 Modified: Dealt with edge of CCD

(See WFCCD/Arcs/wfccd_arcimg.pro)


WFCCD_ARCSOL

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_arcsol
Version 1.0

PURPOSE:
Solves arc solutions for a given mask
Designed to do only 1 at a time

CALLING SEQUENCE:

wfccd_arcsol, wfccd, WFARC=

INPUTS:
wfstrct - WFCCD structure

RETURNS:

OUTPUTS:
wfarc - WFCCD arc structure (fits file)

OPTIONAL INPUTS:
w0off - half-range of lambda zeropoint to check on initial guess

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_arcsol, wfstrct


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
14-Feb-2002 Written by JXP
12-Jul-2002 Modified by JXP: Changed the fit structure

(See WFCCD/Arcs/wfccd_arcsol.pro)


WFCCD_BIAS VERSION 1.0

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_bias Version 1.0

PURPOSE:
Creates Bias frame given structure

CALLING SEQUENCE:

wfccd_bias, struct, SVOV=svov

INPUTS:
struct -- wfccd_strct defining the images of interest

RETURNS:

OUTPUTS:
bias - fits file in the dir BIAS named 'Bias.fits'

OPTIONAL KEYWORDS:
SVOV - save ov files

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_bias, nght1_strct


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
26-July-2001 Written by JXP

(See WFCCD/General/wfccd_bias.pro)


WFCCD_CHKARC

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_chkarc
Version 1.0

PURPOSE:
Plots a series of arc to allow a quick check

CALLING SEQUENCE:

wfccd_chkarc, wfccd, maskid, expsr, XSIZE=, YSIZE=

INPUTS:

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
XSIZE - Size of gui in screen x-pixels (default = 1000)
YSIZE - Size of gui in screen y-pixels (default = 600)

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_chkarc, wfccd, maskid, expsr


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
18-Apr-2002 Written by JXP

(See WFCCD/Arcs/wfccd_chkarc.pro)


WFCCD_CHKFSPEC

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_chkfspec
Version 1.0

PURPOSE:
Plots a series of spectra to allow a quick check

CALLING SEQUENCE:

wfccd_chkfspec, wfccd, maskid, expsr, XSIZE=, YSIZE=

INPUTS:

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
XSIZE - Size of gui in screen x-pixels (default = 1000)
YSIZE - Size of gui in screen y-pixels (default = 600)

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_chkfspec, wfccd, maskid, expsr


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
18-Apr-2002 Written by JXP

(See WFCCD/Analysis/wfccd_chkfspec.pro)


WFCCD_CHKSPEC

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_chkspec
Version 1.0

PURPOSE:
Plots a series of spectra to allow a quick check

CALLING SEQUENCE:

wfccd_chkspec, wfccd, maskid, expsr, XSIZE=, YSIZE=

INPUTS:

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
XSIZE - Size of gui in screen x-pixels (default = 1000)
YSIZE - Size of gui in screen y-pixels (default = 600)

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_chkspec, wfccd, maskid, expsr


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
18-Apr-2002 Written by JXP

(See WFCCD/Extraction/wfccd_chkspec.pro)


WFCCD_CLEANARC

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_cleanarc
Version 1.0

PURPOSE:
Finds all bad wavelength values in the Arc image

CALLING SEQUENCE:

wfccd_cleanarc, wfccd, maskid, exp_id

INPUTS:
wfccdstr - WFCCD structure
mskid - Long defining the mask to process

RETURNS:

OUTPUTS:
wfaimg - Cleaned WFCCD arc image (fits file)

OPTIONAL KEYWORDS:
SLITSTR - slit structure
WFASTR - WFCCD arc structure
NOFITS - Suppress fits output
OUTFIL - Suppress fits output

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_cleanarc, wfccdstr


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
02-May-2002 Written by JXP

(See WFCCD/Arcs/wfccd_cleanarc.pro)


WFCCD_CLEANUP

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_cleanup
Version 1.0

PURPOSE:
Erases a number of files which are generally not needed
after reduction is complete

CALLING SEQUENCE:

wfccd_cleanup, wfccd, mask_id, flg

INPUTS:
wfccd -- wfccd_strct defining the images of interest
mask_id -- Mask ID (e.g. 0L)
flg -- Binary flag (1=Flats, 2=Arcs, 4=Maps)

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_cleanup, wfccd, 0L, 1


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
26-July-2001 Written by JXP

(See WFCCD/General/wfccd_cleanup.pro)


WFCCD_COMBFSPEC

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_combfspec
Version 1.0

PURPOSE:
Converts SDSS eigenfunctions into WFCCD

CALLING SEQUENCE:

wfccd_combfspec, wffspec

INPUTS:

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
XSIZE - Size of gui in screen x-pixels (default = 1000)
YSIZE - Size of gui in screen y-pixels (default = 600)

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_combfspec, wfccd, maskid, expsr


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
16-May-2002 Written by JXP

(See WFCCD/Analysis/wfccd_combfspec.pro)


WFCCD_COMBSPEC

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_combspec
Version 1.0

PURPOSE:
Combines multiple exposures of the same slit

CALLING SEQUENCE:

wfccd_combspec, wfccd, mask_id, exp_id

INPUTS:
wfstrct - WFCCD structure

RETURNS:

OUTPUTS:
wfspec - WFCCD fspec structure (fits file)

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_combspec, wfccd, mask_id, exp_id


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
23-Apr-2002 Written by JXP

(See WFCCD/Extraction/wfccd_combspec.pro)


WFCCD_EDITOBJSTR

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_editobjstr
Version 1.0

PURPOSE:
Finds position of science objects and seredinps in the image
and creates the object structure

CALLING SEQUENCE:

wfccd_editobjstr, wfccd, mask_id, [exp_id], /NOCHK

INPUTS:
wfccd - wfccd structure
mask_id - Mask id value
exp_id - Exposure id

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_editobjstr, wfccd, mask_id, 0L


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
17-Apr-2002 Written by JXP

(See WFCCD/Slits/wfccd_editobjstr.pro)


WFCCD_EDITSLITS

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_editslits
Version 1.0

PURPOSE:
Parses the mask file for slit information

CALLING SEQUENCE:

wfccd_editslits, wfccd, mask_id, SLISTR=

INPUTS:
wfccd - wfccd structure
mask_id - Mask id value

RETURNS:

OUTPUTS:
slitstr - Creates a structure of slits

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_editslits, wfccd, mask_id, SLITSTR=


PROCEDURES/FUNCTIONS CALLED:
X_STSLTGUI

REVISION HISTORY:
27-May-2002 Written by JXP

(See WFCCD/Slits/wfccd_editslits.pro)


WFCCD_EDITSPEC

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_editspec
Versioedit.0

PURPOSE:
Plots a series of spectra to allow a quick check

CALLING SEQUENCE:

wfccd_editspec, wfccd, maskid, expsr, XSIZE=, YSIZE=

INPUTS:

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
XSIZE - Size of gui in screen x-pixels (default = 1000)
YSIZE - Size of gui in screen y-pixels (default = 600)

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_editspec, wfccd, maskid, expsr


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
03-May-2002 Written by JXP

(See WFCCD/Extraction/wfccd_editspec.pro)


WFCCD_EXTOBJBOX

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_extobjbox
Version 1.0

PURPOSE:

CALLING SEQUENCE:

wfccd_extobjbox, wfccd, WFARC=

INPUTS:
wfstrct - WFCCD structure

RETURNS:

OUTPUTS:
wfarc - WFCCD arc structure (fits file)

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_extobjbox, wfstrct


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
01-Apr-2002 Written by JXP

(See WFCCD/Extraction/wfccd_extobjbox.pro)


WFCCD_FIXARC

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_fixarc
Version 1.0

PURPOSE:
Solves arc solutions for a given mask
Designed to do only 1 at a time

CALLING SEQUENCE:

wfccd_fixarc, wfccd, WFARC=

INPUTS:
wfstrct - WFCCD structure

RETURNS:

OUTPUTS:
wfarc - WFCCD arc structure (fits file)

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_fixarc, wfstrct, mask_id, exp_id, slit


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
12-Jul-2002 Written by JXP

(See WFCCD/Arcs/wfccd_fixarc.pro)


WFCCD_FLUXSPEC

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_fluxspec
Version 1.0

PURPOSE:
Fluxes wfccd data. Puts in flambda units by default

CALLING SEQUENCE:

wfccd_fluxspec, wfccd, mask_id, [exp_id]

INPUTS:
wfccd - WFCCD structure
mask_id - WFCCD structure
[exp_id] - WFCCD structure

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_fluxspec, wfccd, mask_id, exp_id


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
23-Apr-2002 Written by JXP

(See WFCCD/Flux/wfccd_fluxspec.pro)


WFCCD_FSPECSUMM

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_fspecsumm
Version 1.0

PURPOSE:
Converts SDSS eigenfunctions into WFCCD

CALLING SEQUENCE:

wfccd_fspecsumm, wffspec

INPUTS:

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
XSIZE - Size of gui in screen x-pixels (default = 1000)
YSIZE - Size of gui in screen y-pixels (default = 600)

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_fspecsumm, wfccd, maskid, expsr


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
19-Apr-2002 Written by JXP

(See WFCCD/Analysis/wfccd_fspecsumm.pro)


WFCCD_FSPECXYPIX

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_fspecxypix
Version 1.0

PURPOSE:
Converts SDSS eigenfunctions into WFCCD

CALLING SEQUENCE:

indx = wfccd_fspecxypix(wffspec, obj_nm)

INPUTS:

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
XSIZE - Size of gui in screen x-pixels (default = 1000)
YSIZE - Size of gui in screen y-pixels (default = 600)

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_fspecxypix, wfccd, maskid, expsr


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
19-Apr-2002 Written by JXP

(See WFCCD/Analysis/wfccd_fspecxypix.pro)


WFCCD_FSPECZHIST

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_fspeczhist
Version 1.0

PURPOSE:
Converts SDSS eigenfunctions into WFCCD

CALLING SEQUENCE:

indx = wfccd_fspeczhist(wffspec, obj_nm)

INPUTS:

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
XSIZE - Size of gui in screen x-pixels (default = 1000)
YSIZE - Size of gui in screen y-pixels (default = 600)

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_fspeczhist, wfccd, maskid, expsr


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
19-Apr-2002 Written by JXP

(See WFCCD/Analysis/wfccd_fspeczhist.pro)


WFCCD_FSPECZIMG

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_fspeczimg
Version 1.0

PURPOSE:
Overplot z,id on xatv image

CALLING SEQUENCE:

wfccd_fspeczimg, fspec_fil

INPUTS:

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
XSIZE - Size of gui in screen x-pixels (default = 1000)
YSIZE - Size of gui in screen y-pixels (default = 600)

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_fspeczimg, wfccd, maskid, expsr


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
19-Apr-2002 Written by JXP

(See WFCCD/Analysis/wfccd_fspeczimg.pro)


WFCCD_GETOBJNM

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_getobjnm
Version 1.0

PURPOSE:

CALLING SEQUENCE:

indx = wfccd_getobjnm(wffspec, obj_nm)

INPUTS:

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
indx = wfccd_getobjnm(wffspec, obj_nm)


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
19-Apr-2002 Written by JXP

(See WFCCD/Analysis/wfccd_objfspec.pro)


WFCCD_MINUT VERSION 1.0

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_minut Version 1.0

PURPOSE:
Creates Bias frame given structure

CALLING SEQUENCE:

wfccd_minut, struct, mask_id, SVOV=svov

INPUTS:
struct -- wfccd_strct defining the images of interest

RETURNS:

OUTPUTS:
flat - fits file in the dir Flats named 'Flat_##.fits'
where ## is the mask_id value
VAR - Variance in the flat (in electrons)

OPTIONAL KEYWORDS:
SVOV - save ov files
NOFITS - No FITS output

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_minut, nght1_strct, mask_id


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
19-Feb-2002 Written by JXP

(See WFCCD/General/wfccd_minut.pro)


WFCCD_MKFLAT

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_mkflat
Version 1.0

PURPOSE:
Creates Bias frame given structure

CALLING SEQUENCE:

wfccd_mkflat, struct, mask_id, SVOV=svov

INPUTS:
struct -- wfccd_strct defining the images of interest

RETURNS:

OUTPUTS:
flat - fits file in the dir Flats named 'Flat_##.fits'
where ## is the mask_id value
VAR - Variance in the flat (in electrons)

OPTIONAL KEYWORDS:
SVOV - save ov files
NOFITS - No FITS output

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_mkflat, nght1_strct, mask_id


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
19-Feb-2002 Written by JXP

(See WFCCD/General/wfccd_mkflat.pro)


WFCCD_MKMAP

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_mkmap
Version 1.0

PURPOSE:
Creates a Map between distorted and undistorted frames

CALLING SEQUENCE:

wfccd_mkmap, struct, mask_id, FLAT=, VAR=, /NOCHK, MAP=

INPUTS:
struct -- wfccd_strct defining the images of interest
mask_id -- Mask ID value (scalar)
[FLAT] - Flat (in memory)
[VAR] - Variance of the Flat

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
NOFITS - No FITS output of the map
YSTRT - Starting column for the tracing
OUTFIL - Name of map output file
NOTRCFITS - No trace structure written to fits

OPTIONAL OUTPUTS:
TRCSTRCT - Trace structure

COMMENTS:

EXAMPLES:
wfccd_mkmap, wfccd_str, mask_id


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
19-Feb-2002 Written by JXP

(See WFCCD/Rectify/wfccd_mkmap.pro)


WFCCD_MKOBJSTR

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_mkobjstr
Version 1.0

PURPOSE:
Finds position of science objects and seredinps in the image
and creates the object structure

CALLING SEQUENCE:

wfccd_mkobjstr, wfccd, mask_id, [exp_id], /NOCHK

INPUTS:
wfccd - wfccd structure
mask_id - Mask id value
exp_id - Exposure id

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_mkobjstr, wfccd, mask_id, 0L


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
17-Apr-2002 Written by JXP
12-May-2002 Revisions for sky edges

(See WFCCD/Slits/wfccd_mkobjstr.pro)


WFCCD_NORMFLAT

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_normflat
Version 1.0

PURPOSE:
Flattens the flat

CALLING SEQUENCE:

wfccd_normflat, struct, mask_id

INPUTS:
wfccd -- wfccd_strct defining the images of interest

RETURNS:

OUTPUTS:
flat - fits file in the dir Flats named 'Flat_##.fits'
where ## is the mask_id value
VAR - Variance in the flat (in electrons)

OPTIONAL KEYWORDS:
SVOV - save ov files
NOFITS - No FITS output

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_normflat, nght1_strct, mask_id, /RMOLD


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
19-Feb-2002 Written by JXP

(See WFCCD/General/wfccd_normflat.pro)


WFCCD_OBJCR

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_objcr
Version 1.0

PURPOSE:
Flags CRs given 2 or more object images

CALLING SEQUENCE:

wfccd_objcr, struct, mask_id, [expsr]

INPUTS:
struct -- wfccd_strct defining the images of interest

RETURNS:

OUTPUTS:
flat - fits file in the dir Flats named 'Flat_##.fits'
where ## is the mask_id value
VAR - Variance in the flat (in electrons)

OPTIONAL KEYWORDS:
SVOV - save ov files
NOFITS - No FITS output

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_objcr, nght1_strct, mask_id


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
14-May-2002 Written by JXP

(See WFCCD/General/wfccd_objcr.pro)


WFCCD_OBJSUMM

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_objsumm
Version 1.0

PURPOSE:
Write a wfccd_struct to an ASCII file

CALLING SEQUENCE:

write_wfccdstr, struct, ANONLY=, OUTFIL=, FITS=

INPUTS:
struct - A wfccd_struct

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
ANONLY - Only print files with flg_anly NE 0

OPTIONAL OUTPUTS:
outfil = Output file (default is image.list)

COMMENTS:

EXAMPLES:
write_wfccdstr, nght1_strct


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
18-Apr-2002 Written by JXP

(See WFCCD/Extraction/wfccd_objsumm.pro)


WFCCD_OVER

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_over
Version 1.0

PURPOSE:
Overscan subtracts a list of images of a structure

CALLING SEQUENCE:

wfccd_over, struct

INPUTS:
struct -- wfccd_strct defining the images of interest

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
erase - Erase pre-existing ov files
inter - Interactive OV fitting

OPTIONAL OUTPUTS:
ovimg - fits files in the dir OV

COMMENTS:

EXAMPLES:
wfccd_over, nght1_strct, ovimg


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
13-Nov-2001 Written by JXP

(See WFCCD/General/wfccd_over.pro)


WFCCD_PLTOBJ

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_pltobj
Version 1.0

PURPOSE:
Calls x_pltobj after gathering the relevant data

CALLING SEQUENCE:

wfccd_pltobj, wfccd, maskid, expsr, XSIZE=, YSIZE=

INPUTS:

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
XSIZE - Size of gui in screen x-pixels (default = 1000)
YSIZE - Size of gui in screen y-pixels (default = 600)

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_pltobj, wfccd, maskid, expsr


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
19-Apr-2002 Written by JXP

(See WFCCD/Analysis/wfccd_pltobj.pro)


WFCCD_PLTSPEC

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_pltspec
Version 1.0

PURPOSE:
Calls x_pltspec after gathering the relevant data

CALLING SEQUENCE:

wfccd_pltspec, wfccd, maskid, expsr, XSIZE=, YSIZE=

INPUTS:

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
XSIZE - Size of gui in screen x-pixels (default = 1000)
YSIZE - Size of gui in screen y-pixels (default = 600)

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_pltspec, wfccd, maskid, expsr


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
19-Apr-2002 Written by JXP

(See WFCCD/Analysis/wfccd_pltspec.pro)


WFCCD_PROCARC

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_procarc
Version 1.0

PURPOSE:
Processes the Arc images

CALLING SEQUENCE:

wfccd_procarc, wfccd, WFAIMG=

INPUTS:
wfccd - WFCCD structure
mask_id - Long defining the mask to process

RETURNS:

OUTPUTS:
wfaimg - WFCCD arc image (fits file)

OPTIONAL KEYWORDS:
SLITSTR - slit structure
WFASTR - WFCCD arc structure
NOFITS - Suppress fits output
OUTFIL - Suppress fits output

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_procarc, wfccdstr


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
18-Feb-2002 Written by JXP

(See WFCCD/Arcs/wfccd_procarc.pro)


WFCCD_PROCOBJ

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_procobj
Version 1.0

PURPOSE:
Process the object frames -- Outputs into Final
OV subtracts, Divides by normalized flat, creates VAR, adds in
Arc image

CALLING SEQUENCE:

wfccd_procobj, wfccd, mask_id

INPUTS:
wfccd -- wfccd_strct defining the images of interest

RETURNS:

OUTPUTS:
finimg - fits file in the dir Final named: final_###.fits
VAR - Variance in the obj (in electrons)
AIMG - Writes the arc image in too

OPTIONAL KEYWORDS:
SVOV - save ov files
NOFITS - No FITS output

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_procobj, wfccd, mask_id


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
21-Feb-2002 Written by JXP

(See WFCCD/General/wfccd_procobj.pro)


WFCCD_PRSSLITS

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_prsslits
Version 1.0

PURPOSE:
Parses the mask file for slit information

CALLING SEQUENCE:

slitstr = wfccd_prsslits( mskfil, [flg] )

INPUTS:
mskfil - Mask file (ASCII) to parse

RETURNS:

OUTPUTS:
slittr - Creates a structure of slits

OPTIONAL KEYWORDS:
flg - Designates the mask file :: Default = 0 -> Andy's
output

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
slitstr = wfccd_prsslits( mskfil, [flg])


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
08-Feb-2002 Written by JXP

(See WFCCD/Slits/wfccd_prsslits.pro)


WFCCD_READASTRCT

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_readastrct
Version 1.0

PURPOSE:
Solves arc solutions for a given mask

CALLING SEQUENCE:

wfccd_readastrct, wfstrct, WFARC=

INPUTS:
wfstrct - WFCCD structure

RETURNS:

OUTPUTS:
wfarc - WFCCD arc structure (fits file)

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_readastrct, wfstrct


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
15-Feb-2002 Written by JXP

(See WFCCD/Arcs/wfccd_readastrct.pro)


WFCCD_SDSSEIG

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_sdsseig
Version 1.0

PURPOSE:
Converts SDSS eigenfunctions into WFCCD

CALLING SEQUENCE:

wfccd_sdsseig, wfccd, maskid, expsr, XSIZE=, YSIZE=

INPUTS:

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
XSIZE - Size of gui in screen x-pixels (default = 1000)
YSIZE - Size of gui in screen y-pixels (default = 600)

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_sdsseig, wfccd, maskid, expsr


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
19-Apr-2002 Written by JXP

(See WFCCD/Analysis/wfccd_sdsseig.pro)


WFCCD_SETSLITS

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_setslits
Version 1.0

PURPOSE:
Parses the mask file for slit information

CALLING SEQUENCE:

wfccd_setslits, wfccd, mask_id, SLISTR=

INPUTS:
wfccd - wfccd structure
mask_id - Mask id value

RETURNS:

OUTPUTS:
slitstr - Creates a structure of slits

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_setslits, wfccd, mask_id, SLITSTR=


PROCEDURES/FUNCTIONS CALLED:
X_SETSLITS
X_STSLTGUI
X_RECTIFY
X_ORIGSLIT

REVISION HISTORY:
19-Feb-2002 Written by JXP

(See WFCCD/Slits/wfccd_setslits.pro)


WFCCD_SKYSUB

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_skysub
Version 1.0

PURPOSE:
Perform sky subtraction on the entire frame slit by slit

CALLING SEQUENCE:

wfccd_skysub, wfccd

INPUTS:
wfccd - WFCCD structure

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_skysub, wfstrct


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
17-Apr-2002 Written by JXP

(See WFCCD/Extraction/wfccd_skysub.pro)


WFCCD_STRCT

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_strct
Version 1.1

PURPOSE:
Creates an outputs a structure for a series of WFCCD
spectroscopic images

CALLING SEQUENCE:

wfccd_strct, struct, [ccd], [tel], LIST=list, MKDIR=mkdir, NOFILE=nofile, NOLIST=nolist

INPUTS:
[CCD] - Set specific CCD header keywords
Options: WFTek5 (default)
[tel] - Set telescope
Options: LCO-100 (default)

RETURNS:

OUTPUTS:
struct - Creates an IDL structure for direct images
- ASCII file summarizing the structure

OPTIONAL KEYWORDS:
LIST - Image list
MKDIR - Make directories

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_strct, nght1_strct, 'WFTek5', 'LCO-100', /MKDIR


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
13-Nov-2001 Written by JXP
18-Feb-2001 Modified by JXP

(See WFCCD/General/wfccd_strct.pro)


WFCCD_SUBSKYSLIT

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_subskyslit
Version 1.0

PURPOSE:
Given the slitstr and slit#, subtract the sky and return
the result using a bsplin technique. Tailored to WFCCD data

CALLING SEQUENCE:

wfccd_subskyslit, slit_fil, slit, obj_fil

INPUTS:
slitstr - Slit structure

RETURNS:

OUTPUTS:
Updates slitstr for original positions

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_subskyslit, slitstr, map


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
11-Sep-2002 Written by JXP

(See WFCCD/Extraction/wfccd_subskyslit.pro)


WFCCD_SUMMARY

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_summary
Version 1.0

PURPOSE:
Creates and outputs a structure for a series of ESI
spectroscopic images

CALLING SEQUENCE:

wfccd_summary, struct

INPUTS:

RETURNS:

OUTPUTS:
struct - Creates an IDL structure for direct images
- ASCII file summarizing the structure

OPTIONAL KEYWORDS:
MKDIR - Make directories

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_summary, nght1_strct, /MKDIR


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
14-Sep-2002 Written by JXP

(See WFCCD/General/wfccd_summary.pro)


WFCCD_WRFSPEC

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_wrfspec
Version 1.0

PURPOSE:
Solves arc solutions for a given mask

CALLING SEQUENCE:

wfccd_wrfspec, wfstrct, WFARC=

INPUTS:
wfstrct - WFCCD structure

RETURNS:

OUTPUTS:
wfarc - WFCCD arc structure (fits file)

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_wrfspec, wfstrct


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
15-Feb-2002 Written by JXP

(See WFCCD/Analysis/wfccd_wrfspec.pro)


WFCCD_WRITEASTRCT

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_writeastrct
Version 1.0

PURPOSE:
Solves arc solutions for a given mask

CALLING SEQUENCE:

wfccd_writeastrct, wfstrct, WFARC=

INPUTS:
wfstrct - WFCCD structure

RETURNS:

OUTPUTS:
wfarc - WFCCD arc structure (fits file)

OPTIONAL KEYWORDS:

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_writeastrct, wfstrct


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
15-Feb-2002 Written by JXP

(See WFCCD/Arcs/wfccd_writeastrct.pro)


WFCCD_ZFIND

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_zfind
Version 1.0

PURPOSE:
Converts SDSS eigenfunctions into WFCCD

CALLING SEQUENCE:

wfccd_zfind, fspec_fil

INPUTS:

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
XSIZE - Size of gui in screen x-pixels (default = 1000)
YSIZE - Size of gui in screen y-pixels (default = 600)

OPTIONAL OUTPUTS:

COMMENTS:

EXAMPLES:
wfccd_zfind, wfccd, maskid, expsr


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
19-Apr-2002 Written by JXP

(See WFCCD/Analysis/wfccd_zfind.pro)


WFCCD_ZSPEC

[Previous Routine] [Next Routine] [List of Routines]

NAME:
wfccd_zspec

PURPOSE:
neat-o interface for WFCCD quality control

CALLING SEQUENCE:
wfccd_zspec,'Extract/Fspec_10.fits.gz', SERENDIP=serendip

INPUTS:
final output from wccd_zfind
serendip = plot serendips in each slit along with objects


OUTPUTS:
plots 1D spectrum + model
postage stamp of 2D spectrum +trace


COMMENTS:
to do- scale greyscale images better
input just mask number?
trace for 2nd image frame
qa control (add bitmask flg)

MODIFICATION HISTORY:
mg 4/04

(See WFCCD/Analysis/wfccd_zspec.pro)


WRITE_WFCCDSTR

[Previous Routine] [List of Routines]

NAME:
write_wfccdstr
Version 1.0

PURPOSE:
Write a wfccd_struct to an ASCII file

CALLING SEQUENCE:

write_wfccdstr, struct, ANONLY=, OUTFIL=, FITS=

INPUTS:
struct - A wfccd_struct

RETURNS:

OUTPUTS:

OPTIONAL KEYWORDS:
ANONLY - Only print files with flg_anly NE 0

OPTIONAL OUTPUTS:
outfil = Output file (default is image.list)

COMMENTS:

EXAMPLES:
write_wfccdstr, nght1_strct


PROCEDURES/FUNCTIONS CALLED:

REVISION HISTORY:
18-July-2001 Written by JXP

(See WFCCD/General/write_wfccdstr.pro)

Document Actions