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

.. _TwoPCFGCInputParameter:

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_TwoPointCorrelation                                                                 |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| Processing function using the data product     | LE3_GC_2PCF                                                                                  |
+------------------------------------------------+----------------------------------------------------------------------------------------------+
| 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 the Galaxy Clustering Two-point Correlation Function, a
parameter file specifying the configuration is needed.  The
configuration file contains all the information about the max/min
scales to use in the computation, the number of output bins in the
correlation function, the estimator to be used and information on the
cosmology to be used for the coordinate transformation.  The estimator
selected in the configuration file defines the output product
obtained.


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 <gc2pcfconf>` with PF parameters for this configuration
**CosmologyFile**
  :ref:`ASCII file <gc2pcfcosm>` with cosmological parameters to use in this configuration
**Comment**
  [OPTIONAL] Comment to configuration


.. _gc2pcfconf:

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


**[Path]** section [used only in LOCAL configuration for code testing]


**input**
  Input data path relative to current workdir
**output**
  Output data path relative to current workdir


**[Catalog.Galaxy]** section [used only in LOCAL configuration for code testing]


**filename**
  Name of input Data file
**name**
  Name of catalog HDU in input file
**coordinates**
  Coordinate system used by the catalog [CARTESIAN/EQUATORIAL/PSERUDO_EQUATORIAL]
**angle_units**
  Angle units used for angular coordinates [DEGREE/RADIANS]
**coord1**
  Position or name of the column to be used as 1st coordinate value
**coord2**
  Position or name of the column to be used as 2nd coordinate value
**coord3**
  Position or name of the column to be used as 3rd coordinate value
**density**
  Position or name of the column to be used as density value
**weight**
  Position or name of the column to be used as object weight value
**filename2**
  Name of input Data file 2


**[Catalog.Random]** section [used only in LOCAL configuration for code testing]


**filename**
  Name of input Random file
**name**
  Name of catalog HDU in input file
**coordinates**
  Coordinate system used by the catalog [CARTESIAN/EQUATORIAL/PSERUDO_EQUATORIAL]
**angle_units**
  Angle units used for angular coordinates [DEGREE/RADIANS]
**coord1**
  Position or name of the column to be used as 1st coordinate value
**coord2**
  Position or name of the column to be used as 2nd coordinate value
**coord3**
  Position or name of the column to be used as 3rd coordinate value
**density**
  Position or name of the column to be used as density value
**weight**
  Position or name of the column to be used as object weight value
**filename2**
  Name of input Random file 2
**filename_rec**
  Name of input Random reconstructed file
**filename_rec2**
  Name of input Random reconstructed file 2


**[2PCF]** section


**statistics**
  Correlation type [ONE_DIM, TWO_DIM_CART, TWO_DIM_POLAR]
**method**
  Pair counting method [LINKED_LIST, KD_TREE]
**bin1_type**
  Type of binning in the 1st dimension [LIN, LOG]
**bin1_num**
  Number of bin channels in the 1st dimension
**bin1_min**
  Minimum separation scale in the 1st dimension
**bin1_max**
  Maximum separation scale in the 1st dimension
**bin2_type**
  Type of binning in the 2nd dimension [LIN, LOG]
**bin2_num**
  Number of bin channels in the 2nd dimension
**bin2_min**
  Minimum separation scale in the 2nd dimension
**bin2_max**
  Maximum separation scale in the 2nd dimension
**pi_max**
  Maximum parallel separation up to which the 2D Cartesian correlation function
  is integrated to compute the projected correlation function
**compute_RR**
  [true, false] Enable/disable RR pair counting in case of pair file re-use
**compute_SS**
  [true, false] Enable/disable SS pair counting in case of pair file re-use
**compute_R1R2**
  [true, false] Enable/disable R1R2 cross pair counting in case of pair file re-use
**compute_S1S2**
  [true, false] Enable/disable S1S2 shifted cross pair counting in case of pair file re-use
**input_file_RR**
  Input RR pairs FITS file to skip RR calculation [used only in LOCAL configuration for code testing]
**input_file_SS**
  Input SS pairs FITS file to skip SS calculation [used only in LOCAL configuration for code testing]
**input_file_R1R2**
  Input R1R2 cross pairs FITS file to skip R1R2 calculation [used only in LOCAL configuration for code testing]
**input_file_S1S2**
  Input S1S2 shifted cross pairs FITS file to skip S1S2 calculation [used only in LOCAL configuration for code testing]
**use_weight**
  [true, false] Use objects weights
**split_factor**
  Number of sub-catalogs in which the random catalog has been split for RR computation
**reconstruction_id**
  TBD
**use_cross**
  TBD
**output_prefix**
  Output file name prefix


**[Validation]** section


**grid_scale**
  LinkedList partitioning scheme grid scaling
**observer_x**
  Position of the observer in direction x
**observer_y**
  Position of the observer in direction y
**observer_z**
  Position of the observer in direction z
**periodic**
  [true, false] Use periodic boundaries conditions..TBD
**plane_parallel**
  [true, false] Use parallel plane TBD
**box_x_min**
  Catalog enclosing box minimum position x
**box_x_max**
  Catalog enclosing box maximum position x
**box_y_min**
  Catalog enclosing box minimum position y
**box_y_max**
  Catalog enclosing box maximum position y
**box_z_min**
  Catalog enclosing box minimum position z
**box_z_max**
  Catalog enclosing box maximum position z
**ascii_out**
  [true/false] Enable ASCII output filen in addition to FITS


.. _gc2pcfcosm:

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

.. DetailedDescEnd