Class ClipToStudyRegionManipulator

source code

     object --+    
              |    
BaseManipulator --+
                  |
                 ClipToStudyRegionManipulator

required argument: 
    target_shape: GEOSGeometry of the shape to be clipped, in srid GEOMETRY_CLIENT_SRID (4326)
optional argument:
    generally USED FOR TESTING ONLY
    study_region: GEOSGeometry of the shape to be clipped, in srid GEOMETRY_CLIENT_SRID (4326)
concerning **kwargs:
    kwargs is included to prevent errors resulting from extra arguments being passed to this manipulator from the generic view
manipulate() return value:
    a call to self.result() 
    with required parameter 'clipped_shape': 
        The returned shape geometry should be in srid GEOMETRY_CLIENT_SRID (4326) 
        The clipped shape will be the largest (in area) polygon result from intersecting target_shape with the study region 
    and optional parameters 'html' and 'success':
        The html is usually a template that will be displayed to the client, explaining the manipulation
        if not provided, this will remain empty
        The success parameter is defined as '1' for success and '0' for failure
        if not provided, the default value, '1', is used

html_templates=='internal'   
                    This represents an 'internal error' and is accessed by raising a ManipulatorInternalException
                    This should occur under the following circumstances:
                        if Study Region not found in database
                        or intersection call failed
                    clipped_shape will be returned as None
html_templates=='invalid_geom'   
                    This represents an 'user error' and is accessed by raising a InvalidGeometryException
                    This should occur under the following circumstances:
                        if geometry can not be generated from target_shape 
                        or if target_shape is not a valid geometry
                    clipped_shape will be returned as None         
html_templates==2   clipped shape is empty (no overlap with Study Region)
html_templates==0   if target_shape is successfully clipped to Study Region