TerraScan Key-in Commands

Most of the tools in TerraScan can be started by entering a key-in command in the MicroStation Key-in line. The Browse Key-in option of the Key-in line can be used to find out the syntax of a key-in command. To bring up the key-in dialog press enter in an active MicroStation view window.

If you select TSCAN in the list at the lower right corner of the Browse Key-in dialog, the selection of commands is limited to TerraScan commands only. There are four list fields that show available commands. Select the first word of a command in the left list. This adds the word to the command line and displays matching second words in the second-left list field. Select the second word of a command. This adds the word to the command line and displays any matching third words in the next list field. Continue until a command is complete.

If you know approximately, how a command looks like, you may start typing the command in the Key-in line. The software automatically completes words of the command, so you just type the first letter(s) and then, confirm the suggested word with <Space>.

Press <Enter> in order to execute a key-in command. This starts the corresponding tool or performs another action called by the command.

Key-in commands are handy because you can assign them to function keys in MicroStation. This can speed up some manual tasks significantly as you can call tools by pressing a key instead of mouse clicks. Especially tools with optional parameters in their key-in commands are well suited for speeding up manual work with function keys.

This lists key-in commands and their optional parameters that you may consider assigning to function keys.

Add Point To Ground

Add Point To Ground key-in command adds a point to the ground class and re-iterates its closest environment. You identify the laser point to add after starting the command with a data click.

Syntax:

add point to ground

Corresponding menu command: Add point to ground

Assign Point Class

Assign Point Class key-in command assigns a point class to a single laser point or to all points belonging to the same group. You identify the laser point with a data click after starting the command.

Syntax:

assign point class from=2/to=6/classify=single/select=highest/ within=2.0

Parameters:

Parameter: Effect:
from=n Source class. Use from=999 or from=any to use any visible points.
to=n Target class.
classify=x Points to classify: single or group.
select=x Point to classify within the search radius: closest to mouse pointer, highest, or lowest.
within=n Search radius for selecting the highest or lowest point.

Corresponding tool: Assign Point Class

Classify Above Line

Classify Above Line key-in command classifies points above a given line in a section view. You specify the line with two data clicks after starting the command.

Syntax:

classify above line [From] To

For example:

“Classify above line 6 9” will setup the tool to classify above line from class 6 to class 9.

“Classify above line 9” will setup the tool to classify above line from any class to class 9.

Parameters:

Parameter: Effect:
from Source class(es). Use 999 or no value at all to classify any visible points. Separate several source classes by a comma or minus, for example class=1,3-5.
to Target class.

Corresponding tool: Classify Above Line

Classify Below Line

Classify Below Line key-in command classifies points below a given line in a section view. You specify the line with two data clicks after starting the command.

Syntax:

classify below line [from] to

Parameters:

Parameter: Effect:
from Source class(es). Use 999 or no value at all to classify any visible points. Separate several source classes by a comma or minus, for example class=1,3-5.
to Target class.

Corresponding tool: Classify Below Line

Classify Close To Line

Classify Close To Line key-in command classifies points above, below or close to a given line in a section view. You define the line with two data clicks inside a section view.

Syntax:

classify close to line abovefrom=any/aboveto=3/abovetol=0.1

Parameters:

Parameter: Effect:
abovefrom=n Source class above line. Use 999 or any to classify any visible points.
aboveto=n Target class above line.
abovetol=x Tolerance above line.
closeform=n Source class close to line. Use 999 or any to classify any visible points.
closeto=n Target class close to line.
belowfrom=n Source class below line. Use 999 or any to classify any visible points.
belowto=n Target class below line.
belowtol=x Tolerance below line.

Corresponding tool: Classify Close To Line

Classify Fence

Classify Fence key-in command classifies points inside an existing fence. It also starts the Place Fence tool so that you can immediately place a new or the next fence.

Syntax:

classify fence [from] to

Parameters:

Parameter: Effect:
from Source class(es). Use 999 or no value at all to classify any visible points. Separate several source classes by a comma or minus, for example class=1,3-5.
to Target class.

Corresponding tool: Classify Fence

Classify Inside Shapes

Classify Inside Shapes key-in command classifies points inside selected shapes. Source class, destination class and expand distance may be set as parameters if the key-in command.

The command requires that at least one shape element is selected in the design file. It classifies the points inside selected shapes immediately, no manual action is required.

Syntax:

classify inside shapes from=5/to=6/expand=1.0

Parameters:

Parameter: Effect:
from=n Source class(es). Use from=999 or from=any to classify from any class.
to=n Target class.
expand=n Distance by which to expand the shapes. Positive values expand and negative values shrink the shapes.

Corresponding macro action: Inside shapes

Classify Using Brush

