WISE Science Data System Subsystem Interface Specifications Description (WSDC D-I002)

I. Introduction

Subsystem Interface Specifications (SIS) are documents that describe the format and content of output files generated by subsystem/modules in the WISE Science Data System (WSDS). Any output file that is read by another WSDS subsystem/module, or that will persist on disk in the operations archive after a session of processing is completed for later use in system trending or data analysis should have a corresponding SIS. The output file described by a SIS may be tabular, image or other formats.

The list of current SIS documents and their corresponding WISE Science Data Center (WSDC) document number is maintained in the WSDC Document Tree.

II. SIS Designations

SIS files shall have the naming convention:     xxxNN

where xxx is a three letter designation refering to the subsystem/module that creates the file described in the SIS, and NN is a two digit number that distinguishes different SIS's from each subsystem module. For example, icl01 is the first SIS for the Instrument Calibration (ICAL) module.

The table below gives the proposed three letter SIS designations and their corresponding subsystem/modules.

Table 1 - SIS Designations

Designation	Subsystem/Module
xec	System Executive Subsystem (EXEC)
ing	Science, H/K and Ancillary Data Ingest Subsystem (INGEST)
sfp	Scan/Frame Pipeline
icl	Instrumental Calibration Module (ICAL)
mdt	Multiband Detection (MDET)
rex	Position Reconstruction Module (PRex)
pht	Source Photometry Module (WPHOT)
cog	Photometry Curve-of-Growth Module (WCOG)
art	Artifact Identification Module (ARTID)
sso	Solar System Object Association Module (SSOID)
pcl	Photometric Calibration Module (PCal)
mop	WISE Moving Object Pipeline Subsystem (WMOPS)
mfp	MultiFrame Pipeline
fco	Frame Coaddition module (COADD)
qua	Quality Assurance Subsystem (QA)
arc	Archive Subsystem (ARCHIVE)
fpg	Final Product Generation Subsystem (FPG)

III. SIS Contents and Formats

[Under Construction]

WSDS Subsystem Interface Specifications should be ascii text files that contain clear descriptions of the format and contents of files created by each WSDS subsystem/module.

1. Header Line

Each SIS should start with a single header line of the form:

WISE Software Interface Specification; designation; (WSDC Document Number) (Date) (version number)

where

• designation is the five character SIS designation (e.g. ing01)
• WSDC Document Number is the WSDC Document Tree Number (e.g. WSDC D-I101)
• Date is the date of the most recent version of the SIS
• version is an optional version number

Following are examples of SISs describing text and image format files:

• Example of SIS for an ASCII text file (qua01)
• Example of SIS for a FITS image (icl01)

IV. List of Current and Planned WSDS SISs

Table 2 contains a listing and brief description of SISs that currently exist or that are planned. Documents that exist in at least draft form have a WSDC Document number listed in the third column. Click on the document number to view the SIS.

Table 2 - List of Current and Planned SISs

Subsystem/ Module	Desig.	WSDC Document Number	Description
EXEC	xec01	D-I168	Incremental Survey Coverage Report
INGEST	ing01	D-I104	Ingest Metadata for QA
	ing02	D-I106	Level 0 frame pixel statistics
	ing03	D-I152	Level 0 FITS image header description
Scan/Frame Pipe	sfp01	D-I102	FITS frame header input specification for WISE co-adder: level-1b products with refined WCS
ICAL	icl01	D-I101	Level 1a frame mask bit definitions and format
	icl02	D-I123	Level-1a intermediate image products from instrumental calibration (format and content).
	icl03	D-I160	Metadata for tempcal calibration products.
	icl04	D-I105	QA diagnostics/metrics/plots
	icl05		not used
	icl06	D-I137	QA metadata for dynamic responsivity map generation
MDET	mdt01		Detection List
	mdt02		Sky Background Image
PRex	rex01	D-I116	SFPRex Metadata (SFMD) file (includes updated position info)
	rex02	D-I117	Reference vs. Band (RvB) statistics table; used for distortion fitting
	rex03	D-I118	Single-frame merged point (SFMP) file; used for QA and input for Multiframe processing
	rex04	D-I119	Unused reference file (UREF); includes 2MASS reference stars contained within frameset that are not used in astrometric solution.
	rex05	D-I131	BMD = Bundle Meta-Data file containing bundle-related MFPRex parameters (one file generated for each iteration of each bundle)
	rex06	D-I132	FMD = Frame Meta-Data file containing MFPRex refined frame position data (one file generated for each core frame during MFPRex wrapup)
	rex07	D-I133	CVEC = Correction VECtor file (one file output for each iteration of each bundle; serves as input to next iteration)
	rex08	D-I134	OLDS = OverLap Difference Statistics file (one file generated for each iteration of each bundle)
	rex09	D-I135	BvB = File of Band-to-Band difference pairs generated by SFPRex (one file per frameset)
	rex10	D-I161	Parameter Covariance (PCOV) file
