Syntax

   FACTORY_DEF <ReaderKeyword> RasterClippingFactory
   [FACTORY_NAME <factory name>]
   [INPUT CLIPPER FEATURE_TYPE <factory type>
   [<attribute name> <attribute value>]*
   [<feature function>]*]
   [INPUT CLIPPEE FEATURE_TYPE <factory type>
   [<attribute name> <attribute value>]*
   [<feature function>]*]
   [REJECT_INVALID_GEOM <Yes|No>]
   [MULTICLIP (YES|NO|CLIPPERS_FIRST)
   [MERGE_CLIPPER_ATTRIBUTES (YES|NO)
   [CLIPPER_ATTR_PREFIX <attribute prefix value>]
   [PRESERVE_CLIPPEE_EXTENTS (YES|NO)]
   [GROUP_BY [<attribute name>]+]
   [FLUSH_WHEN_GROUPS_CHANGE (Yes|No)]
   [OUTPUT (CLIPPED_INSIDE|CLIPPED_OUTSIDE|
   INSIDE|OUTSIDE|REJECTED)
   FEATURE_TYPE <feature type>
   [<attribute name> <attribute value>]*
   [<feature function>]*]*

Overview

   This factory is used to perform a geometric clipping operation on input 
   raster features. It takes two types of features identified by the CLIPPER and 
   CLIPPEE input tags.
   
   Clipping features are identified by the tag CLIPPER. These features identify 
   the area against which all CLIPPEE features are processed. Clippers can be 
   polygon, donut, or aggregate features. Clippees must have raster geometry; 
   they are unaffected by raster band and/or palette subselection.
   
   Clipping will operate such that for each clippee, the following possible 
   output will be generated:

      One CLIPPED_INSIDE feature for every clipper that intersects the clippee, 
      and one CLIPPED_OUTSIDE feature

      One INSIDE feature

      One OUTSIDE feature
   
   Clippees will be output untouched through the OUTSIDE port if they are 
   disjoint from all clippers.
   
   Clippees will be output untouched through the INSIDE port if they are 
   contained in, covered by, or equal to any of the clippers.
   
   Otherwise, each clipper that intersects the clippee will produce output 
   through the CLIPPED_INSIDE port. If PRESERVE_CLIPPEE_EXTENTS is set to "no", 
   the extents of this raster will be equal to the bounding box of the portion 
   of the clipper within the clippee. Otherwise, if PRESERVE_CLIPPEE_EXTENTS is 
   set to "yes", the extents will be identical to those of the clippee. The 
   remaining areas of the clippee that are disjoint from all clippers will be 
   output through the CLIPPED_OUTSIDE port. The extents of this raster will be 
   identical to those of the clippee.
   
   When REJECT_INVALID_GEOM is Yes, the factory will output invalid features to
   Rejected port.

   The MULTICLIP option has the same effect as the MUTICLIP option of the 
   ClippingFactory. Please consult the ClippingFactory documentation for more 
   information on this keyword. 
   
   If MERGE_CLIPPER_ATTRIBUTES is specified, then whenever a clippee is found to 
   be inside or clipped inside a clipper, the attributes of the clipper will be 
   copied to the inside parts of the output features. The CLIPPER_ATTR_PREFIX 
   directive specifies a string prefix to be added to the attributes of a 
   CLIPPER that are copied to a clippee. If attributes of the same name already 
   exist on the clippee, they will be overridden. If this prefix is not 
   specified or is empty, the attributes will still be copied to the output 
   features, but they will not overwrite any existing attributes of the same 
   name.
   
   If the GROUP_BY clause is given, then each clippee will only be clipped by 
   clippers that contain the same values as itself in the attributes specified 
   by this clause.

   If the GROUP_BY clause is specified, and FLUSH_WHEN_GROUPS_CHANGE is set to
   Yes, the factory will flush the current group whenever a feature from a 
   different group is encountered.

Output Tags

   The RasterClippingFactory supports the following output tags.

   CLIPPED_INSIDE
   
      Areas of a clippee that intersect a clipper.
   
   CLIPPED_OUTSIDE
   
      Areas of a clippee that do not intersect any clipper.
   
   INSIDE
      
      Clippees that are contained in, covered by, or equal to a clipper.
   
   OUTSIDE
      
      Clippees that are disjoint from all clippers.
   
   REJECTED
   
      Extraneous clippers that are received by the factory when MULTICLIP is not 
      set to YES, as well as any other invalid features (i.e. non-area clippers)