aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/libpyside/pyside_numpy.h
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2021-04-16 09:46:28 +0200
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2021-04-21 13:20:08 +0200
commitdb52b6e6ec926f48679d091f7afa42f514b5e71c (patch)
treeab1a07975038ddc642e2911905f7965a600ff9d4 /sources/pyside6/libpyside/pyside_numpy.h
parent4cde4075f97fc9f8d349591291289127666b35e5 (diff)
libpyside: Add helpers for numpy
Add utility functions for converting numpy vectors containing x,y data to list of QPoint, QPointF, respectively along with helpers for type checking and initialization. Task-number: PYSIDE-1540 Task-number: PYSIDE-1503 Change-Id: Idde5084434a36ec31eb87bf65dec3d637cff728b Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Diffstat (limited to 'sources/pyside6/libpyside/pyside_numpy.h')
-rw-r--r--sources/pyside6/libpyside/pyside_numpy.h89
1 files changed, 89 insertions, 0 deletions
diff --git a/sources/pyside6/libpyside/pyside_numpy.h b/sources/pyside6/libpyside/pyside_numpy.h
new file mode 100644
index 000000000..158865c1d
--- /dev/null
+++ b/sources/pyside6/libpyside/pyside_numpy.h
@@ -0,0 +1,89 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt for Python.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef PYSIDE_NUMPY_H
+#define PYSIDE_NUMPY_H
+
+#include <sbkpython.h>
+
+#include <pysidemacros.h>
+
+#include <QtCore/QList>
+#include <QtCore/QPoint>
+#include <QtCore/QPointF>
+
+// This header provides a PyArray_Check() definition that can be used to avoid
+// having to include the numpy headers. When using numpy headers, make sure
+// to include this header after them to skip the definition. Also remember
+// that import_array() must then be called to initialize numpy.
+
+namespace PySide::Numpy
+{
+
+bool init();
+
+/// Check whether the object is a PyArrayObject
+/// \param pyIn object
+/// \return Whether it is a PyArrayObject
+PYSIDE_API bool check(PyObject *pyIn);
+
+/// Create a list of QPointF from 2 equally sized numpy array of x and y data
+/// (float,double).
+/// \param pyXIn X data array
+/// \param pyYIn Y data array
+/// \return List of QPointF
+
+PYSIDE_API QList<QPointF> xyDataToQPointFList(PyObject *pyXIn, PyObject *pyYIn);
+
+/// Create a list of QPoint from 2 equally sized numpy array of x and y data
+/// (int).
+/// \param pyXIn X data array
+/// \param pyYIn Y data array
+/// \return List of QPoint
+
+PYSIDE_API QList<QPoint> xyDataToQPointList(PyObject *pyXIn, PyObject *pyYIn);
+
+
+} //namespace PySide::Numpy
+
+#ifndef PyArray_Check
+# define PyArray_Check(op) PySide::Numpy::check(op)
+#endif
+
+#endif // PYSIDE_NUMPY_H