Contents

2 Introduction

2.1 DataArtist user manual

2.2 MapArtist user manual

2.3 ModelArtist user manual

2.4 CompareArtist user manual

2.5 SGE CalcGuide user manual

2.6 SGE Viewer user manual

2.7 SGE Circus videos (external)

3 Quick Start

4 Support

5 Installation, Execution

5.1 System Requirements

5.2 MATLAB Compiler Runtime (MCR)

5.2.1 Portable MATLAB Compiler Runtime usage

5.3 Apache OpenOffice / Microsoft Excel

5.4 Licensing

5.4.1 Shared network licenses

5.5 SGE Circus startup

5.6 Tool startup / file opening

5.7 Update

5.7.1 Automatic software update

5.7.2 Manual update

5.8 Usage statistic

5.9 Startup performance

5.10 Direct tool start

5.11 Direct session / template opening by file association

5.12 Troubleshooting

6 Preferences / History

6.1 General

6.2 File location

6.3 Manage preferences

6.3.1 Settings

6.3.2 Export / Import / Restore

6.3.3 Clean up history

6.3.4 Path / file info

6.4 Preferences instance conflict

7 Graphics

7.1 Menu icons

7.2 Toolbars

7.3 Graphics configuration

7.4 Window handling

8 Process handling

9 File / path history

10 Input handling

10.1 List dialog

10.2 Input dialog

10.3 Input history

10.4 More input options

10.4.1 Help

10.4.2 Input history filter

10.4.3 Export to file / Fill from file

10.4.4 Fill list dialog from clipboard

10.4.5 Multiline edit fields

10.4.6 Checkboxes

11 Loading data

11.1 Supported file formats

11.1.1 MATLAB mat-file format

11.2 MATLAB workspace access

11.3 Simulink simulation output

11.4 File selection

11.5 Drag and drop, paste clipboard

11.6 Loading from compressed zip containers

11.7 Data load settings

11.8 Resolving "Out of Memory" Errors

11.9 Combined MDF – IFile loading

11.10 Calculated channels

12 Tools

12.1 Search files containing channels

12.2 Rename files

12.3 Compress files

12.4 Correlate IFile names

12.5 Convert data files

13 Used 3rd Party Software

13.1 findjobj

13.2 cmdow

13.3 gpml

13.4 fminsearchbnd

13.5 inhull

13.6 FileTime

13.7 nlopt/util/sobolseq

13.8 dndcontrol

13.9 xdelta

14 General information



SGE Circus – User Manual

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

2 Introduction

To be a good calibration engineer you do not necessarily need to perform magic. But it helps a lot. For this reason SGE Circus makes available a series of tools increasing quality and efficiency in terms of ECU calibration, measurement data analysis and processing.

This manual gives information about the installation and execution of the software and main functionality that is common to all tools. For the documentation of the single tools please see the individual documentation.

2.1 DataArtist user manual

The DataArtist is our magic wand in terms of visualizing and processing measurement data.

2.2 MapArtist user manual

The MapArtist is the star in the ring, when on the fly maps are created from data, displayed and edited.

2.3 ModelArtist user manual

The ModelArtist is a tool to visualize and model multirelational data as well as to enable model based calibration.

2.4 CompareArtist user manual

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

2.5 SGE CalcGuide user manual

The SGE CalcGuide is a tool to implement calculation routines by creating graphical flow chart diagrams - included with all tools.

2.6 SGE Viewer user manual

The SGE Viewer is used to visualize the results of measurement analysis and calibration. We prepare the results as special MATLAB(*) figure files, which can be loaded with the SGE Viewer.

2.7 SGE Circus videos (external)

Videos and tutorials are available on the internet.


For information regarding the version dependent software changes please refer to the Release notes accessible using the corresponding menu item inside the SGE Circus.

3 Quick Start

4 Support

If you need assistance regarding the installation or handling of the SGE Circus or if you experience any problems do not hesitate to contact our support using the corresponding menu item or by sending us an email to support@sge-ing.de

5 Installation, Execution

5.1 System Requirements

The operating system must be Microsoft Windows supported by the MCR (see following section). There is a 32bit and a 64bit version of the SGE Circus available.

As data processing requires to handle big amounts of data we recommend to use a 64bit operating system on a computer with at least 8GB RAM memory and a solid state hard drive.

5.2 MATLAB Compiler Runtime (MCR)

To be able to execute the SGE Circus or any of its tools you must have the MATLAB Compiler Runtime (MCR) installed. Installation will be done automatically on demand using the SGE Circus installer. For details see the → installation manual.

5.2.1 Portable MATLAB Compiler Runtime usage

If you don't have the ability to install the MATLAB Compiler Runtime on the computer to use with the SGE Circus you can try to use it in a portable mode. For details see the → installation manual.

By copying the MATLAB Compiler Runtime files you agree to its license in the same way as when installing it. Please refer to the license file MCR_license.txt located in the copied directory.

Using the MATLAB Compiler Runtime in portable mode should always be the second choice as it is reported to be not always a working and stable solution.

