- Undocumented Matlab - https://undocumentedmatlab.com/blog -

Splash window for deployed applications

Posted By Yair Altman On July 26, 2012 | Comments Disabled

One of the most annoying features of the Matlab compiler is the fact that compiled (deployed) applications take a loooooooooong time to load the first time that they are run on the target platform, or after a computer restart. This can take anywhere from 15-60 seconds, depending on platform characteristics. During this time, there is absolutely no visual indication that the application is loading. The application displays no window or other visual cue to let the user know something is loading.

I have seen many users double-click the application icon again and again in frustration, thinking that perhaps the application did not start when they first tried. In fact, this launches multiple applications and MCR loads at the same time, which only prolongs the overall time that it takes the application to actually load and display.

The “normal” solution for this would be to display a splash figure or start-up message at the very beginning of the application. Unfortunately, this doesn’t help because the vast majority of the launch time is due to MCR load time, which happens before any user code is executed. The result is that our application’s splash figure or msgbox will only be displayed after the very long time in which the application appears unresponsive.

Splash-window solution

splash wrapper for deployed Matlab applications I developed a splash-screen wrapper application for deployed applications that solves this problem on Windows platforms.

The idea is to create a stand-alone non-Matlab application that displays a user-specified image (splash) in a dedicated window at the center of the screen, and then immediately launches the requested deployed Matlab application in the background. The wrapper then waits for the Matlab application to load, and automatically closes the splash window when it detects that the target Matlab GUI has finally displayed.

The effect is that upon launching the application, the user sees immediate feedback in the form of a dedicated splash window (for example, displaying an image of the application or company logo with the message “Loading – please wait…”). This does not make the target application load any faster, but at least users are given immediate feedback that prevents them from re-launching the application. Users also report that this makes the application appear to load faster. This is due to a psychological effect called “perceived performance” – we also see this effect with phone ringtones and elevator floor-level indicators.

My splash wrapper application receives the following input parameters:

  1. splash image filepath (BMP/JPG/GIF – note that other formats are NOT supported)
  2. splash image width in pixels (will resize the image if necessary)
  3. splash image height in pixels (will resize the image if necessary)
  4. target window title string
  5. title matching mode:
    • 1 = match at the beginning of the title (case sensitive)
    • 2 = match at any place within the title (case sensitive)
    • 3 = match the entire title (case sensitive)
    • -1, -2, -3 = case-insensitive version of the above values
  6. target application filepath (this is the actual deployed application executable)
  7. optional input parameters for the target application

Sample usage:

splash MySplashImage.bmp 600 450 "My GUI Title" 1 "C:\Program Files\MyApps\MyTargetApplication.exe" param1 param2

This will display the MySplashImage.bmp image in a 600×450 window (resizing the image if needed) until a window with a title of “My GUI Title” appears. In the example above, the parameters to the splash application were as follows:

  1. image filepath – MySplashImage.bmp
  2. image width – 600 pixels
  3. image height – 450 pixels
  4. target window title string – “My GUI Title”
  5. title matching mode – 1 (=match at the beginning of the title)
  6. target application – “C:\Program Files\MyApps\MyTargetApplication.exe”
  7. optional input parameters to your target application – param1, param2

You can create a shortcut that runs the above command-line and then when the user clicks the shortcut it will automatically launch splash.exe, which will automatically display the splash screen and then load your main application.

I’ve contributed dozens of useful open-source utilities to the Matlab user community over the years (look at my File Exchange profile [3]). This utility is different because it directly targets compiled applications, which are typically used commercially. For this reason, my splash wrapper application is not free (but also not very expensive). You can purchase a copy here [4], and I will email it to you.

Please note: this is a Windows application. It will not work on Macs or Linux.

Interested in learning more about actual and perceived performance improvement tricks in Matlab? Consider attending my Matlab Performance Tuning [5] course – email me [6] (altmany at gmail dot com) for details.

Categories: GUI, Low risk of breaking in future versions


Article printed from Undocumented Matlab: https://undocumentedmatlab.com/blog

URL to article: https://undocumentedmatlab.com/blog/splash-window-for-deployed-applications

URLs in this post:

[1] Image: http://undocumentedmatlab.com/feed/

[2] email feed: http://undocumentedmatlab.com/subscribe_email.html

[3] my File Exchange profile: http://www.mathworks.com/matlabcentral/fileexchange/authors/27420

[4] here: https://www.paypal.com/cgi-bin/webscr?cmd=_xclick&business=octahedron.ltd@gmail.com&currency_code=USD&amount=180&return=&item_name=Splash+wrapper+application

[5] Matlab Performance Tuning: https://undocumentedmatlab.com/courses/Matlab_Performance_Tuning_Course.pdf

[6] email me: mailto:%20altmany%20@gmail.com?subject=Matlab%20courses&body=Hi%20Yair,%20&cc=;&bcc=

[7] ScreenCapture utility : https://undocumentedmatlab.com/blog/screencapture-utility

[8] Solving a Matlab hang problem : https://undocumentedmatlab.com/blog/solving-a-matlab-hang-problem

[9] Some Matlab performance-tuning tips : https://undocumentedmatlab.com/blog/some-performance-tuning-tips

[10] Callback functions performance : https://undocumentedmatlab.com/blog/callback-functions-performance

[11] Tab panels – uitab and relatives : https://undocumentedmatlab.com/blog/tab-panels-uitab-and-relatives

[12] Specialized Matlab plots : https://undocumentedmatlab.com/blog/specialized-matlab-plots

Copyright © Yair Altman - Undocumented Matlab. All rights reserved.