(r12) JmmcOiToolsRoadmap < Jmmc/Software

Tags: view all tags
---+ OITools Roadmap

Updated: 20/10/2017


%TOC%


In progress:
   * Project documentation
   * Personal presentation
   * New features for OITOOLS 2 : Units

In Study:
   * !OIFitsValidator enhancements
   * Nom.tam.fits update
   * Github


---++ Personal presentation

Prepare the presentation of my work on OITools and the explanations of my involvement. A link to this presentation will be available after this one (9/11) 




---++ Project documentation

   * Complete the changelog & documentation wiki pages
      * [[http://www.jmmc.fr/twiki/bin/view/Jmmc/Software/JmmcOiToolsDocs][Project documentation]]
   * API Usage Tutorial ?
   * Javadoc
   * Complete / create new schema ?




---++ New features for OITOOLS 2

---+++ Units: [IN PROGRESS]

Description:
   * Units handling: In OIFITS V2, the physical units for few columns are 'user-defined' i.e. given in the column description (TUnit keyword). OITools already parse column keywords but does not store such units in the column meta data
   * Impacted columns are:
      * OI_VIS table: RVIS (RVIS_ERR), IVIS (IVIS_ERR) and VISDATA (VISERR)
      * OI_FLUX table: FLUXDATA

Study:
   * Currently units are implemented by an Enumeration that is not extendable ! 
   * Possible choices:
      * Realize an enum units more permissive, in this case it will be necessary to fix the validation of the units (!OIFitsLoader.parseColumn ()), choose where are store these 'special' units because this one will serve again. They are reused in the data display under !OIFitsExplorer as well as retrieve them for writing files with !WriteOIFits.
      * or proceed to a rewrite of the enumeration units in class which would allow us to be directly more permissive and to directly manage the case of these units which can vary. They will directly store and manage here.

Impacts:
   * unit parsing & validation : !OIFitsLoader
   * !OIFitsExplorer : Display of column units
   * writing or rewriting files

Feedback:
   * The choice that has been made is to change the operation of Units (creating subclass) and to treat the case of special units in the loading of the file and the validation. The units are recover directly from OIFits files.
   * !FitUnit reporting units for images, Merge Units and !FitsUnit ?

---+++ Checksum/Datasum

TODO: description & study


---+++ Management of dimensions (NWaves)

TODO: description & study


---+++ Extra table/column

TODO: study


---+++ OI_INSPOL rules

TODO: description & study




---++ !OIFitsValidator enhancements: [IN PROGRESS]

Description:

   1 An error message more provided of information and more explicit. As well as a clearer display and more exploitable for users (filter).
   2 Need to determine severity with profiles
   3 Setting up a filter, which would allow us not to display redundant or not important messages (and to group them together)
   4 The ability to re-use error messages (xml)
   5 Update test to compare the validation results.

Study:


Impacts:

   * !OIFitsChecker 
      * in creating error messages and validation
      * to define error profiles 
   * !getCheckReport() is used in !OITools, !Aspro2, !LITpro, !OImaging, !OIFitsExplorer for the error message display
   * !OIFitsValidatorTest test save & compare validation results
   * !OIVal & OIDB to the re-use of xml error messages

Feedback:


---+++ 1: Format messages 

   * checker.sever delete and create new message: pointer to file, row/column, table, value, severity, declare the rule bound... (error list with full info)


---+++ 2: Define error profiles 

   * (lenient, strict, software)

---+++ 3: Report enhancements:

   * collect, gather & filter all validation failures
   * generate an "User" report


---+++ 4: Xml serialization

   * Update the xml Output to incorporate messages as xml elements to handle & filter them after in the OIVal & OIDB tools
   * Fix OIVal / OIDB message parsing

---+++ 5: Message Viewer

   * graphical panel displaying the messages (sort, filter, severity) = new Widget (GUI) (litpro/oixp)




---++ Nom.tam.fits update

TODO: description & study

   * The version of the library that we use at have evolved
      * retrieve and compare versions of !GitHub (the one we use and the last one)
      * feasibility study: see at which level the changes made will impact our code.
      * delete our library and add the latest version


---++ !GitHub

TODO: description & study

   * You have to open a repository and send our project on !GitHub
   * Licence
Topic revision: r12 - 2017-11-06 - GuillaumeMella