Classify Using Brush key-in command classifies points inside a circular or rectangular brush. You define the points to classify placing a data click and moving the brush over the points in a top or section view. Stop the tool by placing another data click.

Syntax:

classify using brush from=2/to=6/size=15/shape=circle

Parameters:

Parameter: Effect:
from=n Source class(es). Use from=999 or from=any to classify any visible points. Separate several source classes by a comma or minus, for example class=1,3-5.
to=n Target class.
size=n Brush size. Given in pixels on screen.
shape=n Shape of the brush: circle or rectangle.

Classify View

Classify View key-in command classifies points which are visible inside a view. You select the view with a data click after starting the command.

Syntax:

classify view [From] To

Parameters:

Parameter: Effect:
from Source class(es). Use 999 or no value at all to classify any visible points.
to Target class.

There is no corresponding tool, menu command, or macro action.

Fix Elevation

Fix Elevation key-in command changes the elevations of laser points inside given polygons. Each laser point inside one polygon is fixed to the same elevation value. The polygons used for this action can be defined by a fence, selection, or a specific MicroStation level.

The command manipulates the points inside polygons immediately, no manual action is required.

Syntax:

fix elevation class=2,8/percentile=5/level=10/color=7

Possible parameters:

Parameter: Effect:
class=n Classes to modify. Use class=999 or class=all to modify all points. Separate several classes by a comma or minus, for example class=1,3-5.
polygon=n Type of polygons: fence, selected, or level.
percentile=n If given, elevation values are computed from the points inside the polygon and n specifies the percentile (0=minimum, 50=median, 100=maximum) of points.
elevation=n If given, elevation values of all points are set to the fixed value, for example elevation=0.0.
level=n Design file level to search for polygons. If given, it forces polygon=level.
color=n If given, filters polygons by color in addition to level. Uses MicroStation color numbers.
weight=n If given, filters polygons by line weight in addition to level. Uses MicroStation line weight numbers.
style=n If given, filters polygons by line style in addition to level. Uses MicroStation line style numbers.

Corresponding tool: Fix elevation

Mouse Point Adjustment

Mouse Point Adjustment key-in command can be used for turning mouse point adjustment on/off and setting the appropriate parameters. Mouse Point Adjustment adjusts vector data to the location and/or the elevation of laser points. You can use this tool with any MicroStation element placement tool. Mouse Point Adjustment simply fixes the coordinates of data clicks, which means the vertices of vector elements to laser data coordinates. It might be considered as a “snap to laser points” tool.

Syntax:

Mouse Point Adjustment AdjZ=1/AdjXy=0/Point=Closest/Class=2/Within=0.5

Possible parameters:

Parameter: Effect:
AdjZ=n If on (=1), the elevation of data clicks (vertices) is adjusted.
AdjXy=n If on (=1), the xy location of data clicks (vertices) is adjusted.
Point=n Points or surface model from which element vertex coordinates are derived:

  • Closest – point closest to the data click.
  • Highest – highest point within a search area.
  • Average – average xy and/or z of all points within a search area.
  • Percentile – average xy and/or z of a given percentile of points within a search area.
  • Lowest – lowest point within search area.
  • TIN model – elevation of a triangulated surface model and xy from the closest point.
Class=n If given, specified the point class to adjust to.
Within=n Radius of the search area around the mouse pointer location.

Corresponding tool: Mouse Point Adjustment

Move Backward

Move Backward key-in command moves a section view backward. The key-in command must include a view number (1-8). The section is moved backward by the full depth or half of the depth of the section view, depending on the active setting in the Move Section tool dialog.

Syntax:

move backward [stayactive] ViewNumber

Parameters:

Parameter: Effect:
stayactive Would move the specified view backward and stay active waiting for mouse click to move.
ViewNumber View in which the action is applied. View numbers can range from 1-8.

Corresponding tool: Move Section

Move Forward

Move Forward key-in command moves a section view forward. The key-in command must include a view number (1-8). The section is moved forward by the full depth or half of the depth of the section view, depending on the active setting in the Move Section tool dialog.

Syntax:

move forward [stayactive] ViewNumber

Parameters:

Parameter: Effect:
stayactive Would move the specified view forward and stay active waiting for mouse click to move.
ViewNumber View in which the action is applied.

Corresponding tool: Move Section

Open Block

Open Block key-in command opens a project block for viewing or modification.

Syntax:

  open block [BlockFile [options]]

Parameters:

Parameters: Effect:
BlockFile Block binary file to open. Can be specified by the file name or the unique block number.
Options
neighbours=n Distance to load points from neighbouring blocks.
fit=n View(s) to fit where n is between -1 and 8 (-1=all, 0=none, 1-8=view).
lock=n If n is 0, opens block for viewing only.

If n is not zero, opens block for modification.

Corresponding menu command: Open block

Scan Create Surface

