v0.2.47..v0.2.48 changeset ConfigOptions.asciidoc
Garret Voltz edited this page Sep 27, 2019
·
1 revision
diff --git a/conf/core/ConfigOptions.asciidoc b/conf/core/ConfigOptions.asciidoc
index 3bb23b6..6bf0388 100644
--- a/conf/core/ConfigOptions.asciidoc
+++ b/conf/core/ConfigOptions.asciidoc
@@ -251,6 +251,30 @@ review.score.criterion.max/min.threshold will be removed.
Determines whether the AttributeScoreExtractor uses weighting when extracting scores.
+=== attribute.value.criterion.comparison.type
+
+* Data Type: string
+* Default Value: ``
+
+The value comparison type used by AttributeValueCriterion. Valid values are: NumericEqualTo,
+NumericLessThan, NumericLessThanOrEqualTo, NumericGreaterThan, NumericGreaterThanOrEqualTo,
+TextEqualTo, TextContains, TextStartsWith, or TextEndsWith.
+
+=== attribute.value.criterion.comparison.value
+
+* Data Type: string
+* Default Value: ``
+
+The value to compare with AttributeValueCriterion.
+
+=== attribute.value.criterion.type
+
+* Data Type: string
+* Default Value: ``
+
+The type of attribute to compare with AttributeValueCriterion. Valid key values are: changeset,
+timestamp, user, uid, or version.
+
=== autocorrect.options
* Data Type: bool
@@ -259,6 +283,14 @@ Determines whether the AttributeScoreExtractor uses weighting when extracting sc
Temporary setting that addresses some Hootenanny iD Editor UI bugs. See
MatchFactory::_tempFixDefaults() for more info.
+=== bounds.output.file
+
+* Data Type: string
+* Default Value: `tmp/bounds.osm`
+
+Output location for a bounds file when the `--write-bounds` option is selected for either the
+`changeset-derive`, `convert`, or `crop` commands.
+
=== buffered.overlap.extractor.portion
* Data Type: double
@@ -380,9 +412,9 @@ See also:
* Data Type: bool
* Default Value: `true`
-If true, changesets derived can issue delete statements for the reference dataset (first dataset
-passed to the changeset deriver). If false, no delete statements will be issued for the reference
-dataset.
+If true, changesets derived are allowed to issue delete statements for the reference dataset (first
+dataset passed to the changeset deriver) if calculated. If false, any delete statements calculated
+for the reference dataset will be ignored and not added to changeset output.
=== changeset.apidb.size.max
@@ -418,15 +450,6 @@ another changeset to the OSM API.
The number of seconds after a successful write before submitting another changeset to the OSM API.
-=== changeset.buffer
-
-* Data Type: double
-* Default Value: `0.0`
-
-Value in degrees by which the specified AOI (convert.bounding.box) will be expanded when calculating
-changesets. Setting this too large with some datasets may greatly increase the changeset
-derivation time.
-
=== changeset.description
* Data Type: string
@@ -434,38 +457,6 @@ derivation time.
The text description that is written to the OSM API database with a changeset.
-=== changeset.reference.keep.entire.features.crossing.bounds
-
-* Data Type: bool
-* Default Value: `false`
-
-Overrides crop.keep.entire.features.crossing.bounds for the reference input when deriving
-changesets with a bounds.
-
-=== changeset.secondary.keep.entire.features.crossing.bounds
-
-* Data Type: bool
-* Default Value: `false`
-
-Overrides crop.keep.entire.features.crossing.bounds for the secondary input when deriving
-changesets with a bounds.
-
-=== changeset.reference.keep.only.features.inside.bounds
-
-* Data Type: bool
-* Default Value: `false`
-
-Overrides crop.keep.only.features.inside.bounds for the reference input when deriving
-changesets with a bounds.
-
-=== changeset.secondary.keep.only.features.inside.bounds
-
-* Data Type: bool
-* Default Value: `false`
-
-Overrides crop.keep.only.features.inside.bounds for the secondary input when deriving
-changesets with a bounds.
-
=== changeset.max.size
* Data Type: long
@@ -474,6 +465,14 @@ changesets with a bounds.
The maximum allowed element size of an OSM changeset that can be written to an OSM API database
in a single changeset.
+=== changeset.replacement.allow.deleting.reference.features.outside.bounds
+
+* Data Type: bool
+* Default Value: `true`
+
+If disabled, replacement changesets generated by `changeset-derive-replacement` will never add
+delete statements for reference features falling outside of `convert.bounding.box`.
+
=== changeset.user.id
* Data Type: long
@@ -576,6 +575,7 @@ See also:
** `hoot::SuperfluousWayRemover`
** `hoot::RemoveDuplicateWayNodesVisitor`
** `hoot::RemoveEmptyRelationsOp`
+** `hoot::ApiTagTruncateVisitor`
** `hoot::AddHilbertReviewSortOrderOp`
List of operations to run in the conflate command after data is conflated, but before exporting.
@@ -615,6 +615,16 @@ See also:
The string that lists the types of conflation used in the user interface. The possible values
are: reference, cookieCutter, average, and advancedConflation.
+=== conflate.tag.disable.value.truncation
+
+* Data Type: bool
+* Default Value: `false`
+
+This will disable use of the ApiTagTruncateVisitor, which truncates tag values down to size limit
+acceptable by the OpenStreetMap API, if found in either conflate.pre.ops or conflate.post.ops by
+either the conflate or score-matches commands. Setting this option to true is generally intended for
+testing purposes only.
+
=== conflate.tag.filter
* Data Type: string
@@ -623,6 +633,24 @@ are: reference, cookieCutter, average, and advancedConflation.
A JSON tag filter that is applied to filter features before conflation. See the Hootenanny
User Guide "Feature Filtering" section for filter usage examples.
+=== conflate.use.data.source.ids.1
+
+* Data Type: bool
+* Default Value: `true`
+
+Determines whether the reader used by the conflate command to read the first input dataset will
+use the element ID's specified by the input datasets (true) or use internal ID management for the
+inputs (false).
+
+=== conflate.use.data.source.ids.2
+
+* Data Type: bool
+* Default Value: `false`
+
+Determines whether the reader used by the conflate command to read the second input dataset will
+use the element ID's specified by the input datasets (true) or use internal ID management for the
+inputs (false).
+
=== conflator.min.valid.score
* Data Type: double
@@ -673,6 +701,15 @@ If true, will not break apart features crossing the convert bounds. This is anal
crop.keep.entire.features.crossing.bounds used with the crop command, but used with the convert
command only and kept as a separate option with a different default value.
+=== convert.bounding.box.keep.immediately.connected.ways.outside.bounds
+
+* Data Type: bool
+* Default Value: `false`
+
+If enabled, bounded queries will also return ways that are outside of `convert.bounding.box` but
+immediately connected to ways crossing or within the bounds. Can be used in conjunction with
+`convert.bounding.box.tag.immediately.connected.out.of.bounds.ways`. Not supported by all readers.
+
=== convert.bounding.box.keep.only.features.inside.bounds
* Data Type: bool
@@ -691,6 +728,16 @@ Same as convert.bounding.box but the resultant bounds filtering is only applied
data sources when used with the convert and conflate commands. This setting takes precendence over
the convert.bounding.box setting for OSM API database data sources only.
+=== convert.bounding.box.tag.immediately.connected.out.of.bounds.ways
+
+* Data Type: bool
+* Default Value: `false`
+
+If enabled, all ways that are outside of the bounds specified by convert.bounding.box when
+performing a bounded API database query but are immediately connected to a way that falls within or
+crosses the bounds are tagged with a custom tag. Must be used in conjunction with
+`convert.bounding.box.keep.immediately.connected.ways.outside.bounds`. Not supported by all readers.
+
=== convert.ops
* Data Type: list
@@ -739,7 +786,8 @@ are required. The lower the number, the less accurate it will be.
* Data Type: bool
* Default Value: `false`
-Rounded corners in one dataset can cause non-rounded corners in the secondary dataset to not conflate
+Rounded corners in one dataset can cause non-rounded corners in the secondary dataset to not
+conflate.
=== corner.splitter.rounded.threshold
@@ -1523,6 +1571,22 @@ corresponding implicit tag rules database.
A list of paths to include in the javascript translator search path.
+=== in.bounds.criterion.bounds
+
+* Data Type: string
+* Default Value: ``
+
+The bounding box used by InBoundsCriterion, of the form: minx,miny,maxx,maxy.
+
+=== in.bounds.criterion.strict
+
+* Data Type: bool
+* Default Value: `true`
+
+If true, InBoundsCriterion requires features exist completely within `in.bounds.criterion.bounds`
+in order for the criterion to be satisfied. If false, features that cross the bounds may also
+satisfy the criterion.
+
=== job.id
* Data Type: string
@@ -2996,7 +3060,7 @@ the same house number. e.g. when enabled, 23a Elm Street matches 23 Elm Street
=== poi.polygon.address.match.enabled
* Data Type: bool
-* Default Value: `false`
+* Default Value: `true`
If true, POI/Polygon conflation will compare addresses as one of the criteria for matching features.
If the data being conflated is known to have poor address data, disabling this option may speed up
@@ -3257,6 +3321,15 @@ The threshold at which a review is called a review for PoiPolygon. See
The source tag key to be used in conjunction with poi.polygon.disable.same.source.conflation.
+=== poi.polygon.tag.merger
+
+* Data Type: string
+* Default Value: `hoot::PreserveTypesTagMerger`
+
+The tag merger used by POI/Polygon conflation. See 'tag.merger.default' for more information. If
+'poi.polygon.auto.merge.many.poi.to.one.poly.matches' is set to true then 'PreserveTypesTagMerger'
+is always used.
+
=== poi.polygon.type.score.threshold
* Data Type: double
@@ -3419,24 +3492,6 @@ The number of trees used to train a random forest conflation model.
By default add the `source:datetime` or `source:ingest:datetime` stamp when reading files. Not
honored by all readers.
-=== reader.conflate.use.data.source.ids.1
-
-* Data Type: bool
-* Default Value: `true`
-
-Determines whether the reader used by the conflate command to read the first input dataset will
-use the element ID's specified by the input datasets (true) or use internal ID management for the
-inputs (false).
-
-=== reader.conflate.use.data.source.ids.2
-
-* Data Type: bool
-* Default Value: `false`
-
-Determines whether the reader used by the conflate command to read the second input dataset will
-use the element ID's specified by the input datasets (true) or use internal ID management for the
-inputs (false).
-
=== reader.keep.status.tag
* Data Type: bool
@@ -3766,7 +3821,7 @@ waterway.auto.calc.search.radius = true. See `search.radius.default`.
* Data Type: bool
* Default Value: `false`
-If true, any element with a value populated for the key defined by the set.tag.value.visitor.key
+If true, any element with a value populated for the key defined by the set.tag.value.visitor.keys
option will have the value specified in the set.tag.value.visitor.value option appended to it.
=== set.tag.value.visitor.element.criterion
@@ -3774,17 +3829,17 @@ option will have the value specified in the set.tag.value.visitor.value option a
* Data Type: string
* Default Value: ``
-The plugin name of an element criterion used to select elements to add or modify tags on. To pass
-in complex nested criteria, use the Hootenanny Javascript interface instead.
+The plugin name of an element criterion used to select elements to add or modify tags on used by the
+SetTagValueVisitor and RecursiveSetTagValueOp classes. To pass in complex nested criteria, use the
+Hootenanny Javascript interface instead.
-=== set.tag.value.visitor.key
+=== set.tag.value.visitor.keys
* Data Type: list
* Default Value: ``
-Set the key member in the SetTagValueVisitor class. SetTagValueVisitor allows for
-adding/modifying one or more tags on all elements in a map. The number of keys in
-`set.tag.value.visitor.key` should match the number of keys in `set.tag.value.visitor.value`.
+Sets the key member in the SetTagValueVisitor and RecursiveSetTagValueOp classes. The number of keys
+in `set.tag.value.visitor.keys` should match the number of keys in `set.tag.value.visitor.values`.
Separate list items with a semicolon.
=== set.tag.value.visitor.overwrite
@@ -3792,16 +3847,17 @@ Separate list items with a semicolon.
* Data Type: bool
* Default Value: `true`
-If true, the SetTagValueVisitor class will overwrite any existing tag it finds with
-key=set.tag.value.visitor.key, otherwise it will skip updating the tag.
+If true, the SetTagValueVisitor and RecursiveSetTagValueOp classes will overwrite any existing tag
+it finds with key=set.tag.value.visitor.keys, otherwise it will skip updating the tag.
-=== set.tag.value.visitor.value
+=== set.tag.value.visitor.values
* Data Type: list
* Default Value: ``
-Set the value member in the SetTagValueVisitor class. SetTagValueVisitor allows for
-adding/modifying one or more tags on all elements in a map. Separate list items with a semicolon.
+Set the value member in the SetTagValueVisitor and RecursiveSetTagValueOp classes. The number of
+keys in `set.tag.value.visitor.values` should match the number of keys in
+`set.tag.value.visitor.keys`. Separate list items with a semicolon.
=== shape.file.writer.cols
@@ -3862,7 +3918,15 @@ the existing way node instead of adding the way endpoint node as a new way node
* Default Value: `false`
If true, all way nodes snapped by the Unconnected Way Snapper to another way or way node will be
-marked with a 'hoot:snapped' tag. Useful for debugging purposes.
+marked with a custom tag. Useful for debugging purposes.
+
+=== snap.unconnected.ways.mark.snapped.ways
+
+* Data Type: bool
+* Default Value: `false`
+
+If true, all ways snapped by the Unconnected Way Snapper to another way or way node will be
+marked with a custom tag. Useful for debugging purposes.
=== snap.unconnected.ways.snap.to.way.criterion
@@ -3885,11 +3949,12 @@ for way snapping. This option is only used if snap.unconnected.ways.reuse.way.n
=== snap.unconnected.ways.snap.to.way.status
* Data Type: string
-* Default Value: ``
+* Default Value: `Input1`
-Status of ways or way nodes being snapped to. Valid values are 'Input1' or 'Input2'. Specify
-'Input1' to snap secondary ways to reference ways or 'Input2' to snap reference ways to secondary
-ways.
+Status of ways or way nodes being snapped to. Valid values are 'Input1', 'Input2', or 'Conflated'.
+Specify 'Input1' to snap secondary ways to reference ways or 'Input2' to snap reference ways to
+secondary ways. You may add multiple statuses and separate them with a semicolon. For example, to
+snap to both reference and conflated ways use: 'Input1;Conflated'.
=== snap.unconnected.ways.snap.tolerance
@@ -3912,10 +3977,12 @@ way snapping.
=== snap.unconnected.ways.snap.way.status
* Data Type: string
-* Default Value: ``
+* Default Value: `Input2`
-Status of ways being snapped. Valid values are 'Input1' or 'Input2'. Specify 'Input1' to
-snap reference ways to secondary ways or 'Input2' to snap secondary ways to reference ways.
+Status of ways being snapped. Valid values are 'Input1', 'Input2', or 'Conflated'. Specify
+'Input1' to snap reference ways to secondary ways or 'Input2' to snap secondary ways to reference
+ways. You may add multiple statuses and separate them with a semicolon. For example, to snap both
+reference and conflated ways use: 'Input1;Conflated'.
=== snap.unconnected.ways.use.existing.way.nodes
@@ -4333,9 +4400,24 @@ SampledAngleHistogramExtractor
The way joiner implementation used by the `WayJoinerOp` to repair way splits after a conflation job.
-This operation can take on the following two options:
-* `hoot::WayJoinerBasic`
+This operation can take on the following options:
+* `hoot::ReplacementSnappedWayJoiner`
* `hoot::WayJoinerAdvanced`
+* `hoot::WayJoinerBasic`
+
+=== way.joiner.advanced.strict.name.match
+
+* Data Type: bool
+* Default Value: `false`
+
+If enabled, WayJoinerAdvanced will not consider the "alt_name" tag when performing name comparisons.
+
+=== way.joiner.leave.parent.id
+
+* Data Type: bool
+* Default Value: `false`
+
+If enabled, WayJoinerOp will leave a way's parent ID populated after joining.
=== way.matcher.heading.delta