.. _SHEBFDTraining:
  
Shear BFD Training Data Product
-------------------------------
  
Data product name
=================
.. DataProductNameStart
   
sheBfdTraining
   
.. DataProductNameEnd
   
Data product custodian
======================
.. DataProductCustodianStart
   
SHE
   
.. DataProductCustodianEnd
   
Data model tag
==============
.. DataModelTagStart
   
8.0
   
.. DataModelTagEnd
   
Name of the Schema file
=======================
.. NameSchemaStart
   
ST_DM_Schema/dictionary/pro/she/euc-test-she.xsd
   
.. NameSchemaEnd
   
Schema documentation tag
========================
.. SchemaDocTagStart
   
:emphasis:`Documentation for data product element sheBfdTraining:`
    
An XML data product containing training data for the BFD shear measurement algorithm.

:emphasis:`Documentation for data product element Header:`
    
The generic header of the product.
   
.. SchemaDocTagEnd
   
Data product elements
=====================
.. DataProductElementsStart
   
* ValidityRange (ins:calibrationValidPeriod)
* DataStorage (sheBfdTrainingFile)
   * DataContainer (dss:dataContainer)
* Valid (sheValidStatus)
   
.. DataProductElementsEnd
   
Processing Element(s) creating/using the data product
=====================================================
.. PECreatorStart

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

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

An XML data product containing training data for the BFD shear measurement algorithm. This algorithm produces priors
for the noiseless and unlensed galaxy populations by measuring the Fourier moments and their derivatives (defined in
Bernstein et al. 2016) for the deep field galaxies, which we call templates. For each template, we measure the moments
at the central position and replicate the template over a range of xy positions to account for miscentering in the 
regular survey data. The resulting template moments and their derivatives are stored as the training data in a fits 
table with the following header keywords and columns:


Header keywords:

+--------------+-----------+---------------------------------------------------+
| Keyword name | Optional? | Brief description                                 |
+==============+===========+===================================================+
| FITS_VER     | No        | Table format version number                       |
+--------------+-----------+---------------------------------------------------+
| FITS_DEF     | No        | Table format label                                |
+--------------+-----------+---------------------------------------------------+
| SFLAGVER     | No        | Flags format version number                       |
+--------------+-----------+---------------------------------------------------+
| EXTNAME      | No        | HDU label                                         |
+--------------+-----------+---------------------------------------------------+
| MHASH        | Yes       | Model hash of simulations used as input           |
+--------------+-----------+---------------------------------------------------+
| MSEED        | Yes       | Model seed of simulations used as input           |
+--------------+-----------+---------------------------------------------------+
| NSEED        | Yes       | Noise seed of simulations used as input           |
+--------------+-----------+---------------------------------------------------+
| WT_N         | No        | Value of N parameter in weight function           |
+--------------+-----------+---------------------------------------------------+
| WT_SIGMA     | No        | Value of sigma parameter in weight function       |
+--------------+-----------+---------------------------------------------------+
| T_SNMIN      | No        | SN minimum in flux moment for target measurement  |
+--------------+-----------+---------------------------------------------------+
| T_SIGXY      | No        | measurement error on target XY moments            |
+--------------+-----------+---------------------------------------------------+
| T_SIGFLX     | No        | measurement error on flux moment                  |
+--------------+-----------+---------------------------------------------------+
| T_SIGMAX     | No        | maximum sigma deviation for template replication  |
+--------------+-----------+---------------------------------------------------+
| T_SIGSTEP    | No        | sigma step for template replication               |
+--------------+-----------+---------------------------------------------------+
| T_XYMAX      | No        | maximum allowed centroid for template replication |
+--------------+-----------+---------------------------------------------------+
| VALID        | No        | 0: Not tested; 1: Pass; -1: Fail                  |
+--------------+-----------+---------------------------------------------------+

Columns:

+----------------------------------+----------------+-----------------------------------------------------------------------+
| Parameter name                   | Fits Data type | Brief description                                                     |
+==================================+================+=======================================================================+
| OBJECT_ID                        | K              | Galaxy ID                                                             |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_FIT_FLAGS       | K              | Set of bit flags based on fit status (definition TBD)                 |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_VAL_FLAGS       | K              | Set of bit flags based on validation status (definition TBD)          |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_FIT_CLASS       | I              | Classification of object as galaxy (0), star(1), or unknown (2)       |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_UPDATED_RA      | D              | Estimate of Right Ascension of the galaxy center position [deg]       |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_UPDATED_RA_ERR  | E              | 1-Sigma error on RA                                                   |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_UPDATED_DEC     | D              | Estimate of Declination of the galaxy center position [deg]           |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_UPDATED_DEC_ERR | E              | 1-Sigma error on DEC                                                  |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_BFD_MOMENTS     | E7             | 7 Fourier moments of template galaxy                                  |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_BFD_DM_DG1      | E7             | 7 derivatives of Fourier moments wrt g1 of template galaxy            |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_DM_DG2          | E7             | 7 derivatives of Fourier moments wrt g2 of template galaxy            |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_DM_DMU          | E7             | 7 derivatives of Fourier moments wrt mu of template galaxy            |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_D2M_DG1DG1      | E7             | 7 2nd derivatives of Fourier moments wrt g1 of template galaxy        |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_D2M_DG1DG2      | E7             | 7 2nd derivatives of Fourier moments wrt g1 and g2 of template galaxy |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_D2M_DG2DG2      | E7             | 7 2nd derivatives of Fourier moments wrt g2 of template galaxy        |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_D2M_DG1DMU      | E7             | 7 2nd derivatives of Fourier moments wrt g1 and mu of template galaxy |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_D2M_DG2DMU      | E7             | 7 2nd derivatives of Fourier moments wrt g2 and mu of template galaxy |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_D2M_DMUDMU      | E7             | 7 2nd derivatives of Fourier moments wrt mu of template galaxy        |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_TMPL_WEIGHT     | E              | Template weight                                                       |
+----------------------------------+----------------+-----------------------------------------------------------------------+
| SHE_BFD_TRAINING_JSUPPRESS       | E              | Template suppression value                                            |
+----------------------------------+----------------+-----------------------------------------------------------------------+

   
.. DetailedDescEnd