Contents

2 Introduction

3 Keyboard shortcuts, mouse gestures

4 Features

5 Datasets

5.1 Load datasets

5.2 Drag and drop, paste datasets

5.3 Remove all datasets

5.4 Check files

5.5 Arrange datasets

5.6 Activate / deactivate datasets

5.7 Edit dataset short names

6 Labels

6.1 Define labels to compare

6.2 Label info

6.3 Highlight labels

6.4 Rename labels

6.5 Save / export label names

6.6 Copy label names

6.7 Show label names

7 Comparison result

7.1 Comparison table

7.2 Filter

7.2.1 Filter by label names

7.2.2 Filter by function names

7.2.3 Filter by label type

7.3 Show only diffs

7.4 Show only missing / Ignore missing

7.5 Table font size

8 Visualization

8.1 Visualize (standard comparison)

8.2 Visualize all (cross comparison)

9 Organize

9.1 Window handling

10 Save data

10.1 Save session

11 General information



SGE CompareArtist – User Manual

www.sge-ing.de – Version 14.07.2017 06:30

2 Introduction

The SGE CompareArtist is a tool to compare datasets and visualize their differences.

You can load an arbitrary number of datasets and choose the labels to compare. Filters and powerful visualization enables to keep track of calibration progress and dataset variants.

The SGE CompareArtist is developed in MATLAB and is utilized compiled. It is executable without MATLAB after installation of the freely available MATLAB Compiler Runtime (MCR). Please see the SGE Circus documentation for further information.

SGE Circus documentation

This user manual can be found using the ?-menu of the CompareArtist window or using the F1 button. A collection of examples and tutorials can also be found in menu.

Additionally videos and tutorials are available on the internet.

SGE Circus videos

3 Keyboard shortcuts, mouse gestures

Dataset

Ctrl + o

Add dataset(s) to compare...

Shift + v

Paste dataset files from clipboard into present session.

Ctrl + del

Remove all datasets from comparison...

F2

Edit dataset short names...

F6

Toggle visibility of dataset top section

Right mouse button drag

Reorder datasets

Label

Ctrl + l

F4

Select label(s) to compare...

Ctrl + F2

Rename labels...

Ctrl + i

Label info...

Delete

Remove label(s) from comparison...

Ctrl + h

Toggle highlighting of selected labels

Ctrl + Shift + h

Remove all highlighting

Ctrl + s

Save / export label names to lab-file or ETAS INCA ADM...

Ctrl + c

Copy label names to clipboard...

View

Ctrl + r

Run comparison

Ctrl + w, Double click

Visualize

Ctrl + t

Visualize (text output)

Ctrl + Shift + w

Visualize marked (cross compare)

Ctrl + Shift + t

Visualize marked (cross compare, text output)

Ctrl + d

Show only diffs

Ctrl + m

Show only missing labels

Ctrl + Shift + m

Ignore missing labels

Ctrl + +

Increase font size

Ctrl + -

Decrease font size

Filter

Type lowercase

Filter view regarding label names

Type CAPITALS

Filter view regarding function names

Ctrl + f

Edit filters...

Esc

Remove active filter

Miscellaneous

Ctrl + Shift + s

Save session...

F1

Show manual...

4 Features

The main features of the SGE CompareArtist are listed in this introduction. For details please see the following sections.



Datasets

Labels

Comparison

Visualization

5 Datasets

Calibration data to be managed using the CompareArtist must be stored in DCM-, PaCo- or CDFX-files or handled inside ETAS INCA software. Any number of datasets can be loaded simultaneously.

Exactly one dataset will be the master dataset. Its values will be the reference to compare all other dataset to.

5.1 Load datasets

To load a dataset into the CompareArtist use the “+” buttons at the right border of the main window or the corresponding menu item. A dataset will always be added below the dataset placed in the line of the used “+” button. Multiple files can be loaded at once.

To reload or replace a dataset press the button with the “open folder” sign right to the dataset name.

A dataset can be loaded either from a DCM/PaCO/CDFX file or from a running ETAS INCA software. It is also possible to load a session file.

Source DCM/PaCO/CDFX file

The file(s) to load the dataset from will be asked. When adding new datasets multiple files can be selected at once. When replacing a dataset only one file can be selected.

It is also possible to load session files using this dialog.

Source INCA

When loading datasets from ETAS INCA software you will be asked to select the project and dataset(s) from a tree view showing the actual INCA database.

Short name

An optional short name for the dataset will be asked if a single dataset was loaded. A short name is a convenient way to identify datasets in the main view and visualization windows for datasets with long file names. In case of loading multiple datasets at once the short names will be applied automatically. The dataset short names can be modified after loading the datasets using the corresponding menu item (F2).



No data will be loaded from the selected files or INCA at this point of time. Data will be loaded on demand when a comparison is run.

In case of a file modification during a CompareArtist session or when reloading a session it will be detected and the data will be reloaded from file. This is only true for datasets loaded from file. Changes to datasets retrieved from ETAS INCA software will not be detected. Missing files will be ignored as long as no data has to be loaded to enable working with session even if files are missing.

