Snapplot configuration commands

The following commands can be used in snapplot configuration commands

Configuration menu

config_menu cfg_file_name menu_text

Adds a configuration file to the "Config" menu. This is useful for frequently used configuration files. This command is only used in start up configuration files - it is ignored in configuration files loaded from the menu. This is most sensibly placed in one of the automatically loaded configuration files to reference other configuration files in the default directories (either the program or users directory). In this command cfg_file_name is the name of the configuration file, and menu_text is text that will appear in the menu. The menu text can include an "&" before a character to define it as the hot-key character (i.e. the character that can be used to select the menu item). It can also include spaces.

Station display options

offset_station code east_offset north_offset

Specifies stations that are to be plotted out of position on the map. In this command station_code is the code of the station to be offset, and east_offset and north_offset are the offset distances in metres. The offset is always expressed in metres east and north, regardless of the coordinate system of the data file. A separate command is required for each offset station.

ignore_station_offsets yes|no

Specifies whether stations are to be plotted in their offset locations.

highlight station_list
highlight station_list

Specifies stations that are to be highlighted or not. This command can be used multiple times to select the required stations. The stations are entered in the same way as in snap command file station lists.

hide station_list
show station_list

Specifies stations that are to be hidden or shown. This command can be used multiple times to select the required stations. The stations are entered in the same way as in snap command file station lists.

Observation display options

observation_colours by_type
observation_colours by_file
observation_colours by_std_residual [apriori|aposteriori] max_sres ngroups
observation_colours by_redundancy ngroups
observation_colours by_classification class_name

Defines the colour scheme that will be used to plot observations. The basic options are to colour observations by_type (e.g. slope distance, horizontal angle), by_file (i.e. according to the data file from which the observations are read), by_std_residual, by_redundancy, or by_classification.

To colour by standardised residual you must specify whether apriori or aposteriori standardised residuals are to be used, what is the maximum standardised residual to be in the groupings that will be generated, and how many groups to form.

To colour by redundancy you must specify how many groups (ranges of redundancy values) to form.

To colour by classification you must specify which classification to use. This should correspond to one of the classifications defined in one of the data files.

observation_options options...

Specifies some options related to plotting observations. In this command options can include any of the following:

show_obs_direction Observations for which the direction of observation is important (for example horizontal angle observations) are shown with a dotted line at the target station and a solid line at the instrument station.
no_show_obs_direction All observations are shown as a solid line
merge_all_obs All observations between two stations are represented with a single line between the stations (that is, observations are not offset).
merge_similar_obs Observations of a line corresponding to different entries in the key are offset from one another.
no_merge_obs All observations of a line are offset from one another.
show_hidden_station_obs Show observations between hidden stations.
no_show_hidden_station_obs Don't show observations between hidden stations.

observation_spacing offset [times_default]

This command specifies the offset between observations if the merge_similar_obs or no_merge_obs observation options are in force. The offset is expressed as either a distance in metres at true scale, or as a multiple of a default offset calculated by SNAPPLOT (e.g. 2 times_default)

highlight_observations option [threshold]

Specifies which observations are to be highlighted. option can be one of

none No observations are highlighted
rejected Rejected observations are highlighted
unused Observations between rejected stations that are not explicitly rejected are highlighted.
std_residual Observations with apriori standardised residual greater than threshold are highlighted
apost_std_residual Observations with aposteriori standardised residual greater than threshold are highlighted
redundancy Observations with redundancy less than threshold are highlighted
to_stations Observations to or from highlighted stations are highlighted
between_stations Observations between highlighted stations are highlighted

obs_listing_fields field1 field2 ...

Lists the fields that will be displayed in the list of observations. The fields can be any of "from", "to", "data_type", "status", "std_residual", "redundancy", "data_file", "line_number", "line_length" or the name of any data classification.

obs_listing_order field

Defines the field that will be used as the basis for ordering the observation listing.

Error options

error_type [apriori|aposteriori] standard_error
error_type [apriori|aposteriori] conf confidence

Defines how errors and standardised residuals will be represented by SNAPPLOT. The error can be apriori or aposteriori (the default is to leave unchanged), and standard errors or a percentage confidence limit. The percentage confidence limit applies only to error ellipses and height errors - it does not apply to the errors of observations or residuals written in the text window.

error_scale [horizontal|vertical] exaggeration [times_default]

Defines the scaling used for plotting error ellipses and height errors and the station adjustments. These are plotted at an exaggerated scale on the plot (e.g. 1000 times true size at true scale). The command can apply to just the horizontal or just the vertical errors. If neither horizontal nor vertical is specified it applies to both. The exaggeration can be expressed as a fixed value (e.g. 1000), or as a multiple of the default value determined by SNAPPLOT (e.g. 2.0 times_default).

Colour settings

key "key item name" [on|off] [colour]

This command specifies the settings for an item on the key. "key item name" is the exact text of the item on the key, and is enclosed in quotes. "on" or "off" specify that the item is selected or unselected, and colour specifies the colour for the item. "colour" can be either be a colour name (black, white, red, etc) or a specification or the red, green, and blue components of the colour from 0 to 255 formatted as "rgb(255,0,255)" or "#FF00FF".

See also:

snapplot

Snapplot configuration

Snapplot commands in the command file