Skip to content

v0.2.50..v0.2.51 changeset changeset derive replacement.asciidoc

Garret Voltz edited this page Jan 15, 2020 · 1 revision
diff --git a/docs/commands/changeset-derive-replacement.asciidoc b/docs/commands/changeset-derive-replacement.asciidoc
index 410234c..79d7415 100644
--- a/docs/commands/changeset-derive-replacement.asciidoc
+++ b/docs/commands/changeset-derive-replacement.asciidoc
@@ -21,9 +21,9 @@ while element IDs for the secondary data are not retained and the elements treat
 * +input2+                       - Secondary input with the features used for replacement; may be any supported input format that supports 
                                    bounded reading (e.g. OSM file). See the "Bounds Handling" section for more detail.
 * +bounds+                       - Comma delimited bounds: minx,miny,maxx,maxy; e.g. "-71.4698,42.4866,-71.4657,42.4902"
-* +output+                       - Output location; must be an .osc or .osc.sql file.
-* +osmApiDatabaseUrl+            - Target OSM API database the changeset is to be applied to. Used to maintain element ID continuity with a 
-                                   particular database instance when generating SQL changesets only (.osc.sql).
+* +output+                       - Output location; must be a changeset .osc or .osc.sql file.
+* +osmApiDatabaseUrl+            - Target OSM API database the derived changeset is to be applied, used to maintain element ID continuity. 
+                                   Required only if the changeset output format is .osc.sql. 
 * +--full-replacement+           - Determines how much of the reference data is replaced. The default behavior replaces reference feature with
                                    overlap with secondary features only. The option is incompatible with the +--retainment-filters+ option and 
                                    will result in an error when combined with it. See the  "Bounds Handling" section for more detail.
@@ -46,6 +46,10 @@ while element IDs for the secondary data are not retained and the elements treat
                                    section for more detail.
 * +--retainment-filter-options+  - Optional configuration options for the filters specified in +--retainment-filters+. See the 
                                    "Retainment Filtering" section for more detail.
+* +--disable-way-snapping+       - Optional configuration option which disables the snapping of unconnected ways before changeset derivation. 
+                                   By default way snapping is enabled.
+* +--disable-conflation+         - Optional configuration option which disables the conflation of data cut out during replacement and the 
+                                   replacement data. By default conflation is enabled.
 * +--stats+                      - Stats flag, when turned on a table of create, modify, delete for each of the types node, way, relation (only 
                                    valid for .osc output files)
 * +--write-bounds+               - If the `convert.bounding.box` configuration option is specified, optionally outputs a file containing the 
@@ -54,7 +58,7 @@ while element IDs for the secondary data are not retained and the elements treat
 === Usage
 
 --------------------------------------
-changeset-derive-replacement (input1) (input2) (bounds) (output) [osmApiDatabaseUrl] [--full-replacement] [--strict-bounds] [--geometry-filters] [--replacement-filters] [--chain-replacement-filters] [--replacement-filter-options] [--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] [--stats] [--write-bounds]
 --------------------------------------
 
 === Examples
@@ -62,6 +66,20 @@ changeset-derive-replacement (input1) (input2) (bounds) (output) [osmApiDatabase
 * https://github.com/ngageoint/hootenanny/blob/master/docs/user/CommandLineExamples.asciidoc#applying-changes[Basic]
 * https://github.com/ngageoint/hootenanny/blob/master/docs/user/CommandLineExamples.asciidoc#applying-changes-1[Advanced]
 
+=== Workflow
+
+The high level workflow looks like:
+
+1) load reference map at specified bounds
+2) filter reference map (optional)
+3) load secondary map at specified bounds
+4) filter secondary map (optional)
+5) cookie cut secondary map out of the reference map
+6) combine the cookie cut reference map back with the secondary map
+7) conflate the data in the combined map (optional)
+8) snap linear features in the combined map (optional)
+9) derive a changeset between the combined map and the reference map
+
 === Input Data
 
 All inputs must support bounded reading. To list the Hootenanny input formats that support bounded reading:
@@ -193,11 +211,18 @@ features in the reference layer to be replaced in the changeset output, thus ove
 
 === Versioning
 
-If the final target of the resulting changeset is an OSM API data store (direct connect or via Rails Port, all input features from the 
+If the final target of the resulting changeset is an OSM API data store (direct connect or via Rails Port), all input features from the 
 reference dataset must be populated with the correct changeset versions or application of the resulting changeset will fail. 
 
 To ensure this for the output from Overpass API queries, add "out meta" to the query retrieving the reference data.
 
+=== Conflation
+
+Conflation is used by default primarily to clean up data at the seams of the boundary between the cookie cut reference map and the new secondary
+data. Both reference and secondary inputs are processed separately for each geometry type they have (point/line/polygon), therefore, cross
+geometry conflation types like POI to Polygon conflation, will have no effect on the output. POI to Polygon conflation should be run on the
+map data outside of this changeset replacement derivation workflow. 
+
 === See Also
 
 * `changeset-derive` command
Clone this wiki locally