SMART FITS Header Keywords

SMART uses a number of FITS keywords that are added to the FITS header for use in analysis.

Fixed Format Keywords

Header Keyword Type Description Written By Used In
SM_BCD Integer BCD number sm_preset_bcd.pro
RA_SLT Floating Point Boresight RA sm_preset_bcd.pro , sm_slitpos.pro
DEC_SLT Floating Point Boresight DEC sm_preset_bcd.pro, sm_slitpos.pro
ROLL_SLT Floating Point Boresight Roll sm_preset_bcd.pro
AORKEY Integer AOR key sm_preset_bcd.pro, trim_mipl.pro
EXPID Integer Exposure ID sm_preset_bcd.pro, trim_mipl.pro
DCENUM Integer Data Collection Event number sm_preset_bcd.pro
BUNIT String Units of flux   sm_preset_bcd.pro, sm_e_jy.pro


Data Type Default Value
Peakup DN (= Digital Number)
BCD Image, Campaigns 1 - 44 e-/sec
BCD Image, Campaigns 45, 46, 47 e- (data is actually in e-/sec)
Extracted Spectra jy

OBJECT String Object name sm_preset_bcd.pro
S_TARG String SMART Target name sm_preset_bcd.pro
SM_TINT Floating Point Integration time in seconds., Value of "RAMPTIME" keyword or default of 6.0 seconds. sm_preset_bcd.pro
S_TNUM String Number of point sources found in all orders for a given BCD., EG. Low resoloution : Found 2 in order 1, 1 in order 2 and 0 in order 3 then S_TNUM = '2,1,0', EG. High resoloution :Found 1 point source in every order then S_TNUM = '1,1,1,1,1,1,1,1,1,1' sm_preset_bcd.pro, sm_apply_2this_bcd.pro, sm_auto_all.pro, sm_wipe_headers.pro
|APERNAME |string |Aperture Name. Possible values : IRS_Short_Hi_1st_Position, IRS_Short_Hi_2nd_Position, IRS_Long_Hi_1st_Position, IRS_Long_Hi_2nd_Position, IRS_Short_Lo_1st_Order_1st_Position, IRS_Short_Lo_1st_Order_2nd_Position, IRS_Short_Lo_2nd_Order_1st_Position, IRS_Short_Lo_2nd_Order_2nd_Position, IRS_Long_Lo_1st_Order_1st_Position, IRS_Long_Lo_1st_Order_2nd_Position, IRS_Long_Lo_2nd_Order_1st_Position, IRS_Long_Lo_2nd_Order_2nd_Position |sm_preset_bcd.pro, sm_import_bcdhdr.pro | |S_FWHM |Floating Point |Value of "!sm_fwhmfactor" at time of extraction. (See User Parameters.) |sm_ext_isap.pro |Reference | |S_EXTYxx |String |Extraction type actually used for order xx, xx = 1-3 or 11-20 (IE. Relevant order number) EG. Keyword "S_EXTY12" denotes extraction type actually used for order 12.


Possible Values Possible Comment Values
Full 'Extraction type actually used for order xx'
Gaussian  
Tapered Column  
Fixed Column  
Optimal  

S_EXTY30 String Extraction type originally requested (all BCD) smart_proj__define

Possible Values Possible Comment Values
Full 'Extraction type originally requested (all BCD)'
Gaussian  
Tapered Column  
Fixed Column  
Optimal  
Manual  

|S_EXTY31 |String |Value = contents of "ttnum" array, Comment = 'No source in orders 2 & 3, source in 1' |sm_bcd_isap.pro |Reference | |S_EXTY32 |String |Value = contents of "ttnum" array
Comment = 'No source in order 1, source in 2 & 3'

sm_bcd_isap.pro Reference
|S_EXTY33 |String |This keyword is only set when manual source finding is used.
(IE. Keyword "S_EXTY30" must equal "Manual".)
This lists the extraction type set in the manual source finder tool for that particular BCD.

Possible Values Possible Comment Values
Full 'Extraction type originally requested (all BCD)'
Gaussian  
Tapered Column  
Fixed Column  
Optimal  

