OriginDestinationCostMatrix

Summary

An ArcPy class for performing an origin destination cost matrix analysis.

Discussion

An origin destination cost matrix analysis allows you to calculate the travel time or distance along a network between a set of origins and a set of destinations.

Learn more about origin destination cost matrix analysis

Learn more about how to perform a network analysis using arcpy.nax

Syntax

OriginDestinationCostMatrix(in_network)

Name	Explanation	Data type
in_network	The network dataset or service that will be used for the network analysis. The argument can be specified using one of the following: The catalog path to the network dataset A network dataset layer object The string name of the network dataset layer A NetworkDataset object The URL for ArcGIS Online or an ArcGIS Enterprise portal configured with standard routing services A dictionary specifying connection information for a routing service on a stand-alone ArcGIS Server site To use a network dataset, the network must have at least one travel mode. To use a portal URL, you must be signed in to the portal with an account that has routing privileges. Learn how to sign in to a portal in Python Learn more about network analysis using routing services When using ArcGIS Online or an ArcGIS Enterprise portal whose routing services are configured using ArcGIS Online as the in_network value, solving the analysis will consume credits and will be subject to certain limits, such as the number of allowed inputs. Learn more about credit consumption and analysis limits in network analysis	String

Properties

Name	Explanation	Data type
accumulateAttributeNames (Read and Write)	A list of cost attributes that will be accumulated during analysis. These accumulated attributes are for reference only; the solver only uses the cost attribute used by the designated travel mode when solving the analysis. The default is an empty list. Setting this property returns an error if the network data source is ArcGIS Online or an ArcGIS Enterprise portal that does not support accumulating attributes.	String
allowAutoRelocate (Read and Write)	Specifies whether inputs with existing network location fields can be automatically relocated at solve time to ensure valid, routable location fields for the analysis. If the value is True, points located on restricted network elements and points affected by barriers will be relocated to the closest routable location. If the value is False, network location fields will be used as is, even if the points are unreachable, and this may cause the solve to fail. Even if the value is False, inputs with no location fields or incomplete location fields will be located at solve time. The default is True. This property affects locating for all input types. To change this property for individual input types, use the setLocateSettingsOverrides method. Learn more about network location fields and how inputs are located on the network Setting this property returns an error if the network data source is ArcGIS Online, an ArcGIS Enterprise portal that does not support using network location fields, or a portal running a version of ArcGIS Enterprise earlier than 11.0.	Boolean
allowSaveLayerFile (Read and Write)	Specifies whether saving the analysis result as a layer file using the saveAsLayerFile method on the result object will be allowed. A value of True indicates that you can save a layer file. A value of False indicates that you cannot save a layer file. The default is True if the analysis references a network dataset and False if it references a portal service. Saving a layer file may slow down the analysis when the analysis references a portal service.	Boolean
defaultDestinationCount (Read and Write)	The maximum number of destinations to find per origin. The default is None, which means to find all destinations. The value set in this property can be overridden on a per-origin basis using the TargetDestinationCount field in the input origins.	Integer
defaultImpedanceCutoff (Read and Write)	The impedance value at which to stop searching for destinations from a given origin. If the travel mode used in the analysis uses a time-based impedance attribute, the defaultImpedanceCutoff is interpreted in the units specified in the timeUnits property. If the travel mode used in the analysis uses a distance-based impedance attribute, the defaultImpedanceCutoff is interpreted in the units specified in the distanceUnits property. If the travel mode's impedance attribute is neither time based nor distance based, the defaultImpedanceCutoff value is interpreted in the units of the impedance attribute. The default is None, which means that no cutoff is applied. The defaultImpedanceCutoff can be overridden on a per-origin basis using the Cutoff field in the input origins.	Double
distanceUnits (Read and Write)	The units that will be used when reporting the travel distance in the analysis output. Regardless of the units of the cost attributes in the network dataset, the output will be transformed to and reported in the units set in this property. The property is returned and set as a member of the DistanceUnits enumeration. The default is DistanceUnits.Kilometers. Caution: The DistanceUnits.Decimeters, DistanceUnits.Centimeters, DistanceUnits.Millimeters, and DistanceUnits.Inches units are not supported when the analysis uses a service as its network data source.	Object
ignoreInvalidLocations (Read and Write)	Specifies whether invalid input locations will be ignored. A value of True indicates that invalid input locations will be ignored so that the analysis will succeed using only valid locations. A value of False indicates that invalid locations will not be ignored and will cause the analysis to fail. Legacy: Routing services based on portals running versions of ArcGIS Enterprise earlier than 10.9 always ignore invalid input locations. The method returns a ValueError exception if you set ignoreInvalidLocations to False and the service does not support this option.	Boolean
lineShapeType (Read and Write)	The type of linear shape that will be generated to represent the output of the analysis. The travel time and distance are calculated along the network; however, the linear output shapes represent the connections calculated between the input points in the analysis rather than the path through the network. The property is returned and set as a member of the LineShapeType enumeration. The default is LineShapeType.StraightLine.	Object
networkDataSource (Read only)	The full catalog path to the network dataset or the URL of the service being used for the analysis.	String
overrides (Read and Write)	Note: This property is for internal use only.	String
searchQuery (Read and Write)	Legacy: This property has been superseded by the searchSources property, which was introduced at ArcGIS Pro 3.0. The searchQuery property continues to work to maintain backward compatibility with existing scripts, but it is recommended you use the searchSources property for new scripts instead. When locating inputs on the network, this property specifies a query to restrict the search to a subset of the features in a source feature class. This is useful if you don't want to find features that may be unsuited for a network location. For example, if you don't want to locate on highway ramps, you can define a query to exclude them. The property value is specified as a list with nested lists, with one entry per network source. Each inner list is composed of two values indicating the name of the network source and the SQL expression used as the query for that source. An empty string, "", indicates no query for a particular source. For example, the value [["Streets", "ROAD_CLASS <> 3"], ["Streets_ND_Junctions", ""]] specifies an SQL expression for the Streets source feature class and no expression for the Streets_ND_Junctions source feature class. If a network source is not included in the list, it is interpreted to have no query. The value [["Streets", "ROAD_CLASS <> 3"]] is equivalent to [["Streets", "ROAD_CLASS <> 3"], ["Streets_ND_Junctions", ""]]. By default, no query is used for any source. Learn more about locating inputs on the network For more information about SQL syntax, see SQL reference for query expressions used in ArcGIS. Setting this property returns an error if the network data source is ArcGIS Online or a portal running a version of ArcGIS Enterprise earlier than 11.0.	List
searchSources (Read and Write)	When locating inputs on the network, this property specifies the list of network sources that will be used, and, optionally, a query to restrict the search to a subset of the features in a source feature class. The default value is to locate on all network sources except system junctions and override junctions created by running the Dissolve Network tool. By default, no query is used for any source. The property value is specified as a list with nested lists, with at most one entry per network source. Each inner list is composed of two values indicating the name of the network source and the SQL expression used as the query for that source. Possible values for the network source component are the string feature class names of edge and junction sources that participate in the network. Sources in the list will be used for locating, and sources not in the list will not. Queries are useful if you don't want to find features that may be unsuited for a network location. For example, if you don't want to locate on highway ramps, you can define a query to exclude them. For the query component, see SQL reference for query expressions used in ArcGIS for correct syntax. An empty string, "", indicates no query for a particular source. For example, the value [["Streets", "ROAD_CLASS <> 3"], ["Streets_ND_Junctions", ""]] specifies that inputs can be located on both the Streets and Streets_ND_Junctions sources. A SQL expression for the Streets source feature class prohibits inputs from locating on streets where the ROAD_CLASS field has a value of 3. No query is used for the Streets_ND_Junctions source feature class. A value of [["Streets", "ROAD_CLASS <> 3"]] indicates that only the Streets source feature class will be used for locating, and Streets_ND_Junctions will not. Additionally, a query is applied to Streets. This property affects locating for all input types. To change this property for individual input types, use the setLocateSettingsOverrides method. Learn more about locating inputs on the network Setting this property returns an error if the network data source is ArcGIS Online or a portal running a version of ArcGIS Enterprise earlier than 11.0.	String
searchTolerance (Read and Write)	The maximum search distance that will be used when locating the input features on the network. The property is returned and set as a double, and the units of this value are accessed through the searchToleranceUnits property. The default is 5000. This property affects locating for all input types. To change this property for individual input types, use the setLocateSettingsOverrides method. Learn more about locating inputs on the network Legacy: Setting this property returns an error if the network data source is a portal running a version of ArcGIS Enterprise earlier than 11.0.	Double
searchToleranceUnits (Read and Write)	Specifies the units of the searchTolerance property. The property is returned and set as a member of the DistanceUnits enumeration. The default is DistanceUnits.Meters. This property affects locating for all input types. To change this property for individual input types, use the setLocateSettingsOverrides method. Legacy: Setting this property returns an error if the network data source is a portal running a version of ArcGIS Enterprise earlier than 11.0.	Object
timeOfDay (Read and Write)	The date and time of day that will be used for the analysis. The property is specified using a datetime object. For example, to specify that travel should begin at 5:00 p.m. on March 29, 2022, specify the parameter value as datetime.datetime(2022, 3, 29, 17, 0, 0). Instead of using a particular date, a day of the week can be specified using the following dates: Today—12/30/1899 Sunday—12/31/1899 Monday—1/1/1900 Tuesday—1/2/1900 Wednesday—1/3/1900 Thursday—1/4/1900 Friday—1/5/1900 Saturday—1/6/1900 For example, to specify that travel should begin at 5:00 p.m. on Tuesday, specify the parameter value as datetime.datetime(1900, 1, 2, 17, 0, 0). The default is None, which indicates that the analysis will be time neutral. The property will have no impact if the analysis' travel mode's impedance attribute has no time-dependent properties, such as traffic or public transit. Learn more about how dates and times are used and interpreted in a network analysis	DateTime
timeUnits (Read and Write)	Specifies the units that will be used when reporting the travel time in the analysis output. Regardless of the units of the cost attributes in the network dataset, the outputs will be transformed to and reported in the units set in this property. The property is returned and set as a member of the TimeUnits enumeration. The default is TimeUnits.Minutes.	Object
timeZone (Read and Write)	Specifies whether the time specified in the timeOfDay property will be interpreted as the local time at the input locations or as coordinated universal time (UTC). The property is returned and set as a member of the TimeZoneUsage enumeration and is applicable only when the timeOfDay property is not None. The default is TimeZoneUsage.LocalTimeAtLocations.	Object
travelMode (Read and Write)	The travel mode that will be used for the analysis. The value is returned and set as an arcpy.nax.TravelMode object, but it can also be set using the string name of the travel mode or a string containing the valid JSON representation of a travel mode. The default is the default travel mode defined on the network dataset used for the analysis. Learn more about travel modes	Object

Methods

addFields(input_type, field_description[field_description,...])

Adds custom fields to the designated input class. These fields will be included in the field mapping dictionary created by the fieldMappings method and will also be available for use with the insertCursor method.

Learn more about using custom fields in analysis inputs

Name	Explanation	Data type
input_type	The type of input to which the fields will be added. Set this parameter using the OriginDestinationCostMatrixInputDataType enumeration.	Object
field_description[field_description,...]	The fields and their properties that will be added to the input class. The value will be constructed as a list of lists with each row containing the following items: Field name—The name of the field that will be added to the input class. Field type—The type of the new field. Field alias—The alternate display name for the field name. Field length—The length of the field being added. This sets the maximum number of allowable characters for each record of the field. This option is only applicable to fields of type text. The default length is 255. Default value—The default value of the field. Available field types are as follows: Field type Description TEXT The field type will be text. Text fields support a string of characters. FLOAT The field type will be float. Float fields support fractional numbers between -3.4E38 and 1.2E38. DOUBLE The field type will be double. Double fields support fractional numbers between -2.2E308 and 1.8E308. SHORT The field type will be short. Short fields support whole numbers between -32,768 and 32,767. LONG The field type will be long. Long fields support whole numbers between -2,147,483,648 and 2,147,483,647. DATE The field type will be date. Date fields support date and time values. GUID The field type will be GUID. GUID fields store registry-style strings consisting of 36 characters enclosed in curly brackets. BIGINTEGER The field type will be big integer. Big integer fields support whole numbers between -(253) and 253. TIMEONLY The field type will be time only. Time only fields support time values with no date values. DATEONLY The field type will be date only. Date only fields support date values with no time values. TIMESTAMPOFFSET The field type will be timestamp offset. Timestamp offset fields support a date, time, and offset from a UTC value. Only the field name and type are required. Use None as a place holder for any of the other parameters to accept the default or if the parameter does not apply to the specified field type. The method will return an error if the field already exists in the table or if any of the field properties are invalid. Legacy: The GUID, BIGINTEGER, TIMEONLY, DATEONLY, and TIMESTAMPOFFSET field types are not supported when the network data source is a portal running ArcGIS Enterprise 11.1.x or earlier.	TEXT

count(input_type)

Returns the number of rows added for an input type.

Name	Explanation	Data type
input_type	The type of input features to count. Set this parameter using the OriginDestinationCostMatrixInputDataType enumeration.	Object

Return value

Data type	Explanation
Integer	The number of rows.

fieldMappings(input_type, {use_location_fields}, {list_candidate_fields[list_candidate_fields,...]})

Generates an NAClassFieldMappings dictionary that maps the field names of the input type to arcpy.nax.NAClassFieldMap objects that allow you to map fields from the input data to the properties of the solver. The dictionary can be used as input to the field_mappings argument of the load method.

Learn more about how to use field mappings when loading inputs

Name	Explanation	Data type
input_type	The type of input for which the field mappings will be returned. Set this parameter using the OriginDestinationCostMatrixInputDataType enumeration. Learn more about the fields available for each input type	Object
use_location_fields (Optional)	Specifies whether network location fields will be included in the returned field mappings dictionary. Network location fields describe the point on the network where an object is located. You can use network location fields to more precisely control how analysis inputs locate on the network and to save time when calling the solve method because the solver will not have to calculate the location fields from the geometry of the inputs. You can calculate location fields for a feature class using the Calculate Locations tool. Learn more about network location fields and how inputs are located on the network When this argument is set to True, the returned field mappings dictionary will include network location fields. The default is False, which means the field mapping dictionary will not include network location fields. The default value is False.	Boolean
list_candidate_fields[list_candidate_fields,...] (Optional)	Use this parameter to map additional, nondefault fields from the input data to the analysis inputs. For example, if the input feature class contains a field named MyField, and you want it to be included in the analysis inputs, pass the MyField field object to the list_candidate_fields parameter. MyField will be included in the returned field mapping dictionary and automatically mapped. When you call the load method using these field mappings, MyField will be included in the analysis inputs along with all the default fields. In many cases, these extra fields will be passed to the analysis output as well. Specify this parameter as a list of arcpy.Field objects, which can be obtained from a specified feature class or table using the arcpy.ListFields function. Learn more about best practices for setting up analysis inputs Legacy: If the network data source is an ArcGIS Enterprise portal, the method will return an error if any of the fields specified are of a type that is not supported by the portal version. The default value is None.	Field

