Skip to content
GitLab
Commit 29584425 authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

reformat data model

parent 48577d69
Show whitespace changes
Inline Side-by-side
docs/source/mbi/data_model.md
View file @ 29584425
......@@ -4,29 +4,31 @@
- 精简、丰富、修改每个关键字定义的comment
- `---`表示在模块算法失败的情况下按照实际情况填写，比如无论模块是否成功，时间戳都应该填写实际值
- keyword开头是“-”号的，根据理解和最终的产品无关，建议去掉
- keyword开头是“*”号的，表示有所修改，请检查是否需要，完善注释，并检查对fallback_value的设置是否合理
- keyword开头是“*”号的，表示有所修改，请检查是否需要，完善注释，并检查对fill value的设置是否合理
- flux模块中的天光背景测量已经移动到instrumens，请把该数值利用zp转换为SKY_MAG（单位mag/arcsed^2）
- 版本，完成时间，状态三个参数的name进行了统一，分别以VER_，STM_，STA_开头
## File: *_{img/wht/flg}_L1_1.fits
### File contents
| HDU | data | note |
|------|-------------------------|------------|
| HDU0 | None | PrimaryHDU |
| HDU1 | reduced image (9k x 9k) | ImageHDU |
### HDU0
| keyword | value | comment | fallback_value | type | module |
|---------|:------|---------------|----------------|------|-----------|
| keyword | value | comment | fill value | type | module |
|---------|:------|---------------|---------------|------|-----------|
| SIMPLE | True | Fits standard | True | bool | csst_sims |
### HDU1
#### Header of `csst_ms_mbi_instrument`
| keyword | value | comment | fallback_value | type | module |
|----------|:----------------------|-------------------------------------------------|----------------|------|--------------------------|
| keyword | value | comment | fill value | type | module |
|-----------|:----------------------|-------------------------------------------------|--------------|------|--------------------------|
| *STA_BIAS | 0 | Status flag for bias frame correction | 1 | i8 | csst_ms_mbi_instrument |
| *STA_DARK | 0 | Status flag for dark frame correction | 1 | i8 | csst_ms_mbi_instrument |
| *STA_FLAT | 0 | Status flag for flat frame correction | 1 | i8 | csst_ms_mbi_instrument |
......@@ -44,8 +46,8 @@
#### Header of `csst_ms_mbi_distortion`
| keyword | value | comment | fallback_value | type | module |
|----------|:----------------------|-------------------------------------|----------------|------|------------------------|
| keyword | value | comment | fill value | type | module |
|----------|:----------------------|-------------------------------------|------------|------|------------------------|
| *RADESYS | 'ICRS ' | | '?' | str | csst_ms_mbi_distortion |
| *NS_DIST | 11 | The number of stars used in fitting | --- | i8 | csst_ms_mbi_distortion |
| PV1_0 | 0.003205383944913964 | | -9999 | f32 | csst_ms_mbi_distortion |
......@@ -74,8 +76,8 @@
#### Header of `csst_ms_mbi_position`
| keyword | value | comment | fallback_value | type | module |
|-----------|:----------------------------|--------------------------------------------|----------------|------|-------------------------|
| keyword | value | comment | fill value | type | module |
|-----------|:-------------------------|--------------------------------------------|------------|------|-------------------------|
| RADESYS | 'ICRS ' | should be always 'ICRS' | '?' | str | csst_ms_mbi_position |
| PV1_0 | -7.032303876526E-04 | | -9999 | f32 | csst_ms_mbi_position |
| PV1_1 | 9.986639936274E-01 | | -9999 | f32 | csst_ms_mbi_position |
......@@ -107,8 +109,8 @@
#### Header of `csst_ms_mbi_flux`
| keyword | value | comment | fallback_value | type | module |
|-------------|:----------------------|------------------------------------------------|----------------|------|--------------------|
| keyword | value | comment | fill value | type | module |
|-------------|:----------------------|------------------------------------------------|-----------------|------|--------------------|
| REF_FLUX | 'GAIA_DR3 ' | the reference database for calibration | '?' | str | csst_ms_mbi_flux |
| ZP | 23.8435 | photometric zero point in magnitude | -9999 | f32 | csst_ms_mbi_flux |
| ZPRMS | 0.0101 | zpt rms of the matched objects | -9999 | f32 | csst_ms_mbi_flux |
......@@ -127,8 +129,9 @@
| *STM_FLUX | '2022-12-30 18:36:05' | flux calibration operation time | --- | str | csst_ms_mbi_flux |
#### Header of `csst_ms_qc0 qc0 check`
| keyword | value | comment | fallback_value | type | module |
|-----------|---------|-----------------------------------------------|----------------|-------|---------------|
| keyword | value | comment | fill value | type | module |
|-----------|---------|-----------------------------------------------|------------|-------|---------------|
| *CRCCHECK | T | CRC check | F | bool | csst_ms_qc0 |
| PRIPARAM | 0 | Primary parameters verification | 1 | int | csst_ms_qc0 |
| SECPARAM | 0 | Secondary parameters verification | 1 | int | csst_ms_qc0 |
......@@ -153,17 +156,18 @@
| VER_QC0 | '0.0.1' | Pipeline version | '0.0.1' | str | csst_ms_qc0 |
#### Header of `csst_ms_qc0 qc1 check`
| keyword | value | comment | fallback_value | type | module |
|----------|:----------|-------------------------|----------------|-------|---------------|
| keyword | value | comment | fill value | type | module |
|----------|:----------|-------------------------|---------------|-------|---------------|
| *STA_QC1 | 0 | QC1 Status (0/non-zero) | -1 | int | csst_ms_qc0 |
| ME_FWHM | 0.158212 | MEAN FWHM (in arcsec) | -9999 | f32 | csst_ms_qc0 |
| WCS_OFF | T | WCS OFFSET (T/F) | F | bool | csst_ms_qc0 |
| VER_QC1 | '0.0.1' | Pipeline version | '0.0.1' | str | csst_ms_qc0 |
## File: *_cat.fits
### File contents
| HDU | data | note |
|------|-------------------------|------------|
| HDU0 | None | PrimaryHDU |
......@@ -172,8 +176,9 @@
### HDU0
#### Header of photometry
| keyword | value | comment | fallback_value | type | module |
|-----------|:--------------------------|-------------------------------|----------------|------|-------------------------|
| keyword | value | comment | fill value | type | module |
|--------------------|:----------------------------------|---------------------------------------------|------------|-------|--------------------------|
| APERSIZE | '3,4,5,6,8,10,13,16,20,25,30,40,' | aperture radii in pixels | | str | csst_ms_mbi_photometry |
| NS_APER | 75 | number of stars used in aperture correction | | i8 | csst_ms_mbi_photometry |
| APCOR0 | -0.06074262037873268 | mag correction for aperture #0 | | f32 | csst_ms_mbi_photometry |
......@@ -200,15 +205,15 @@
| APERR10 | 0.0 | mag correction error for aperture #10 | | f32 | csst_ms_mbi_photometry |
| APCOR11 | 0.0952027440071106 | mag correction for aperture #11 | | f32 | csst_ms_mbi_photometry |
| APERR11 | 0.0 | mag correction error for aperture #11 | | f32 | csst_ms_mbi_photometry |
| HIERARCH ns_HYBRID | 328 |number of stars used in HYBRID correction | | i8 | csst_ms_mbi_photometry |
| HIERARCH ns_HYBRID | 328 | number of stars used in HYBRID correction | | i8 | csst_ms_mbi_photometry |
| HYBCOR | 0.0498337559401989 | mag correction for HYBRID | | f32 | csst_ms_mbi_photometry |
| HYBERR | 0.000711286964798456 | mag correction error | | f32 | csst_ms_mbi_photometry |
| NS_PSF | 306 | number of stars used in PSF correction | | i8 | csst_ms_mbi_photometry |
| PSFCOR | -0.00268870708532631 | mag correction for PSF | | f32 | csst_ms_mbi_photometry |
| PSFERR | 0.000903990056504255 | mag correction error | | f32 | csst_ms_mbi_photometry |
| NS_MODEL | 324 | number of stars used in MODEL correction| | i8 | csst_ms_mbi_photometry |
| NS_MODEL | 324 | number of stars used in MODEL correction | | i8 | csst_ms_mbi_photometry |
| MODCOR | 0.04189466685056686 | mag correction for MODEL | | f32 | csst_ms_mbi_photometry |
| MODERR | 0.000894258863834524| mag correction error | | f32 | csst_ms_mbi_photometry |
| MODERR | 0.000894258863834524 | mag correction error | | f32 | csst_ms_mbi_photometry |
### HDU1
......@@ -227,16 +232,16 @@
#### Header
| keyword | value | comment | fallback_value | type | module |
|---------|:------|---------------|----------------|------|------------------|
| keyword | value | comment | fill value | type | module |
|---------|:------|----------------|---------------|------|------------------|
| SIMPLE | True | Fits standard | True | bool | csst_ooc_psf_mbi |
### HDU1
#### Header of `csst_ooc_psf_mbi`
| keyword | value | comment | fallback_value | type | module |
| -------- |:------------ | --------------------------------------------- | -------------- | ---- | ---------------- |
| keyword | value | comment | fill value | type | module |
|------------|:-------------|-----------------------------------------------|------------|-------|--------------------|
| LOADED | 579 | Number of loaded sources | | I8 | csst_ooc_psf_mbi |
| ACCEPTED | 573 | Number of accepted sources | | I8 | csst_ooc_psf_mbi |
| CHI2 | 1.12832649 | Final reduced chi2 | | f32 | csst_ooc_psf_mbi |
......@@ -260,8 +265,8 @@
#### Header of `csst_ooc_psf_strategy_crds`
| keyword | value | comment | fallback_value | type | module |
| --------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ---- | -------------------------- |
| keyword | value | comment | fill value | type | module |
|------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------|------------|--------|------------------------------|
| USEAFTER | '2028-07-22T18:52:33' | date and time after the reference files will be used. (YYYY-MM-DDThh:mm:ss) | | str | csst_ooc_psf_strategy_crds |
| OBSSTART | '2028-07-22T18:52:33' | UTC date and time of start of first observation (YYYY-MM-DDThh:mm:ss) | | str | csst_ooc_psf_strategy_crds |
| OBSEND | '2028-07-23T17:54:27' | UTC date and time of end of last observation (YYYY-MM-DDThh:mm:ss) | | str | csst_ooc_psf_strategy_crds |
......@@ -279,10 +284,11 @@
| P5_ FOCUS | 28025.63452 | parameter 5 of focal length (in mm) | | f32 | csst_ooc_psf_strategy_crds |
| P6_ FOCUS | 28025.63452 | parameter 6 of focal length (in mm) | | f32 | csst_ooc_psf_strategy_crds |
| FSM_STAT | T | working state of fast-steering mirror (FSM) | | bool | csst_ooc_psf_strategy_crds |
#### Header of `csst_ms_mbi_astrometry`
| keyword | value | comment | fallback_value | type | module |
|-------------------|:--------------------|---------------------------------------------------------------------------------------------------------------------|------------------------|--------|---------------------------|
| keyword | value | comment | fill value | type | module |
|-------------------|:----------------------|---------------------------------------------------------------------------------------------------------------------|------------------------|--------|---------------------------|
| *STA_CCRS CCRSCAL | 0 | Completion degree of relative astrometric solution in CCRS | 1 | i8 | csst_ms_mbi_astrometry |
| *VER_CCRS CCRSVE | "v2023.01" | Version of CSST relative Astrometry soft in CCRS | "v2023.01" | str | csst_ms_mbi_astrometry |
| CCRSGATE | " " | Camera shutter information | " " | str | csst_ms_mbi_astrometry |
......
docs/source/sls/data_model.md
View file @ 29584425
......@@ -24,13 +24,13 @@ COMMENT QC0 CHECK
COMMENT ==================================================================
```
精简每个关键字的comment
`-`表示不可能失败，不会使用fallback_value
`-`表示不可能失败，不会使用fill value
### HDU1-1 (先不管)
| keyword | value | comment | fallback_value | type | last modified |
|--------------------|:-----------------------|-----------------------------------------------|-----------------------|--------|-------------------------|
| keyword | value | comment | fill value | type | last modified |
|--------------|:-------------------------|----------------------------------------------|------------|--------|---------------|
| VER_CRDS | '0.0.1 ' | Version of CRDS file selection software used | - | str | C7 |
| R_GAIN | '*.gain.fits' | Gain reference file name | 'N/A' | str | C7 |
| R_READN | '*.rn.fits' | Read noise reference file name | 'N/A' | str | C7 |
......@@ -41,7 +41,7 @@ COMMENT ==================================================================
| R_DFLAT | '*flat.fits' | Detector Flat reference file name | 'N/A' | str | C7 |
| STA_DQINI | 0 | Data Quality Initialization status | 1 | int | C7 |
| STA_SATURA | 0 | Saturation Checking status | 1 | int | C7 |
| STA_ERRINI | 0 | Error Initialization status |1 | int | C7 |
| STA_ERRINI | 0 | Error Initialization status | 1 | int | C7 |
| STA_BIAS | 0 | Bias correction status | 1 | int | C7 |
| STA_DARK | 0 | Dark correction status | 1 | int | C7 |
| STA_FLAT | 0 | Flat field correction status | 1 | int | C7 |
......@@ -55,8 +55,8 @@ COMMENT ==================================================================
#### Header of `csst_ms_sls_instrument`
| keyword | value | comment | fallback_value | type | last modified |
|-----------|:---------|-----------------------------------------|----------------|------|--------------------------|
| keyword | value | comment | fill value | type | last modified |
|-----------|:---------|---------------------------------------|------------|--------|---------------|
| EXTNAME | 'SCI' | Extension name | 'SCI' | str | C7 |
| EXTVER | 1 | Extension version number | 1 | int | C7 |
| BUNIT | 'e-/s' | Brightness units | 'e-/s' | str | C7 |
......@@ -74,8 +74,8 @@ COMMENT ==================================================================
位置定标信息新开一节
CD1_1等系数在修改后挪到这一节
| keyword | value | comment | fallback_value | type | module | last modified |
|----------|:----------------------|------------------------------|----------------|--------|-----------------------|------|
| keyword | value | comment | fill value | type | module | last modified |
|----------|:----------------------|------------------------------------------|------------|--------|-----------------------|---------------|
| CTYPE1 | 'RA---TPV' | type of ra | 'RA---TAN' | str | csst_ms_sls_position | C7 |
| CTYPE2 | 'DEC--TPV' | type of dec | 'DEC--TAN' | str | csst_ms_sls_position | C7 |
| CUNIT1 | 'deg ' | unit of ra | 'deg' | str | csst_ms_sls_position | C7 |
......@@ -108,8 +108,8 @@ CD1_1等系数在修改后挪到这一节
#### Header of `csst_ms_sls_qc1`
| keyword | value | comment | fallback_value | type | last modified |
|----------------|:-------------------------|------------------------------|----------------|-------|---------------|
| keyword | value | comment | fill value | type | last modified |
|----------------|:--------------------------|------------------------------|------------|-------|---------------|
| STA_QC1 | 0 | 0 for success, 1 for failure | -1 | i8 | C7 |
| VER_QC1 | '0.0.1' | QC1 pipeline version | '0.0.1' | str | C7 |
| QC1_FLAG | 0 | Quality flags | -9999 | i16 | C7 |
......@@ -119,8 +119,8 @@ CD1_1等系数在修改后挪到这一节
#### Header of `csst_ms_sls_instrument`
| keyword | value | comment | fallback_value | type | last modified |
|----------|---------------|----------------------------|----------------|---------|-------------------------|
| keyword | value | comment | fill value | type | last modified |
|----------|-----------|----------------------------|------------|-----------|---------------|
| XTENSION | 'IMAGE' | Image extension | - | str | C7 |
| BITPIX | -32 | Bits per data value | - | int | C7 |
| NAXIS | 2 | Number of array dimensions | - | int | C7 |
......@@ -136,12 +136,12 @@ CD1_1等系数在修改后挪到这一节
#### Header of `csst_ms_sls_instrument`
| keyword | value | comment | fallback_value | type | last modified |
|-----------|-------------|----------------------------|----------------|--------|------------------------|
| keyword | value | comment | fill value | type | last modified |
|----------|-------------|----------------------------|----------------|----------|---------------|
| XTENSION | 'IMAGE' | Image extension | - | str | C7 |
| BITPIX | 16 | Bits per data value | - | int | C7 |
| NAXIS | 2 | Number of array dimensions | - | int | C7 |
| NAXIS1 | 9216 | Size of the axis |- | int | C7 |
| NAXIS1 | 9216 | Size of the axis | - | int | C7 |
| NAXIS2 | 9232 | Size of the axis | - | int | C7 |
| PCOUNT | 0 | Number of parameters | - | int | C7 |
| GCOUNT | 1 | Number of groups | - | int | C7 |
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment