-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathLargeNetworkAnalysisTools.SolveLargeODCostMatrix.pyt.xml
2 lines (2 loc) · 14.2 KB
/
LargeNetworkAnalysisTools.SolveLargeODCostMatrix.pyt.xml
1
2
<?xml version="1.0"?>
<metadata xml:lang="en"><Esri><CreaDate>20210326</CreaDate><CreaTime>13454300</CreaTime><ArcGISFormat>1.0</ArcGISFormat><SyncOnce>TRUE</SyncOnce><ModDate>20230525</ModDate><ModTime>8564700</ModTime><scaleRange><minScale>150000000</minScale><maxScale>5000</maxScale></scaleRange><ArcGISProfile>ItemDescription</ArcGISProfile></Esri><tool name="SolveLargeODCostMatrix" displayname="Solve Large OD Cost Matrix" 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><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>The feature class or layer containing the origins.</SPAN></P></DIV></DIV></DIV></dialogReference></param><param name="Destinations" displayname="Destinations" type="Required" direction="Input" datatype="Feature Layer" expression="Destinations"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>The feature class or layer containing the destinations.</SPAN></P></DIV></DIV></DIV></dialogReference></param><param name="Network_Data_Source" displayname="Network Data Source" type="Required" direction="Input" datatype="Network Data Source" expression="Network_Data_Source"><dialogReference><DIV STYLE="text-align:Left;"><DIV><P><SPAN>Network dataset, network dataset layer, or portal URL to use when calculating the OD Cost Matrix.</SPAN></P></DIV></DIV></dialogReference></param><param name="Travel_Mode" displayname="Travel Mode" type="Required" direction="Input" datatype="Network Travel Mode" expression="Travel_Mode"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Network travel mode to use when calculating the OD Cost Matrix</SPAN></P></DIV></DIV></DIV></dialogReference></param><param name="Time_Units" displayname="Time Units" type="Required" direction="Input" datatype="String" expression="Minutes | Days | Hours | Seconds"><dialogReference><DIV STYLE="text-align:Left;"><DIV><P><SPAN>The time units the output Total_Time field will be reported in.</SPAN></P></DIV></DIV></dialogReference></param><param name="Distance_Units" displayname="Distance Units" type="Required" direction="Input" datatype="String" expression="Miles | Kilometers | Meters | Yards | Feet | NauticalMiles"><dialogReference><DIV STYLE="text-align:Left;"><DIV><P><SPAN>The distance units the output Total_Distance field will be reported in.</SPAN></P></DIV></DIV></dialogReference></param><param name="Max_Inputs_Per_Chunk" displayname="Maximum Origins and Destinations per Chunk" type="Required" direction="Input" datatype="Long" expression="Max_Inputs_Per_Chunk"><dialogReference><DIV STYLE="text-align:Left;"><DIV><P><SPAN>Defines the chunk size for parallel OD Cost Matrix calculations. For example, if you want to process a maximum of 1000 origins and 1000 destinations in a single chunk, set this parameter to 1000.</SPAN></P></DIV></DIV></dialogReference></param><param name="Max_Processes" displayname="Maximum Number of Parallel Processes" type="Required" direction="Input" datatype="Long" expression="Max_Processes"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Defines the maximum number of parallel processes to run at once. Do not exceed the number of logical processors of your machine.</SPAN></P></DIV></DIV></DIV></dialogReference></param><param name="Output_Updated_Origins" displayname="Output Updated Origins" type="Required" direction="Output" datatype="Feature Class" expression="Output_Updated_Origins"><dialogReference><DIV STYLE="text-align:Left;"><DIV><P><SPAN>Path to the output feature class that will contain the updated origins, which may be spatially sorted and have added fields. The OriginOID field in the Output OD Lines Feature Class refers to the ObjectID of the Output Updated Origins and not the original input origins.</SPAN></P></DIV></DIV></dialogReference></param><param name="Output_Updated_Destinations" displayname="Output Updated Destinations" type="Required" direction="Output" datatype="Feature Class" expression="Output_Updated_Destinations"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Path to the output feature class that will contain the updated destinations, which may be spatially sorted and have added fields. The DestinationOID field in the Output OD Lines Feature Class refers to the ObjectID of the Output Updated Destinations and not the original input destinations.</SPAN></P></DIV></DIV></DIV></dialogReference></param><param name="Output_Format" displayname="Output OD Cost Matrix Format" type="Required" direction="Input" datatype="String" expression="Feature class | CSV files | Apache Arrow files"><dialogReference><DIV STYLE="text-align:Left;"><DIV><P><SPAN>The desired output format for the OD Cost Matrix Lines. The available choices are:</SPAN></P><UL><LI><P><SPAN>"Feature class" - A single, combined feature class. This option is the slowest to create and will likely fail for extremely large problems.</SPAN></P></LI><LI><P><SPAN>"CSV files" - A set of .csv files. Each file represents the OD Cost Matrix Lines output, without shape geometry, for a chunk of origins and a chunk of destinations, using the naming scheme `ODLines_O_#_#_D_#_#.csv`, where the `#` signs represent the ObjectID ranges of the origins and destinations in the chunk. If you have set a value for the Number of Destinations to Find for Each Origin parameter, you may find some output files using the naming scheme `ODLines_O_#_#.csv` because results from all destinations have been combined into one file.</SPAN></P></LI><LI><P><SPAN>"Apache Arrow files" - A set of Apache Arrow files. Each file represents the OD Cost Matrix Lines output, without shape geometry, for a chunk of origins and a chunk of destinations, using the naming scheme `ODLines_O_#_#_D_#_#.arrow`, where the `#` signs represent the ObjectID ranges of the origins and destinations in the chunk. If you have set a value for the Number of Destinations to Find for Each Origin parameter, you may find some output files using the naming scheme `ODLines_O_#_#.arrow` because results from all destinations have been combined into one file. This option is not available in versions of ArcGIS Pro prior to 2.9 and is not available if the network data source is a service.</SPAN></P></LI></UL></DIV></DIV></dialogReference></param><param name="Output_OD_Lines_Feature_Class" displayname="Output OD Lines Feature Class" type="Optional" direction="Output" datatype="Feature Class" expression="{Output_OD_Lines_Feature_Class}"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Path to the output feature class that will contain the OD Cost Matrix Lines output computed by the tool. The schema of this feature class is described in the </SPAN><A href="https://pro.arcgis.com:443/en/pro-app/latest/arcpy/network-analyst/origindestinationcostmatrix-output-data-types.htm" target="ESRI_SECTION1_9FF9489173C741DD95472F21B5AD8374" STYLE="text-decoration:underline;"><SPAN>arcpy documentation</SPAN></A><SPAN>.</SPAN></P></DIV></DIV></DIV></dialogReference></param><param name="Output_Folder" displayname="Output Folder" type="Optional" direction="Output" datatype="Folder" expression="{Output_Folder}"><dialogReference><DIV STYLE="text-align:Left;"><DIV><P><SPAN>Path to a folder, which will be created by the tool, that will contain the CSV or Arrow files representing the OD Cost Matrix Lines results if the Output OD Cost Matrix Format parameter value is "CSV files" or "Apache Arrow files". The schema of the files is described in the </SPAN><A href="https://pro.arcgis.com:443/en/pro-app/latest/arcpy/network-analyst/origindestinationcostmatrix-output-data-types.htm" target="ESRI_SECTION1_9FF9489173C741DD95472F21B5AD8374" STYLE="text-decoration:underline;"><SPAN>arcpy documentation</SPAN></A><SPAN>.</SPAN></P></DIV></DIV></dialogReference></param><param name="Cutoff" displayname="Cutoff" type="Optional" direction="Input" datatype="Double" expression="{Cutoff}"><dialogReference><DIV STYLE="text-align:Left;"><DIV><P><SPAN>Impedance cutoff limiting the search distance for each origin. For example, you could set up the problem to find only destinations within a 15 minute drive time of the origins. This parameter is optional. Leaving it blank uses no cutoff.</SPAN></P><UL><LI><P><SPAN> If your travel mode has time-based impedance units, Cutoff represents a time and is interpreted in the units specified in the Time Units parameter.</SPAN></P></LI><LI><P><SPAN> If your travel mode has distance-based impedance units, Cutoff represents a distance and is interpreted in the units specified in the Distance Units parameter.</SPAN></P></LI><LI><P><SPAN> If your travel mode has other units (not time- or distance-based), Cutoff should be specified in the units of your travel mode's impedance attribute.</SPAN></P></LI></UL></DIV></DIV></dialogReference></param><param name="Num_Destinations" displayname="Number of Destinations to Find for Each Origin" type="Optional" direction="Input" datatype="Long" expression="{Num_Destinations}"><dialogReference><DIV STYLE="text-align:Left;"><DIV><P><SPAN>The number of destinations to find for each origin. For example, setting this to 3 will result in the output including the travel time and distance from each origin to its three closest destinations. This parameter is optional. Leaving it blank results in finding the travel time and distance from each origin to all destinations.</SPAN></P></DIV></DIV></dialogReference></param><param name="Time_Of_Day" displayname="Time of Day" type="Optional" direction="Input" datatype="Date" expression="{Time_Of_Day}"><dialogReference><DIV STYLE="text-align:Left;"><DIV><P><SPAN>The start time of day for the analysis. No value indicates a time neutral analysis.</SPAN></P></DIV></DIV></dialogReference></param><param name="Barriers" displayname="Barriers" type="Optional" direction="Input" datatype="Multiple Value" expression="{Barriers;Barriers...}"><dialogReference><DIV STYLE="text-align:Left;"><DIV><P><SPAN>Point, line, and polygon barriers to use in the OD Cost Matrix analysis.</SPAN></P></DIV></DIV></dialogReference></param><param name="Precalculate_Network_Locations" displayname="Precalculate Network Locations" type="Optional" direction="Input" datatype="Boolean" expression="{Precalculate_Network_Locations}"><dialogReference><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>When you solve a network analysis, the input points must "locate" on the network used for the analysis. When chunking your inputs to solve in parallel, inputs may be used many times. Rather than calculating the network location fields for each input every time it is used, it is more efficient to calculate all 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 for every situation unless:</SPAN></P><UL><LI><P><SPAN> 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.</SPAN></P></LI><LI><P><SPAN> 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.</SPAN></P></LI></UL></DIV></DIV></DIV></dialogReference></param><param name="Sort_Inputs" displayname="Spatially Sort Inputs" type="Optional" direction="Input" datatype="Boolean" expression="{Sort_Inputs}"><dialogReference><DIV STYLE="text-align:Left;"><DIV><P><SPAN>Whether to spatially sort origins and destinations prior to commencing the parallel solve. Using sorted data will improve the efficiency of the chunking behavior significantly, and it may reduce the number of credits consumed if you're using a service that charges credits. If your input data is already sorted, then sorting is not useful, and you should set this parameter to false. Otherwise, you should set his parameter to true. Note, however, that spatial sorting is only available if you have the Advanced license. Spatial sorting will be skipped automatically if you don't have the necessary license, and the parameter will be hidden in the tool dialog.</SPAN></P></DIV></DIV></dialogReference></param></parameters><summary><DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Sample script tool to solve a large OD Cost Matrix problem by chunking up the data and solving the chunks in parallel.</SPAN></P></DIV></DIV></DIV></summary></tool><dataIdInfo><idCitation><resTitle>Solve Large OD Cost Matrix</resTitle></idCitation><searchKeys><keyword>Network Analyst</keyword><keyword>OD Cost Matrix</keyword><keyword>large</keyword><keyword>origins</keyword><keyword>destinations</keyword></searchKeys></dataIdInfo><distInfo><distributor><distorFormat><formatName>ArcToolbox Tool</formatName></distorFormat></distributor></distInfo><mdHrLv><ScopeCd value="005"/></mdHrLv><mdDateSt Sync="TRUE">20230525</mdDateSt></metadata>