LargeNetworkAnalysisTools.SolveLargeAnalysisWithKnownPairs.pyt.xml

<?xml version="1.0"?>
<metadata xml:lang="en"><Esri><CreaDate>20220401</CreaDate><CreaTime>09541800</CreaTime><ArcGISFormat>1.0</ArcGISFormat><SyncOnce>TRUE</SyncOnce><ModDate>20230106</ModDate><ModTime>9402100</ModTime><scaleRange><minScale>150000000</minScale><maxScale>5000</maxScale></scaleRange><ArcGISProfile>ItemDescription</ArcGISProfile></Esri><tool name="SolveLargeAnalysisWithKnownPairs" displayname="Solve Large Analysis With Known OD Pairs" toolboxalias="LargeNetworkAnalysisTools" xmlns=""><arcToolboxHelpPath>c:\program files\arcgis\pro\Resources\Help\gp</arcToolboxHelpPath><parameters><param name="Origins" displayname="Origins" type="Required" direction="Input" datatype="Feature Layer" expression="Origins"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;The feature class or layer containing the origins.  For the one-to-one Origin-Destination Assignment Type, the origins dataset must have a field populated with the ID of the destination the origin is assigned to.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="Origin_Unique_ID_Field" displayname="Origin Unique ID Field" type="Required" direction="Input" datatype="Field" expression="Origin_Unique_ID_Field"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;A field in origins representing the origin's unique ID.  For the many-to-many Origin-Destination Assignment Type, the values in the Origin-Destination Pair Table's origin ID field must correspond to these unique origin IDs.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="Destinations" displayname="Destinations" type="Required" direction="Input" datatype="Feature Layer" expression="Destinations"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;The feature class or layer containing the destinations.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="Destination_Unique_ID_Field" displayname="Destination Unique ID Field" type="Required" direction="Input" datatype="Field" expression="Destination_Unique_ID_Field"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;P&gt;&lt;SPAN&gt;A field in destinations representing the destination's unique ID.  For the one-to-one Origin-Destination Assignment Type, the values in the origins table's Assigned Destination Field should correspond to these unique destination IDs.  For the many-to-many Origin-Destination Assignment Type, the values in the Origin-Destination Pair Table's destination ID field must correspond to these unique destination IDs.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;</dialogReference></param><param name="OD_Pair_Type" displayname="Origin-Destination Assignment Type" type="Required" direction="Input" datatype="String" expression="A field in Origins defines the assigned Destination (one-to-one) | A separate table defines the origin-destination pairs (many-to-many)"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;P&gt;&lt;SPAN&gt;A text string indicating which type of preassigned origin-destination pairs to use for the analysis.  The options are:&lt;/SPAN&gt;&lt;/P&gt;&lt;UL&gt;&lt;LI&gt;&lt;P&gt;&lt;SPAN&gt;A field in Origins defines the assigned Destination (one-to-one)&lt;/SPAN&gt;&lt;/P&gt;&lt;/LI&gt;&lt;LI&gt;&lt;P&gt;&lt;SPAN&gt;A separate table defines the origin-destination pairs (many-to-many)&lt;/SPAN&gt;&lt;/P&gt;&lt;/LI&gt;&lt;/UL&gt;&lt;/DIV&gt;</dialogReference></param><param name="Assigned_Destination_Field" displayname="Assigned Destination Field" type="Required" direction="Input" datatype="Field" expression="Assigned_Destination_Field"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;P&gt;&lt;SPAN&gt;A field in Origins indicating the ID of the destination each origin is assigned to. Any origin with a null value or a value that does not match a valid destination ID will be ignored in the analysis.  This parameter is only applicable for the one-to-one Origin-Destination Assignment Type.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;</dialogReference></param><param name="OD_Pair_Table" displayname="Origin-Destination Pair Table" type="Required" direction="Input" datatype="Table View" expression="OD_Pair_Table"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;A table or CSV file defining origin-destination pairs. The table must be populated with a column of origin IDs matching values in the Origin Unique ID Field of the Origins table and a column of destination IDs matching values in the Destination Unique ID Field of the Destinations table.  This parameter is only applicable for the many-to-many Origin-Destination Assignment Type.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="Pair_Table_Origin_Unique_ID_Field" displayname="Origin ID Field in Origin-Destination Pair Table" type="Required" direction="Input" datatype="Field" expression="Pair_Table_Origin_Unique_ID_Field"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;The field name in the Origin-Destination Pair Table defining the origin IDs.  This parameter is only applicable for the many-to-many Origin-Destination Assignment Type.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="Pair_Table_Destination_Unique_ID_Field" displayname="Destination ID Field in Origin-Destination Pair Table" type="Required" direction="Input" datatype="Field" expression="Pair_Table_Destination_Unique_ID_Field"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;The field name in the Origin-Destination Pair Table defining the destination IDs.  This parameter is only applicable for the many-to-many Origin-Destination Assignment Type.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="Network_Data_Source" displayname="Network Data Source" type="Required" direction="Input" datatype="Network Data Source" expression="Network_Data_Source"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Network dataset, network dataset layer, or portal URL to use when calculating the Route analysis.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="Travel_Mode" displayname="Travel Mode" type="Required" direction="Input" datatype="Network Travel Mode" expression="Travel_Mode"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Network travel mode to use when calculating the Route analysis.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="Time_Units" displayname="Time Units" type="Required" direction="Input" datatype="String" expression="Minutes | Days | Hours | Seconds"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;The time units the output travel time will be reported in.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="Distance_Units" displayname="Distance Units" type="Required" direction="Input" datatype="String" expression="Miles | Kilometers | Meters | Yards | Feet | NauticalMiles"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;The distance units the output travel distance will be reported in.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="Max_Pairs_Per_Chunk" displayname="Maximum OD Pairs per Chunk" type="Required" direction="Input" datatype="Long" expression="Max_Pairs_Per_Chunk"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Defines the chunk size for parallel Route calculations, the number of origin-destination routes to calculate simultaneously. For example, if you want to process a maximum of 1000 origins and 1000 destinations in a single chunk, for a total of 1000 paired routes, set this parameter to 1000.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="Max_Processes" displayname="Maximum Number of Parallel Processes" type="Required" direction="Input" datatype="Long" expression="Max_Processes"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Defines the maximum number of parallel processes to run at once. Do not exceed the number of logical processors of your machine.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="Output_Routes" displayname="Output Routes" type="Required" direction="Output" datatype="Feature Class" expression="Output_Routes"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Path to the output feature class that will contain the calculated routes between origins and their assigned destinations.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="Time_Of_Day" displayname="Time of Day" type="Optional" direction="Input" datatype="Date" expression="{Time_Of_Day}"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;The start time of day for the analysis. No value indicates a time neutral analysis.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="Barriers" displayname="Barriers" type="Optional" direction="Input" datatype="Multiple Value" expression="{Barriers;Barriers...}"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Point, line, or polygon barriers to use in the OD Cost Matrix analysis. This parameter is optional.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param><param name="Precalculate_Network_Locations" displayname="Precalculate Network Locations" type="Optional" direction="Input" datatype="Boolean" expression="{Precalculate_Network_Locations}"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;P&gt;&lt;SPAN&gt;When you solve a network analysis, the input points must "locate" on the network used for the analysis. If origins and destinations are used more than once, it is more efficient to calculate the network location fields up front and re-use them.  Set this parameter to True to pre-calculate the network location fields. This is recommended unless:&lt;/SPAN&gt;&lt;/P&gt;&lt;UL&gt;&lt;LI&gt;&lt;P&gt;&lt;SPAN&gt;You are using a portal URL as the network data source. In this case, pre-calculating network locations is not possible, and the parameter is hidden.&lt;/SPAN&gt;&lt;/P&gt;&lt;/LI&gt;&lt;LI&gt;&lt;P&gt;&lt;SPAN&gt;You have already pre-calculated the network location fields using the network dataset and travel mode you are using for this analysis. In this case, you can save time by not precalculating them again.&lt;/SPAN&gt;&lt;/P&gt;&lt;/LI&gt;&lt;LI&gt;&lt;P&gt;&lt;SPAN&gt;Each destination has only one assigned origin. In this case, there is no efficiency gain in calculating the location fields in advance.&lt;/SPAN&gt;&lt;/P&gt;&lt;/LI&gt;&lt;/UL&gt;&lt;/DIV&gt;</dialogReference></param><param name="Sort_Origins" displayname="Sort Origins by Assigned Destination" type="Optional" direction="Input" datatype="Boolean" expression="{Sort_Origins}"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;P&gt;&lt;SPAN&gt;A Boolean indicating whether to sort origins by their assigned destination prior to commencing the parallel solve.  Using sorted data will improve the efficiency of the solve slightly.  If your input data is already sorted, or if no origins are assigned to the same destinations, then sorting is not useful, and you should set this parameter to false.  This parameter is only applicable for the one-to-one Origin-Destination Assignment Type.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;</dialogReference></param><param name="Reverse_Direction" displayname="Reverse Direction of Travel" type="Optional" direction="Input" datatype="Boolean" expression="{Reverse_Direction}"><dialogReference>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;A Boolean indicating whether to reverse the direction of travel and calculate the route from the destination to the origin. The default is false.  This parameter is only applicable for the one-to-one Origin-Destination Assignment Type.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</dialogReference></param></parameters><summary>&lt;DIV STYLE="text-align:Left;"&gt;&lt;DIV&gt;&lt;DIV&gt;&lt;P&gt;&lt;SPAN&gt;Calculate the travel time and distance and generate routes between known origin-destination pairs by chunking up the problem and solving in parallel.&lt;/SPAN&gt;&lt;/P&gt;&lt;/DIV&gt;&lt;/DIV&gt;&lt;/DIV&gt;</summary></tool><dataIdInfo><idCitation><resTitle>Solve Large Analysis With Known OD Pairs</resTitle></idCitation><searchKeys><keyword>Route pairs</keyword><keyword>parallel processing</keyword><keyword>OD Cost Matrix</keyword><keyword>Network Analyst</keyword></searchKeys></dataIdInfo><distInfo><distributor><distorFormat><formatName>ArcToolbox Tool</formatName></distorFormat></distributor></distInfo><mdHrLv><ScopeCd value="005"/></mdHrLv><mdDateSt Sync="TRUE">20230106</mdDateSt></metadata>