Travel - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum OnDemand
Spectrum > Spatial > Spectrum Spatial Analyst
Spectrum > Geocoding > Enterprise Tax
Spectrum > Spatial > Spectrum Spatial
Enterprise Geocoding
Spectrum > Dataflow Designer
Spectrum > Discovery
Spectrum > Quality > Addressing
Spectrum > Web Services
Spectrum > Spectrum Platform
Spectrum > Quality > Context Graph
Spectrum > Quality > Spectrum Quality
Spectrum > Spatial > Spectrum Spatial Insights
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
ft:lastEdition
2024-06-03
ft:lastPublication
2024-06-03T16:02:19.077100

Travel options specify assumptions to make about travel speed off network roads and whether to use only major roads when calculating the travel boundary. Most travel options have to do with ambient speed.

Table 1. GetTravelBoundary Travel Options

Parameter

Description

Option.MaximumOffRoadDistance

Specifies the maximum distance to allow travel off the road network. Examples of off-network roads include driveways and access roads. For example, if you specify a maximum off road distance of 1 mile the travel boundary will extend no further than one mile from the network road. If you specify a value of 0 the travel boundary will not extend beyond the road itself. Use the ambient speed options to specify the speed of travel along non-network roads.

Option.Units

The units of measure in which you want the data returned. One of the following:

  • Kilometer (default)
  • Meter
  • Mile

Option.MajorRoads

Specifies whether to include all roads in the calculation or just major roads. By default, the Get Travel Boundary is calculated with major roads set to true. This improves performance but the accuracy may decrease.

This map represents a travel boundary with travel allowed on all roads:

This map represents a travel boundary with travel restricted to major roads only:

One of the following:

Y
Include only major roads in the calculation. Default.
N
Include all roads in the calculation.

Option.DefaultAmbientSpeed

Specifies the speed to travel when going off a network road to find the travel boundary. Examples of off-network travel include driveways and access roads.

This option is available only when you specify a time value in the Option.DefaultCostUnits parameter or the Data.TravelBoundaryCostUnits parameter. The default is 15. Specify the speed units in the Option.AmbientSpeedUnit parameter.

To control how off-network travel is used in the travel boundary calculation, you need to specify the speed of travel off the road network (the ambient speed). Ambient speed can affect the size and shape of the travel boundary polygon. In general, the faster the ambient speed, the larger the polygon. For example, if you were at a point with 5 minutes left, and if the ambient speed were 15 miles per hour, boundary points would be put at a distance of 1.25 miles. If the ambient speed were reduced to 10 miles per hour, boundary points would be put at a distance of 0.83 miles. Note that you can limit the distance allowed off a network road by using the Option.MaximumOffRoadDistance parameter.

Note: If you are calculating pedestrian travel boundaries we recommend that you change the default ambient speed to 3 MPH (5 KPH).

Option.AmbientSpeedUnit

The unit of measure to use with the value specified in the Option.DefaultAmbientSpeed parameter.

KPH
Kilometers per hour.
MPH
MILES per hour. Default.
MTPS
Meters per second.
MTPM
Meters per minute.

Option.AmbientSpeed.RoadType.<Type>

Specifies the ambient speed to use for off-network travel based on the road type. If you do not specify an ambient speed for a road type, the default ambient speed will be used, as specified in the Option.DefaultAmbientSpeed parameter.

The following map shows an example of a travel boundary without ambient speed overrides: