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

.. _ThreePCFGCInputParameter:

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

Data product name
=================
.. DataProductNameStart

DpdLE3gcConfigurationSet

.. DataProductNameEnd

Data product custodian
======================
.. DataProductCustodianStart

|CUSTODIANTAG|

.. DataProductCustodianEnd

Data model tag
==============
.. DataModelTagStart

|GCTAG|

.. DataModelTagEnd

Name of the Schema file
=======================
.. NameSchemaStart

euc-test-le3-gc-conf-set.xsd

.. NameSchemaEnd

Schema documentation tag
========================
.. SchemaDocTagStart

|DOCTAG|

.. SchemaDocTagEnd

Data product elements
=====================
.. DataProductElementsStart

:Header:       object of type sys:genericHeader
:Data:         object of type gc:gcConfigurationSet
:QualityFlags: object of type dqc:sqfPlaceHolder
:Parameters:   object of type ppr:genericKeyValueParameters

.. DataProductElementsEnd

Processing Element(s) creating/using the data product
=====================================================
.. PECreatorStart

Creator: 3PCF-GC

.. PECreatorEnd

Processing function using the data product
==========================================
.. PFUsingStart

Input to: LE3-GC-3PCF

.. PFUsingEnd

Detailed description of the data product
========================================
.. DetailedDescStart

To compute Galaxy Clustering Three Point Correlation Function, 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 correlation function,
the estimator to be used and information on the cosmology to be used for
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 <gc3pcfconf>` with PF parameters for this configuration
**CosmologyFile**
  :ref:`ASCII file <gc3pcfcosm>` with cosmological parameters to use in this configuration
**Comment**
  [OPTIONAL] Comment to configuration 


.. _gc3pcfconf:

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


**[3PCF]** section


**correlation**
  correlation type [CONNECTED, REDUCED]
**configuration**
  triangle configuration [SINGLE, ALL]
**method**
  triplet method [DIRECT_COUNTING / SPHERICAL_HARMONICS_DECOMPOSITION]
**binning**
  triplet binning [COSTHETA, THETA, SIDE]
**n_orders**
  legendre polynomial order
**use_weight**
  use object weights [true, false]
**ASCII_out**
  enable ASCII output files defined below
**reconstruction_ID**
  identifier for the reconstruction


**[3PCF.SINGLE]** section


**r12**
  first side lenght
**r12_binSize**
  first side shell size
**r13**
  second side lenght
**r13_binSize**
  second side shell size
**n_bins**
  number of bins


**[3PCF.ALL]** section 


**rMin**
  minimum side lenght
**rMax**
  maximum side lenght
**shell_size**
  binsize


**[3PCF.FILES]** section  


**input_file_NNN**
  TBD
**input_file_RRR**
  TBD
**input_file_NNN_Legendre**
  TBD
**input_file_RRR_Legendre**
  TBD
**output_file_NNN**
  TBD [only for ASCII outputs]
**output_file_RRR**
  TBD [only for ASCII outputs]
**output_file_NNN_Legendre**
  TBD [only for ASCII outputs]
**output_file_RRR_Legendre**
  TBD [only for ASCII outputs]
**output_file_Corr**
  TBD [only for ASCII outputs]


**[Cosmology]** section


**Cosmology**
  Cosmology configuration file [used ONLY in LOCAL run of the code]


.. _gc3pcfcosm:

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

.. DetailedDescEnd