tilupy.make_mass
================

.. py:module:: tilupy.make_mass



Functions
---------

.. autoapisummary::

   tilupy.make_mass.calotte



Module Contents
---------------


Functions
^^^^^^^^^

.. py:function:: calotte(x: numpy.ndarray, y: numpy.ndarray, z: numpy.ndarray, x0: float, y0: float, radius: float, norm_offset: float = 0, res_type: str = 'projected_normal') -> numpy.ndarray

   Construct mass on topography as volume between sphere and topography.

   :param x: X-axis array, with length nx.
   :type x: numpy.ndarray
   :param y: Y-axis array, with length ny.
   :type y: numpy.ndarray
   :param z: Array of altitudes, of size (ny, nx). z[0, 0] has coordinates
             (x[0], y[-1]).
   :type z: numpy.ndarray
   :param x0: X position of the calotte.
   :type x0: float
   :param y0: Y position of the calotte.
   :type y0: float
   :param radius: Radius of the shpere.
   :type radius: float
   :param norm_offset: Downwards offset between the sphere center and the topography, in the
                       direction normal to the topography, by default 0.
   :type norm_offset: float, optional
   :param res_type:
                    Type of thickness output:

                        - 'true_normal': Real thickness in the direction normal to the topography.
                        - 'vertical': Thickness in the vertical direction.
                        - 'projected_normal': Thickness normal to the topography is computed from the vertical
                          thickness projected on the axe normal to the topography.

                    The default is 'projected_normal'.
   :type res_type: string, optional

   :returns: Array of mass height, in the direction normal to topography.
   :rtype: numpy.ndarray