|
|
|
|
@ -25,57 +25,58 @@
|
|
|
|
|
|
|
|
|
|
.. py:class:: magnum.trade.ImageData1D |
|
|
|
|
|
|
|
|
|
See `ImageData2D` for more information. |
|
|
|
|
See :ref:`ImageData2D` for more information. |
|
|
|
|
|
|
|
|
|
.. py:class:: magnum.trade.ImageData2D |
|
|
|
|
|
|
|
|
|
Similarly to `Image2D`, holds its own data buffer, thus doesn't have an |
|
|
|
|
equivalent to `ImageView2D.owner`. Implicitly convertible to `ImageView2D` |
|
|
|
|
/ `MutableImageView2D`, so all APIs consuming image views work with this |
|
|
|
|
type as well. |
|
|
|
|
Similarly to :ref:`Image2D`, holds its own data buffer, thus doesn't have |
|
|
|
|
an equivalent to :ref:`ImageView2D.owner`. Implicitly convertible to |
|
|
|
|
:ref:`ImageView2D` / :ref:`MutableImageView2D`, so all APIs consuming image |
|
|
|
|
views work with this type as well. |
|
|
|
|
|
|
|
|
|
.. py:class:: magnum.trade.ImageData3D |
|
|
|
|
|
|
|
|
|
See `ImageData2D` for more information. |
|
|
|
|
See :ref:`ImageData2D` for more information. |
|
|
|
|
|
|
|
|
|
.. py:property:: magnum.trade.ImageData1D.storage |
|
|
|
|
:raise AttributeError: If `is_compressed` is :py:`True` |
|
|
|
|
:raise AttributeError: If :ref:`is_compressed` is :py:`True` |
|
|
|
|
.. py:property:: magnum.trade.ImageData2D.storage |
|
|
|
|
:raise AttributeError: If `is_compressed` is :py:`True` |
|
|
|
|
:raise AttributeError: If :ref:`is_compressed` is :py:`True` |
|
|
|
|
.. py:property:: magnum.trade.ImageData3D.storage |
|
|
|
|
:raise AttributeError: If `is_compressed` is :py:`True` |
|
|
|
|
:raise AttributeError: If :ref:`is_compressed` is :py:`True` |
|
|
|
|
|
|
|
|
|
.. py:property:: magnum.trade.ImageData1D.format |
|
|
|
|
:raise AttributeError: If `is_compressed` is :py:`True` |
|
|
|
|
:raise AttributeError: If :ref:`is_compressed` is :py:`True` |
|
|
|
|
.. py:property:: magnum.trade.ImageData2D.format |
|
|
|
|
:raise AttributeError: If `is_compressed` is :py:`True` |
|
|
|
|
:raise AttributeError: If :ref:`is_compressed` is :py:`True` |
|
|
|
|
.. py:property:: magnum.trade.ImageData3D.format |
|
|
|
|
:raise AttributeError: If `is_compressed` is :py:`True` |
|
|
|
|
:raise AttributeError: If :ref:`is_compressed` is :py:`True` |
|
|
|
|
|
|
|
|
|
.. py:property:: magnum.trade.ImageData1D.pixel_size |
|
|
|
|
:raise AttributeError: If `is_compressed` is :py:`True` |
|
|
|
|
:raise AttributeError: If :ref:`is_compressed` is :py:`True` |
|
|
|
|
.. py:property:: magnum.trade.ImageData2D.pixel_size |
|
|
|
|
:raise AttributeError: If `is_compressed` is :py:`True` |
|
|
|
|
:raise AttributeError: If :ref:`is_compressed` is :py:`True` |
|
|
|
|
.. py:property:: magnum.trade.ImageData3D.pixel_size |
|
|
|
|
:raise AttributeError: If `is_compressed` is :py:`True` |
|
|
|
|
:raise AttributeError: If :ref:`is_compressed` is :py:`True` |
|
|
|
|
|
|
|
|
|
.. py:property:: magnum.trade.ImageData1D.pixels |
|
|
|
|
:raise AttributeError: If `is_compressed` is :py:`True` |
|
|
|
|
:raise AttributeError: If :ref:`is_compressed` is :py:`True` |
|
|
|
|
.. py:property:: magnum.trade.ImageData2D.pixels |
|
|
|
|
:raise AttributeError: If `is_compressed` is :py:`True` |
|
|
|
|
:raise AttributeError: If :ref:`is_compressed` is :py:`True` |
|
|
|
|
.. py:property:: magnum.trade.ImageData3D.pixels |
|
|
|
|
:raise AttributeError: If `is_compressed` is :py:`True` |
|
|
|
|
:raise AttributeError: If :ref:`is_compressed` is :py:`True` |
|
|
|
|
|
|
|
|
|
.. py:class:: magnum.trade.ImporterManager |
|
|
|
|
:summary: Manager for `AbstractImporter` plugin instances |
|
|
|
|
:summary: Manager for :ref:`AbstractImporter` plugin instances |
|
|
|
|
|
|
|
|
|
Each plugin returned by `instantiate()` or `load_and_instantiate()` |
|
|
|
|
references its owning `ImporterManager` through `AbstractImporter.manager`, |
|
|
|
|
ensuring the manager is not deleted before the plugin instances are. |
|
|
|
|
Each plugin returned by :ref:`instantiate()` or :ref:`load_and_instantiate()` |
|
|
|
|
references its owning :ref:`ImporterManager` through |
|
|
|
|
:ref:`AbstractImporter.manager`, ensuring the manager is not deleted before |
|
|
|
|
the plugin instances are. |
|
|
|
|
|
|
|
|
|
.. py:class:: magnum.trade.AbstractImporter |
|
|
|
|
|
|
|
|
|
Similarly to C++, importer plugins are loaded through `ImporterManager`: |
|
|
|
|
Similarly to C++, importer plugins are loaded through :ref:`ImporterManager`: |
|
|
|
|
|
|
|
|
|
.. |
|
|
|
|
>>> from magnum import trade |
|
|
|
|
@ -99,15 +100,15 @@
|
|
|
|
|
:raise RuntimeError: If no file is opened |
|
|
|
|
.. py:function:: magnum.trade.AbstractImporter.mesh_level_count |
|
|
|
|
:raise RuntimeError: If no file is opened |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than `mesh_count` |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than :ref:`mesh_count` |
|
|
|
|
.. py:function:: magnum.trade.AbstractImporter.mesh_for_name |
|
|
|
|
:raise RuntimeError: If no file is opened |
|
|
|
|
.. py:function:: magnum.trade.AbstractImporter.mesh_name |
|
|
|
|
:raise RuntimeError: If no file is opened |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than `mesh_count` |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than :ref:`mesh_count` |
|
|
|
|
.. py:function:: magnum.trade.AbstractImporter.mesh |
|
|
|
|
:raise RuntimeError: If no file is opened |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than `mesh_count` |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than :ref:`mesh_count` |
|
|
|
|
|
|
|
|
|
.. py:property:: magnum.trade.AbstractImporter.image1d_count |
|
|
|
|
:raise RuntimeError: If no file is opened |
|
|
|
|
@ -118,13 +119,16 @@
|
|
|
|
|
|
|
|
|
|
.. py:function:: magnum.trade.AbstractImporter.image1d_level_count |
|
|
|
|
:raise RuntimeError: If no file is opened |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than `image1d_count` |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than |
|
|
|
|
:ref:`image1d_count` |
|
|
|
|
.. py:function:: magnum.trade.AbstractImporter.image2d_level_count |
|
|
|
|
:raise RuntimeError: If no file is opened |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than `image2d_count` |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than |
|
|
|
|
:ref:`image2d_count` |
|
|
|
|
.. py:function:: magnum.trade.AbstractImporter.image3d_level_count |
|
|
|
|
:raise RuntimeError: If no file is opened |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than `image3d_count` |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than |
|
|
|
|
:ref:`image3d_count` |
|
|
|
|
|
|
|
|
|
.. py:function:: magnum.trade.AbstractImporter.image1d_for_name |
|
|
|
|
:raise RuntimeError: If no file is opened |
|
|
|
|
@ -135,20 +139,26 @@
|
|
|
|
|
|
|
|
|
|
.. py:function:: magnum.trade.AbstractImporter.image1d_name |
|
|
|
|
:raise RuntimeError: If no file is opened |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than `image1d_count` |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than |
|
|
|
|
:ref:`image1d_count` |
|
|
|
|
.. py:function:: magnum.trade.AbstractImporter.image2d_name |
|
|
|
|
:raise RuntimeError: If no file is opened |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than `image2d_count` |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than |
|
|
|
|
:ref:`image2d_count` |
|
|
|
|
.. py:function:: magnum.trade.AbstractImporter.image3d_name |
|
|
|
|
:raise RuntimeError: If no file is opened |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than `image3d_count` |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than |
|
|
|
|
:ref:`image3d_count` |
|
|
|
|
|
|
|
|
|
.. py:function:: magnum.trade.AbstractImporter.image1d |
|
|
|
|
:raise RuntimeError: If no file is opened |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than `image1d_count` |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than |
|
|
|
|
:ref:`image1d_count` |
|
|
|
|
.. py:function:: magnum.trade.AbstractImporter.image2d |
|
|
|
|
:raise RuntimeError: If no file is opened |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than `image2d_count` |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than |
|
|
|
|
:ref:`image2d_count` |
|
|
|
|
.. py:function:: magnum.trade.AbstractImporter.image3d |
|
|
|
|
:raise RuntimeError: If no file is opened |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than `image3d_count` |
|
|
|
|
:raise ValueError: If :p:`id` is negative or not less than |
|
|
|
|
:ref:`image3d_count` |
|
|
|
|
|