Geocoding Options - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

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

GeocodeAddressUSA Geocoding Options

This table lists the options that control how a location's coordinates are determined.

Parameter Description

Option.AddressPointInterpolation

Specifies whether to perform address point interpolation when an exact match for the address cannot be found in the geocoding database. Address point interpolation is a patented process that results in a more accurate interpolated point. It improves upon regular street segment interpolation by using point data in the interpolation process, as opposed to using street segments alone.

Note: Address point interpolation is only available when using a point-level geocoding database. It is not available when using point addresses in an auxiliary file.
Y
Yes, perform address point interpolation.
N
No, do not perform address point interpolation. Default.

This illustration shows how address point interpolation works. In the example, the input house number is 71. The geocoding database contains address points for 67 and 77. The street segment has a range of 11 to 501. With address point interpolation, GeocodeAddressUSA performs the interpolation for the input house number 71 using the points of 67 and 77. Without address point interpolation, GeocodeAddressUSA performs the interpolation with the street segment end points of 11 and 501, resulting in a far less accurate result.

Option.AlwaysFindCandidates

Specifies whether to enable centerline matching in order to get street centerline information.

Note: Centerline matching requires that a point-level database is installed.
Y
Yes, enable centerline matching. To return centerline data in the output, you must also set Option.OutputRecordType = N.
N
No, do not enable centerline matching. Default.

Option.CenterlineOffset

The offset distance, in feet, used to calculate the street centerline coordinates. Default = 0 feet.

If you specify a value other than 0, GeocodeAddressUSA calculates the street centerline coordinates by offsetting the centerline point by the distance you specify in the direction of the parcel centroid.

In an interpolated match, the centerline offset cannot be greater than the distance from the centerline to the interpolated address point. If you specify a centerline offset distance that is greater than this distance, the offset will be limited to the distance to the interpolated point. In effect, the centerline coordinates would be the same as the coordinates for the interpolated point.

Option.CentroidPreference

Determines the type of centroids returned by the geocoder. A centroid is the center of an area. The centroid coordinates are the average of the sets of coordinates that describe the area.

NoCentroids
Do not return centroids. If an address-level geocode cannot be determined, do not attempt to determine a centroid.
AddressUnavailable
Return a ZIP Code centroid if an address-level geocode cannot be determined (default).
AllCentroids
Return ZIP Code centroids only. If you select this option, address-level geocodes will not be returned.

Option.Dataset

The name of the database resource that contains the data to use in the search process. Use the database name specified in Management Console's Spectrum Databases page.

Option.Datum

Determines the North American Datum to use when geocoding datum on the input value. Datum is the mathematical model of the Earth used to calculate the coordinates on any map, chart, or survey system.

NAD27
This datum does not include the Alaskan Islands or Hawaii. Latitudes and longitudes that are surveyed in the NAD27 system are valid only in reference to NAD27 and are not valid for maps outside the U.S.
NAD83
This datum is earth-centered and defined with satellite and terrestrial data. NAD83 is compatible with the World Geodetic System 1984 (WGS84), which is the terrestrial reference frame associated with the NAVSTAR Global Positioning System (GPS) used extensively for navigation and surveying. Default.

Option.FallbackToGeographic

Specifies whether to attempt to return a city, county, or state centroid when an address-level geocode cannot be determined. The geocoder returns the most precise geographic centroid that it can based on the input. For example, if the input contains a valid city and state, a city centroid would be returned.

Note: There are approximately 300 major cities that can be geocoded to a city centroid level even if a valid state is not provided in the input.

Geographic centroid geocodes are indicated by value in the LocationCode output field that begins with "G". For more information, see Geographic Centroid Location Codes.

Note: This option is not available if you set Option.MatchMode to CASS.
Y
Yes, attempt to determine the geographic centroid when an address-level geocode cannot be determined.
N
No, do not attempt to determine the geographic centroid when an address-level geocode cannot be determined. Default.

Option.FallbackToStreet

Specifies whether to attempt to return a street centroid when an address-level geocode cannot be determined. To determine a street centroid, the geocoder searches the input ZIP Code or city for the closest match. If the geocoder is able to locate the street, it returns a geocode along the matched street segment.

For example, if the input address is 5000 Walnut Street, Boulder 80301, and there is no 5000 Walnut Street, the geocoder searches for the closest match to that address within the ZIP Code 80301. If there were no input ZIP Code, the geocoder would search for the closest match to the input address within Boulder.

If the input address is Walnut Street, Boulder 80301, since there is no house number, the geocoder searches for the street within the input ZIP Code.

Street centroid geocodes are indicated by value in the LocationCode output field that begins with "C". For more information, see Street Centroid Location Codes.

Note: This option is not available if you set Option.MatchMode to CASS.
Y
Yes, attempt to determine the street centroid when an address-level geocode cannot be determined.
N
No, do not attempt to determine the street centroid when an address-level geocode cannot be determined. Default.

Option.FIND_APPROXIMATE_PBKEY