5.3 Apache OpenOffice / Microsoft Excel

If you want to be able to load / save data from / to *.xls- or *.ods-spreadsheet-files you have to install the free Apache OpenOffice suite or Microsoft Excel. This is used by the SGE Circus tools via a COM interface to access these files.

5.4 Licensing

You need a proper license file to run the SGE Circus. If you did not receive a license file yet please remove all portable hard drives and network interfaces from the computer to allow proper detection of the license id.

Afterwards start the SGE_Circus.exe to find out the license id used to retrieve the license. The following message will appear.

You can copy the license id to the clipboard if you would like to request a license file manually or you could use the feature to prepare an email message automatically.

Depending on the license linking type the license validity is checked against the computer hardware (e.g. hard drive, network interfaces) or the logged on user name (only available in networks with domain controllers and central user management ). So make sure to remove all removable hard drives and network interfaces before proceeding. With a valid license installed you can then add removable hardware again.

Licenses can be individual or shared. If you want to use a shared tool, make sure to have a network connection to the license server available. See “Shared network licenses” for details.

After retrieving the license file you may also import it using this dialog window again.

Additional options regarding licensing are available through the corresponding menu items available from the SGE Circus “?” menu. For example you can import an updated license file, see details regarding the license file (expire dates...) and deactivate the SGE Circus software permanently by deleting all license files.

5.4.1 Shared network licenses

Network licenses allow any number of users access to the licenses. Therefore a license server is contacted via network and the requested licenses are checked out. From this time until the check-in, these licenses are not available to any other user.

The check-out is performed automatically when a tool is started and the check-in is also completed when the last tool of a network license is closed. A network connection to the license server is therefore required for checkout and re-check-in.

In order to enable the work even without a network connection there is the possibility to borrow licenses permanently, if this function is activated in the license. If a license is borrowed permanently, it will not be automatically returned to the server when the tools are closed. This must be done manually to make the license available to other users again.

Use the corresponding menu item available from the SGE Circus “?” menu to borrow and return borrowed licenses.

Already borrowed licenses will be initially checked and the date of borrowing will be shown. Decide which licenses to borrow permanently by checking the corresponding items. This allows you to access shared licenses even without a network connection to the license server. Uncheck items to return their license to the sever. If the license is still in use it will be return upon exit of the tools using the license.

5.5 SGE Circus startup

The SGE Circus is delivered as one executable file SGE_Circus.exe. No installation is needed if the MATLAB Compiler Runtime (MCR) is available on the computer. See “MATLAB Compiler Runtime (MCR)“ for details. Execute the SGE_Circus.exe file to start the SGE Circus. Then in the background the components are extracted and the application is launched. If you want to use a tool with a shared license, make sure to have a network connection to the license server available.

Also a command window will open. This is used to display some messages and will disappear after startup. It can be reopened using the corresponding menu item.

5.6 Tool startup / file opening

Start the tool you like to use from the SGE Circus window by clicking the corresponding button or using a keyboard shortcut Ctrl + ”Number”. When you are finished terminate the SGE Circus. Never terminate the command window while SGE Circus or any tool window is opened. Otherwise the preferences will not get saved.

Additionally to opening the single tools you can open session and template files from e.g. the MapArtist or DataArtist directly using the corresponding item in the “File” menu or a keyboard shortcut. Multiple files can be selected at once and will be opened using the adequate tools. You cannot open e.g. measurement data files from the SGE_Circus directly. Start the single tools instead.

A list of recent session / template files is maintained in the the “File” menu to enable quick access.

5.7 Update

If activated by the license file you will have the possibility to check for updates and install them. In this case you will find a menu entry „Update“.

Also a periodic check for updates during SGE Circus start can be done automatically and is activated by default. You can modify the interval to ask for updates or turn off the automatic check in the preferences. For details see section “6.3.1 Settings”.

The source to look for updates at may be an internet server or a local directory. The information is located inside the license file.

5.7.1 Automatic software update

The sub menu “Check for updates” will first try to perform an automatic check for updates and ask to start the automatic update process if an update is available. The update process differs depending on the update source.

Your license file may specify a internet server as update source. In this case choose the “Download automatically” option if your computer has a stable, fast internet connection. The download will be performed automatically but cannot be interrupted and will not show any progress information.

After successful download or location of an update container you will be asked to start the update process.

In case of errors during the automatic update process you will be routed to the manual update.

5.7.2 Manual update

If the source is an internet server but your computer has no stable internet connection, a proxy server must be used or if a firewall denies the automatic internet access the update can be done manually. You will be routed to the update internet page using the system browser. The update container can be downloaded if any available. If a updated software version exists you can download a software container file.

The second sub menu “Integrate update container” lets you integrate the downloaded file. Do not unzip the file manually.

Be aware that during the update the SGE Circus will be exited without any further warning. So save your work before performing a update. Depending to the update extent you will be guided through the process by a graphical user interface and / or a command window. A update may concern the application and / or the license file.

After the update process you have to restart the SGE Circus.

5.8 Usage statistic