Return value

Data type	Explanation
Dictionary	An NAClassFieldMappings dictionary in which the keys are the field names and the values are arcpy.nax.NAClassFieldMap objects.

fieldNames(input_type, {use_location_fields})

Get a list of field names supported by the specified input type.

Name	Explanation	Data type
input_type	The type of input for which the supported field names are returned. Set this parameter using the OriginDestinationCostMatrixInputDataType enumeration. Learn more about the fields available for each input type	Object
use_location_fields (Optional)	Indicates whether network location fields will be included in the returned list of field names. Network location fields describe the point on the network where an object is located. You can use network location fields to more precisely control how your analysis inputs locate on the network and to save time when calling the solve method because the solver will not have to calculate the location fields from the geometry of the inputs. You can calculate location fields for a feature class using the Calculate Locations tool. Learn more about network location fields and how inputs are located on the network When this argument is set to True, the returned list of field names will contain network location fields. The default is False; the list of field names will not include network location fields. The default value is False.	Boolean

Return value

Data type	Explanation
String	A list of field names supported by the specified input type.

insertCursor(input_type, field_names[field_names,...], {append})

Establishes a write cursor on the specified input type. This cursor can be used to add rows directly to the input.

Learn more about how to insert inputs

Name	Explanation	Data type
input_type	The type of input into which the cursor can be used to insert rows. Set this parameter using the OriginDestinationCostMatrixInputDataType enumeration.	Object
field_names[field_names,...]	A list of field names of the input type whose values you want to set when inserting rows using the cursor. You can get the names of the fields supported by an input type using the fieldNames method. Learn more about the fields available for each input type In addition to regular fields, you can also set the geometry of the input using one of the following geometry tokens: SHAPE@XY—A tuple of the feature's centroid x,y coordinates. SHAPE@XYZ—A tuple of the feature's centroid x,y,z coordinates. SHAPE@JSON—The Esri JSON string representing the geometry. SHAPE@WKB—The well-known binary (WKB) representation for OGC geometry. It provides a portable representation of a geometry value as a contiguous stream of bytes. SHAPE@WKT—The well-known text (WKT) representation for OGC geometry. It provides a portable representation of a geometry value as a text string. SHAPE@—A geometry object for the feature. The SHAPE@XY and SHAPE@XYZ tokens are only supported for point-based input types. When using the SHAPE@XY and SHAPE@XYZ tokens, specify the x-, y-, and z-values in the spatial reference of the network data source being used in the analysis.	String
append (Optional)	Specifies whether the features being inserted will be appended to the existing set of features for the input type. A value of True indicates that the new features will be appended; the existing features will be preserved. This is the default. A value of False indicates that any existing features for the input type will be deleted and replaced with the features being inserted. The default value is True.	Boolean

