casagui.data.casaimage
======================

.. py:module:: casagui.data.casaimage

.. autoapi-nested-parse::

   image utilities



Functions
---------

.. autoapisummary::

   casagui.data.casaimage.new
   casagui.data.casaimage.shape


Package Contents
----------------

.. py:function:: new(pattern, path, overwrite=False)

   Create a new image using ``pattern`` as a pattern. ``pattern`` supplies the
   shape for the new image as well as the coordinate system for the new image.

   :param path: path to the image to be created
   :type path: str
   :param pattern: path to the image on which the new image should be based
   :type pattern: str
   :param overwrite: overwrite any existing image, directory or file
   :type overwrite: bool


.. py:function:: shape(path)

   Return the shape of an image.

   :param path: path to the image
   :type path: str

   :returns: shape of image
   :rtype: list of int