You can activate a usage statistic for the SGE Circus tools usage the corresponding menu item in the SGE Circus. The usage statistic is deactivated by default.

The collected data can only be viewed using the SGE Circus itself and is not transmitted to any other computer.

Different views are available to analyze the data collected.

5.9 Startup performance

The process of extracting the components to a temporary directory during first startup lasts some time. If the temporary directories on your system get deleted frequently this is done every time you start the SGE Circus.

To avoid this performance loss you might declare the environment variable “MCR_CACHE_ROOT” pointing to a fast accessible permanent location. This might be done in your operating system or using a batch file that declares the environment variable and starts the SGE Circus afterwards.

The content of the batch file could look like this:


@echo off

rem Batch file to start the SGE Circus in portable mode

rem without MCR Matlab Compiler Runtime installed.

rem The SGE_Circus.exe file must be located in the same directory.


rem Warn and exit if we were started from UNC path

if /i "%~d0" EQU "\\" (

cls

echo.

echo ###########################################

echo # Starting directly from UNC network path #

echo # is not supported. #

echo # Please connect the network share #

echo # using a drive letter an retry. #

echo ###########################################

echo.

echo Press enter to exit.

set /P exit=

goto ENDWAIT

)


rem change to directory of batch file

cd /d %~dp0


rem Define MCR cache root environment variable.

set MCR_CACHE_ROOT_DEMAND=%APPDATA%\SGE_Circus\mcr_cache_root\

if NOT EXIST "%MCR_CACHE_ROOT_DEMAND%" (

mkdir "%MCR_CACHE_ROOT_DEMAND%"

rem Set environment variable only in case of no error.

rem Otherwise MCR will not start.

if errorlevel 1 (

echo "### Error creating MCR_CACHE_ROOT directory. ###"

) else (

set MCR_CACHE_ROOT=%MCR_CACHE_ROOT_DEMAND%

)

) else (

set MCR_CACHE_ROOT=%MCR_CACHE_ROOT_DEMAND%

)


rem Modify PATH environment variable.

rem Activate line matching the OS configuration.

rem set "PATH=%PATH%;v82_32bit\runtime\win32"

set "PATH=%PATH%;v82_64bit\runtime\win64"


rem Start application and pass command line parameter. This

rem allows the immediate run of a function. If parameter

rem contains spaces it must be enclosed in "".

echo Starting SGE application...

SGE_Circus.exe "%~1"


rem Wait for end

:ENDWAIT

echo Press enter to exit.

set /P exit=


5.10 Direct tool start

If you are using single tools from the SGE Circus frequently and want to create e.g. a shortcut to start them directly, you can do this by passing the name as an argument to the SGE Circus executable file. The name must be exactly equal to the string written onto the corresponding button in the SGE Circus enclosed into “”.

Example: SGE_Circus.exe “DataArtist”

5.11 Direct session / template opening by file association

You can associate the file ending *.fig and *.mat in your operating system with the SGE_Circus.exe. Afterwards the SGE Circus is started automatically to load these files when they are opened e.g. by double clicking.

5.12 Troubleshooting

6 Preferences / History

6.1 General

The SGE Circus and its tools save information between sessions. For example color settings, window positions and recent paths are remembered. This information is kept in a preference file. No information is written to the operating system registry. For performance reason the preferences are kept in memory. They are stored to file only from time to time and when terminating.

Therefore it is important to terminate the SGE Circus and wait until the preferences are stored to disk. Do not terminate the command window before this process finished.

6.2 File location

The location on disk where the preferences are stored is automatically arranged by the SGE Circus. Several standard locations will be checked and the first appropriate one is used. This could for example be paths defined in the environment variables %APPDATA% and %USERPROFILE% or the directory of the executable file. The actual location can be displayed using the “Manage preferences” functionality – see below.

The SGE Circus would be inoperable if no preference file could be stored. It is therefore terminated if the preference file cannot be created in any of the standard locations. In this case you should make sure to have a writable location defined in the environment variables mentioned above or in the directory of the executable file.

6.3 Manage preferences

In the ...-menu of the SGE Circus you will find a “Manage preferences” entry.

6.3.1 Settings

Here you can specify some general settings.

6.3.2 Export / Import / Restore

It is possible to export / import all preferences/history to / from file. This can be used to backup and restore preferences/history and to transfer preferences between users and computers.

Additionally a restore is available to reset the preferences/history to one of the automatically created backup versions.

6.3.3 Clean up history

Large sets of history data slow down the application. Therefore it is possible to delete history data by age. Additionally you can move preference/history backup files to the recycle bin by age. While deleting preference/history backups does not affect the actual used preferences/history you should be aware that deleted history data is not available any more. So you should only delete history data older than that point of time you want to refer to using the history.

From the graphical view you can determine the quantity of preferences/history and backup files correlating to its age and decide the age to delete preferences and backup files from.

The preferences/history loading time is measured internally. If it exceeds a threshold you will be automatically asked to clean up preferences. The time threshold can be modified in the “Settings” menu in “Manage preferences”.

