Skip to content

v0.2.50..v0.2.51 changeset ConfigOptions.asciidoc

Garret Voltz edited this page Jan 15, 2020 · 1 revision
diff --git a/conf/core/ConfigOptions.asciidoc b/conf/core/ConfigOptions.asciidoc
index b771cd6..634497c 100644
--- a/conf/core/ConfigOptions.asciidoc
+++ b/conf/core/ConfigOptions.asciidoc
@@ -121,6 +121,14 @@ By default,conflation examines standard OSM tags for address comparisons (see th
 file).  You can expand the tag keys searched by populating this list. From the command line,
 separate list items with a semicolon and surround the entire list in double quotes.
 
+=== address.allow.lenient.house.number.matching
+
+* Data Type: bool
+* Default Value: `true`
+
+If true, conflation that uses address matching will allow house number subletter mismatches for the
+addresses with the same house number.  e.g. when enabled, 23a Elm Street matches 23 Elm Street
+
 === address.tag.keys.file
 
 * Data Type: string
@@ -128,6 +136,29 @@ separate list items with a semicolon and surround the entire list in double quot
 
 Flat file containing tag keys that make up feature address components.
 
+=== address.translate.to.english
+
+* Data Type: bool
+* Default Value: `false`
+
+If true, Hootenanny will attempt to translate to English the value of any tag that is part of an
+address before normalizing it during conflation address matching (note that address normalization
+may involve some form of language translation even when this setting is).  This can have significant
+impact on the runtime performance of conflation when enabled and should only be enabled if the
+source data is known to have non-English addresses.  The configuration option,
+'language.translation.translator', controls which translator is used.
+
+=== address.use.default.language.translation.only
+
+* Data Type: bool
+* Default Value: `true`
+
+If true, conflation using address matching will use only libpostal for translating languages in
+addresses, which occurs during address normalization.  If false, and  address.translate.to.english
+is enabled, POI/Polygon conflation will use additional to English language translation before
+address normalization.  Disable this only if libpostal's language translation is not adequate for
+your language translation needs.
+
 === angle.histogram.extractor.bins
 
 * Data Type: int
@@ -325,6 +356,38 @@ Output location for a bounds file when the `--write-bounds` option is selected f
 
 The portion of the sqrt max of the area that the BufferedOverlapExtractor buffers object by.
 
+=== building.address.match.enabled
+
+* Data Type: bool
+* Default Value: `true`
+
+If true, Building Conflation will use building addresses to resolve match conflicts.
+
+=== building.adjoining.tag.score.threshold
+
+* Data Type: double
+* Default Value: `0.8`
+
+The minimum similarity score required for an adjoining building (building=terrace) to be recognized
+during conflation.
+
+=== building.changed.review
+
+* Data Type: bool
+* Default Value: `false`
+
+If enabled, during building merging conflation will look for a "changed" building defined as a
+matched building pair where their Intersection over Union value is greater than zero but falls below
+the value specified in building.changed.review.iou.threshold. If the pair is classified as "changed"
+they will be marked for review.
+
+=== building.changed.review.iou.threshold
+
+* Data Type: double
+* Default Value: `0.2`
+
+See building.changed.review.
+
 === building.date.format
 
 * Data Type: string
@@ -439,8 +502,8 @@ for the reference dataset will be ignored and not added to changeset output.
 * Data Type: long
 * Default Value: `1000`
 
-This is the maximum number of elements to write to an OSM API database in a changeset. This value
-is used when splitting a changeset into smaller pieces.
+This is the maximum number of elements to write to an OSM API database in a changeset push.
+This value is used when splitting a changeset into smaller pieces.
 
 NOTE: This is different to `changeset.max.size` which is the maximum number of elements that the
 database can handle in a single changeset.
@@ -2808,7 +2871,7 @@ The size of the PERTY grid spacing in meters.
 ** `hoot::RandomElementRenamer`
 
 A list of operations that should be applied after the geometries have been shifted by PERTY.
-'hoot info --operators | grep Perty' displays information about the available operations.
+'hoot info --operators | grep Random' displays information about the available operations.
 
 === perty.search.distance
 
@@ -3001,14 +3064,6 @@ See also:
 
  * _Estimate Pairwise Relationships_, <<hootalgo>>
 
-=== poi.polygon.address.allow.lenient.house.number.matching
-
-* Data Type: bool
-* Default Value: `true`
-
-If true, POI/Polygon conflation will allow house number subletter mismatches for the addresses with
-the same house number.  e.g. when enabled, 23a Elm Street matches 23 Elm Street
-
 === poi.polygon.address.match.enabled
 
 * Data Type: bool
@@ -3020,29 +3075,6 @@ conflation runtime performance.  This option is left turned off by default due t
 time required to use libpostal (~5s), which would be wasteful for small datasets known to have no
 addresses in them.  The startup time is incurred only once per Hootenanny command invocation.
 
-=== poi.polygon.address.translate.to.english
-
-* Data Type: bool
-* Default Value: `false`
-
-If true, Hootenanny will attempt to translate to English the value of any tag that is part of an
-address before normalizing it (note that address normalization may involve some form of language
-translation even when this setting is ).  This can have significant impact on the runtime
-performance of conflation when enabled and should only be enabled if the source data is known to
-have non-English addresses.  The configuration option, 'language.translation.translator', controls
-which translator is used.
-
-=== poi.polygon.address.use.default.language.translation.only
-
-* Data Type: bool
-* Default Value: `true`
-
-If true, POI/Polygon conflation will use only libpostal for translating languages in addresses,
-which occurs during address normalization.  If false, and poi.polygon.translate.addresses.to.english
-is enabled, POI/Polygon conflation will use additional to English language translation before
-address normalization.  Disable this only if libpostal's language translation is not adequate for
-your language translation needs.
-
 === poi.polygon.allow.cross.conflation.merging
 
 * Data Type: bool
@@ -3603,6 +3635,15 @@ have negative IDs.  Not honored by all readers.
 
 By default should a reader use the file status from the file. Not honored by all readers.
 
+=== reader.warn.on.zero.version.element
+
+* Data Type: bool
+* Default Value: `false`
+
+If true supporting map readers will log a warning when an element is encountered with a version of
+zero. This is useful to track when deriving changesets where the reference data is expected to be
+pre-existing.
+
 === relation.with.most.members.op.member.criterion
 
 * Data Type: string
Clone this wiki locally