Return value

Data type	Explanation
Object	A SolverInsertCursor object that can be used to write features.

load(input_type, features, {field_mappings}, {append}, {max_features})

Sets input features to use for the analysis.

Learn more about how to load inputs

Name	Explanation	Data type
input_type	The type of input feature that will be loaded. Set this parameter using the OriginDestinationCostMatrixInputDataType enumeration.	Object
features	The input features that will be loaded. This parameter accepts the following input types: The catalog path to a feature class or a table A Layer object The string representing the name of a layer A FeatureSet or RecordSet object For layer inputs, only selected features will be loaded. If a layer has a definition query, only the subset of features visible with the definition query will be loaded. The method also honors the Extent geoprocessing environment; only features in the specified extent will be loaded.	String
field_mappings (Optional)	An NAClassFieldMappings dictionary that maps the field names of the input type to arcpy.nax.NAClassFieldMap objects representing the mapping of fields from the input features. Valid input for this parameter can be constructed using the fieldMappings method. If no field mappings are specified, all fields from the input features that have the same name as the supported fields for the input type will be mapped. Learn more about the fields available for each input type The default value is None.	Dictionary
append (Optional)	Specifies whether the features being loaded will be appended to the existing set of features for the input type. A value of True indicates that the new features will be appended, and existing features will be preserved. This is useful when loading inputs from multiple feature classes or tables to use in a single analysis. This is the default. A value of False indicates that any existing features for the input type will be deleted and replaced with the features currently being loaded. The default value is True.	Boolean
max_features (Optional)	The maximum number of features that can be loaded into the input type. This is useful if you are creating a tool or service and want an error returned if the size of the input exceeds the available resources. The load method will return an arcpy.nax.LimitError if the number of input features exceeds the max_features limit. If no value is provided, no limit will be enforced for the count of the input features. The default value is None.	Integer

setLocateSettingsOverrides(input_type, {search_sources[[Source, Expression],...]}, {allow_auto_relocate}, {search_tolerance}, {search_tolerance_units})

Set locate settings for a designated input class, overriding the default locate settings specified for the analysis. This is useful if you want to use different rules to locate different inputs. For example, in an OD cost matrix analysis, you can use a search query that applies to the input origins only, if that query should not apply to the input destinations and barriers.

Using this method, you can override the values of the searchSources, allowAutoRelocate, searchTolerance, and searchToleranceUnits properties for the designated input class.

Learn more about locating inputs on the network

