[yt-svn] commit/yt: 2 new changesets
commits-noreply at bitbucket.org
commits-noreply at bitbucket.org
Fri Jun 16 06:34:19 PDT 2017
2 new commits in yt:
https://bitbucket.org/yt_analysis/yt/commits/120af7fca291/
Changeset: 120af7fca291
User: ngoldbaum
Date: 2017-06-15 23:51:41+00:00
Summary: improve docstrings for coloring of opaque sources in VR
Affected #: 2 files
diff -r 31b5c84d3d288cadf419ba86429ba50f73877507 -r 120af7fca29158da181d3a183bb1c001aaed70e7 yt/visualization/volume_rendering/render_source.py
--- a/yt/visualization/volume_rendering/render_source.py
+++ b/yt/visualization/volume_rendering/render_source.py
@@ -1047,6 +1047,7 @@
The right edge coordinates of the box.
color : array-like of shape (4,), float, optional
The colors (including alpha) to use for the lines.
+ Default is black with an alpha of 1.0.
Examples
--------
@@ -1205,7 +1206,10 @@
Parameters
----------
colors: array-like of shape (3,4), optional
- The x, y, z RGBA values to use to draw the vectors.
+ The RGBA values to use to draw the x, y, and z vectors. The default is
+ [[1, 0, 0, alpha], [0, 1, 0, alpha], [0, 0, 1, alpha]] where ``alpha``
+ is set by the parameter below. If ``colors`` is set then ``alpha`` is
+ ignored.
alpha : float, optional
The opacity of the vectors.
diff -r 31b5c84d3d288cadf419ba86429ba50f73877507 -r 120af7fca29158da181d3a183bb1c001aaed70e7 yt/visualization/volume_rendering/scene.py
--- a/yt/visualization/volume_rendering/scene.py
+++ b/yt/visualization/volume_rendering/scene.py
@@ -645,7 +645,9 @@
ds : :class:`yt.data_objects.static_output.Dataset`
This is the dataset object corresponding to the
simulation being rendered. Used to get the domain bounds.
-
+ color : array_like of shape (4,), optional
+ The RGBA value to use to draw the domain boundaries.
+ Default is black with an alpha of 1.0.
Examples
--------
@@ -713,9 +715,9 @@
Parameters
----------
- colors: array_like of shape (4,), optional
+ color : array_like of shape (4,), optional
The RGBA value to use to draw the mesh lines.
- Default is black.
+ Default is black with an alpha of 1.0.
alpha : float, optional
The opacity of the mesh lines. Default is 255 (solid).
@@ -735,7 +737,10 @@
Parameters
----------
colors: array-like of shape (3,4), optional
- The x, y, z RGBA values to use to draw the axes.
+ The RGBA values to use to draw the x, y, and z vectors. The default
+ is [[1, 0, 0, alpha], [0, 1, 0, alpha], [0, 0, 1, alpha]] where
+ ``alpha`` is set by the parameter below. If ``colors`` is set then
+ ``alpha`` is ignored.
alpha : float, optional
The opacity of the vectors.
https://bitbucket.org/yt_analysis/yt/commits/7db4296b0ebc/
Changeset: 7db4296b0ebc
User: jzuhone
Date: 2017-06-16 13:33:59+00:00
Summary: Merge pull request #1454 from ngoldbaum/improve-vr-docs
Improve docstrings for coloring of opaque sources in VR
Affected #: 2 files
diff -r 31b5c84d3d288cadf419ba86429ba50f73877507 -r 7db4296b0ebccbadbcad8e927a056c71dd39564b yt/visualization/volume_rendering/render_source.py
--- a/yt/visualization/volume_rendering/render_source.py
+++ b/yt/visualization/volume_rendering/render_source.py
@@ -1047,6 +1047,7 @@
The right edge coordinates of the box.
color : array-like of shape (4,), float, optional
The colors (including alpha) to use for the lines.
+ Default is black with an alpha of 1.0.
Examples
--------
@@ -1205,7 +1206,10 @@
Parameters
----------
colors: array-like of shape (3,4), optional
- The x, y, z RGBA values to use to draw the vectors.
+ The RGBA values to use to draw the x, y, and z vectors. The default is
+ [[1, 0, 0, alpha], [0, 1, 0, alpha], [0, 0, 1, alpha]] where ``alpha``
+ is set by the parameter below. If ``colors`` is set then ``alpha`` is
+ ignored.
alpha : float, optional
The opacity of the vectors.
diff -r 31b5c84d3d288cadf419ba86429ba50f73877507 -r 7db4296b0ebccbadbcad8e927a056c71dd39564b yt/visualization/volume_rendering/scene.py
--- a/yt/visualization/volume_rendering/scene.py
+++ b/yt/visualization/volume_rendering/scene.py
@@ -645,7 +645,9 @@
ds : :class:`yt.data_objects.static_output.Dataset`
This is the dataset object corresponding to the
simulation being rendered. Used to get the domain bounds.
-
+ color : array_like of shape (4,), optional
+ The RGBA value to use to draw the domain boundaries.
+ Default is black with an alpha of 1.0.
Examples
--------
@@ -713,9 +715,9 @@
Parameters
----------
- colors: array_like of shape (4,), optional
+ color : array_like of shape (4,), optional
The RGBA value to use to draw the mesh lines.
- Default is black.
+ Default is black with an alpha of 1.0.
alpha : float, optional
The opacity of the mesh lines. Default is 255 (solid).
@@ -735,7 +737,10 @@
Parameters
----------
colors: array-like of shape (3,4), optional
- The x, y, z RGBA values to use to draw the axes.
+ The RGBA values to use to draw the x, y, and z vectors. The default
+ is [[1, 0, 0, alpha], [0, 1, 0, alpha], [0, 0, 1, alpha]] where
+ ``alpha`` is set by the parameter below. If ``colors`` is set then
+ ``alpha`` is ignored.
alpha : float, optional
The opacity of the vectors.
Repository URL: https://bitbucket.org/yt_analysis/yt/
--
This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.
More information about the yt-svn
mailing list