Before the clean up a backup of the preference file is done in the preferences directory. This can be restored just in case via the preferences menu.

6.3.4 Path / file info

The file used to save all preferences and history information of the SGE Circus and its tools is shown.

Additionally the directory to store the internal Matlab preferences and the directory used to extract the executable components to are displayed.

6.4 Preferences instance conflict

If you operate multiple SGE Circus instances at a time you will probably run into conflicts between the preferences/history in memory and saved to file. This will happen for example if one instance has just saved its preferences to file while another instance is modifying it in memory and try to save later. It will then detect the conflict and let you decide how to proceed.

In any case a backup will be performed before applying any changes. You will find the backup files in the same directory as the preferences file and you can restore the backups using the “Export / Import / Restore” function in “Manage preferences”.

7 Graphics

7.1 Menu icons

You can choose whether to enable the display of icons for some menu items. In some operating system configurations this may lead to problems and may be therefore turned off.

The initial creation of the menu icons lasts some time. So turning off the menu icon display will increase the startup speed of the SGE Circus tools.

Turning off the menu icons will also turn off the tooltips of the menu entries.

In the ...-menu of the SGE Circus you will find a “Manage preferences” entry that enables to turn on / off the menu icon display. A restart will be required to make the setting change apply.

7.2 Toolbars

The single SGE Circus tools provide a toolbar at the upper window border to easy and speed up the access to frequently used functionality.

The display of the toolbar can be turned on / off for the single tools individually using the corresponding menu entry (e.g. “View” → “Toolbar”).

The toolbar can be configured. Unneeded icons can be removed and missing icons can be added. To start the toolbar editing use the corresponding menu entry (e.g. “View” → “Toolbar”).

Edit toolbar instructions

The upper area shows the actual toolbar configuration and the lower area shows the icons available.

7.3 Graphics configuration

By default the graphics configuration is chosen automatically. OpenGL is used if available as well as hardware acceleration. When you experience problems with the graphics display you should first check if an update for your graphics driver software is available from the computer or graphics hardware manufacturer.

If the problem still exists you can try to enable one or more of the graphics driver bug workarounds or to modify the OpenGL setting. See the section “Settings” for details.

In the ...-menu of the SGE Circus you will find a “Manage preferences” entry that enables to modify the graphics configuration.

7.4 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.

8 Process handling

As mentioned the SGE_Circus.exe is used to start the main application that is then used to start single tools like the DataArtist or MapArtist.

It is possible to start multiple equal or different single tools from one SGE Circus application because the window stays visible. So for example you can work with multiple MapArtists at one time. This is called single-process-mode.

Alternatively you could start multiple SGE Circus applications each used to start just one tool (multi-process-mode). Both strategies have advantages and disadvantages as shown in the following table.

Single-process mode is generally recommended as it avoids preference conflicts.

Criterion

single-process

multi-process

Preferences exchange

Multiple tools share preferences that are saved at runtime. E.g. colors of lines and maps.

No conflicts may occur.

All tools keep separate preference sets in memory. They are not exchanged until both main applications are restarted. Conflicts may occur when saving preferences to file.

Snapshot exchange

Yes

No

Multi core usage

No. All tools are calculated by one processor core. Blocking actions (e.g. waitbars) block all tools.

Yes. Main applications and therefore tools are calculated as separate processes and use multiple cores. They do not block each other.

9 File / path history

File open and save dialog are used for various functionality. To ease the access to commonly used files and paths a special history concept is provided.

When you are prompted to select a file to open or save and the prefilled path does not fit your needs, you can just Cancel the dialog or hit the Escape key. The dialog will close and reopen again with the next path from history. This can be done several times until the desired path it reached. When the last path from history is reached, this is shown in the file name field.

To cancel the open or save process loop, you can close the little extra window shown between the file select dialog.

As it is shown only for a short time there are some tips to close it:

The number of paths/files maintained in the history can be adjusted via the “Settings“. It is also possible to turn off the path/file the history feature.

10 Input handling

Two main kinds of input dialog are used commonly by all tools. A list input dialog and a field input dialog.

10.1 List dialog

List dialog allow to quickly choose one or more entries from a prefilled list. The available elements are listed on the left side. By pressing characters on the keyboard the filter is written and applied. Use * as a wildcard character. Also a list of recent filter setting is available.

Elements are selected by “space”. For quick selection of all elements on the left side use “Ctrl+a” and for quick removal of all elements from the right side use “Ctrl+del”. After selecting an element the filter is reset when the first character is pressed. When confirming the dialog the elements listed on the right side are regarded as chosen. If no elements are listed on the right side the marked elements on the left side will be regarded as chosen.

List dialog can be filled from clipboard if the clipboard contains a list of strings.

List dialog keyboard shortcuts

Space

Move selected elements from active list to other side.

Ctrl + a

Add all items from left to right list.

Ctrl + c

Copy right list to clipboard.

Ctrl + del

Remove all items from right list.

Ctrl + h

Fill from history linked to the recent window.

Tab

Toggle active element (lists, buttons)

