.. _SPEPfOutputCatalog: SPE PF output catalog product ----------------------------- $SetSchemaPath spe/euc-spe-SpePfOutputCatalog.xsd Data product name ================= .. DataProductNameStart $PrintDataProductName .. DataProductNameEnd Data product custodian ====================== .. DataProductCustodianStart $PrintDataProductCustodian .. DataProductCustodianEnd Name of the Schema file ======================= .. NameSchemaStart $PrintSchemaFilename .. NameSchemaEnd Processing Element(s) creating/using the data product ===================================================== .. PECreatorStart Creators: * This product is created by the *SPE merge* processing element of the SPE PF which merges the outputs of the *SPE process spectra* and *SPE feature measurements* processing elements. .. PECreatorEnd Processing function using the data product ========================================== .. PFUsingStart LE3 PF is using SPE PF output product. .. PFUsingEnd Data product elements ===================== .. DataProductElementsStart $PrintDataProductElements .. DataProductElementsEnd Detailed description of the data product ======================================== The information carried by this product are split in 4 FITS files: - The :ref:`Redshift catalog` - The :ref:`PDF catalog` - The :ref:`Lines catalog` - The :ref:`Models catalog` They are described in details bellow: .. _spectroZCatalog: Redshift catalog ~~~~~~~~~~~~~~~~ This part of the product is a FITS file with 5 binary table extension HDUs. For each spectrum the first extension (HDU#1) contains several quality flags. For processed spectra, the second extension (HDU#2) contains the classification information. Other extensions contain up to 5 redshift candidates for galaxy (HDU#3), 1 relative velocity candidate for star (HDU#4) and up to 5 redshift candidates for QSO (HDU#5). Name of file: ``EUC_SPE_WIDE-CAT-Z-[TILE_ID]_[INSTANCE_ID]_[YYYYMMDDThhmmss.s]Z_[VERSION].fits`` Structure of file: $PrintHDUTableContents fit/euc-spe.xml spe.spectroZCatalog "Quality" $PrintHDUTableContents fit/euc-spe.xml spe.spectroZCatalog "Classification Catalog" $PrintHDUTableContents fit/euc-spe.xml spe.spectroZCatalog "GALAXY candidates catalog" $PrintHDUTableContents fit/euc-spe.xml spe.spectroZCatalog "STAR candidates catalog" $PrintHDUTableContents fit/euc-spe.xml spe.spectroZCatalog "QSO candidates catalog" **Quality flag for redshift catalog** The quality of the redshift estimate must be interpreted differently depending on whether the user is interested in a specific type of object. Indeed, for a user interested in Halpha emitters, the failure of the star classification algorithm may not be a significant quality criterion. Users are therefore advised to : - Check the ``SPE_ERROR_FLAG`` flag value. The value of the ``SPE_ERROR_FLAG`` flag should be equal to ``0`` (see the table dedicated to ``SPE_ERROR_FLAG`` for more details on the meaning of flag values). - For users interested in galaxy solutions, check the ``SPE_GAL_ERROR_FLAG`` flag value. The value of the ``SPE_GAL_ERROR_FLAG`` flag should be equal to ``0`` (see the table dedicated to ``AMAZED_ERROR`` for more details on the meaning of flag values). - For users interested in star solutions, check the value of the ``SPE_STAR_ERROR_FLAG`` flag. The value of the ``SPE_STAR_ERROR_FLAG`` flag should be equal to ``0`` (see the table dedicated to ``AMAZED_ERROR`` for more details on the meaning of flag values). - For users interested in QSO solutions, check the ``SPE_QSO_ERROR_FLAG`` flag value. The value of the ``SPE_QSO_ERROR_FLAG`` flag should be equal to ``0`` (see the table dedicated to ``AMAZED_ERROR`` for more details on the meaning of flag values). ``SPE_ERROR_FLAG`` *table* +------------+--------------------------------------------------------------------------------+ | Bit number | Description | +============+================================================================================+ | 0 | Error in context stage (see ``AMAZED_ERROR`` table) | +------------+--------------------------------------------------------------------------------+ | 1 | Error in classification stage (see ``AMAZED_ERROR`` table) | +------------+--------------------------------------------------------------------------------+ | 2 | Unable to read the SIR combined spectrum product | +------------+--------------------------------------------------------------------------------+ | 3 | Empty spectrum in the SIR combined spectrum product | +------------+--------------------------------------------------------------------------------+ | 4 | NaN values detected in the SIR combined spectrum product | +------------+--------------------------------------------------------------------------------+ | 5 | Different data array (lambda, flux, err, ...) size after filtering | +------------+--------------------------------------------------------------------------------+ | 6 | Short size spectrum | +------------+--------------------------------------------------------------------------------+ ``AMAZED_ERROR`` *table* +------------+--------------------------------------------------------------------------------+ | Err number | Description | +============+================================================================================+ | 1 | INTERNAL_ERROR, | +------------+--------------------------------------------------------------------------------+ | 2 | EXTERNAL_LIB_ERROR, | +------------+--------------------------------------------------------------------------------+ | 3 | INVALID_SPECTRA_FLUX, | +------------+--------------------------------------------------------------------------------+ | 4 | INVALID_NOISE, | +------------+--------------------------------------------------------------------------------+ | 5 | SMALL_WAVELENGTH_RANGE, | +------------+--------------------------------------------------------------------------------+ | 6 | NEGATIVE_CONTINUUMFIT, | +------------+--------------------------------------------------------------------------------+ | 7 | BAD_CONTINUUMFIT, | +------------+--------------------------------------------------------------------------------+ | 8 | NULL_AMPLITUDES, | +------------+--------------------------------------------------------------------------------+ | 9 | PEAK_NOT_FOUND_PDF, | +------------+--------------------------------------------------------------------------------+ | 10 | MAX_AT_BORDER_PDF, | +------------+--------------------------------------------------------------------------------+ | 11 | MISSING_PARAMETER, | +------------+--------------------------------------------------------------------------------+ | 12 | BAD_PARAMETER_VALUE, | +------------+--------------------------------------------------------------------------------+ | 13 | UNKNOWN_ATTRIBUTE, | +------------+--------------------------------------------------------------------------------+ | 14 | BAD_LINECATALOG, | +------------+--------------------------------------------------------------------------------+ | 15 | BAD_LOGSAMPLEDSPECTRUM, | +------------+--------------------------------------------------------------------------------+ | 16 | BAD_COUNTMATCH, | +------------+--------------------------------------------------------------------------------+ | 17 | BAD_TEMPLATECATALOG, | +------------+--------------------------------------------------------------------------------+ | 18 | INVALID_SPECTRUM, | +------------+--------------------------------------------------------------------------------+ | 19 | OVERLAPFRACTION_NOTACCEPTABLE, | +------------+--------------------------------------------------------------------------------+ | 20 | DZ_NOT_COMPUTABLE, | +------------+--------------------------------------------------------------------------------+ | 21 | INCOHERENT_INPUTPARAMETERS, | +------------+--------------------------------------------------------------------------------+ | 22 | BAD_CALZETTICORR, | +------------+--------------------------------------------------------------------------------+ | 23 | SPECTRUM_NOT_LOADED, | +------------+--------------------------------------------------------------------------------+ | 24 | MULTILSF_NOT_HANDLED, | +------------+--------------------------------------------------------------------------------+ | 25 | UNALLOWED_DUPLICATES, | +------------+--------------------------------------------------------------------------------+ | 26 | UNSORTED_ARRAY, | +------------+--------------------------------------------------------------------------------+ | 27 | INVALID_DIRECTORY, | +------------+--------------------------------------------------------------------------------+ | 28 | INVALID_FILEPATH, | +------------+--------------------------------------------------------------------------------+ | 29 | INVALID_PARAMETER, | +------------+--------------------------------------------------------------------------------+ | 30 | MISSING_CONFIG_OPTION, | +------------+--------------------------------------------------------------------------------+ | 31 | BAD_FILEFORMAT, | +------------+--------------------------------------------------------------------------------+ | 32 | INCOHERENT_CONFIG_OPTIONS, | +------------+--------------------------------------------------------------------------------+ | 33 | ATTRIBUTE_NOT_SUPPORTED, | +------------+--------------------------------------------------------------------------------+ | 34 | INCOMPATIBLE_PDF_MODELSHAPES, | +------------+--------------------------------------------------------------------------------+ | 35 | UNKNOWN_RESULT_TYPE, | +------------+--------------------------------------------------------------------------------+ | 36 | RELIABILITY_NEEDS_TENSORFLOW, | +------------+--------------------------------------------------------------------------------+ | 37 | OUTPUT_READER_ERROR, | +------------+--------------------------------------------------------------------------------+ | 38 | PYTHON_API_ERROR, | +------------+--------------------------------------------------------------------------------+ | 39 | INVALID_NAME, | +------------+--------------------------------------------------------------------------------+ | 40 | INVALID_FILTER_INSTRUCTION, | +------------+--------------------------------------------------------------------------------+ | 41 | INVALID_FILTER_KEY, | +------------+--------------------------------------------------------------------------------+ | 42 | NO_CLASSIFICATION, | +------------+--------------------------------------------------------------------------------+ | 43 | INVALID_PARAMETER_FILE, | +------------+--------------------------------------------------------------------------------+ .. _spectroGalaxyPdf: PDF catalog ~~~~~~~~~~~ This part of the product is a FITS file with 2 binary table extension HDU containing for each spectrum the estimated redshift PDFs (Probability Density Function) galaxies (#HDU1) and QSO (#HDU2). This product is available for DEEP survey only. Name of file: ``EUC_SPE_DEEP-CAT-PDF-[TILE_ID]_[INSTANCE_ID]_[YYYYMMDDThhmmss.s]Z_[VERSION].fits`` Structure of file: $PrintHDUTableContents fit/euc-spe.xml spe.spectroGalaxyPdf "Galaxy Spectroscopic Redshift PDF Catalog" $PrintHDUTableContents fit/euc-spe.xml spe.spectroGalaxyPdf "QSO Spectroscopic Redshift PDF Catalog" .. _spectroLineFeaturesCatalog: Lines catalog ~~~~~~~~~~~~~ This part of the product is a FITS file with 4 binary table extension HDU containing for each spectrum the spectral line measurements (#HDU1), the measurement of absorption Atomic indices (HDU#2), absorption molecular indices (HDU#3) and Continuum features (HDU#4). Name of file: ``EUC_SPE_WIDE-CAT-LIN-[TILE_ID]_[INSTANCE_ID]_[YYYYMMDDThhmmss.s]Z_[VERSION].fits`` Structure of file: $PrintHDUTableContents fit/euc-spe.xml spe.spectroLineFeaturesCatalog "Spectral Line Catalog" $PrintHDUTableContents fit/euc-spe.xml spe.spectroLineFeaturesCatalog "Atomic Indices Catalog" $PrintHDUTableContents fit/euc-spe.xml spe.spectroLineFeaturesCatalog "Molecular Indices Catalog" $PrintHDUTableContents fit/euc-spe.xml spe.spectroLineFeaturesCatalog "Continuum Features Catalog" **Quality flag for lines catalog** The quality flag is always an integer number composed by 3 digits, respectively indicating (from left to right) measure type, measure quality and grism used. It is applicable to Direct Integration and Gaussian Fits methods. The 1st digit can be: - 1 : Direct Integration - 2 : Gaussian Fit - 3 : Hα_GF for QSOs - "-" : the line is outside the redshift range The 2nd digit can assume one of the following values : - 0, 1, 2, 3, 5, 8, 9 (see table bellow) The 3rd digit can be : - 1 : Blue grism - 2 : Red grism - 3 : Blue and red grism - 6 : Blue grism and is the best one - 7 : Red grism and is the best one - 8 : Blue and red grism and is the best one *Second digit table* +----------+-------------+-----------------------------------------------------+--------------+ |2nd digit |Definition |Description |Applicable to | +==========+=============+=====================================================+==============+ |0 |Not measured |The standard pipeline does not provide a | All | | | |measurement (for DI) or a fit (for GF or Hα_QSO). | | | | | | | | | |Possible values for the QualFlag: | | | | | 101, 102, 201, 202, 301, 302 | | +----------+-------------+-----------------------------------------------------+--------------+ |1 |Good measure |The measure is considered reliable | All | | | | | | | | |Possible values for the QualFlag: | | | | | 111, 112, 211, 212, 311, 312 | | +----------+-------------+-----------------------------------------------------+--------------+ |2 |Low SNR |The measure might be good but the line has a low SNR.| All | | | |(SNR < 2.0). | | | | | | | | | |Possible values for the QualFlag: | | | | | 121, 122, 221, 222, 321, 322 | | +----------+-------------+-----------------------------------------------------+--------------+ |3 |EW > 0 |The EW has a positive value (probably due to a | GF or | | | |negative continuum). The value is set to zero but the| Hα_QSO | | | |other measures (e.g. fluxes) are however reported. | | | | | | | | | |Possible values for the QualFlag: | | | | | 231, 232, 331, 332 | | +----------+-------------+-----------------------------------------------------+--------------+ |5 |Acceptable |The measure is acceptable but up to 15% of the pixels| GF or Hα_QSO | | | |within the line are missing. | | | | | | | | | |Possible values for the QualFlag: | | | | | 251, 252, 351, 352 | | +----------+-------------+-----------------------------------------------------+--------------+ |8 |Unreliable or|The measure is unreliable because more than 15% of | All | | |wrong fluxes |the pixels are missing (GF or QSO) or it’s wrong | | | | |because more than 1 pixel is missing (DI). | | | | | | | | | |Possible values for the QualFlag: | | | | | 181, 182, 281, 282, 381, 382 | | +----------+-------------+-----------------------------------------------------+--------------+ |9 |Outside range|The line is not measurable in the redshift range. | All | | | | | | | | |Possible values for the QualFlag: | | | | | -91, -92 | | +----------+-------------+-----------------------------------------------------+--------------+ .. _spectroModelsCatalog: Models catalog ~~~~~~~~~~~~~~ This part of the product is a FITS file with 4 binary table extension HDUs containing for each spectrum the parameters required for building spectrum model of each galaxy candidates (HDU#2), star candidate (HDU#3) and QSO candidates (HDU#4). Line catalog is also given (HDU#1) Name of file: ``EUC_SPE_WIDE-CAT-MOD-[TILE_ID]_[INSTANCE_ID]_[YYYYMMDDThhmmss.s]Z_[VERSION].fits`` Structure of file: $PrintHDUTableContents fit/euc-spe.xml spe.spectroModelCatalog "Lines Catalog" $PrintHDUTableContents fit/euc-spe.xml spe.spectroModelCatalog "GALAXY models Catalog" $PrintHDUTableContents fit/euc-spe.xml spe.spectroModelCatalog "STAR models catalog" $PrintHDUTableContents fit/euc-spe.xml spe.spectroModelCatalog "QSO models catalog"