ShortestPathFinder

Network

Lines defining the network in which to find a path or paths. Input line features must be a topologically noded network with features connecting at line ends only. That is, all features must be split at junctions.

From-To

The From-To line contains vertices that define the source and destination nodes in the network. It can contain intermediate stops before the final destination. For example, a From-To line may be used to find the path from A to B to C to D. This can also be read as “the path from A to D that also passes through B and C.” From-To lines can be created by connecting points together to form a line, using the LineBuilder or VertexCreator transformers.

Note Intermediate stops on a From-To line need to exactly match an existing node in the network features. To help with this you might use the Chopper transformer (to chop the network into 2-point lines) or the AnchoredSnapper transformer (to snap the intermediate points onto the network).

Path

For each From-To line, if a path is found it will be output as a single feature through the Path port. This output feature contains the attributes and coordinate system of the original From-To line. The geometry of the output feature is made up of all the parts of network that form the shortest path. Note that if Cost Type is set to By One Attribute or By Two Attributes then the “shortest path” is the one where the sum of the values of the applicable Cost Attribute values is the least.

The total cost of the found path is given by the _total_cost attribute.

NoPath

If a path is not found for a given From-To line, then this From-To line will be output through the NoPath port.

Unused

All network features that are not used as part of the shortest path are output through the Unused port.

From-To

Input From-To lines are output through this port. If Reorder From-To Line is Intermediate Points Only or All Points, a _reordered attribute is added indicating whether the From-To line was reordered.

All non-linear features from either input port are output through the <Rejected> port, as are any From-To lines that have a negative cost (when Cost Type is set to By One Attribute or By Two Attributes).

Rejected features will have an fme_rejection_code attribute with one of the following values:

INVALID_DESTINATION_GEOMETRY_TYPE
INVALID_LINE_GEOMETRY_TYPE
INVALID_PARAMETER_WEIGHT

Group Processing

Group By

The default behavior is to use the entire set of input features as the group. This option allows you to select attributes that define which groups to form. You can select attributes from both Network and From-To input features.

Complete Groups

Select the point in processing at which groups are processed:

When All Features Received	This is the default behavior. Processing will only occur in this transformer once all input is present.
When Group Changes (Advanced)	This transformer will process input groups in order. Changes of the value of the Group By parameter on the input stream will trigger processing on the currently accumulating group. This may improve overall speed (particularly with multiple, equally-sized groups), but could cause undesired behavior if input groups are not truly ordered.

General

Dimension

Select the type of coordinates to use when identifying topological connections:

2D: Use x and y coordinates only, ignoring z.
3D: Use x, y and z coordinates.

Cost Type

The values that result from Cost Type are summed for all input lines as they relate to the From-To line, and the shortest sum becomes the shortest-found path. Select a type:

By Length	The cost of each input line is set to the length of the line. Orientation of the line is not considered.
By Length (Forward Only)	The cost of each input line is set to the length of the line. The algorithm considers only the original orientation of the lines when finding the shortest path.
By One Attribute	The cost of each input line is specified by Forward Cost Attribute. The algorithm considers only the original orientation of the lines when finding the shortest path.
By Two Attributes	The shortest path algorithm will consider both directions of the input lines. The original orientation of the input line has the cost specified by Forward Cost Attribute and the reversed orientation of the input line has the cost specified by Reverse Cost Attribute.
By Straight Line Distance (No Network)	Cost is calculated as the straight line distance between vertices in the From-To line. When using this option, the Reorder From-To Line parameter should be set to Intermediate Points Only or All Points.

Forward Cost Attribute

This parameter is used when Cost Type is set to By One Attribute or By Two Attributes.

Reverse Cost Attribute

This parameter is used when Cost Type is set to By Two Attributes.

Allow U-Turns

Whether to allow the reverse of a line in the network to be used immediately following that line. If No, paths that reverse on each other are not considered when finding a shortest path.

Segment Attribute List

When specified, this attribute list that will hold the attributes for each input Network feature that make up Path output features.

This list also contains a _direction attribute that stores the direction of the segment of the shortest path as compared to its original Network feature. It will either be “same” or “opposite”, depending if the original Network feature had to be reversed or not.

Attribute Accumulation

Generate List

When enabled, adds a list attribute to the output features.

Segment Attribute List

Enter a name for the list attribute.

Note List attributes are not accessible from the output schema in FME Workbench unless they are first processed using a transformer that operates on them, such as ListExploder or ListConcatenator. Alternatively, AttributeExposer can be used.

Add To List

All Attributes: All attributes will be added to the output features.

Selected Attributes: Enables the Selected Attributes parameter, where specific attributes may be chosen for inclusion.

Selected Attributes

Enabled when Add To List is set to Selected Attributes. Specify the attributes you wish to be included.

Snap

From-To and Network Snapping

Select Yes to snap the points of the From-To line to the closest end points of the Network lines. The points are only snapped to the network lines if they are within the tolerance specified in Snapping Tolerance.

Note The shortest distance is calculated based on the specified From-To line and is not affected by snapping.

Snapping Tolerance

The tolerance used when From-To and Network Snapping is set to Yes. Points of the From-To line will be snapped to the Network lines if they are within this tolerance.

See Geometry Concepts > Tolerance.

Optimization

Reorder From-To Line