Ctrl + →

Load next list from history.

Ctrl + ←

Load previous list from history.

Ctrl + o

Fill list from file...

Ctrl + s

Export list to file...

Ctrl + v

Fill right list from clipboard

Shift + Enter

Confirm dialog

Escape

Cancel dialog

Characters, arrow keys, del

Enter filter string

10.2 Input dialog

Field input dialog consist of check boxes, drop down fields and single- or multiline input fields. In most fields that accept numeric input you can enter numbers or expressions that evaluate to a valid number (e.g. 1/10, 1+2).

Generally you must use a point as decimal separator – especially when you enter expressions that evaluate to a number, e.g. “1.5+2.5”. When entering a single number you can also use a comma, e.g. “1.5”.

Field input dialog keyboard shortcuts

F1

Show help for input field

Tab

Jump to next element or button

Ctrl + →

Load next list from history.

Ctrl + ←

Load previous list from history.

Ctrl + h

Fill from history linked to the recent window.

Ctrl + o

Import from file...

Ctrl + s

Export to file...

Shift + Enter

Confirm dialog

Escape

Cancel dialog

Ctrl + g

Set filter

Additional multiline input fields keyboard shortcuts

Ctrl + +/-

Add / remove line

Ctrl + f

Fit input field to text

Ctrl + e

Open content in external editor. Format can be chosen in global preferences.

10.3 Input history

To do your work efficiently the dialog assist by providing history functionality. So every time you confirm a dialog its inputs are remembered. The next time you use the dialog the fields are prefilled.

But of course you do not need just the last value again. So the single input fields as well as the whole dialog provide history buttons > < x. With the > < buttons you can shift through history. With x you can delete a history entry. While the buttons right of the single fields shift only the value of the field, the buttons on the right bottom edge shift all fields simultaneously. Really quick you get when using the shortcuts Ctrl+right/leftarrow.

Additionally the dialog provide a feature to fill them from a history linked to the actual figure window (session). So when you open a session and e.g. want to reload the data the dialog can be filled with the same values that were used to create the session even if in the meantime the dialog was filled with different values. The feature is accessible using the F button near the history buttons or using a keyboard shortcut.

10.4 More input options

Some more options are available using the i button for single fields or the entire dialog. These are also accessible by shortcuts. Part of these options depend on the kind of field and are not available for all kind of fields.

10.4.1 Help

Most fields provide a help dialog describing the functionality in detail and provide examples.

10.4.2 Input history filter

You can define a filter string to apply when walking through the history. Only entries that contain this string will be regarded when you switch through the history. Enter a simple substring without using wildcarts like *. You can also enter a regular expression if you check the corresponding option. If a filter is active the background of the corresponding i-button is darkened.

Example: If you remember that you once entered a channel name that included the string "interp" you could this string and then walk through the history using the <> buttons or keyboard shortcuts. Only matching entries will be shown.

10.4.3 Export to file / Fill from file

All inputs of the entire dialog can be exported to a text or binary file and also be filled by a file. As also this functionality is available via shortcuts it it very easy to keep records of the work done with are inputs saved and also to redo some work by filling the dialog from file.

10.4.4 Fill list dialog from clipboard

List dialog can be additionally be filled from clipboard. If the clipboard contains a list of strings matching listbox elements they get selected and listed on the right side. If the list already contains elements you will be asked whether to replace them or to add the new elements.

10.4.5 Multiline edit fields

10.4.6 Checkboxes

11 Loading data

In case the tool you will use provides the functionality to load data from files this section gives you a reference to the possibilities to do so.

11.1 Supported file formats

You can load data from the following file formats:

Format

Ending

Description

MDF3/4

*.dat. *.mdf, *.mf4

IFiles with same name in same directory are automatically loaded in parallel.

Text-Files

*.csv, *.asc, *.txt

Channels must be saved column wise. Values to load must be numeric.

MATLAB

*.mat

Data saved as mat-file by the SGE Circus may be reloaded. Also mat-files generated by other applications may be loaded. See the following section for details.

Spreadsheet

*.xls, *.xlsx, *.ods

Apache OpenOffice or Microsoft Excel must be installed.

Tellert

*.tms


Diadem

*.dat


Horiba VTS

*.VTS

Emission testbench results and modal data.

BLF / ASC

*.blf, *.asc

CAN signals. DBC description also necessary.

Keihin

*.dsf

Development status.

2D-Logger

*.ddd

Lap information may be available. In this case additional channels “LapNr”, “LapTime”, “LapProgress” will be provided.

Get-Logger

*.sxd

Development status.

IFile

*.0**


ZIP

*.zip

All data formats can be loaded also from zip containers. See below for details.

Session files

*.fig

Previous sessions saved by e.g. the MapArtist or DataArtist can be reopened.



11.1.1 MATLAB mat-file format

Data saved as mat-file by the SGE Circus may be reloaded. Also mat-files generated by other applications may be loaded if they agree with one of the following formats:

Source

Description / Variables

SGE Circus