sm_apply_2this_bcd.pro Reference
|S_EXTY90 |String |Value = 'WARNING'
Comment = 'Extraction defaulted to FULL'
NOTE : This message may appear even if only one or some
but not all of the orders in a given BCD are defaulted.
Check other keywords carefully.
|sm_bcd_isap.pro
sm_auto_all.pro
sm_ext_isap.pro
sm_apply_2this_bcd.pro |Reference | |S_EXTY91 |String |Value = 'WARNING'
Comment = 'Multiple sources in order(s) - Check S_TNUM'
sm_bcd_isap.pro sm_sky_meth.pro
|S_EXTY92 |String |Value = 'WARNING'
Comment = 'No sources in any orders - Check S_TNUM'
sm_bcd_isap.pro sm_sky_meth.pro
|S_EXTY94 |String |Value = 'WARNING'
Comment = 'High res extraction defaulted to Tapered Column'
NOTE : Currently automatic extraction of High Resoloution data
is only extracted as Tapered Column.
sm_auto_all.pro Reference
|S_SKSUxx |String |Sky Subtraction Type actually used for order xx

xx = 1-3 or 11-20 (IE. Relevant order number)

EG. Keyword "S_SKSB12" denotes sky subtraction type used for order 12.

Possible Values Possible Comment Values
none 'Sky subtraction = none'
local 'Sky = Median Pixel Val * Area Resolution Element(pixels)'
alternative 'Sky File = '[FILENAME]
image 'Sky File = '[FILENAME]

sm_ext_fullap.pro Reference
|S_SKSU90 |String |Value = 'WARNING'
Comment = 'Sky Subtraction Defaulted to NONE'
sm_bcd_isap.pro Reference
|S_SKSU91 |String |Value = 'WARNING'
Comment = 'Sky sub type not recognised, last order = xx'
xx = 1-3 or 11-20 (IE. Relevant order number)
sm_sky_meth Reference
|S_SKSU92 |String |Value = 'WARNING'
Comment = 'No valid sky sub value - check sm_mansky = '
where "sm_mansky" is calling parameter. (Valid values = 0, 1, 2, 3, 4, 5, 6)
sm_sky_meth Reference
|S_SKSU93 |String |Value = 'WARNING'
Comment = 'Only None and Image sky sub valid for High Res
Used in conjunction with S_SKSU90 when "Local" or "Alternative"
sky subtraction is over-ridden for high res data. |sm_ext_fixcol.pro
sm_ext_fullap.pro
sm_ext_gauss.pro
sm_ext_npsf.pro |Reference | |S_SKSRxx |String |Sky Subtraction type originally requested for order xx

Possible Values Possible Comment Values
none 'Sky subtraction = none'
none 'Unrecognised sky sub type, default to NONE'
local 'Sky = Median Pixel Val * Area Resolution Element(pixels)'
alternative 'Sky File = '[FILENAME]
image 'Sky File = '[FILENAME]

sm_ext_fullap.pro Reference
|S_SKPUxx |String |Sky Subtraction Polynomial Order actually used for order xx

Placed after 'S_SKSBxx' if value is 'local' or 'alternative'.

xx = 1-3 or 11-20 (IE. Relevant order number)

EG. Keyword "S_SKPO12" denotes sky subtraction polynomial order for order 12

Possible Values Possible Comment Values
0 'Sky subtraction polynomial order'
1  

sm_ext_fullap.pro Reference
|S_SKPU90 |String |Value = 'WARNING'
Comment = 'Sky Subtraction Polynomial Order Defaulted to NONE'
  Reference
|S_SKPU91 |String |Value = 'WARNING'
Comment = 'Sky sub poly order not recognised, last order = xx'
xx = 1-3 or 11-20 (IE. Relevant order number)
  Reference
|S_SKPRxx |String |Sky Subtraction Polynomial Order originally requested for order xx

Placed after 'S_SKSBxx' if value is 'local' or 'alternative'.

xx = 1-3 or 11-20 (IE. Relevant order number)

EG. Keyword "S_SKPO12" denotes sky subtraction polynomial order for order 12

Possible Values Possible Comment Values
0 'Sky subtraction polynomial order'
1  

sm_ext_fullap.pro Reference
|S_FWORxx |String |Value = "WARNING"
Comment = "Override : sm_fwhmfactor = 1.0 for order xx"