Specifies whether the points of the input From-To line should be reordered to find a shorter path. This option is useful when the order of points of the From-To line is not important, such as in traveling salesman problems. A metaheuristic is used to find a low-cost ordering of points.

No: The input From-To line is used as-is. No optimization occurs.

Automatic: The input From-To line is reordered automatically, without the need to adjust parameters per dataset. This mode attempts to produce a good result in a short amount of time, but may not work well for all datasets. For datasets with cost values that differ by less than one unit, use Advanced mode.

Advanced: The input From-To line is reordered according to the Number of Iterations and Completion Conditions parameters. This mode is useful when a specific cost is desired, or for datasets where Automatic mode does not provide a good result.

Reorder Points

Intermediate Points Only: The start and end points of the input From-To line are untouched. Intermediate points are reordered.

All Points Except First: All points except the start point of the input From-To line are reordered.

All Points Except Last: All points except the end point of the input From-To line are reordered.

All Points (Advanced Mode Only): All points of the input From-To line are reordered.

Number of Iterations

The number of times to run each step of the optimization algorithm. The greater the number of iterations, the closer the result will be to the optimal solution. Increasing this parameter increases translation time.

This parameter must be set to a positive integer. The default value is 10000.

Completion Conditions

Finish Optimization	This parameter specifies what criteria should be used when determining whether to finish the optimization or run another round of iterations. Completion conditions are evaluated at the end of each round of iterations. After a single round of iterations: The optimization algorithm will complete the number of steps specified in the Number of Iterations parameter. When all conditions pass: The optimization algorithm will finish when all of the specified completion conditions have passed. When any condition passes: The optimization algorithm will finish when any of the specified completion conditions have passed, regardless of the status of the other conditions.
Number of Verifications	The number of times the optimization algorithm needs to return the same potential result before it is accepted. Setting this parameter to a high value may result in very long translation time or cause the translation to never complete. This parameter must be set to a non-negative integer. A value of 0 specifies that no verifications are required. The default value is 1. Note that if this condition is required, setting a very low value for Optimization Options > Number of Iterations may result in a translation that will not complete, as it decreases the likelihood of repeatedly finding the same potential result
Desired Cost	The greatest cost that will be accepted as valid. Setting this parameter to a low value may cause the translation to never complete. This parameter must be set to a non-negative value. A value of 0 specifies that there is no restriction on the cost that will be accepted. The default value is 0.
Iteration Rounds	The minimum number of times to run the overall optimization algorithm.
Time (minutes)	The minimum number of minutes to run the optimization.
Completion Condition Attribute	When Finish Optimization is When any condition passes, name the attribute to contain the optimization completion condition that was met. Possible values are verifications, cost, rounds, or time.

Advanced

Preserve Feature Order

This parameter controls the order in which features exit a transformer.

When a transformer has more than one output port, features usually exit one port at a time. At times, it may be useful to keep the order that features arrived in, switching from port to port as necessary. This allows feature order to be preserved, though at a potential cost in processing efficiency.

Select a method for feature ordering.

Per Output Port (Default)

Only preserve the input order of features as they occur within the group of features exiting a given output port.

All features exiting an output port retain their ordering relative to each other (within the group), but not relative to features exiting other output ports.

This option is generally the most efficient, where large chunks of features will exit an output port together (taking advantage of bulk mode).

As features exiting different output ports may not be strictly output in the order they arrived, output ordering may be unpredictable.

Across Output Ports

Strictly preserve the input order of features, regardless of which output port they exit. Features will be output singly in the same order they arrived, switching from port to port as necessary. This option is generally less efficient as the processing gains of bulk mode are less likely to apply - however, feature order is predictable.

How to Set Parameter Values

Defining Values

There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters.

Using the Text Editor

The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.

Text Editor

Using the Arithmetic Editor

The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.

Arithmetic Editor

Conditional Values

Set values depending on one or more test conditions that either pass or fail.

Parameter Condition Definition Dialog

Content

Expressions and strings can include a number of functions, characters, parameters, and more.

When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.

Content Types

String Functions	These functions manipulate and format strings.
Special Characters	A set of control characters is available in the Text Editor.
Math Functions	Math functions are available in both editors.
Date/Time Functions	Date and time functions are available in the Text Editor.
Math Operators	These operators are available in the Arithmetic Editor.
FME Feature Functions	These return primarily feature-specific values.
FME Parameters	FME and workspace-specific parameters may be used.
Creating and Modifying User Parameters	Create your own editable parameters.

Dialog Options - Tables

Table Tools

Transformers with table-style parameters have additional tools for populating and manipulating values.

Row Reordering

Enabled once you have clicked on a row item. Choices include:

Add a row
Remove a row
Move current row up one
Move current row down one
Move current row to top
Move current row to bottom

Cut, Copy, and Paste

Enabled once you have clicked on a row item. Choices include:

Cut a row - delete and copy to clipboard
Copy a row to the clipboard
Paste a row from the clipboard

Cut, copy, and paste may be used within a transformer, or between transformers.

Filter

Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output.

Import

Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers.

Reset/Refresh

Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers.

Note: Not all tools are available in all transformers.

ShortestPathFinder

Usage Notes

Configuration

Input Ports

Output Ports

Parameters

Editing Transformer Parameters

FME Community