Data exported from e.g. the DataArtist in mat-file format can be reloaded without any further user input to specify the variable names.

SIMULINK / ScopeData output

See the next section for details how to load Simulink simulation output.

Any

If the following variables are used to store the data it can be loaded without any further user input to specify the variable names.

channels”

  • Cell array of unique channel name strings. Length must be equal to “data”.

units”

  • Cell array of channel unit strings. Length must be equal to “data”.

data”

  • Cell array of numeric vectors. Each vector contains the data of one channel.

time”

  • Cell array of one ore more numeric axis vectors. Each vector contains one axis. The correlation of the axes to the data is done in “channeltimeaxinds”.

channeltimeaxinds”

  • Numeric vectors with the indices of the axes in “time” to use for the channels in “data”. Length must be equal to “data” and the index of the first axis is 1.

Example:

channels = {'eng_speed','temperature','throttle'};

units = {'1/min','°C','%'};

data{1} = [2000 2100 2300 2500 2000 1500 0];

data{2} = [20 22 5];

data{3} = [2 10 15 20 15 10 5];

time{1} = [0 1 2 3 4 5 6];

time{2} = [0 3 6];

channeltimeaxinds = [1 2 1];

Any

Generally data from mat-files can be loaded if it was saved in matrix format with channels column wise. The correlation of the variables will be asked.



11.2 MATLAB workspace access

Using the "from MATLAB" object in calculation channels makes it possible to integrate data from the workspace from a running MATLAB instance using the COM API interface.

CalcGuide documentation

11.3 Simulink simulation output

Simulink simulation and Scopedata can be output to the workspace and saved to a mat-file. Use the “StopFcn” of the model properties to conveniently save the workspace to a mat-file after simulation stop. Simulink offers two ways to output data to workspace.

Signal logging

“Signal logging” feature in Simulink enables to store data of signals anywhere inside the model – even inside subsystems. Using the standard variable name “logsout” and the format “Dataset” enables to load the data into the SGE Circus without any further user input when converting with the following StopFcn:


function logsout2mat(filename, logvar)

% Parameter 1 is a string containing the desired target filename ending with ".mat".

% Leave empty to automatically generate a filename.

if nargin < 1

filename = '';

end

% Parameter 2 is a string with the variable name of the simulation output.

% The class of the variable must be "Simulink.SimulationData.Dataset".

if nargin < 2

logvar = 'logsout';

end

% Check parameters

if ~ischar(logvar)

error('Second parameter must be a string with the variable name of the simulation output.');

end

if ~isempty(filename) ...

&& ...

(~ischar(filename) || isempty(regexpi(filename,'\.mat$')))

error('First parameter must be a string containing the desired target filename ending with ".mat".');

end

% Get logsout from simulation output in base workspace

try

logsout = evalin('base', logvar);

catch err

error('Error retrieving "%s" from base workspace: %s', logvar, err.message);

end

% Check

if ~isa(logsout,'Simulink.SimulationData.Dataset')

error('"%s" must be of class "Simulink.SimulationData.Dataset".',logvar);

end

disp(['Saving ' logvar ' to *.mat file ...']);

% Initialize

data = {};

time = {};

channels = {};

units = {};

channeltimeaxinds = [];

% Get signals

signals= logsout.getElementNames;

for iSignal = 1:length(signals)

element = logsout.getElement(signals{iSignal});

sw = size(element.Values.Data, 2);

for k = 1:sw

% Channel name

if sw > 1

channels{end+1} = sprintf('%s_[%d]',signals{iSignal},k); %#ok

else

channels{end+1} = signals{iSignal}; %#ok

end

% Channel unit

if isfield(element.Values,'DataInfo') ...

&& ...

isfield(element.Values.DataInfo,'Units')

units{end+1} = element.Values.DataInfo.Units; %#ok

else

units{end+1} = '-'; %#ok

end

% Data

data{end+1} = element.Values.Data(:,k); %#ok

% Axis

FoundAxis = 0;

for iAx = 1:length(time)

if isequal(time{iAx},element.Values.Time)

channeltimeaxinds(end+1) = iAx; %#ok

FoundAxis = 1;

break;

end

end

if ~FoundAxis

time{end+1} = element.Values.Time; %#ok

channeltimeaxinds(end+1) = length(time); %#ok

end

end

end

% filename generation

if isempty(filename)

% including timestamp

filename = [datestr(now,'yyyy-mm-dd_HHMMSS') '_' genvarname(gcs) '_SimulationOutput.mat'];

% without timestamp

%filename = [genvarname(gcs) '_SimulationOutput.mat'];

end

% save to file

save(filename, 'channels', 'units', 'data', 'time', 'channeltimeaxinds');

% beep() does not work on all computers -> use sound()

sound([sin(5000*(0:1/8192:0.15)) sin(8000*(0:1/8192:0.15))]);

disp(' ...done.');

end


Save to workspace

“Save to workspace” feature in Simulink enables to store data of the inports, outports and ScopeData. Using the standard variable names “tout”, “yout”, “ScopeData” and ”time” and the format “Structure with time” enables to load the data into the SGE Circus without any further user input when converting with the following StopFcn:


