Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

Table of Contents

Table of Contents

MODECALC USER GUIDE

Anchor
_Toc146644828
_Toc146644828
Introduction

ModeCalc is a GUI that provides a graphical shell for a Python sensor mode generator module. It only gets parameter lists from the Python file, populates its window with a control for each one, calls the Python file to get results, and displays the results. It's completely sensor independent.

Anchor
_Toc146644829
_Toc146644829
Functionalities

  • It has 'exporters' to convert results of user generated modes to a file.

    • The resultant file can be saved in classic DevX ini format, or as shared settings format or as json file.

  • It can save the user's set of parameter values in a text file so the user can preserve it for later, share it, check it in to a repository, etc.

  • It has a text editor that's loaded with the Python source code of the module in use.

  • There's a Python Console window (like DevWareX) that shows print() output, error messages, etc.

Anchor
_Toc146644830
_Toc146644830
Session

ModeCalc provides an option to load only one session i.e., either by loading the python sensor settings module file or saved json file at any one point of time. But user can clone the settings to a new one and modify it with multiple sets of parameters. So, in each tab in the main view user can maintain multiple settings for example, Linear, 2-exposure HDR, 3-exposure HDR, etc., and easily flip between them & save them all in one file.

Anchor
_Toc146644831
_Toc146644831
User Launch

ModeCalc is part of the DevX release, it will be in the bin folder of the installation path. As the user launches it, will look like below.

...

Anchor
_Toc146644832
_Toc146644832
ModeCalc Window

Once user loads the python module or saved json file from the session pane the ModeCalc window will appear as shown below. The ModeCalc window has multiple sub windows.

...

ModeCalc Window’s top pane provides different functionalities to an user. Each of them are explained in detail in below sections.

  • Session

  • Modes

  • Export

  • Python

Anchor
_Toc146644833
_Toc146644833
Session Window

This window provides user below functionalities.

...

Each of the session operations are shown below.

Anchor
_Toc146644834
_Toc146644834
New session

Once user clicks new session, a window will pop up which lists the sensor part numbers which are previously loaded or user can select the new python module file by choosing the option “Browse for a file…”

...

Once the user selects the right python module and clicks ok, the ModeCalc window will look like below picture. This window will load all the default parameters for each of the controls from the python module and generates the output.

Image RemovedImage Added

Anchor
_Toc146644835
_Toc146644835
Open Session

User can load a session by choosing the proper json file. The json file which was saved earlier should be in the same path where the python module file resides. Below picture has BLUE colored highlighted section which clearly shows the json data files from the folder location. Once user chooses a particular json file, ModeCalc will load the parameters as per the json file and displays the results.

...

Anchor
_Toc146644836
_Toc146644836
Save Session

This option will save the current session to a json file format.

Anchor
_Toc146644837
_Toc146644837
Save Session As

This option helps the user to save the session to a json file format. User can load this saved session using open session option.

Anchor
_Toc146644838
_Toc146644838
Modes Window

Modes window will help the user in below scenario.

...

User can switch to any of the mode by clicking on the respective tabs or by choosing the modes listed in the Modes window.

...

Anchor
_Toc146644839
_Toc146644839
Export Widow

User has generated a mode and has to export this settings / mode / preset to proper file format so that this preset can be tested in DevX or in Canvas. ModeCalc provides an option to save the generated mode into 3 different options –

  1. Shared settings format

  2. Ini file format

  3. Json file format

Anchor
_Toc146644840
_Toc146644840
Single Mode exported in Shared Settings format.

A sample shared setting file for a single mode is shown below.

...

Initializer file

...

Python File

...

Anchor
_Toc146644841
_Toc146644841
Single mode exported to an Ini file.

...

Anchor
_Toc146644842
_Toc146644842
Multiple Modes exported into a Shared Settings file.

When user as cloned a mode and generated multiple modes / settings out of it and wants to save all the modes into a single shared setting file. ModeCalc can does by export option. User can choose export and choose the Shared settings format. ModeCalc will generate below initializer file and python file supporting multiple modes.

...

Python file with multiple modes.

...

Anchor
_Toc146644843
_Toc146644843
Multiple modes exported to an ini file format.

In below picture clearly, we can see at line numbers 2, 30 & 58 provides the multiple mode names and rest of the lines depicts the standard ini file modules generated by ModeCalc which are required to load these settings in DevX.

...

Anchor
_Toc146644844
_Toc146644844
Python Window

User has loaded a session with python module file and wants to update or change the source of the file with some new parameters or formulas. In such scenario, ModeCalc provides an option to load the Python source file and update those and check the results on fly. On the pane window click on “Python” and load the respective python source file. Once user selects the proper python source file, a python text editor will appear where use can update the values or formulas & execute it to check for the result.

...