5.2 Drag and drop, paste datasets

In addition to using the file load dialog, you can load datasets and sessions from file by using drag and drop or the clipboard. To do this, one or more files can be dragged directly to the CompareArtist session or inserted via keyboard shortcut (Shift + v). It is also possible to copy files directly to the clipboard as well as strings containing the file names line by line.

5.3 Remove all datasets

To create a clear initial state all datasets can be removed at once.

5.4 Check files

The files the datasets were loaded from are remembered.

It may happen that files have been renamed or moved during the work or after reloading a session. Use the “Check files” option in this case to search the missing files and update their names and path automatically. Remember that sometimes it is not possible to find missing files. Datasets corresponding to missing files can be removed from the comparison.

5.5 Arrange datasets

Each datasets is listed in one line at the upper section of the main window. The upper most dataset is always the master dataset.

To modify the order of the datasets use the “arrow” buttons right of the dataset names or just drag the dataset buttons using the right mouse button. Use the “crown” button to make a dataset the master regardless of its actual position in the list.

To remove a dataset from the comparison use the “trash bin” button.

5.6 Activate / deactivate datasets

Datasets loaded can be active or inactive. Only active datasets take part in the comparison result. Datasets are active by default. To deactivate a dataset press the button containing the dataset name. Buttons of inactive dataset are displayed sunken and with a faded out dataset name.

5.7 Edit dataset short names

Short names describe each dataset and are used to identify the datasets in the comparison result table and other views. Edit the short names to ensure a meaningful and unique description. The dataset short names can be edited even after loading the datasets (F2) in a two step procedure.

In the first step you will be asked for replacement patterns. Decide whether to apply the rules to the dataset source or the actual short names. These replacement rules are applied to all datasets and are useful to do common renaming tasks. The replacement patterns are given one rule per line. The string to look for and the replacement are separated by two colons, like "SoftwareVersion :: SwVer". The replacement is case sensitive and done in the order of lines from top to bottom. If the corresponding check box is set the strings are interpreted as regular expression.

In the second step you will asked for each short name individually to modify.

After the editing was done a message will inform about the short name modification and allows to undo the changes.

6 Labels

6.1 Define labels to compare

A dataset contains of one or more label(s). The labels to compare must be chosen (Ctrl + l). Different modes are available and it can be chosen if of all data from the datasets is loaded or only the labels to compare.

After selecting labels you will be asked whether to add them to the current labels or to replace them or to remove from them.

Additionally it is possible to quickly remove the selected labels from the comparison view (Delete).

6.2 Label info

After running a comparison it is possible to show the information available for one or multiple marked labels (Ctrl + i).

When clicking onto a label and hovering the mouse afterwards a tool tip will be shown containing information for this label including the ranges of values and axes, its size and some descriptive information. Also the maximum difference to master labels values is shown if available and their size does agree.

6.3 Highlight labels

Labels can be highlighted (Ctrl + h) which means that they are emphasized in the comparison result table and their names are remembered even if they are not present in the comparison result table e.g. due to an active filter.

Highlighting can be used to collect a set of labels for later usage. For example highlighted labels may be copied to clipboard or saved / exported.

When highlighted labels are not contained in the comparison result table you will be warned when they get involved for e.g. copying or saving purposes.



6.4 Rename labels

Sometimes a comparison of labels is required whose names do not match. While this can be done using “Visualize all (cross comparison)” there is another option to realize this comparison that is much more comfortable for a high number of labels. A good example is an engine with two banks and therefore two ECUs with separate datasets. Lets imagine an bank identifier is appended to the names of the labels of both banks – _B1 for bank 1 and _B2 for bank 2.

By renaming the label names (Ctrl + F2) to remove the bank identifiers we get the same label names for both banks which enables a comfortable comparison.

You can rename label names or using replacement patterns (Ctrl + F2). The new names must be unique for the single datasets. Otherwise they will be skipped while renaming.

When renaming the label names the replacement patterns must be given one rule per line. The string to look for and the replacement are separated by two colons, like "EngineSpeed :: RPM". The replacement is case sensitive and done in the order of lines from top to bottom. If the corresponding check box is set the strings are interpreted as regular expression.

After the editing was done a message will inform about the label name modification and allows to undo the changes.

6.5 Save / export label names

Label names can be saved to a *.lab-file or can be transferred to the ETAS INCA ADM (Ctrl + s). You can select whether to copy all labels, the labels of the comparison result table, the highlighted labels or the selected labels from the comparison result table only.

To transfer label names to the ETAS INCA ADM some conditions must be met. INCA and the ADM must a started and a proper source dataset must be inserted that contains the labels to transfer. As it is not possible to check the transfer result automatically the user must check manually that the label names were transferred successfully. The Monitor window of the ETAS INCA software may contain useful information regarding the transfer success.

6.6 Copy label names

Label names can be copied to clipboard (Ctrl + c). You can select whether to copy all labels, the labels of the comparison result table, the highlighted labels or the selected labels from the comparison result table only.

6.7 Show label names

