.. include:: ../../gcsubstitutions.txt .. _TwoPCFGC1D: Output - 1D [Angle-averaged Auto-correlation Product] ======================================================== Metadata ______________________ +------------------------------------------------+----------------------------------------------------------------------------------------------+ | Data product name | DpdLE3gcTwoPointAutoCorr | +------------------------------------------------+----------------------------------------------------------------------------------------------+ | Data product custodian | GC2PCF | +------------------------------------------------+----------------------------------------------------------------------------------------------+ | Name of the Schema file | .. raw:: html | | | | | | `euc-le3-gc-2pcf-auto.xsd `_ | +------------------------------------------------+----------------------------------------------------------------------------------------------+ | Last Edited for DPDD Version | 1.1 | +------------------------------------------------+----------------------------------------------------------------------------------------------+ | Processing Element(s) creating/using the data | **Creators:** | | product | | | | * LE3_GC_2PCF | | | | | | **Consumers:** | | | | | | * LE_GC_CM2PCF | +------------------------------------------------+----------------------------------------------------------------------------------------------+ | Processing function using the data product | * LE3_GC_TwoPointCovariance | | | * This is a SGS pipeline final output product to be used by SWGs. | +------------------------------------------------+----------------------------------------------------------------------------------------------+ | Proposed for inclusion in EAS/SAS | This product is proposed for inclusion in the SAS: Yes | | | | | | Is going to be used by the SWG-GC for their scientific analysis. | +------------------------------------------------+----------------------------------------------------------------------------------------------+ Data Product Elements ______________________ +--------------+----------------------------------------------+ | Header | object of type sys:genericHeader | +--------------+----------------------------------------------+ | Data | object of type gc:gcTwoPointAuto | +--------------+----------------------------------------------+ | QualityFlags | object of type dqc:sqfPlaceHolder | +--------------+----------------------------------------------+ | Parameters | object of type ppr:genericKeyValueParameters | +--------------+----------------------------------------------+ Detailed Description of the Data Product _________________________________________ .. DetailedDescStart This output product is the angle-averaged two-point auto-correlation function at different separation scales. The product contains 2 FITS files: one for the 1D pair counts and one for the angle-averaged two-point auto-correlation function. XML Keywords ^^^^^^^^^^^^ The product contains the following keywords: **DataCatalog** Name of input DATA catalog **RandCatalog** Name of input RANDOM catalog **CountingMethod** Counting method [LINKED_LIST, KD_TREE] **BinType** Binning scale type [LIN, LOG] **BinNumber** Number of bins in scale **BinMinValue** Minimum separation scale Mpc/h **BinMaxValue** Maximum separation scale Mpc/h **UseWeight** Use object weight in the computation [true/false] **SplitFactor** Number of random sub-catalogs used for RR computation **CosmologyID** Identifier for the cosmology used **ReleaseName** Name of the release **PairsFile** :ref:`FITS` file with 1D pair counts **CorrelationFile** :ref:`FITS` file with the angle averaged auto correlation .. _gc2pcfpairautofile: **PairsFile** FITS file ^^^^^^^^^^^^^^^^^^^^^^^ The FITS type *le3.gc.2pcf.auto.pair.1D* contains one binary table HDU named **PAIRS** with the following structure: .. table:: :width: 100% +----------------------------------------------------------------------------------------------------------------------+ | **HDU** *PAIRS*: header | +==========+==========+==============================================================================+=================+ | | **Name** | **Description** | **Value** | +----------+----------+------------------------------------------------------------------------------+-----------------+ | Keywords | XTENSION | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | BITPIX | | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | NAXIS | | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | NAXIS1 | | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | NAXIS2 | | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | PCOUNT | | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | GCOUNT | | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | TFIELDS | | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | EXTNAME | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | DATE | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | CHECKSUM | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | DATASUM | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | FILENAME | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TTYPE1 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TFORM1 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TUNIT1 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TTYPE2 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TFORM2 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TUNIT2 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TTYPE3 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TFORM3 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TUNIT3 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TTYPE4 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TFORM4 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TUNIT4 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TELESCOP | Mission identifier | string = EUCLID | + +----------+------------------------------------------------------------------------------+-----------------+ | | INSTRUME | PF identifier | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | FILENAME | Name of FITS file Catalog Related Keywords | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | D_NAME | Name of DATA catalog | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | D_ID | Identifier of DATA catalog | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | D_NOBJ | Object Number of DATA catalog | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | R_NAME | Name of RANDom catalog | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | R_ID | Identifier of RANDom catalog | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | R_NOBJ | Object Number of RANDom catalog 2PCF Related Keywords | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | RUNTYPE | Type of clustering measurement | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | SELECT | Identifier for the SEL selection performed | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | BLINDING | Flag that identifies products that have been blinded for scientific analysis | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | STAT | 2PCF Related Keywords Statistics of 2PCF (e.g. ONE_DIM) | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | METHOD | Pair counting method: KD_TREE, LINKED_LIST | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | BIN_TYPE | Scale for used in binning: LINear, LOGarithmic | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | BIN_NUM | Number of bins in scale | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | BIN_MIN | Min value of bin in scale | double | + +----------+------------------------------------------------------------------------------+-----------------+ | | BIN_MAX | Max value of bin in scale | double | + +----------+------------------------------------------------------------------------------+-----------------+ | | WEIGHT | Use object weight in the computation : true, false | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | SPLIT | Split factor - number of R subcatalogs - used in computation | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | PAIR_DD | | double | + +----------+------------------------------------------------------------------------------+-----------------+ | | PAIR_DR | | double | + +----------+------------------------------------------------------------------------------+-----------------+ | | PAIR_RR | | double | + +----------+------------------------------------------------------------------------------+-----------------+ | | COSMO_ID | Cosmology Related Keywords Identifier for the cosmology used | string | +----------+----------+------------------------------------------------------------------------------+-----------------+ .. table:: :width: 100% +----------------------------------------------------------------------------------------------------------------------+ | **HDU** *PAIRS*: 4 columns table | +=============+===============+===================================================+===============+====================+ | | **Name** | **Description** | **Unit** | **Format** | +-------------+---------------+---------------------------------------------------+---------------+--------------------+ | Columns | SCALE | Binning Scale | NA | FITS *1D* | + +---------------+---------------------------------------------------+---------------+--------------------+ | | DD | DD pairs counted per scale bin | NA | FITS *1D* | + +---------------+---------------------------------------------------+---------------+--------------------+ | | DR | DR pairs counted per scale bin | NA | FITS *1D* | + +---------------+---------------------------------------------------+---------------+--------------------+ | | RR | RR pairs counted per scale bin | NA | FITS *1D* | +-------------+---------------+---------------------------------------------------+---------------+--------------------+ .. _gc2pcfcorrautofile: **CorrelationFile** FITS file ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The FITS type *le3.gc.2pcf.auto.corr.1D* contains one binary table HDU named **CORRELATION** with the following structure: .. table:: :width: 100% +----------------------------------------------------------------------------------------------------------------------+ | **HDU** *CORRELATION*: header | +==========+==========+==============================================================================+=================+ | | **Name** | **Description** | **Value** | +----------+----------+------------------------------------------------------------------------------+-----------------+ | Keywords | XTENSION | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | BITPIX | | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | NAXIS | | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | NAXIS1 | | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | NAXIS2 | | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | PCOUNT | | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | GCOUNT | | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | TFIELDS | | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | EXTNAME | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | DATE | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | CHECKSUM | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | DATASUM | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | FILENAME | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TTYPE1 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TFORM1 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TUNIT1 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TTYPE2 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TFORM2 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TUNIT2 | | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | TELESCOP | Mission identifier | string = EUCLID | + +----------+------------------------------------------------------------------------------+-----------------+ | | INSTRUME | PF identifier | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | FILENAME | Name of fits file | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | D_NAME | Catalog Related KeywordsName of DATA catalog | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | D_ID | Identifier of DATA catalog | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | D_NOBJ | Object Number of DATA catalog | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | R_NAME | Name of RANDom catalog | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | R_ID | Identifier of RANDom catalog | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | R_NOBJ | Object Number of RANDom catalog 2PCF Related Keywords | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | RUNTYPE | Type of clustering measurement | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | SELECT | Identifier for the SEL selection performed | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | BLINDING | Flag that identifies products that have been blinded for scientific analysis | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | STAT | 2PCF Related Keywords Statistics of 2PCF (e.g. ONE_DIM) | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | METHOD | Pair counting method : KD_TREE, LINKED_LIST | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | BIN_TYPE | Scale for used in binning : LINear, LOGarithmic | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | BIN_NUM | Number of bins in scale | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | BIN_MIN | Min value of bin in scale | double | + +----------+------------------------------------------------------------------------------+-----------------+ | | BIN_MAX | Max value of bin in scale | double | + +----------+------------------------------------------------------------------------------+-----------------+ | | WEIGHT | Use object weight in the computation : true, false | string | + +----------+------------------------------------------------------------------------------+-----------------+ | | SPLIT | Split factor - number of R subcatalogs - used in computation | integer | + +----------+------------------------------------------------------------------------------+-----------------+ | | COSMO_ID | Cosmology Related Keywords Identifier for the cosmology used | string | +----------+----------+------------------------------------------------------------------------------+-----------------+ .. table:: :width: 100% +----------------------------------------------------------------------------------------------------------------------+ | **HDU** *CORRELATION*: 2 columns table | +==============+================+==============================================+================+======================+ | | **Name** | **Description** | **Unit** | **Format** | +--------------+----------------+----------------------------------------------+----------------+----------------------+ | Columns | SCALE | Bin scale | NA | FITS *1D* | + +----------------+----------------------------------------------+----------------+----------------------+ | | XI | Correlation value per bin | NA | FITS *1D* | +--------------+----------------+----------------------------------------------+----------------+----------------------+ .. DetailedDescEnd