Scan Create Surface key-in command creates a TerraModeler surface model. The command starts TerraModeler if it is not yet running. It creates the surface model, keeps the model in the memory and stores the model file on the hard disk. The storage location and name of the model file on the hard disk are the same as of the design file.

Syntax:

  scan create surface class name

Parameters:

Parameters: Effect:
class Point class from which the surface model is created.
name Name of the surface model.

Corresponding menu command: Create surface model

Scan Display

Scan Display key-in command changes the view display mode for laser points. The key-in “Scan Display” on its own, without any parameters, simply opens the dialog.

Syntax:

scan display off=all/on=2/color=class

Parameters:

Parameter: Effect:
view=n View to which the display settings are applied. View numbers can range from 1-8, for example view=3. If this parameter is given, it must be the first one and causes an immediate display change to the specified view. If not given, you select a view with a data click.
on=n Class(es) to switch on. Examples: on=2 or on=1,5-8 or on=all.
off=n Class(es) to switch off. Examples: off=7 or off=3-11 or off=all.
color=n Coloring mode, n can be class, echo, elevation, line, intensity, distance, color, lineint, echolen, scanner, dimension, group, shading, or slope. Example: color=class.
weight=n Weight (point size) where n is line weight value 0-7 or -1 for class-based weight. Examples: weight=1 or weight=-1.
lineon=n Flightlines to switch on. Examples: lineon=1-3 or lineon=all.
lineoff=n Flightlines to switch off. Examples: lineoff=1-3 or lineoff=all.
sparse=n Sparse display mode. Examples: sparse=on or sparse=off.
depth= Depth display mode. Examples: depth=on or depth=off.

Corresponding menu command: Display mode

Scan Delete Inside Fence

Scan Delete Inside Fence key-in command deletes points inside a fence or selected polygon. You accept the action with a data click inside the view where the fence is drawn or the polygon is selected.

The command requires that a fence is drawn or a polygon is selected before it is started.

Syntax:

scan delete inside fence

Corresponding menu command: Delete / Inside fence

Scan Delete Outside Fence

Scan Delete Outside Fence key-in command deletes points outside fence or selected polygon. You accept the action with a data click inside the view where the fence is drawn or the polygon is selected.

The command requires that a fence is drawn or a polygon is selected before it is started.

Syntax:

scan delete outside fence

Corresponding menu command: Delete / Outside fence

Scan Fit View

Scan Fit View key-in command fits a view to display the area covered by laser points. You can specify the view to fit as an optional parameter or by selecting it with a data click.

Syntax:

Scan Fit View [View]

Parameter: Effect:
View View to which the action is applied. View numbers can range from 1-8.

Corresponding menu command: Fit view

Scan Move Sun

Scan Move Sun key-in command moves the sun direction (azimuth) in shaded views.

Syntax:

Scan Move Sun Degree

Parameter: Effect:
Degree Value to add to the current sun direction, angle by which the sun direction is moved.

Corresponding dialog setting: Display mode dialog, Azimuth setting for Color by Shading.

Scan Open Main Toolbox

Open Main Toolbox key-in command opens the TerraScan Main Toolbox in CONNECT if it has been closed. The Main Toolbox can also be opened from the TerraScan Main Window -> Tools -> Toolboxes -> Main tool box

Syntax:

  scan app main

Parameters:

None

Corresponding menu command: In v8/v8i only: Applications -> TerraScan -> Main tool box

Scan Open Main Window

Open Main Window key-in command opens the TerraScan Main Window in CONNECT after it has been accidentally closed.

Syntax:

  scan app mainwin

Parameters:

None

Corresponding menu command: In v8/v8i only: Applications -> TerraScan -> Main Window

Scan Run Macro

Scan Run Macro key-in command executes a macro.

Syntax is:

Scan Run Macro Macrofile

Parameter: Effect:
Macrofile File name of the macro to execute. If the file name does not include a directory path, the value of TSCAN_MACRODIR environment variable is used as the directory to search from. See Configuration Variables for more information.

Corresponding menu command: Run macro

Travel Step Backward

Travel Step Backward key-in command moves Travel Path windows by one section backward.

This works only, if the Travel Path tool has been used to set up the Travel Player of TerraScan.

Syntax:

travel step backward [Count]

Parameter: Effect:
Count Number of steps to move.

There is a corresponding button in the TerraScan Travel Player which is opened by the Travel Path tool.

Travel Step Forward

Travel Step Forward key-in command moves Travel Path windows by one section forward. This works only, if the Travel Path tool has been used to set up the Travel Player of TerraScan.

Syntax:

travel step forward [Count]

Parameter: Effect:
Count Number of steps to move.

There is a corresponding button in the TerraScan Travel Player which is opened by the Travel Path tool.

Additional Key-in Commands:

