Chapter 2. The “cupid” Command

 

How to run  the “cupid” command, type:

 

     cupid  PROCESSING_DIRECTORY(s)   [OPTION(s)]

 

A PROCESSING DIRECTORY (at least one is required)

 

Generally each processing directory will contain a raw/ subdirectory.Output files will be created in the bcd/ and pbcd/ subdirectories. Spitzer Heritage Archive downloads often contains 4 processing directories (ch0/ ch1/ ch2/ ch3/)

 

 

PIPELINE SELECTION options:

 

The default is to run the following 7 pipelines:

1.      BCD 

2.      COADD 

3.      BKSUB 

4.      BKSUBX 

5.      COADDX

6.      BCDX

7.      CUTOUT

    

A pipeline specifier is of the following form:

PIPE/p1

or   

PIPE/p1.p2.p3....

where the pN can be any of the following:

 

BCD          - run the BCD image pipeline

COADD     - run the COADD image pipeline

BKSUB      - run the background subtraction image pipeline

BKSUBX   - run the BKSUB extraction pipeline

COADDX - run the COADD extraction pipeline

BCDX        - run the BCD extraction pipeline

CUTOUT   - run the CUTOUT image pipeline

BCDACQ - run the BCDACQ image pipeline

DARK       - run the DARK image pipeline

1                - run: BCD

2                - run: BCD COADD

3                - run: BCD COADD BKSUB

4                - run: BCD COADD BKSUB BKSUBX

5                - run: BCD COADD BKSUB BKSUBX COADDX

6                - run: BCD COADD BKSUB BKSUBX COADDX BCDX

7                - run: BCD COADD BKSUB BKSUBX COADDX BCDX CUTOUT

8                - run: BCD COADD BKSUB BKSUBX COADDX BCDX CUTOUT BCDACQ

 

e.g.  PIPE/3  or  PIPE/BCD  or  PIPE/BCD.COADD.BKSUBX

 

 

PARAMETER options will override a parameter for a module in the BCD pipeline:

(default is to run with the same parameters as operational pipeline)

 

SET.[module]-[flag]=[value] (sets param to value for module), e.g.:

SET.droopop-a=0

 (sets the "a" parameter to 0 for the droopop module)

 

 

FLOW options will change the which STEPS are run in the BCD pipeline:

(default is to run with the same steps as the operational pipeline)

 

START.[STEP] to start processing of at specified step, e.g.

START.SATCOR

 

STOP.[STEP] to stop processing after specified step, e.g.

STOP.FLATAP

 

SKIP.[STEP] to skip a step, e.g.

SKIP.STRAYCROSS

 

DO.[STEP2].AFTER.[STEP1] to run STEP2 immediately after STEP1, e.g.

DO.CUBESUB.AFTER.DARKBASE

 

OPTIONS for the other pipelines:

The "PARAMETER" and "FLOW" options above apply to the BCD pipeline. However, these same options may be used for other pipelines if prepended appropriately.  Use:

 

X/            for all of the extraction pipelines (BKSUBX COADDX BCDX)

COADD/ for the COADD pipeline

DARK/    for the DARK pipeline

 

e.g.

 

X/SET.extract-nanDrop=1

X/STOP.IRS_TUNE

X/SKIP.TBL2FITS

COADD/SET.coad2d-cf=0.25

DARK/SET.darkest-r=22.0

2.1.1        Examples

·         unix% cupid /scr/r33776128/ch0

runs the 7 standard pipelines in /scr/r33776128/ch0

(on all raw.fits files in /scr/r33776128/ch0/raw)

·         unix% cupid /scr/r33776128/ch0 PIPE/BCD

runs the BCD pipeline in /scr/r33776128/ch0

(on all raw.fits files in /scr/r33776128/ch0/raw)

·         unix% cupid /scr/r33776128/ch0 PIPE/8

runs all 8 pipelines in /scr/r33776128/ch0

(BCD COADD BKSUB BKSUBX COADDX BCDX CUTOUT BCDACQ)

(on all raw.fits files in /scr/r33776128/ch0/raw) .

·         unix% cupid /scr/r33776128/ch0 PIPE/BCD.DARK STOP.DARKBASE

runs BCD pipeline up through DARKBASE to produce individual cubes, and then co-adds the cubes together to make a single dark file.

(This is how a custom DARK file is commonly produced.)

·         unix% cupid /scr/r33776128/ch0 PIPE/BCD.COADD.BKSUB

runs pipelines BCD, COADD, and BKSUB in /scr/r33776128/ch0

(on all raw.fits files in /scr/r33776128/ch0/raw/)

·         unix% cupid /scr/r33776128/ch* PIPE/6

runs the first 6 standard pipelines for all channels

(in /scr/r33776128/ch0, /scr/r33776128/ch1,

/scr/r33776128/ch2 and /scr/r33776128/ch3)

·         unix% cupid /scr/r33776128/ch1 PIPE/COADDX X/STOP.IRS_TUNE

does extractions on the coadds but stops after IRS_TUNE (does not produce FITS table files)

·         unix% cupid /scr/r33776128/ch0 PIPE/BCD SKIP.STRAYCROSS SET.snest_irs-gain=6.0

runs BCD pipeline in /scr/r33776128/ch0 but:

for snest_irs module set "-gain" parameter to 6.0 and

skip over the STRAYCROSS step.

·          unix% cupid /scr/r33776128/ch3 PIPE/BCD DO.DROOPRES.AFTER.STRAYCROSS

runs entire BCD pipeline but runs DROPRES step after STRAYCROSS step.

·         unix% cupid /scr/r33776128/ch2 PIPE/BCD START.STRAYCROSS

runs BCD pipeline starting at STRAYCROSS

i.e. runs just steps: STRAYCROSS, FLATAP, FPGEN

 

 

 

• 
• 
• 
• 
•