save([datestr(now,'yyyy-mm-dd_HHMMSS') '_' genvarname(gcs) '_SimulationOutput.mat']);


11.4 File selection

Files are selected using the dialog of the operating system. To ease the access to commonly used files and paths a special history concept is provided. See “File / path history“ for details.

When you are prompted to select a file to open or save and the prefilled path does not fit your needs, you can just Cancel the dialog or hit the Escape key. The dialog will close and reopen again with the next path from history. This can be done several times until the desired path it reached. When the last path from history is reached, this is shown in the file name field.

You can select multiple files at a time. The data of these files is then sequentially concatenated. To load multiple files at a time the following restrictions must be met:

When loading multiple files you will find an additional channels “FileCnt” and “FileCntNum” during channel selection. These channels are a counter that points at the file number loaded and enables you to see where files start and end during data evaluation. Depending on the application the data is loaded into the counter numbers may be translated into file names directly (“FileCnt”) or the correlated filenames are available from the channels comment (“FileCntNum”). Remember "FileCnt" and “FileCntNum” can only be loaded together with at least one valid data channel at the same time – so when “FileCnt” or “FileCntNum” should be added at a later time another channel must be loaded in parallel.

11.5 Drag and drop, paste clipboard

In addition to using the file load dialog, you can load files by using drag and drop or the clipboard. To do this, one or more files can be dragged directly to the SGE Circus or an open session or inserted via keyboard shortcut. It is also possible to copy files directly to the clipboard as well as strings containing the file names line by line.

The supported file formats differ depending on the tool. Sessions and templates can be opened by all tools and the SGE Circus in this way.

11.6 Loading from compressed zip containers

All data formats can also be loaded directly from zip containers. Multiple zip files can be selected at a time. All files from the zip containers (also in subdirectories) will be treated as if they were located in the top level of the structure inside the zip file. Therefore file names may become overlapping and will be modified automatically by adding an index.

11.7 Data load settings

Depending on the file format additional settings may be asked as shown in the following figures for some file formats.

11.8 Resolving "Out of Memory" Errors

If you load big amounts of data at a time and your computer does not provide enough memory you will experience “Out of Memory” errors.

The limiting factor may be the total available memory as well as the biggest continuous memory segment left because it limits the maximum array size MATLAB can create.

Consider the following hints:


@echo off

rem Batch file to start the SGE Circus in portable mode

rem without MCR Matlab Compiler Runtime installed.

rem The SGE_Circus.exe file must be located in the same directory.


rem Warn and exit if we were started from UNC path

if /i "%~d0" EQU "\\" (

cls

echo.

echo ###########################################

echo # Starting directly from UNC network path #

echo # is not supported. #

echo # Please connect the network share #

echo # using a drive letter an retry. #

echo ###########################################

echo.

echo Press enter to exit.

set /P exit=

goto ENDWAIT

)


rem change to directory of batch file

cd /d %~dp0


rem Define MCR cache root environment variable.

set MCR_CACHE_ROOT_DEMAND=%APPDATA%\SGE_Circus\mcr_cache_root\

if NOT EXIST "%MCR_CACHE_ROOT_DEMAND%" (

mkdir "%MCR_CACHE_ROOT_DEMAND%"

rem Set environment variable only in case of no error.

rem Otherwise MCR will not start.

if errorlevel 1 (

echo "### Error creating MCR_CACHE_ROOT directory. ###"

) else (

set MCR_CACHE_ROOT=%MCR_CACHE_ROOT_DEMAND%

)

) else (

set MCR_CACHE_ROOT=%MCR_CACHE_ROOT_DEMAND%

)


rem Modify PATH environment variable

set "PATH=%PATH%;v82_32bit\runtime\win32"


rem Start application and pass command line parameter. This

rem allows the immediate run of a function. If parameter

rem contains spaces it must be enclosed in "".

rem To maximize continuous memory area MemShieldStarter can be used

rem on 32bit systems instead of directly starting the exe.

rem Uncomment one of the following lines and comment the previous line.

rem Double "" "" are necessary then.


echo Starting SGE application...

MemShieldStarter -shield minimum SGE_Circus.exe ""%~1""

rem MemShieldStarter -shield medium SGE_Circus.exe ""%~1""

rem MemShieldStarter -shield maximum SGE_Circus.exe ""%~1""


rem Wait for end

:ENDWAIT

echo Press enter to exit.

set /P exit=


11.9 Combined MDF – IFile loading

Often ECU measurements are done simultaneously to indicating measurements. To have both data available for evaluation both files are loaded at a time. You can select just the MDF-file. In the channel selection dialog you will also find the channels from the IFile.

The synchronization of the angular based IFile data to the time based data is done automatically. To have the angular information still available two additional channels are created automatically. “CrankAngle”, “CrankAngleCum”, “CrankAngleNorm” and “CrankAngleNormCum” show the absolute and relative angle during combustion cycle. The “CrankAngleNorm” range is from -0.5 to 0.5 for every combustion and “CrankAngleNormCum” accumulated for the whole measurement.

