.. include:: ../../gcsubstitutions.txt

.. _BKGCInputParameters:

Input - Configuration Product
================================

Metadata
______________________

+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product name                              | DpdLE3gcConfigurationSet                                                                     |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Data product custodian                         | GCCONF                                                                                       |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Name of the Schema file                        | .. raw:: html                                                                                |
|                                                |                                                                                              |
|                                                | `euc-le3-gc-conf-set.xsd <https://gitlab.euclid-sgs.uk/ST-DM/ST_DataModel/-/blob/10.1.2/ST_D |
|                                                | M_Schema/auxdir/ST_DM_Schema/dpd/le3/gc/inp/euc-le3-gc-conf-set.xsd>`_                       |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Last Edited for DPDD Version                   | 1.1                                                                                          |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing Element(s) creating/using the data  | **Creators:**                                                                                |
| product                                        |                                                                                              |
|                                                | * None: Created by hand.                                                                     |
|                                                |                                                                                              |
|                                                | **Consumers:**                                                                               |
|                                                |                                                                                              |
|                                                | * LE3_GC_BK                                                                                  |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing function using the data product     | LE3-LE3_GC_Bispectrum                                                                        |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| 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:gcConfigurationSet         |
+--------------+----------------------------------------------+
| QualityFlags | object of type dqc:sqfPlaceHolder            |
+--------------+----------------------------------------------+
| Parameters   | object of type ppr:genericKeyValueParameters |
+--------------+----------------------------------------------+

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

To compute Galaxy Clustering Bispectrum, a parameter file specifying the
configuration is needed.

The configuration file contain all the information about the max/min scale
to use in the computation, the number of output bins in the output spectrum,
the estimator to be used and information on the cosmology to be used for
coordinate transformation.

XML Product
^^^^^^^^^^^
The product contains the following keywords:

**PF**
  Name of the Processing function using this configuration
**ConfigurationID**
  Identifier for the configuration Parameters+Cosmology used in this product
**ParameterSetID**
  Identifier for the configuration Parameter set used in this configuration
**CosmologyID**
  Identifier for the Cosmology used in this configuration
**ReleaseName**
  Name of the release that uses this configuration
**ParameterFile**
  :ref:`ASCII file <gcbkconf>` with PF parameters for this configuration
**CosmologyFile**
  :ref:`ASCII file <gcbkcosm>` with cosmological parameters to use in this configuration
**Comment**
  [OPTIONAL] Comment to configuration


.. _gcbkconf:

**ParameterFile** ASCII file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The ASCII ``.ini`` file has a ``keyword=value`` structure divided into [sections].
The Bispectrum accepts the following keyword list:


**[Bk]** section


**statistics**
  Power spectrum estimator [DOAFFT, YBCFFT, YSCFFT, YDS]
**use_random_catalog**
  [true/false] Enable random catalog usage (for estimators that use it)
**Nft**
  Grid cube side
**compute_box_side**
  [true/false] Enable enclosing box computation
**box_side**
  Lenght of the box (Mpc/h) in configuration space if ``compute_box_side = false``
**catalog_center**
  X  Y  Z  position of the catalog center
**MAS_scheme**
  Mass Assignment Schema to be used to prepare the grid
**use_FKP_weight**
  [true/false] Enable FKP weighting schema
**Pest**
  Estimated power for FKP weights
**cosmology**
  Cosmology configuration file [used ONLY in LOCAL run of the code]
**output_prefix**
  Extre ID name in the output file


**[Bk.meanDensity]** section


**method**
  Method used to calculate Nbar
**name**
  string
**format**
  string


**[Bk.Binning]** section


**k_min**
  Minumum k in units of the fundamental frequency 2pi/Lbox for spectrum
**k_max**
  Maximum k in units of the fundamental frequency 2pi/Lbox for spectrum
**delta_k**
  Binning step


**[Bk.Validation]** section


**compute_catalog_center**
  [true/false] Enable catalog center computation
**use_MAS_correction**
  [true/false] Enable MAS correction
**use_interlacing**
  [true/false] Enable interlaced grid usage
**use_SN_correction**
  [true/false] Enable poisson shot-noise correction
**use_ascii_output**
  [true/false] Enable ASCII output filen in addition to FITS


.. _gcbkcosm:

.. include:: ../../gc_input_cosmology_inifile.rst


.. DetailedDescEnd