WPHOT	pht01	D-I107	Table of photometry
	pht02	D-I113	WPHOT metadata table
	pht03	D-I111	Differential source counts as derived from WPRO (LogN vs. mag). One per band.
	pht04	D-I112	Binned pixel distribution for star-subtracted images generated by WPRO. One per band.
	pht05	D-I166Source information table updated to include artifact identification and photometric calibration.
COG	cog01	D-I127	COG Output Curve of Growth Sources Table
	cog02	D-I128	COG Output Median COG and Aperture Corrections Table
PCal	pcl01	D-I108	Frame Photometric Calibration System output file
	pcl02	D-I109	Primary photometric calibration star list
	pcl03	D-I110	SPCal metadata.
	pcl04	D-I114	FPCAL frame-level metadata table
	pcl05	D-I115	Scan-level photometric zero point values for four bands
	pcl06	D-I120	All source matches to calibration stars for a scan. QA supporting output.
	pcl07	D-I129	Scan zero-point QA information.
	pcl08	D-I130	No longer used.
	pcl09	D-I136	Zero points derived for a scan to be inserted into the Calibration Database.
ARTID	art01	D-I122	Source table with artifact flagging (cc_map, cc_map_str, cc_flg) parameters
	art02	D-I156	Table of latent parents on a frame brighter than threshold magnitude
	art03	D-I157	Schema of sqlite3 databases of accumulated latent parent sources - per anneal
	art04	D-I158	Artifact summary metadata table
SSOID	sso01	D-I145	SSO Orbital Elements File
	sso02	D-I146	SSO ssoinit/ssoid Intermediate File
	sso03	D-I147	SSO Three-Epoch Ephemeris File
	sso04	D-I148	SSO/WISE Associations File
	sso05	D-I149	SSO Meta-Data File
	sso06	D-I151	Planetary Satellite Data File
WMOPS	mop01	D-I169	Minor Planet Center-formatted astrometry report for objects discovered by WMOPS (.mpc)
	mop02	D-I170	Per-tracklet source ID list (.mpc.sids)
	mop03	D-I171	Summary report of the SSOID comparison data & statistics (.rpt)
	mop04	D-I172	List of tracks that contained mixed or noisy tracks of objects identified by SSOID (.relog)
	mop05	D-I173	List of objects identified by SSOID that did not yield WMOPS tracklets (.detlog)
	mop06	D-I174	MPCOID orbit fitting routine output (.els)
MultiFrame Pipe
COADD	fco01	D-I125	Level 2a/b single frame distortion corrected and interpolated intermediate image product formats and header content
	fco02		not used
	fco03		not used
	fco04		not used
	fco05		not used
	fco06		not used
	fco07	D-I121	Level 3 QA diagnostics and metrics table
QA	qua01	D-I103	PSF shape characterization from scan-synchronization frames
	qua02	D-I159	QA Frame Grade file
	qua03		Multiframe input criteria
	qua04		FPG input criteria
	qua05	D-I165	QA Scan Grade File
	qua06		QA Coadd Grade File
	qua07		MFP QA checksum metadata
	qua08	D-I167	Quicklook QA Anomaly Report
	qua09	D-I175	Ecliptic pole reference source tables
ARCHIVE	arc01	D-I138	Level 1b Source Data Table Archive DB Interface Specification
	arc02	D-I139	Level 1b Frame Metadata Table Archive DB Interface Specification
	arc03	D-I140	Level 1b Calibration Match Data Table Archive DB Interface Specification
	arc04	D-I141	Level 1b Calibration Frame Metadata Table Archive DB Interface Specification
	arc05	D-I142	Level 1b Calibration Scan Metadata Table Archive DB Interface Specification
	arc06	D-I143	Level 1b Solar System Object Match Data Table Archive DB Interface Specification
	arc07	D-I144	Level 1b Solar System Object Frame Metadata Table Archive DB Interface Specification
	arc08	D-I150	Level 1b Image Frame Metadata Table Archive Image Service Interface Specification
	arc09	D-I153	2MASS PSC Association Matches File Interface
	arc10	D-I154	2MASS PSC Association 2MASS Non-Matches File Interface
	arc11	D-I155	2MASS PSC Association WISE Non-Matches File Interface
	arc12	D-I162	Level 3o Source Data Table Archive DB Interface Specification
	arc13	D-I163	Level 3o Coadd Metadata Table Archive DB Interface Specification
	arc14	D-I164	Level 3o Image Frame Metadata Table Archive Image Service DB Interface Specification
FPG	fpg01	D-I124	Level-1b products: headers/metadata for archive.
	fpg02	D-I126	Level 3 Atlas Image products: headers/metadata for archive.