Skip to content

v0.2.54..v0.2.55 changeset changeset derive replacement.asciidoc

Garret Voltz edited this page Aug 14, 2020 · 1 revision
diff --git a/docs/commands/changeset-derive-replacement.asciidoc b/docs/commands/changeset-derive-replacement.asciidoc
index dcbb949..d95004a 100644
--- a/docs/commands/changeset-derive-replacement.asciidoc
+++ b/docs/commands/changeset-derive-replacement.asciidoc
@@ -56,19 +56,22 @@ IDs in the secondary data are not retained and those elements treated as complet
 * +--retainment-filter-options+  - Optional configuration options for the filters specified in +--retainment-filters+. See the 
                                    "Retainment Filtering" section for more detail.
 * +--disable-way-snapping+       - Disables the snapping of unconnected ways at the seams between the data used for replacement and the data 
-                                   being replaced.
+                                   being replaced. See the "Unconnected Way Snapping" section for more detail.
 * +--disable-conflation+         - Disables the conflation of new secondary features with unremoved reference features. See the "Conflation" 
                                    section for more detail.
+* +--disable-cleaning+           - Disables cleaning of data. Cleaning must be run before conflation, so this option is ignored unless 
+                                   +--disable-conflation+ is also enabled. See the "Conflation" section for more detail.
 * +--disable-oob-way-handling+   - Determines whether Hootenanny automatically handles protecting out of bounds immediately connected reference 
                                    ways from deletion in the changeset output. See the ""Bounds Handling" section for more detail.
-* +--stats+                      - Displays changeset statistics (only valid for .osc changeset output files)
+* +--stats+                      - Displays changeset statistics and may be optionally followed by an output JSON file name to write the 
+                                   statistics to.
 * +--write-bounds+               - If the +convert.bounding.box+ configuration option is specified, outputs a file containing the specified 
                                    input bounds. The location of the file is controlled via the +bounds.output.file+ configuration option.
 
 === Usage
 
 --------------------------------------
-changeset-derive-replacement (input1) (input2) (bounds) (output) [osmApiDatabaseUrl] [--full-replacement] [--strict-bounds] [--geometry-filters] [--replacement-filters] [--chain-replacement-filters] [--replacement-filter-options] [--disable-way-snapping] [--disable-conflation] [--disable-oob-way-handling] [--stats] [--write-bounds]
+changeset-derive-replacement (input1) (input2) (bounds) (output) [osmApiDatabaseUrl] [--full-replacement] [--strict-bounds] [--geometry-filters] [--replacement-filters] [--chain-replacement-filters] [--replacement-filter-options] [--disable-way-snapping] [--disable-conflation] [--disable-oob-way-handling] [--stats filename] [--write-bounds]
 --------------------------------------
 
 === Examples
@@ -128,7 +131,7 @@ With the +--strict-bounds+ option specified:
 
 * Only point and polygon features completely inside the specified bounds are replaced. Polygon features are never split.
 * Only sections of linear features within the specified bounds are modified, and they may be cut where they cross the bounds and optionally 
-  joined back up with reference data via way snapping.
+  joined back up with reference data via way snapping (see "Snap Unconnected Ways" section in the User Documentation).
 
 With the +--strict-bounds+ option omitted:
 
@@ -214,10 +217,33 @@ Both reference and secondary map inputs are processed separately for each geomet
 geometry conflation algorithms, such as POI to Polygon conflation, will have no effect on the conflated output. Cross geometry conflation 
 algorithms must be run on the map data outside of the usage of this command. 
 
+Hootenanny always runs cleaning operations on input data before conflating them in order to get the best conflated output result. If you opt
+not to run conflation with +--disable-conflation+, you may also opt out of the cleaning operations by using the +--disable-cleaning+ option. If
+conflation is enabled by omitting +--disable-conflation+ cleaning may not be disabled and +--disable-cleaning+ is ignored.
+
+=== Unconnected Way Snapping
+
+Unconnected way snapping is used to repair cut ways at the replacement boundary seams when the +--full-replacement+ option is enabled. The
+input data must be of a slightly larger area than the replacement AOI in order for there to be any ways to snap back to. This is primarily 
+useful with roads but can be made to work with any linear data. The +--disable-way-snapping+ can be specified to disable way snapping.
+
+Alternatively, marking snappable ways as needing review instead of snapping them can be performed to provide more control over the changeset 
+output. See the "Snap Unconnected Ways" section of the User Documentation for more detail.
+
+=== Missing Elements
+
+Changeset replacement derivation will not remove any references to missing children elements passed in the input data. If any ways with 
+references to missing way nodes or relations with references to missing elements are found in the inputs to changeset replacement derivation, 
+they will be tagged with the custom tag, "hoot::missing_child=yes". This is due to the fact that changeset replacement derivation may 
+inadvertantly introduce duplicate/unwanted child elements into these features since it is not aware of the existence of the missing children. 
+This tag should be searched for after the resulting changeset has been applied and features having it should be manually cleaned up, if 
+necessary.
+
 === See Also
 
 * `changeset-derive` command
 * `changeset.*` configuration options
 * `cookie.cutter.alpha.*` configuration options
+* "Snap Unconnected Ways" section of the User Documentation
 * `snap.unconnected.ways.*` configuration options
 * "Supported Input Formats":https://github.com/ngageoint/hootenanny/blob/master/docs/user/SupportedDataFormats.asciidoc
Clone this wiki locally