SpatialContains
===============

.. currentmodule:: globalmapper
.. py:function:: SpatialContains (GM_LayerHandle_t32 aLayer1, GM_LayerHandle_t32 aLayer2, GM_SpatialOps_Params_t aParams) -> GM_Error_t32

	The **Contains** predicate returns the set of features from one layer that wholly contain a feature from another layer.
	Contain is the opposite of within, i.e. feature A contains feature B if and only if feature B is within feature A.
	
	:param GM_LayerHandle_t32 aLayer1: First layer in predicate
	:param GM_LayerHandle_t32 aLayer2: Second layer in predicate
	:param GM_SpatialOps_Params_t aParams: Parameters
	:returns: Error Code
	:rtype: GM_Error_t32
		
| 

.. list-table::
    :width: 100%
    :class: borderless
    :header-rows: 1

    * - BEFORE
      - AFTER

    * - .. image:: ../images/SpatialAnalysis_Images/EnclosedCircles.png
            :width: 150px
            :height: 150px
            :align: center

      - .. image:: ../images/SpatialAnalysis_Images/BlueCircle.png
			:width: 150px
			:height: 150px
			:align: center

| 

Example
-------
The following is an example of SpatialContains.

.. literalinclude:: ../../sample_tests/sample_code/SpatialContains_sample.py
   :language: python