Syntax

   FACTORY_DEF <ReaderKeyword> SpikeRemoverFactory
   [FACTORY_NAME <factory name>]
   [INPUT FEATURE_TYPE <factory type>
      [<attribute name> <attribute value>]*
      [<feature function>]*]*
   [DIMENSIONS (2D|3D)]
   [REMOVE_SPIKES_ITERATIVELY (Yes|No)]
   [SPIKE_ANGLE <maximum spike angle>]
   [SPIKE_LENGTH <maximum spike length>]
   [REJECT_INVALID_GEOM (Yes|No)]
   [OUTPUT (CHANGED|FLAGGED|UNCHANGED) FEATURE_TYPE <feature type>
   [<attribute name> <attribute value>]*
   [<feature function>]*]*

Overview

   Cleans up feature geometries by removing spikes.

   The factory looks at every pair of line segments made up of three consecutive 
   distinct points. If the angle between two line segments is less than or equal 
   to the <maximum spike angle>, then the middle point is a spike and is 
   removed.

   If the <maximum spike length> is specified, then the factory will skip line 
   segments longer than this length. Otherwise all line segments are considered.

   If dimensions are set to 2D, features will be 'flattened' before spikes
   are handled, resulting in spikes that are only visible in 3D mode being
   left unchanged.

   If REMOVE_SPIKES_ITERATIVELY is set to Yes, the factory will make sure that
   no spikes are 'left behind' when it passes through. It also will not return
   spike_angle, spike_length1, and spike_length2.

   If the geometry of a feature is a path, the factory removes spikes between 
   consecutive path segments as well. For a polygon or donut, if the start/end 
   point is a spike, then it is also removed. The end result is still a 
   polygon/donut. Any polygons, donuts, paths or lines that are part of a 
   collection of geometry will also be processed.

   The factory will also remove any duplicate points.

   The factory is not effective when the line contains many deviations other 
   than spikes. In such cases, it is recommended to first clean up the features 
   using the LineGeneralizer transformer with Douglas-Poiker algorithm.

Output Tags

   The SpikeRemoverFactory supports the following output tag.
   
   CHANGED  
   
      Features that are cleaned up.

   FLAGGED  
   
      Duplicate points and spikes.

   UNCHANGED   
   
      Untouched features.