Skip to content

v0.2.48..v0.2.49 changeset node density plot.asciidoc

Garret Voltz edited this page Oct 2, 2019 · 1 revision
diff --git a/docs/commands/node-density-plot.asciidoc b/docs/commands/node-density-plot.asciidoc
index 78d3e9c..37ccfba 100644
--- a/docs/commands/node-density-plot.asciidoc
+++ b/docs/commands/node-density-plot.asciidoc
@@ -5,25 +5,17 @@
 
 The +node-density-plot+ command creates a density plot of the specified input.
 
-* +input+         - Input path.
-* +output-image+  - Output image name. Must always be a +.png+ file. A
-                    corresponding +.pngw+ file will also be generated.
-* +max-dimension+ - Maximum size of the image on one side. The actual size will
-                    be determined based on the envelope. If the envelope is wider than tall then
-                    this will be the width of the image (and vice versa). The pixels in the output
-                    image will always be square and the image may be slightly larger than the
-                    envelope to accommodate this.
-* +base-colors+   - Base colors to use for each channel. These will be added to
-                    each channel (R,G,B,A). Alpha of 255 is opaque.
-* +multiplier+    - Multiply the log count ratio by these values. 4 comma delimited
-                    values (R,G,B,A).
-
-By default the colors of the image are black to white where black represents no
-data. The colors are always in log scale. You can manipulate the +base-color+
-and +count-colors+ parameters to change the colors. This approach allows
-creating simple positive gradients. If you require more complex color mappings
-you may want to take a peek at link:$$http://www.imagemagick.org/$$[ImageMagick]
-or some other similar mechanism.
+* +input+         - Input path; may be any supported input format (e.g. OSM file).
+* +output-image+  - Output image name. Must always be a +.png+ file. A corresponding +.pngw+ file will also be generated.
+* +max-dimension+ - Maximum size of the image on one side. The actual size will be determined based on the envelope. If the envelope is wider 
+                    than tall then this will be the width of the image (and vice versa). The pixels in the output image will always be square 
+                    and the image may be slightly larger than the envelope to accommodate this.
+* +base-colors+   - Base colors to use for each channel. These will be added to each channel (R,G,B,A). Alpha of 255 is opaque.
+* +multiplier+    - Multiply the log count ratio by these values. 4 comma delimited values (R,G,B,A).
+
+By default the colors of the image are black to white where black represents no data. The colors are always in log scale. You can manipulate 
+the +base-color+ and +count-colors+ parameters to change the colors. This approach allows creating simple positive gradients. If you require 
+more complex color mappings you may want to take a peek at link:$$http://www.imagemagick.org/$$[ImageMagick] or some other similar mechanism.
 
 The coloring uses the following equations for each pixel:
 
@@ -55,12 +47,10 @@ endif::HasLatexMath[]
 * +colorMultiplier+ The array passed in the +multiplier+ argument.
 * +baseColor+ The array passed in the +base-colors+ argument.
 
-All the color values are bound to 0-255 before being assigned in the output
-image.
+All the color values are bound to 0-255 before being assigned in the output image.
 
-The amount of time this takes depends on many factors, but on circa 2012
-hardware processing all of OSM's planet file in a +.osm.pbf+ format took about
-4.5 hours.
+The amount of time this takes depends on many factors, but on circa 2012 hardware processing all of OSM's planet file in a +.osm.pbf+ format 
+took about 4.5 hours.
 
 === Usage
 
@@ -70,17 +60,20 @@ node-density-plot (input) (output-image) (max-dimension) [base-colors] [multipli
 
 ==== Example
 
-Paint node density using the default color scale of black to white where black
-is no data. The image will either have a maximum height of 100 pixels or a
-maximum width of 100 pixels.
+Paint node density using the default color scale of black to white where black is no data. The image will either have a maximum height of 100 
+pixels or a maximum width of 100 pixels.
 
 --------------------------------------
 hoot node-density-plot MyInput.osm.pbf MyLocalOutput.png 100
 --------------------------------------
 
-Paint node density using the default color scale of transparent brown to opaque
-green. Transparent is no data. The image will be at most 256 pixels on one side.
+Paint node density using the default color scale of transparent brown to opaque green. Transparent is no data. The image will be at most 256 
+pixels on one side.
 
 --------------------------------------
 hoot node-density-plot MyInput.osm.pbf MyLocalOutput.png 256 "100,0,0,0" "0,255,0,255"
 --------------------------------------
+
+=== See Also
+
+* https://github.com/ngageoint/hootenanny/blob/master/docs/user/SupportedDataFormats.asciidoc#applying-changes-1[Supported Input Formats]
Clone this wiki locally