Scan Settings
Scan Define Coordinate Setup
Define Classes
Design Block Boundaries
Define Project
Manage Trajectories
Load Airborne Points
Load Ground Points
About TerraScan
Help On TerraScan

Draw Vertical Section
Draw Horizontal Section
Move Section
Rotate Section
Cut Section
Travel Path
Synchronize Views
Measure Point Density
Update Distance Coloring

Place Collection Shape
Fit Linear Element
Drape Linear Element
Find Breakline Along Element
Find Curb Along Element
Set Polygon Elevation
Cut Linear Element
Construct Planar Building

Find Automatic Breaklines
Find Road Breaklines
Import Road Breaklines
Draw Slope Arrows
Draw Sight Distances
Fit Geometry Components

Create Editable Model
Add Synthetic Point
Remove Vegetation
Rebuild Editable Model

Place Tower String
Detect Wires
Place Catenary String
Check Catenary Attachments
Assign Wire Attributes

Place Tower
Edit Tower Information
Move Tower
Rotate Tower
Add Cross Arm
Modify Cross Arm
Rotate Cross Arm
Extend Cross Arm
Set Cross Arm Elevation
Delete Cross Arm
Create Attachments
Add Attachment
Move Attachment
Delete Attachment

Activate Powerline
View Tower Spans
Find Danger Objects
Label Towers
Label Catenary Height
Create Span Tiles
Output Catenary
Export Powerline

Place Railroad String
Fit Railroad String
Find Rails
Activate Rail String
Move Rail Vertex
Recompute Rail Interval
Find Wires
Check Wire Ends

Scan Undo Display
Scan Save
Open Inside Fence
Open Scan Project

Find Detail Planes
Add Building Plane
Mirror Building Plane
Merge Building Planes
Delete Building Plane
Create Direction Group
Add Plane To Group
Assign Plane Block
Assign Plane Symmetry
Adjust Building Plane

Set Boundary Type
Auto Align Boundaries
Place Boundary Shape
Modify Boundary Shape
Align Boundary Segment
Cut Boundary Corner
Cut Boundary Segment
Delete Boundary Vertex

Show Plane Location

Vectorize Buildings
Construct Roof Polygons
Create Buildings from Polygons
Check Building Models

Extrude Building
Set All Edges

Apply Straight Line
Apply Intersection Line
Modify Edge
Move Edge Vertex
Align Edge Segment
Build Step Corner
Cut Edge Corner
Cut Edge Segment
Delete Edge Vertex
Insert Edge Vertex
Split Building
Split Patch
Merge Patches
Remove Patch
Remove Details
Draw Building Section

View Waveform
Extract Echoes

Draw Polygons
Draw Slope Arrows

Development Memory

Scan Undo Classification
Place Target Object
Translate Measurement
Rotate Measurement
Classify Above Curve
Classify Below Curve
Split Trajectory
Add Wire Point
Approve Wire End

Share

GeoCue Group Support

GeoCue Group Support has written 542 articles

6 thoughts on “TerraScan Key-in Commands

  1. lidarlover says:

    Thank you for compiling this list.

    I use the View Tower Spans tool to move through towers on a powerline. I frequently have to manually switch to the window to move to the next or previous tower. I can do this successfully with the arrow key on my keyboard but only when I have that window maximized. It would be easier if I could do this with a keystroke.

    Is there a way to string a key in command to go to the next or previous tower from that window?

    Thanks.

    1. There is not currently a key-in command for moving to/from next/previous tower in the Tower Spans dialog. As you noted this can only be done by using the arrow keys on the keyboard while the Tower Spans dialog is the active dialog. We’ll file a change request on your behalf to see if the development team can add a key-in to support this functionality.

  2. DavidSTL says:

    I’m not understanding the usage of Classify Using Brush. I would like to set a keyin to use a brush FROM classes 3-5 TO another class.

    Example:
    Classify Using Brush from=3-5/to=1

    I’ve also tried (among other variations)
    Classify Using Brush class=3-5/to=1
    Classify Using Brush from=3,4,5/to=1

    From documentation:
    Source class(es). Use from=999 or from=any to classify any visible points. Separate several source classes by a comma or minus, for example class=1,3-5.

    Is this to imply that with multiple FROM classes that you do not use the “FROM” command?
    In any case, it seems whatever combination I try, I can only get it to set a single class when using a keyin. I can select multiple classes in the dialog if I do it manually.

    So I’m not sure if it is a bug, a typo, or am I using it wrong? Thanks

  3. DavidSTL says:

    Thanks for the list of commands.

    For the SCAN DISPLAY command:
    I would like an option for this to refresh the display mode dialog.

    The ability to use KEY-IN to change display modes is great; but it is confusing when the dialog is showing different values than what is actually on the display. If we could close/reopen dialog through a keyin, I believe that would work.

Leave a Reply