Denotes sm_fwhmfactor was overridden from -1.0 to 1.0
for the processing of order xx.
Done because sm_fwhmfactor = -1.0 requires SMART to use "psf-fov" files for extraction. There are no "psf-fov" files for high resoloution data.

xx = 11-20 (IE. Relevant order number, high resoloution ONLY.)

EG. Keyword "S_FWOR12" denotes sm_fwhmfactor = 1.0 override for order 12

NOTE : xx = 30 if SMART cannot ascertain relevant order number.
If so, comment = "Override : sm_fwhmfactor = 1.0 for unknown order".

sm_ext_isap.pro Reference
|S_OPALGO |String |Algorithm used in Optimal Extraction

Only used if extraction type is "Optimal".

Possible Values Possible Comment Values
0 'Horne Algorithm'
1 'Truncated Horne Algorithm'
2 'Narron et al Algorithm'
3 'Sloan Algorithm'
All others 'Unknown Optimal Algorithm'

(See Optimal Extraction Options.)

sm_ext_opt.pro Reference
|S_OPERR |String |Error plane USED/NOT USED in Optimal Extraction

Only used if extraction type is "Optimal".

Possible Values Possible Comment Values
0 'Error plane NOT USED in optimal extraction'
1 'Error plane USED in optimal extraction'

(See Optimal Extraction Options.)

sm_ext_opt.pro Reference
|S_OPPOS |String |Value = Value of center position of source used in Optimal Extraction.
(Units = pixels in cross-dispersion direction.)
Comment = 'Center Position for Optimal Extraction'

(See Optimal Extraction Options.)
sm_ext_opt.pro Reference
|S_OP90 |String |Value = 'WARNING'
Comment = 'Optimal extraction algorithm defaulted to Horne'

(See Optimal Extraction Options.)
sm_ext_opt.pro Reference
|S_OP91 |String |Value = 'WARNING'
Comment = '!sm_opt_ex_method value unknown = xx'
xx = value of sm_opt_ex_method

(See Optimal Extraction Options.)
sm_ext_opt.pro Reference
|S_IMOP01 |String |Image Operation Result from 'Combine' operation

Possible Values
Combine : Add
Combine : Mean
Combine : Median
Combine : Median Filter
Combine : Fair Coadd
Combine : Sigma Clipping Coadd

imops__define.pro Reference
S_IMOP02 String Image Operation Result - 'Arithmetics' imops__define.pro Reference
|S_IMOP03 |String |Image Operation Result - 'Multiple Subtraction'
Followed by two 'HISTORY' keywords listing the original and subtracting file names
imops__define.pro Reference
|S_IMOP04 |String |Image Operation Result - 'Multiple Division'
Followed by two 'HISTORY' keywords listing the original and dividing file names
imops__define.pro Reference
SM_LHP25 String

Possible Values Meaning
PRE Pre LH detector bias voltage change calibration files used.
POST Post LH detector bias voltage change calibration files used.

Comment contains the string :
"Type of campaign 25 LH calibration files used" |smart_proj__define.pro |Reference |

SM_LLP45 String

Possible Values Meaning
PRE Pre LL detector bias voltage change calibration files used.
POST Post LL detector bias voltage change calibration files used.

