Interactive Commands
alignment
Permalink to alignmentalignment [alignment_subcommand]
Note: The alignment subcommands are reserved for use by SOS software to align the sphere. It is not recommended that third-party software make use of these commands, as they may change with any future SOS software release. They are documented here for informational purposes only.
annotation help
Permalink to annotation helpThis command describes the annotation command options.
annotation
Permalink to annotationannotation [subcommand]
The annotation command is used for interactive drawing on the sphere. The subcommand is a list of one or more of the following:
clear
Permalink to clearClears the annotation.
drawline
Permalink to drawlineannotation drawline [lat1,lon1,lat2,lon2,width,red,green,blue]
Draw a line based on the parameters that are provided for position, width and color. Parameters lat1,lon1 specify the starting latitude and longitude coordinate of the line, while lat2,lon2 specify the ending latitude and longitude coordinate. Parameter width specifies the width of the line in pixels. Parameters red, green, and blue specify the color of the line and the values of each RGB component may be from 0 to 255. The position of the drawn line is dependent on the current orientation and is not draw exactly to the latlon specified.
drawlineAbsolute
Permalink to drawlineAbsoluteannotation drawlineAbsolute [lat1,lon1,lat2,lon2,width,red,green,blue]
Draw a line based on the parameters that are provided for position, width and color. Parameters lat1,lon1 specify the starting latitude and longitude coordinate of the line, while lat2,lon2 specify the ending latitude and longitude coordinate. Parameter width specifies the width of the line in pixels. Parameters red, green, and blue specify the color of the line and the values of each RGB component may be from 0 to 255. The position of the drawn line is will be drawn to the latlon coordinates specified, regardless of sphere orientation.
labelvisible
Permalink to labelvisiblelabelvisible [1 | 0 | on | off]
This command turns the label text on (1) or off (0). New in SOS 5.3.
layer help
Permalink to layer helpThis command describes the layer command options
layer info
Permalink to layer infoThis command gives you information about layers in the currently loaded dataset, including PIPs and labels.
layer
Permalink to layerlayer [index] [subcommands]
This command lets you modify the existing layers. The index value can be top
(the top layer), pip or label, or an integer layer index (zero-based). You can
get this information by first issuing the layer info
command. The subcommands
available are:
[name]
Permalink to [name]Renames the layer to the provided name.
Turns the layer off.
off
Permalink to offTurns the layer on alpha [0.0-1.0] ~ adjusts the transparency.
minzoom
Permalink to minzoomlayer [index] minzoom [float]
Adjusts the minimum zoom level.
maxzoom
Permalink to maxzoomlayer [index] maxzoom [float]
Adjusts the maximum zoom level.
east
Permalink to eastlayer [index] east [float]
Sets the east boundary of the layer.
west
Permalink to westlayer [index] west [float]
Sets the west boundary of the layer.
north
Permalink to northlayer [index] north [float]
Sets the north boundary of the layer.
south
Permalink to southlayer [index] south [float]
Sets the south boundary of the layer.
delete
Permalink to deleteDeletes the layer.
pointer
Permalink to pointerpointer [subcommand]
The pointer command takes multiple arguments for manipulating the state of the associate sphere image.
Turns on the pointer, making it visible on the sphere.
off
Permalink to offTurns off the pointer, making it disappear from the sphere.
red
Permalink to redMakes the pointer image a red simulated laser pointer.
green
Permalink to greenMakes the pointer image a green simulated laser pointer.
grab
Permalink to grabMakes the sphere “stick” to the pointer, so the sphere data set moves as the pointer is moved.
ungrab
Permalink to ungrabReleases the sphere after a pointer grab, so the sphere no longer moves with the pointer.
[lat,lon]
Permalink to [lat,lon]Moves the pointer to an absolute position specified by latitude,longitude. No white space is allowed in lat,lon.
[Dlat,lon]
Permalink to [Dlat,lon]Moves the pointer by an incremental “delta” latitude,longitude. No white space is allowed in Dlat,lon.
pointerimage
Permalink to pointerimagepointerimage [filename]
The pointerimage
command gives the name of an image file to use as the
pointer image. This allows other types of pointers than the default red or
green simulated laser pointer. This should be a png file with a transparent
background.
pointersize
Permalink to pointersizepointersize [degrees]
The pointersize
command specifies the diameter of the simulated laser pointer
image. The argument is the width and height of the underlying image, in degrees
at the equator.
splitter help
Permalink to splitter helpThis command describes the splitter command options.
splitter info
Permalink to splitter infoThis command lists all the information about the current state of the splitter.
splitter
Permalink to splittersplitter [subcommands]
The splitter
command controls an interactive feature to split the sphere into
2-4 slices and replicate the section of data currently being displayed on the
sphere at the center of the User Position (the red dot by default, or latlon
below). The subcommands that are available are:
Turns the splitter on.
off
Permalink to offTurns the splitter off.
latlon
Permalink to latlonsplitter latlon [float,float]
Defines where the splitter should be centered.
slices
Permalink to slicessplitter slices [int]
Sets the number of slices.
write
Permalink to writeDisplays the splitter with the current settings.
zoom help
Permalink to zoom helpThis command describes the zoom command options.
zoom
Permalink to zoomzoom [subcommand]
The zoom
command sets and displays attributes of the virtual magnifying glass,
which is used to zoom in on global sphere data. The subcommands that are
available are:
Turns the zoom on.
off
Permalink to offTurns the zoom off.
factor
Permalink to factorzoom factor [float]
Defines the level of zoom.
winsize
Permalink to winsizezoom winsize [float]
Sets the size of the zoom window.
latlon
Permalink to latlonzoom latlon [float,float]
Set the position of the zoom window.
pips
Permalink to pipspips [on|off]
Show (on) or hide (off) the pips under the magnifying glass. Pips are not shown be default. If you would like them to be shown by default, set the environment variable SOS_MAGNIFY_PIPS to “on” or “off” in ~/sos_stream_control.config.