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

.. _PKGCInputParameters:

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

$SetSchemaPath le3/gc/inp/euc-le3-gc-conf-set.xsd

Data Product Name
___________________
.. DataProductNameStart

$PrintDataProductName

.. DataProductNameEnd

Data Product Custodian
________________________
.. DataProductCustodianStart

$PrintDataProductCustodian

.. DataProductCustodianEnd

Name of the Schema File
________________________
.. NameSchemaStart

$PrintSchemaFilename

.. NameSchemaEnd

Last Edited for DPDD Version
____________________________
.. DpddVersionlTagStart

1.1

.. DpddVersionTagEnd

Processing Elements Creating / Updating / Using the Product
___________________________________________________________
.. PECreatorStart

**Creators:**

* LE3-GC

**Consumers:**

* LE3-GC

.. PECreatorEnd

Processing function using the data product
______________________________________________
.. PFUsingStart

Input to: LE3-GC-PK

.. PFUsingEnd

Proposed for inclusion in EAS/SAS
_________________________________

.. IncludeInSASStart

This product is proposed for inclusion in the SAS: Yes

Is going to be used by the SWG-GC for their scientific analysis.

.. IncludeInSASEnd

Data Product Elements
______________________
.. DataProductElementsStart

$PrintDataProductElements

.. DataProductElementsEnd

Detailed Description of the Data Product
_________________________________________
.. DetailedDescStart

The configuration product is needed to specify the compute Galaxy Clustering Power Spectrum, a Configuration 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.
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 using this configuration
**ParameterFile**
  :ref:`ASCII file <gcpkconf>` with PF parameters for this configuration
**CosmologyFile**
  :ref:`ASCII file <gcpkcosm>` with cosmological parameters to use in this configuration
**Comment**
  [OPTIONAL] Comment to configuration


.. _gcpkconf:

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


**[Pk]** section


**statistics**
  Power spectrum estimator [DOAFFT, YBCFFT, YSCFFT, YDS]
**use_random_catalog**
  [true/false] Enable random catalog usage (for estimators that use it)
**compute_cross_power**
  [true/false] Enable cross spectrum computation
**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



**[Pk.meanDensity]** section


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


**[Bk.Binning]** section


**type_of_binning**
  Type of bin scale: [LIN/LOG]
**shift_to_bin_center**
  [true/false] Enable output scale referred on bin center
**num_log_bins**
  Number of log-spaced bins if binning LOG
**bin_width_dat**
  The shell-width in units of the fundamental frequency
**bin_width_rand**
  The shell-width in units of the fundamental frequency for the random catalog
**k_min_pk**
  Minumum k in units of the fundamental frequency 2pi/Lbox for spectrum
**k_max_pk**
  Maximum k in units of the fundamental frequency 2pi/Lbox for spectrum
**k_min_win**
  Minumum k in units of the fundamental frequency 2pi/Lbox for window
**k_max_win**
  Maximum k in units of the fundamental frequency 2pi/Lbox for window
**num_mu_bins**
  Number of mu-bins for 2D spectrum P(k,mu) (for estimators that use it)


**[Pk.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


.. _gcpkcosm:

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

.. DetailedDescEnd