When Option.FIND_APPROXIMATE_PBKEY is enabled, if an address match is not made to Master Location Data (MLD), but to a different dataset, the PreciselyID of the nearest MLD point located within the search distance is returned. To distinguish when a fallback PreciselyID is returned, the PreciselyID return value contains a leading character of "X" rather than "P", for example: X00001XSF1IF. Note, all of the other fields returned for the address match, including the geocode and all associated data, reflect the match results for the input address. The fallback PreciselyID can then be used for the lookup to the GeoEnrichment dataset(s), and the attribute data for the fallback location is returned for the match.

For more information, see PreciselyID Fallback.

Note: This option requires that you have licensed and installed the Master Location Dataset.

The search distance for the nearest MLD point is configurable using the Option.SearchDistance parameterwith an allowable search radius of 0-5280 feet and a default value of 150 feet.

Y
When a matched address does not have an associated PreciselyID, attempt to return the nearest address record's PreciselyID.
N
When a matched address does not have an associated PreciselyID, do not return the nearest address record's PreciselyID. Default.

Option.LatLonFormat

Specifies the format of the latitude/longitude returned by the geocoder.

Decimal
The latitude/longitude is returned in decimal format. Default. For example: 90.000000-180.000000
Integer
The latitude/longitude is returned in integer format. For example: 90000000-180000000

Option.MatchMode

Custom
Allows you to select the specific criteria to use when matching the input address to an address in the postal database.
Exact
Requires a very tight match. This is a restrictive mode that generates the fewest number of match candidates to search, which decreases the time to obtain a match. When using this mode, ensure that your input address list is very clean; free of misspellings and incomplete addresses.
Close
Requires a moderately confident match. Generates a moderate number of match candidates.
Relax
This is the loosest match mode and generates the most match candidates, which increases the processing time and results in more multiple matches. Use this mode if your address list may contain misspellings and incomplete addresses. This mode does not respect the street parity for an address match. Default.
Interactive
Available in single-line address matching only. This mode is designed to better handle the specific matching challenges presented by interactive matching. Interactive mode permits for more flexible matching patterns and may, in some cases, return additional possible matches than relaxed match mode. This mode recognizes and parses two unit numbers on the same address line, for example a building and unit number. This mode does not respect the range parity when making an address match.
CASS
Imposes additional rules to ensure compliance with the USPS regulations for CASS. The purpose of this mode is to create a list of mailable addresses. This mode generates a large number of match candidates. This mode deviates from the other modes in its processing. This mode does not perform intersection, building name, or spatial alias (street name alias) matches. It does not match to candidates from data sources that do not have USPS equivalent records. This mode recognizes and parses two unit numbers on the same address line, for example a building and unit number.

Option.Offset

Specifies the offset distance from the street segments, in feet. The range is 0 to 5280. Default = 50 feet.

The offset distance is used in street-level geocoding to prevent the geocode from being in the middle of a street. It compensates for the fact that street-level geocoding returns a latitude and longitude point in the center of the street where the address is located. Since the building represented by an address is not on the street itself, you do not want the geocode for an address to be a point on the street. Instead, you want the geocode to represent the location of the building which sits next to the street. For example, an offset of 40 feet means that the geocode will represent a point 40 feet back from the center of the street. The distance is calculated perpendicular to the portion of the street segment for the address. Offset is also used to prevent addresses across the street from each other from being given the same point. The diagram below shows an offset point in relation to the original point.

Street coordinates are accurate to 10,000ths of a degree and interpolated points are accurate to the millionths of a degree.

Option.PredictiveLastLine

Specifies whether GeocodeAddressUSA should match using the street address and input latitiude/longitude coordinates, rather than the traditional street address with lastline input.

Y
Enable Predictive Lastline processing.
N
Disable Predictive Lastline processing. Default.

Option.SearchDistance

When the PBKey Fallback option is enabled, this field sets the distance to use when searching for the nearest address record with an associated PreciselyID. The allowable range is 0-5280 feet. Default = 150 feet.
Note: Supported only in forward geocoding.

Option.Squeeze

Specifies the distance, in feet, to move the street segment end points toward the middle of the segment. Squeeze is used in street-level matching. Use the squeeze setting to prevent address points from residing in an intersection or too close to the end of a street.

The range is 0 to 2147483647. Default = 50 feet.

The following diagram compares the end points of a street to squeezed end points.

Squeezing the street segment endpoints affects street-level matching by reducing the length of a street segment, thereby reducing the spacing between address points along the segment. For example, if the length of a street segment is 1,000 feet and there are 10 addresses along the segent, street-level matching would result in each address being spaced 100 feet apart (1,000 ÷ 10). If you were to set a squeeze value of 100 feet, moving each street segment endpoint 100 feet torward the center of the street segment, the length of the street segment would be reduced to 800 feet (reduced by 100 feet on each end). Street-level matching would then result in addresses beging spaced 80 feet apart (800 ÷ 10).