extract Module

CUPID_V2.0

CUPID General Info     "cupid" Command     All Pipelines     All Modules     


This module will extract a 1D spectrum table.

The module is used in the following pipelines:     BCDX    COADDX    BKSUBX

Constant values:

-f   Fatal bits for BMASK
default: 16384      override allowed: N >= 0 bitmask value

-fix   This controls if the NaNs should be replaced with approximated values before doing extraction. A value of 0 means "don't replace", while an integer, N, means that for each NaN pixel, the N rows above and N rows below are averaged column by column within the order, and then a line is fit to these column averages to approximate the NaN.
default: 2      override allowed: N >= 0

-full   Extraction type; 0 = sub_slit and 1 = full_slit.
default: 0 iff all of the following are true: (a) the "-w" flag is not explicitly set, (b) this is a LO-RES observation, (c) this is not a LO-RES center position observation      override allowed: 0 or 1

-height1   Sets the wavsamp height. Set to 1 to force the wavsamp height to be 1 pixel; set to 0 to use actual height.
default: 0      override allowed: 0 or 1

-l   Reference wavelength (in microns) of the aperture width specified with the "-w" flag. A value of 0 selects a constant width extraction aperture.
default: use value in psf_fov      override allowed: 0.0 <= X <= 50.0

-nanDrop   Wavelength bins with NaNs will be removed from the output spectrum 0 = set flux to -9999 1 = drop row from output table
default: 0      override allowed: 0 or 1

-norm   Normalize the fluxes
0 = no normalization
1 = divide by height of wavsamp rectangle
2 = divide by area of wavsamp rectangle
default: ch0,ch2,ch3=1 ch1=0      override allowed: 0 1 2

-ord   This refers to the spectral order, and is used for low-resolution extractions only. You can set this to:
0 = (as targeted)
1 = 1
2 = (2+bonus)
99 =(1+2+bonus)
default: 0      override allowed: 0 <= N <= 3

-over   Output overlay file (used by SPICE)
default: (none)      override allowed: name of overlay file to write

-p   The calibration table that codes the order to be extracted for each FOVID, the default ridge location, and the extraction aperture width at a fiducial wavelength.
default: ch0,ch2=../cal/psf_fov.tbl ch1,ch3=(none)      override allowed: users psf_fov.tbl file

-v   Level of verbosity
default: 1      override allowed: N >= 0

-w   Width (pixels) of the extraction aperture at the reference wavelength
default: ch0,ch2 = use the value given in the psf_fov; ch1,ch3 = use full width of order      override allowed: X > 0.0

Pipeline calibration files:

      (none)

Pipeline namelist files:

-n   Namelist file
default: appropriate extract.nl file in ../cdf/      override allowed: name of user's namelist file

Pipeline input datafiles:

-b   Input BMASK file (FITS)
[pipeline datafile --- override not allowed]

-e   Input UNC file (FITS)
[pipeline datafile --- override not allowed]

-i   Input FLUX file (FITS)
[pipeline datafile --- override not allowed]

-r   Output table from running the RIDGE module in the previous step.
[pipeline datafile --- override not allowed]

Pipeline output datafiles:

-o   Output spectrum table (IPAC table file)
[pipeline datafile --- override not allowed]

Pipeline datafiles updated:

      (none)