DPDD User Manual Template

Keywords List

Listing 1 Commands: Keywords

 $SetSchemaPath
 $PrintDataProductName
 $PrintDataProductCustodian
 $PrintSchemaFilename
 $PrintDataProductElements
 $PrintCatalog
 $PrintPrimaryHeader
 $PrintExtensionHeader
 $PrintHDUTableContents

The specific set of keywords shown above represent the set of commands created for the user. As can be observed every command will start with “$”.

Set the Schema Path

Listing 2 Commands: Set the Schema Path

$SetSchemaPath le3/wl/inp/euc-test-le3-wl-InputLE2Catalog.xsd

This command sets the path to the corresponding Data Model product and allows information to be retrieved automatically.

This command is positioned after the title of the document.

The information that we are able to retrieve is the Name of the Data Product, the Data Product Custodians, the Name of the Schema and Data Product Elements.

Data Product name

Listing 3 Commands: Present Name of the Data Product

$PrintDataProductName

Retrieve the current Name of the Data Product used within the Data Model. The Data Product Name adheres to the Euclid Data Model naming conventions.

Data Product Custodian (level 3)

Listing 4 Commands: Present the Formal Teams in charge of the Data Product

$PrintDataProductCustodian

This command will display the current custodian(s) for the Data Product.

Name of the Schema File

Listing 5 Commands: Name of the XSD Schema File. Link GitLab.

$PrintSchemaFilename

This command will display the name of the XSD file for the Data Product and provide a link to the corresponding file in the Data Model.

Data Product elements

Listing 6 Commands: Attributes “Name” and “type” of tree elements for the Data Product

$PrintDataProductElements

This command will display the Data Product elements, such as the Headers, Data, Quality Flags and Parameters.

Detailed description of the data product

Previous Information

The Following commands are normally included within this section.

Print Catalog

Listing 7 Commands: Table with Column, Name, and Description

$PrintCatalog fit/euc-test-le3-wl.xml le3.wl.input.le2catalog

This command prints the content of a FITS catalogue within a table in an organised manner. This is optional but highly recommended.

Fig. 21 : Sintax of command print catalog

When to use it ?

Use it to print tables that emphasize to show the content within Column Lists.

Design of table

Column Name, Description and Unit.

Primary Header

Listing 8 Commands: Table

$PrintPrimaryHeader fit/euc-test-le1-vis.xml le1.visRawImage

This command prints the content of a FITS catalogue within a table in an organised manner. This is optional but highly recommended.

Fig. 22 : Sintax of command Print Primary Header

When to use it ?

Use it to print tables that emphasize to show the content of Primary Header.

Design of table

Name, if Fixed exists it creates a table or not and Description.

Extension Header

Listing 9 Commands: Table

$PrintExtensionHeader fit/euc-test-le1-vis.xml le1.visRawImage SCI.n

This command allow developers to bring the FitsFormat or FitsFiles within a table in an organized manner. Is highly recommended its use.

Fig. 23 : Sintax of command Print Extension Header

When to use it ?

Use it to print tables that emphasize to show the content of any Extension Header.

Design of table

Name, if Fixed exists it creates a table or not and Description.

HDU Table

Listing 10 Commands: Table

$PrintHDUTableContents fit/euc-test-le3-gc.xml le3.gc.bkpf.spe.mono BISPECTRUM

This command allow developers to bring the FitsFormat or FitsFiles within a table in an organized manner. Is highly recommended its use.

Fig. 24 : Sintax of command Print HDU Table Contents

When to use it ?

Use it to print tables that emphasize to show at the same time the content of any Extension Header and Column List.

Design of table

Is a combination divided in two sections, keywords and Columns List:

• For keywords name, if Fixed exist and Description.

• For Columns Name, Description, Format and Unit

Required Stucture for Documentation

This is the minimal content structure that developers shall provide for data product.

Listing 11 Commands: Minimal content

/**
 * ├──Title
 *      ├── Data product name
 *      ├── Data product custodiangit
 *      ├── Name of the Schema file
 *      ├── Data product elements
 *      └── Data product detailed description
 */

These are some additional titles used by some products.

Listing 12 Commands: Additonal Subsections used in other Data Producs

/**
 * ├──Title
 *      ├── Data product name
 *      ├── Data product custodian
 *      ├── Name of the Schema file
 *      ├── Data product elements
 *      ├── Data product detailed description
 *                ├── Processing Element(s) creating/using the data product
 *                ├── Processing function using the data product
 *                ├── XML Product (Keywords Origin in data Data Model pro dictionay)
 */

Examples

This example shows the output obtained by using the command PrintCatalog for data-product-doc/ST_FitsDataModel/ST_DM_FitsSchema/auxdir/ST_DM_FitsSchema/instances/fit/euc-test-le3-wl.xml with the FitsFormat id le3.wl.input.le2catalog.

Example for 2dmasswl_shearcatalog.rst using the command PrintCatalog

This example shows the output obtained by using the command PrintPrimaryHeader and PrintExtensionHeader for data-product-doc/ST_FitsDataModel/ST_DM_FitsSchema/auxdir/ST_DM_FitsSchema/instances/fit/euc-test-le1-vis.xml with the fits format le1.visRawImage and in the case of Extension Header we need to include the ArrayHDU attribute name SCI.n .

Example for le1_visrawframe.rst using the command PrintPrimaryHeader and PrintExtensionHeader

This example shows the output obtained by using the command PrintHDUTableContents for data-product-doc/ST_FitsDataModel/ST_DM_FitsSchema/auxdir/ST_DM_FitsSchema/instances/fit/euc-test-le3-gc.xml with the FitsFormat id le3.gc.bkpf.spe.mono and in addition is needed to specify the the attribute name of TableHDU as for this scenario BISPECTRUM and SPECTRUM.

Example for bkgc_OUTPUT_spe_mono.rst using the command PrintHDUTableContents