Description | Example | Return Message | Group

Graphics ImageInlay

Set properties for an inlay image on a 2D Graphics window

Syntax

Graphics <ScenarioPath> ImageInlay "<FilePath>" {ImageOption} <Value> [{ImageOption} <Value>...]

Description

The Graphics InlayImage command allows you to control the display of a specified image on a 2D Graphics window. In STK, images are registered in an Images list once you add them via the Images page of the 2D Graphics properties or this command. Regardless of the method in which the image is registered, the image name, file location and position in the 2D Graphics window when displayed is saved in STK. When an image is registered, STK creates a position file with the same name as the image file but with a .pos extension.

If the image has not been added to the STK Image list, the "<FilePath>" must be the fully qualified file path. If the image has already been added to the list (whether by the user interface or via Connect), "<FilePath>" can be simply the file name of the image.

{ImageOption} <Value> pairs can be:

{ImageOption} <Value> Description
Show On Display the specified image. You can specify a ppm, bmp, or pdttx file.
Off Hide the specified image.
Transparent On Use the upper left corner pixel color as the transparent color for the image.

Note: The Transparent option will be ignored for JPEG 2000, CIB, CADRG, and PDTTX images because transparency data is included in the image file and cannot be changed.

Off Do not use transparency in the image.
Positon [<MinLat> <MinLon> <MaxLat> <MaxLon>] If the image is being registered for the first time and there is no associated position file, you'll also need to specify the position coordinates in degrees using the <MinLat> <MinLon> <MaxLat> <MaxLon> parameters. If the Image has already been added to the Image list, you don't need to specify the latitude and longitude position coordinates, as this information has already been saved with the image's position file (*.pos). Connect searches for the associated position file, and, if it is found, the image displays at the coordinates specified in that file. If Connect can't find the position file or no coordinates are specified, the position displays at minimum latitude -90.0, minimum longitude -180.0, maximum latitude 90.0, maximum longitude 180.0 by default.

Note: If you enter latitude and longitude coordinates and a position file already exists, the coordinates entered are ignored.

Note: The Position option is not valid with a pdttx file because position data is included in the image file and cannot be changed.

Translucency <Value> Enter a value between 0.0 and 100.0.
WindowID <WinNumber> Enter the number of the 2D Graphics window to which the changes should be applied.

Example

To display the AGILogo at minimum latitude -45.0, minimum longitude -90.0, maximum latitude 0.0, maximum longitude 0.0 on the first Map:

Graphics * ImageInlay "/tmp/AGILogo.bmp" Show On Position -45.0 -90.0 0.0 0.0 WindowID 1

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

2D Graphics Window

Version

9.0

STK Programming Interface 11.0.1