Obey the following restrictions to allow simultaneous loading:

11.10 Calculated channels

Your measurement files contain channels you want to analyze. But sometimes it is helpful to have additional channels available depending on the measured ones. For example you want to look at a filtered engine speed because the measured one is noisy. Or you have measured an air temperature before and after intercooler but you really want to know is the difference of these two.

Therefore you have the possibility to create calculated channels. During channel selection you will find channel names like “** calculate **”.

When you select at least one of them you will be asked to edit the calculations afterwards.

By pressing the single buttons for the calculated channels the CalcGuide tool will be started and allows to manipulate the calculation in a graphical manner.

Depending on the application there may be additional buttons on the right side (+,x,^,v) to dynamically add or remove calculated channels or to modify their order.

By editing the result block you can enter the name and unit for a calculated channel. See the CalcGuide documentation for details.

12 Tools

Useful support functions are provided under this menu item.

12.1 Search files containing channels

Search for files containing channels that you are looking for that you are looking for or that meet certain data conditions (e.g. temperature exceeding threshold). Several options, regular expressions and recursive search are supported.

12.2 Rename files

Rename files automatically using pattern matching. Several options and regular expressions are supported. Even inserting numerical data from a measurement file or predefined date/time strings into its file name is possible.

12.3 Compress files

Compress files automatically using pattern matching. Several options and regular expressions are supported as well as' recursive directory operation.

12.4 Correlate IFile names

Rename IFiles automatically corresponding to the MDF files that were recorded in in parallel using OHI interface.

12.5 Convert data files

This tool is used to convert data files. You can load any number of files and change the data format, sample rate or axis range, for example. The result can be saved in the form of individual files or an entire file.

13 Used 3rd Party Software

The SGE Circus includes Third Party Software as shown in the following list.

13.1 findjobj

Software

Version

Description / Source

findjobj.m

01.01.50

Yair Altman, http://undocumentedmatlab.com

Copyright (c) 2017, Yair Altman

All rights reserved.



Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

13.2 cmdow

Software

Version

Description / Source

cmdow.exe

1.4.4

Ritchie Lawrence, http://sourceforge.net/projects/cmdow/

The MIT License (MIT)

Copyright (c) 2014 Ritchie Lawrence

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

13.3 gpml

Software

Version

Description / Source

GAUSSIAN PROCESS REGRESSION AND CLASSIFICATION Toolbox

3.6

http://gaussianprocess.org/gpml

Copyright (c) 2005-2015 Carl Edward Rasmussen & Hannes Nickisch. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY CARL EDWARD RASMUSSEN & HANNES NICKISCH “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CARL EDWARD RASMUSSEN & HANNES NICKISCH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of Carl Edward Rasmussen & Hannes Nickisch.

The code and associated documentation is available from

http://gaussianprocess.org/gpml/code.

13.4 fminsearchbnd

Software

Version

Description / Source

fminseachbnd.m

Release: 4

John D'Errico, woodchips@rochester.rr.com

Copyright (c) 2006, John D'Errico

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

13.5 inhull

Software

Version

Description / Source

inhull.m

26.10.2006

John D'Errico, woodchips@rochester.rr.com

Copyright (c) 2009, John D'Errico

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

13.6 FileTime

Software

Version

Description / Source

SetFileTime.m

29.06.2011

Jan Simon, matlab.THISYEAR(a)nMINUSsimon.de

Copyright (c) 2009, Jan Simon

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

13.7 nlopt/util/sobolseq

Software

Version

Description / Source

sobolseq.c, soboldata.h

2007

Steven G. Johnson, https://github.com/stevengj/nlopt

Copyright (c) 2007 Massachusetts Institute of Technology

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

13.8 dndcontrol

Software

Version

Description / Source

dndcontrol.m, MLDropTarget.jaca, MLDropTarget.class

13 Oct 2015

Maarten van der Seijs, https://de.mathworks.com/matlabcentral/fileexchange/53511-drag---drop-functionality-for-java-gui-components/content/dndcontrol.m

Copyright (c) 2015, Maarten van der Seijs

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

13.9 xdelta

Software

Version

Description / Source

Xdelta3

3.0.11

http://xdelta.org/

To obtain the source code use the following download link or contact us via mail:

GNU GENERAL PUBLIC LICENSE

Version 2, June 1991

Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

Preamble

The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.

To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.

For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.

We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.

Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.

Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.

The precise terms and conditions for copying, distribution and modification follow.

GNU GENERAL PUBLIC LICENSE

TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  1. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".

    Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.

  2. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.

  3. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:

    1. You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.

    2. You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.

    3. If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)

    These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.

  4. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:

    1. Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

    2. Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

    3. Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)

    The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.

  5. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

  6. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.

  7. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.

  8. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.

  9. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.

  10. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.

  11. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.

NO WARRANTY

  1. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

  2. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THEPOSSIBILITY OF SUCH DAMAGES.

END OF TERMS AND CONDITIONS

14 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.