Comment contains the string :
"Type of campaign 45 LL calibration files used" |smart_proj__define.pro |Reference | |SM_SLA01 |String |Value = "Set"
Comment contains the string :
"SL fluxcon calib file overridden to aploss" |sm_cal_override_fluxcon |Reference | |SM_LLA01 |String |Value = "Set"
Comment contains the string :
"LL fluxcon calib file overridden to aploss" |sm_cal_override_fluxcon |Reference | |S_CAL0 |String |Value = "Cal file setting"
Comment contains the string :
"sys" - System defaults for Calibration files.
"user" - User selected defaults for Calibration files.
(See Calibration Files.) |sm_ext_isap.pro |Reference | |S_CALxxx |String |xx = 1-999
Value = "Cal file used"
Comment contains the string : Name of Calibration file.
(See Calibration Files.) |sm_ext_isap.pro |Reference | |S_PRM0 |String |Value = "Parm file setting"
Comment contains the string :
"sys" - System defaults for settable Parameters.
"user" - User selected values for settable Parameters.
(See User Parameters.) |sm_ext_isap.pro |Reference | |S_PRMxxx |String |xx = 1-999
Value = "Parameter used"
Comment contains the string : Name of Parameter and value.
(See User Parameters.) |sm_ext_isap.pro |Reference | |S_OPT0 |String |Value = "Opt file setting"
Comment contains the string :
"sys" - System defaults for Optimal Extraction Options.
"user" - User selected values for Optimal Extraction Options.
(See Optimal Extraction Options.) |sm_ext_isap.pro |Reference | |S_OPTxxx |String |xx = 1-999
Value = "Optimal used"
Comment contains the string : Name of Optimal Extraction Option and value.
(See Optimal Extraction Options.) |sm_ext_isap.pro |Reference | |S_SET1 |String | Value = "Home Dir"
Comment contains the string : Name of SMART home directory.
(See Start-up Files?.) |sm_ext_isap.pro |Reference | |S_SET2 |String | Value = "Cal Dir"
Comment contains the string : Name of Calibration directory.
(See Start-up Files?.) |sm_ext_isap.pro |Reference | |S_SET3 |String | Value = "User Cal Set Dir"
Comment contains the string : Name of User Calibration settings directory.
(See Start-up Files?.) |sm_ext_isap.pro |Reference | |S_SET4 |String | Value = "User Parm Set Dir"
Comment contains the string : Name of User parameter settings directory.
(See Start-up Files?.) |sm_ext_isap.pro |Reference | |S_SET5 |String | Value = "System Cal Set Dir"
Comment contains the string : Name of System Calibration settings directory.
(See Start-up Files?.) |sm_ext_isap.pro |Reference | |S_SET6 |String | Value = "System Parm Set Dir"
Comment contains the string : Name of System parameter settings directory.
(See Start-up Files?.) |sm_ext_isap.pro |Reference |

Variable Format Keywords

Keywords listed here designate values specific to a given order and place of a source within an order.

EG. S_O2P1 - Order 2, place 1.

Place here refers to the place of a source within an order.
It is NOT the same as the nod position.

The place of a source is numbered from left to right across the order.
If there are no sources in an order then place = 0.
If there is only one source in a order then place = 1. (Regardless of the position of the source.)
If there are two sources in an order then the first (leftmost) is place = 1 and the second = 2.
If there are three sources in an order then the first (leftmost) is place = 1, the second = 2 and the third = 3, etc.

Order value = 1-3 for low resoloution data or = 11-20 for high resoloution data.

Place value = 1, 2, 3, ... for low or high resoloution data.

Header Keyword Type Description Written By Used In
|S_OXPXA |string |Point source found in order X at place X. "A" keyword.

EG. S_O1P1A = '-3.73167,4.16299,G' /SMART npsf x, FWHM, Method

x = source position in pixels (cross-dispersion)
FWHM = source fwhm in pixels
Method :

Possible Values Meaning
C (Tapered) Column
G Gaussian
X Fixed Column

|sm_auto_all.pro sm_apply_2this_bcd.pro sm_mandefine_1.pro | |S_OXPXB |string |Point source found in order X at place X. "B" keyword.

EG. S_O1P1B = '318.61848,10.006190' /SMART npsf RA, Dec

RA & Dec values, slit center +/- offset from slit center |sm_auto_all.pro sm_apply_2this_bcd.pro sm_mandefine_1.pro | |SKOXPX |string |Sky vertices for source found in order X at place X.

EG. SKO1P1? = 'SMART Sky vertices' / -14.00,-11.07,4.03,12.00

Sky region(s), positions in pixel numbers in cross-dispersion direction.
Pairs (x1,x2), beginning and end of sky region. Up to 3 pairs possible.
Only used for SL and LL data. |sm_auto_all.pro sm_apply_2this_bcd.pro sm_ext_fixcol.pro sm_ext_gauss.pro sm_ext_npsf.pro |
S_TPOSX string Was a point source found at the nominal slit position in order X - TRUE or FALSE. sm_auto_all.pro

Examples of FITS file headers

  1. BCD FITS header?
  2. MIPL FITS header?
  3. Pipeline FITS header?
  4. Tran header?

Additional information about SMART FITS Files can be found in DCE FITS File Format?.

 
This site is powered by FoswikiCopyright © 2002-2009 by the Cornell IRS Team.
Send feedback. We use Foswiki.