:py:mod:`hazimp.jobs.plane_from_points`
=======================================

.. py:module:: hazimp.jobs.plane_from_points

.. autoapi-nested-parse::

   Given a set of xyz values estimate z for new x, y pairs.



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

Classes
~~~~~~~

.. autoapisummary::

   hazimp.jobs.plane_from_points.Plane



Functions
~~~~~~~~~

.. autoapisummary::

   hazimp.jobs.plane_from_points.fit_plane_svd



.. py:class:: Plane(xyz)

   Bases: :py:obj:`object`

   A plane, defined by best fit to a set of points.
   Designed to estimate a z value.

   .. py:method:: estimate_z(self, x, y)

      Giving x and y arrays, estimate the z array.



.. py:function:: fit_plane_svd(xyz)

   Calculates a plane that passes thru the origin
   representing a best fit to the xyz values.

   (v[0]x + v[1]y)/ - v[2] = z
   v[3] = ??

   # Code from;
   # http://stackoverflow.com/questions/15959411/
   # fit-points-to-a-plane-algorithms-how-to-iterpret-results