Name	Explanation	Data type
input_type	The type of input for which to override default locate settings. Set this parameter using the OriginDestinationCostMatrixInputDataType enumeration.	Object
search_sources[[Source, Expression],...] (Optional)	The list of network sources to be used when locating inputs of the designated type on the network, and, optionally, a query to restrict the search to a subset of the features within a source feature class. See the documentation for the searchSources property for examples of proper syntax for this parameter. Specifying a value for this parameter overrides the default searchSources property value for the designated input type. If this parameter is not specified or is set to None, the searchSources value will be used for this input type. The method returns an error if this parameter is used and the network data source is ArcGIS Online.	String
allow_auto_relocate (Optional)	Specifies whether inputs of the designated type with existing network location fields can be automatically relocated at solve time to ensure valid, routable location fields for the analysis. If the value is True, points located on restricted network elements and points affected by barriers will be relocated to the closest routable location. If the value is False, network location fields will be used as is, even if the points are unreachable, and this may cause the solve to fail. Even if the value is False, inputs with no location fields or incomplete location fields will be located at solve time. Specifying a value for this parameter overrides the default allowAutoRelocate property value for the designated input type. If this parameter is not specified or is set to None, the allowAutoRelocate value will be used for this input type. The method returns an error if the network data source is ArcGIS Online. The method returns an error if the network data source is an ArcGIS Enterprise portal that does not support using network location fields.	Boolean
search_tolerance (Optional)	The maximum search distance to use when locating inputs of the designated type on the network. Specifying a value for this parameter overrides the default searchTolerance property value for the designated input type. If this parameter is not specified or is set to None, the searchTolerance value will be used for this input type. The units of this parameter value are set using the search_tolerance_units parameter; however, if no value is set for that parameter, the search_tolerance value will be interpreted in the units specified in the searchToleranceUnits property. This parameter does not apply to line and polygon barriers; the method will return an error if this parameter is specified when the input_type value is one of these barrier types.	Double
search_tolerance_units (Optional)	The units of the maximum search distance when locating inputs of the designated type of the network. The parameter is specified using a member of the DistanceUnits enumeration. Specifying a value for this parameter overrides the default searchToleranceUnits property value for the designated input type. If this parameter is not specified or is set to None, the searchToleranceUnits will be used for this input type. The value specified using the search_tolerance parameter is interpreted using these units. If that parameter is not specified, the value of the searchTolerance property will be interpreted using these units for the designated input type only. This parameter does not apply to line and polygon barriers; the method will return an error if this parameter is specified when the input_type value is one of these barrier types.	Double

solve()

Perform the origin destination cost matrix analysis using the properties set on the OriginDestinationCostMatrix object and the loaded inputs.

Return value

Data type	Explanation
Object	An arcpy.nax.OriginDestinationCostMatrixResult object that can be used to access outputs and solver messages.

Code sample

OriginDestinationCostMatrix example

Perform an origin destination cost matrix analysis.

# An example showing how to perform origin destination cost matrix analysis using inputs from feature classes.
import arcpy

nds = "C:/data/NorthAmerica.gdb/Routing/Routing_ND"
nd_layer_name = "Routing_ND"
input_origins = "C:/data/io.gdb/Origins"
input_destinations = "C:/data/io.gdb/Destinations"
output_lines = "C:/data/io.gdb/ODCostMatrixLines"

# Create a network dataset layer and get the desired travel mode for analysis
arcpy.nax.MakeNetworkDatasetLayer(nds, nd_layer_name)
nd_travel_modes = arcpy.nax.GetTravelModes(nd_layer_name)
travel_mode = nd_travel_modes["Driving Time"]

# Instantiate a OriginDestinationCostMatrix solver object
odcm = arcpy.nax.OriginDestinationCostMatrix(nd_layer_name)
# Set properties
odcm.travelMode = travel_mode
odcm.timeUnits = arcpy.nax.TimeUnits.Minutes
odcm.defaultImpedanceCutoff = 15
odcm.defaultDestinationCount = 5
odcm.lineShapeType = arcpy.nax.LineShapeType.NoLine
# Load inputs
odcm.load(arcpy.nax.OriginDestinationCostMatrixInputDataType.Origins, input_origins)
odcm.load(arcpy.nax.OriginDestinationCostMatrixInputDataType.Destinations, input_destinations)
# Solve the analysis
result = odcm.solve()

# Export the results to a feature class
if result.solveSucceeded:
    result.export(arcpy.nax.OriginDestinationCostMatrixOutputDataType.Lines, output_lines)
else:
    print("Solve failed")
    print(result.solverMessages(arcpy.nax.MessageSeverity.All))