.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples/Statistics/plot_DataArray.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_examples_Statistics_plot_DataArray.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_Statistics_plot_DataArray.py:


DataArray Class
----------------

Extends the numpy ndarray class to add extra attributes such as names, and
units, and allows us to attach statistical descriptors of the array.
The direct extension to numpy maintains speed and functionality of numpy arrays.

.. GENERATED FROM PYTHON SOURCE LINES 10-48




.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    DataArray
    Name:   1
    Address:['0x1455d7b50']
    Shape:  (1,)
    Values: [0.]
    Min:    0.0
    Max:    0.0

    DataArray
    Name:   10
    Address:['0x1455d45d0']
    Shape:  (10,)
    Values: [0. 0. 0. ... 0. 0. 0.]
    Min:    0.0
    Max:    0.0

    DataArray
    Name:   (2, 10)
    Address:['0x10e47ce50']
    Shape:  (2, 10)
    Values: [[0. 0. 0. ... 0. 0. 0.]
     [0. 0. 0. ... 0. 0. 0.]]
    Min:    0.0
    Max:    0.0

    DataArray
    Name:   (2, 10)
    Address:['0x10e47d3d0']
    Shape:  (2,)
    Values: [ 2 10]
    Min:    2
    Max:    10

    DataArray
    Name:   45.454
    Address:['0x10e463bd0']
    Shape:  (1,)
    Values: [45.454]
    Min:    45.454
    Max:    45.454

    DataArray
    Name:   45.454
    Address:['0x10e47d550']
    Shape:  (1,)
    Values: [45.454]
    Min:    45.454
    Max:    45.454

    DataArray
    Name:   test ($\frac{g}{cc}$)
    Address:['0x10e47d3d0']
    Shape:  (1,)
    Values: [1.2639152]
    Min:    1.2639151990006638
    Max:    1.2639151990006638

    DataArray
    Name:   test ($\frac{g}{cc}$)
    Address:['0x10e47d550']
    Shape:  (10,)
    Values: [0. 1. 2. ... 7. 8. 9.]
    Min:    0.0
    Max:    9.0

    DataArray
    Name:   test ($\frac{g}{cc}$)
    Address:['0x10e460250']
    Shape:  (10,)
    Values: [0. 1. 2. ... 7. 8. 9.]
    Min:    0.0
    Max:    9.0







|

.. code-block:: Python

    import  numpy as np
    from geobipy import DataArray, StatArray

    # Integer
    test = DataArray(1, name='1')
    assert isinstance(test, DataArray) and test.size ==  1 and test.item() == 0.0, TypeError("da 0")
    print(test.summary)
    test = DataArray(10, name='10')
    assert isinstance(test, DataArray) and test.size ==  10 and np.all(test == 0.0), TypeError("da 1")
    print(test.summary)
    # tuple/Shape
    test = DataArray((2, 10), name='(2, 10)')
    assert isinstance(test, DataArray) and np.all(test.shape ==  (2, 10)) and np.all(test == 0.0), TypeError("da 2")
    print(test.summary)

    test = DataArray([2, 10], name='(2, 10)')
    assert isinstance(test, DataArray) and np.all(test ==  [2, 10]), TypeError("da 2")
    print(test.summary)

    # float
    test = DataArray(45.454, name='45.454')
    assert isinstance(test, DataArray) and test.size ==  1 and test.item() == 45.454, TypeError("da 3")
    print(test.summary)
    test = DataArray(np.float64(45.454), name='45.454')
    assert isinstance(test, DataArray) and test.size ==  1 and test.item() == 45.454, TypeError("da 4")
    print(test.summary)

    # array
    test = DataArray(np.random.randn(1), name="test", units="$\frac{g}{cc}$")
    assert isinstance(test, DataArray) and test.size ==  1, TypeError("da 5")
    print(test.summary)

    test = DataArray(np.arange(10.0), name="test", units="$\frac{g}{cc}$")
    assert isinstance(test, DataArray) and test.size ==  10, TypeError("da 6")
    print(test.summary)

    test = DataArray(test)
    assert isinstance(test, DataArray) and test.size ==  10, TypeError("da 6")
    print(test.summary)

.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.004 seconds)


.. _sphx_glr_download_examples_Statistics_plot_DataArray.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_DataArray.ipynb <plot_DataArray.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_DataArray.py <plot_DataArray.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: plot_DataArray.zip <plot_DataArray.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_