Label names can be visualized as a list. You can select whether to show all labels, the labels of the comparison result table, the highlighted labels or the selected labels from the comparison result table only.

7 Comparison result

7.1 Comparison table

After running a comparison (Ctrl + r) a typical view looks like in the following figure.

Top section

The top section contains the list of loaded datasets, their short names (if any) and the buttons to arrange and delete the datasets. The visibility of this section can be turned off (F6) to maximize the bottom section area.

Bottom section

The bottom section contains the table with the compare result. Each column represents one dataset. The fist column lists the label names for the master dataset. If it is selected to show only diffs (Ctrl + d) the list will only contain labels that differ to the master for at least one dataset.

The remaining columns display the compare result for one dataset each. Signs are used to indicate the type of difference (e.g. axes, values, size). The following table gives a overview of the denotation of the signs and entries in the table. Multiple signs may be combined in one table cell.

Sign

Description

label

If a label is missing in the master dataset the label name is struck out and colored red. As a comparison is always done to the master no comparison is done for missing labels.

-

The label is missing in the compared dataset.

size

The size or type of the label differs compared to the master.

x

The x axis values differ compared to the master.

y

The y axis values differ compared to the master.

w

The values differ compared to the master.

#

Map label type

/

Curve label type

.

Parameter label type

:

Axis label type

Background colors are used to group datasets that are equal for a label but differ from the master. Therefore it is easy to identify common differences.

7.2 Filter

The view of the compare result can be adapted by using filters. Except for the label name filter these can be configured using a dialog available from the corresponding menu item or a keyboard shortcut (Ctrl + f).

7.2.1 Filter by label names

To show only a compare result for a reduced set of labels based on their names just type in lower case letters regardless of the case of the label name. The wildcard * can be used to match any characters. If the filter string starts with a / the expression will be evaluated as a regular expression.

The active filter will be displayed in the table header of the master dataset. An active filter can be removed at once (Esc).

7.2.2 Filter by function names

To show only a compare result for a reduced set of labels based on their functions just type in upper case letters regardless of the case of the function name. No wildcards or regular expressions must be used.

The active filter will be displayed in the table header of the master dataset. As long as the filter does not match a single function exactly it is colored red. Otherwise it is colored green. The comparison table will only show labels if the filter matched at least one function exactly.

An active filter and can be removed at once (Esc). The function filter may also be set using a dialog (Ctrl + f).

7.2.3 Filter by label type

It can be defined which label types (maps, curves, scalars, axes) the compare result table should list.

The label type filters may also be set using a dialog (Ctrl + f).

7.3 Show only diffs

It can be defined (Ctrl + d) whether the compare result table should only list labels that differ for at least one dataset or should contain all labels chosen even if they do not differ. Missing labels in master are regarded as difference and will be listed if only diffs are shown.

7.4 Show only missing / Ignore missing

It can be defined (Ctrl + m, Ctrl + Shift + m) whether the compare result table should only list or ignore labels that are missing in at least one dataset. This functionality can be used to quickly obtain an overview regarding missing and new labels or to remove missing labels from the comparison result.

7.5 Table font size

The font size of the comparison result table can be adjusted using the corresponding menu items or keyboard shortcuts (Ctrl + +, Ctrl + -).

8 Visualization

8.1 Visualize (standard comparison)

The values of the labels marked in the table can be shown in a comparative view (Ctrl + w, Double click). Depending on the type the label (map, curve, scalar, text) the presentation is chosen to be graphically or textually. It is also possible to force textual output (Ctrl + t).

In this mode for each label marked in the table a separate representation of the comparison is shown. The representation will always contain the label of all datasets even if the label was only marked for one dataset. If a label is missing in a dataset or its type or size does not match the master it will be excluded.

8.2 Visualize all (cross comparison)

This special visualization mode (Ctrl + Shift + w) allows to compare labels e.g. with different label names. Different to the normal visualization the representation will not be done separately for the marked labels but combined. And also in contrast only the marked table cells will be considered. So not all datasets will be considered but only the marked ones.

Depending on the type the label (map, curve, scalar, text) the presentation is chosen to be graphically or textually. It is also possible to force textual output (Ctrl + Shift + t).

If a label is missing in a dataset or its type or size does not match the master it will be excluded.

9 Organize

9.1 Window handling

Since the SGE Circus offers to open a considerable number of windows an automatic window handling feature is implemented. Using the corresponding menu item enables to arrange all or a subset of the windows of the current session.

10 Save data

10.1 Save session

The whole session including data can be stored as file (Ctrl + Shift + s). After re-opening the whole functionality can be used again immediately.

Session files can be opened the same way as dataset files or using the SGE Circus or SGE Viewer.

11 General information

Duplication, processing, distribution or any form of commercialization of the documents content beyond the scope of the copyright law shall require the prior written consent of the SGE Ingenieur GmbH. All trade and product names given in this document may also be legally protected even without special labeling (e.g. as a trademark).

SGE Ingenieur GmbH – www.sge-ing.de

Copyright 2011-2017. All rights reserved.