### Navigation

- ☰
- PyTecplot-0.9 »
- Module code »

# Source code for tecplot.plot.slice

    from builtins import int

    import itertools as it

    from collections import namedtuple
    from numbers import Integral

    from ..tecutil import _tecutil
    from ..constant import *
    from ..exception import *
    from .. import session, version
    from ..tecutil import Index, color_spec, lock, sv

    class SliceGroupStyle(session.Style):
        def __init__(self, slice_group, *svargs):
            self.slice_group = slice_group
            kw = dict(uniqueid=slice_group.plot.frame.uid,
                      offset1=slice_group.index)
            super().__init__(slice_group._sv, *svargs, **kw)

    class SliceMesh(SliceGroupStyle):
        """Mesh attributes of the slice group.

            .. code-block:: python
                :emphasize-lines: 11-12

                from os import path
                import tecplot as tp
                from tecplot.constant import SliceSurface, ContourType

                examples_dir = tp.session.tecplot_examples_directory()
                datafile = path.join(examples_dir, 'SimpleData', 'DuctFlow.plt')
                dataset = tp.data.load_tecplot(datafile)
                plot = tp.active_frame().plot()
                plot.show_slices = True
                plot.contour(0).variable = dataset.variable('U(M/S)')

                plot.slice(0).mesh.show = True

                tp.export.save_png('slice_mesh.png', 600, supersample=3)

            .. figure:: /_static/images/slice_mesh.png
                :width: 300px
                :figwidth: 300px
        """
        def __init__(self, mesh):
            super().__init__(mesh, sv.MESH)

        @property
        def show(self):
            """Show mesh lines.

            :type: `boolean <bool>`

            Example usage::

                >>> plot.slice(0).mesh.show = True
            """
            return self._get_style(bool, sv.SHOW)

        @show.setter
        def show(self, value):
            self._set_style(bool(value), sv.SHOW)

        @property
        def color(self):
            """Slice mesh line `Color` or `ContourGroup`.

            :type: `Color` or `ContourGroup`

            Slice mesh lines can be a solid color or be colored by a
            `ContourGroup` as obtained through the ``plot.contour`` property.

            Example usage::

                >>> plot.slice(0).mesh.show = True
                >>> plot.slice(0).mesh.color = Color.Green
            """
            return color_spec(self._get_style(Color, sv.COLOR),
                              self.slice_group.plot)

        @color.setter
        def color(self, value):
            self._set_style(color_spec(value), sv.COLOR)

        @property
        def line_thickness(self):
            """Mesh line thickness.

            :type: `float`

            The mesh line thickness is specified as a percentage of the frame width.

            Example usage::

                >>> plot.slice(0).mesh.show = True
                >>> plot.slice(0).mesh.line_thickness = 0.8
            """
            return self._get_style(float, sv.LINETHICKNESS)

        @line_thickness.setter
        def line_thickness(self, value):
            self._set_style(float(value), sv.LINETHICKNESS)

    class SliceShade(SliceGroupStyle):
        """Shade attributes of the slice group.

            Show shading on the slice when `SliceContour.show` has not been
            selected or is set to `ContourType.Lines`.

            .. code-block:: python
                :emphasize-lines: 11-14

                from os import path
                import tecplot as tp
                from tecplot.constant import Color

                examples_dir = tp.session.tecplot_examples_directory()
                datafile = path.join(examples_dir, 'SimpleData', 'Pyramid.plt')
                dataset = tp.data.load_tecplot(datafile)

                plot = tp.active_frame().plot()
                plot.show_slices = True
                plot.slice(0).contour.show = False
                shade = plot.slice(0).shade
                shade.show = True
                shade.color = Color.Red  # Slice will be colored solid red.
                tp.export.save_png('slice_shade.png', 600, supersample=3)

            .. figure:: /_static/images/slice_shade.png
                :width: 300px
                :figwidth: 300px
        """

        def __init__(self, shade):
            super().__init__(shade, sv.SHADE)

        @property
        def show(self):
            """Show shade attributes.

            :type: `boolean <bool>`

            Example usage::

                >>> plot.slice(0).shade.show = True
            """
            return self._get_style(bool, sv.SHOW)

        @show.setter
        def show(self, value):
            self._set_style(bool(value), sv.SHOW)

        @property
        def color(self):
            """Shade color.

            :type: `Color`

            `Color.MultiColor` and `Color.RGBColor` coloring are not available.
            Use flooded contours for multi-color or RGB flooding

            Example usage::

                >>> plot.slice(0).shade.show = True
                >>> plot.slice(0).shade.color = Color.Blue
            """
            return self._get_style(Color, sv.COLOR)

        @color.setter
        def color(self, value):
            self._set_style(Color(value), sv.COLOR)

        @property
        def use_lighting_effect(self):
            """Use lighting effect.

            When set to `True`, the lighting effect may be selected with the
            `SliceEffects.lighting_effect` attribute.

            .. note::
                Setting `SliceShade.use_lighting_effect` will also set
                the same value for `SliceContour.use_lighting_effect`,
                and vice-versa.

            :type: `Boolean <bool>`

            Example usage::

                >>> plot.slice(0).shade.use_lighting_effect = True
                >>> plot.slice(0).effects.lighting_effect = LightingEffect.Paneled
            """
            return self._get_style(bool, sv.USELIGHTINGEFFECT)

        @use_lighting_effect.setter
        def use_lighting_effect(self, value):
            self._set_style(bool(value), sv.USELIGHTINGEFFECT)

    class SliceEffects(SliceGroupStyle):
        """Slice effects for this slice.

            .. code-block:: python
                :emphasize-lines: 16-18

                from os import path
                import tecplot as tp

                examples_dir = tp.session.tecplot_examples_directory()
                datafile = path.join(examples_dir, 'SimpleData', 'DuctFlow.plt')
                dataset = tp.data.load_tecplot(datafile)

                plot = tp.active_frame().plot()

                plot.show_slices = True
                slice_0 = plot.slice(0)

                plot.contour(0).variable = dataset.variable('U(M/S)')
                slice_0.contour.show = True

                slice_0.effects.use_translucency = True
                slice_0.effects.surface_translucency = 70

                tp.export.save_png('slice_effects.png', 600, supersample=3)

            .. figure:: /_static/images/slice_effects.png
                :width: 300px
                :figwidth: 300px

        """
        def __init__(self, effects):
            super().__init__(effects, sv.EFFECTS)

        @property
        def lighting_effect(self):
            """Lighting effect.

            :type: `LightingEffect`

            Slice lighting effects must be enabled by setting
            `SliceContour.use_lighting_effect` or
            `SliceShade.use_lighting_effect` to `True` when setting this value.

            There are two types of lighting effects: Paneled and Gouraud:

                * `Paneled`: Within each cell, the color assigned to each area by
                    shading or contour flooding is tinted by a shade constant
                    across the cell. This shade is based on the orientation
                    of the cell relative to your 3D light source.
                * `Gouraud`: This offers smoother, more continuous shading than
                    Paneled shading, but it also results in slower plotting and
                    larger print files. `Gouraud` shading is not continuous across
                    zone boundaries unless face neighbors are specified in the
                    data. `Gouraud` shading is not available for finite element
                    volume `Zones <data_access>` when blanking is active. The
                    zone's lighting effect reverts to `Paneled` shading in this
                    case.

            Example usage::

                >>> plot.slice(0).contour.use_lighting_effect = True
                >>> plot.slice(0).effects.lighting_effect = LightingEffect.Paneled
            """
            return self._get_style(LightingEffect, sv.LIGHTINGEFFECT)

        @lighting_effect.setter
        def lighting_effect(self, value):
            self._set_style(LightingEffect(value), sv.LIGHTINGEFFECT)

        @property
        def surface_translucency(self):
            """Surface translucency of the slice group.

            :type: `integer <int>`

            Slice surface translucency must be enabled by setting
            `SliceEffects.use_translucency` = `True` when setting this value.

            Valid slice translucency values range
            from one (opaque) to 99 (translucent).

            Example usage::

                >>> plot.slice(0).effects.use_translucency = True
                >>> plot.slice(0).effects.surface_translucency = 20
            """
            return self._get_style(int, sv.SURFACETRANSLUCENCY)

        @surface_translucency.setter
        def surface_translucency(self, value):
            self._set_style(int(value), sv.SURFACETRANSLUCENCY)

        @property
        def use_translucency(self):
            """Enable surface translucency for this slice group.

            :type: `boolean <bool>`

            The surface translucency value can be changed by setting
            `SliceEffects.surface_translucency`.

            Example usage::

                >>> plot.slice(0).effects.use_translucency = True
                >>> plot.slice(0).effects.surface_translucency = 20
            """
            return self._get_style(bool, sv.USETRANSLUCENCY)

        @use_translucency.setter
        def use_translucency(self, value):
            self._set_style(bool(value), sv.USETRANSLUCENCY)

    class SliceEdge(SliceGroupStyle):
        """Edge attributes of the slice group.

            When enabled, selected edge lines of all slices in this group will
            be shown.

            .. code-block:: python
                :emphasize-lines: 14-17

                from os import path
                import tecplot as tp

                examples_dir = tp.session.tecplot_examples_directory()
                datafile = path.join(examples_dir, 'SimpleData', 'DuctFlow.plt')
                dataset = tp.data.load_tecplot(datafile)

                plot = tp.active_frame().plot()

                plot.show_slices = True
                slice_0 = plot.slice(0)

                plot.contour(0).variable = dataset.variable('U(M/S)')

                slice_0.edge.show = True
                slice_0.edge.line_thickness = 0.8

                tp.export.save_png('slice_edge.png', 600, supersample=3)

            .. figure:: /_static/images/slice_edge.png
                :width: 300px
                :figwidth: 300px

        """

        def __init__(self, vector):
            super().__init__(vector, sv.EDGELAYER)

        @property
        def edge_type(self):
            """Edge type.

            :type: `EdgeType`

            There are two types of edges in |Tecplot 360|:
            creases and borders.

            An edge border is the boundary of a `Zone <data_access>`.
            An edge crease appears when the inside angle between two
            cells is less than a user-defined limit.
            The inside angle can range from 0-180 degrees
            (where 180 degrees indicates coplanar surfaces).
            The default inside angle for determining an edge
            crease is 135 degrees.

            Example usage::

                >>> plot.slice(0).edge.show = True
                >>> plot.slice(0).edge.edge_type = EdgeType.BordersAndCreases
            """
            return self._get_style(EdgeType, sv.EDGETYPE)

        @edge_type.setter
        def edge_type(self, value):
            self._set_style(EdgeType(value), sv.EDGETYPE)

        @property
        def show(self):
            """Show edges.

            This property must be set to `True` to show any of the other edge
            properties.

            :type: `boolean <bool>`

            Example usage::

                >>> plot.slice(0).edge.show = True
                >>> plot.slice(0).edge.edge_type = EdgeType.BordersAndCreases
            """
            return self._get_style(bool, sv.SHOW)

        @show.setter
        def show(self, value):
            self._set_style(bool(value), sv.SHOW)

        @property
        def color(self):
            """Edge color.

            :type: `Color`

            Example usage::

                >>> plot.slice(0).edge.show = True
                >>> plot.slice(0).edge.color = Color.Blue
            """
            return self._get_style(Color, sv.COLOR)

        @color.setter
        def color(self, value):
            self._set_style(Color(value), sv.COLOR)

        @property
        def line_thickness(self):
            """Edge line thickness as a percentage of frame width.

            :type: `float`

            Example usage::

                >>> plot.slice(0).edge.show = True
                >>> plot.slice(0).edge.line_thickness = .8
            """
            return self._get_style(float, sv.LINETHICKNESS)

        @line_thickness.setter
        def line_thickness(self, value):
            self._set_style(float(value), sv.LINETHICKNESS)

    class SliceVector(SliceGroupStyle):
        """Vector attributes of the slice group.

        .. code-block:: python
            :emphasize-lines: 22-25

            from os import path
            import tecplot as tp
            from tecplot.constant import *

            examples_dir = tp.session.tecplot_examples_directory()
            datafile = path.join(examples_dir, 'SimpleData', 'DuctFlow.plt')
            dataset = tp.data.load_tecplot(datafile)

            plot = tp.active_frame().plot()

            plot.show_slices = True
            slice_0 = plot.slice(0)

            plot.contour(0).variable = dataset.variable('T(K)')

            # Vector variables must be assigned before displaying
            vectors = plot.vector
            vectors.u_variable = dataset.variable('U(M/S)')
            vectors.v_variable = dataset.variable('V(M/S)')
            vectors.w_variable = dataset.variable('W(M/S)')

            slice_vector = plot.slice(0).vector
            slice_vector.show = True
            slice_vector.vector_type = VectorType.MidAtPoint
            slice_vector.color = Color.BluePurple

            slice_0.effects.use_translucency = True
            slice_0.effects.surface_translucency = 30

            tp.export.save_png('slice_vector.png', 600, supersample=3)

        .. figure:: /_static/images/slice_vector.png
            :width: 300px
            :figwidth: 300px
        """

        def __init__(self, vector):
            super().__init__(vector, sv.VECTOR)

        @property
        def show(self):
            """Show vectors on slices.

            :type: `boolean <bool>`

            Example usage::

                >>> plot.slice(0).vector.show = True
            """
            return self._get_style(bool, sv.SHOW)

        @show.setter
        def show(self, value):
            self._set_style(bool(value), sv.SHOW)

        @property
        def color(self):
            """Set slice vector color.

            :type: `Color`

            Example usage::

                >>> plot.slice(0).vector.show = True
                >>> plot.slice(0).vector.color = Color.Red
            """
            return self._get_style(Color, sv.COLOR)

        @color.setter
        def color(self, value):
            self._set_style(Color(value), sv.COLOR)

        @property
        def is_tangent(self):
            """Use tangent vectors for slices.

            :type: `boolean <bool>`

            Example usage::

                >>> plot.slice(0).vector.show = True
                >>> plot.slice(0).vector.is_tangent = True
            """
            return self._get_style(bool, sv.ISTANGENT)

        @is_tangent.setter
        def is_tangent(self, value):
            self._set_style(bool(value), sv.ISTANGENT)

        @property
        def line_thickness(self):
            """Vector line thickness as a percentage of the frame height.

            :type: `float`

            Typical values are .02, .1, .4, .8, 1.5

            Example usage::

                >>> plot.slice(0).vector.show = True
                >>> plot.slice(0).vector.line_thickness = .1
            """
            return self._get_style(float, sv.LINETHICKNESS)

        @line_thickness.setter
        def line_thickness(self, value):
            self._set_style(float(value), sv.LINETHICKNESS)

        @property
        def vector_type(self):
            """Type of vector for slices in this slice group.

            :type: `VectorType`

            Example usage::

                >>> plot.slice(0).vector.show = True
                >>> plot.slice(0).vector.vector_type = VectorType.MidAtPoint
            """
            return self._get_style(VectorType, sv.VECTORTYPE)

        @vector_type.setter
        def vector_type(self, value):
            self._set_style(VectorType(value), sv.VECTORTYPE)

        @property
        def arrowhead_style(self):
            """Arrowhead style of slice vectors.

            :type: `ArrowheadStyle`

            Example usage::

                >>> plot.slice(0).vector.show = True
                >>> plot.slice(0).vector.arrowhead_style = ArrowheadStyle.Hollow
            """
            return self._get_style(ArrowheadStyle, sv.ARROWHEADSTYLE)

        @arrowhead_style.setter
        def arrowhead_style(self, value):
            self._set_style(ArrowheadStyle(value), sv.ARROWHEADSTYLE)

    class SliceContour(SliceGroupStyle):
        """Contour attributes of the slice group.

        .. code-block:: python
            :emphasize-lines: 19-22

            from os import path
            import tecplot as tp
            from tecplot.constant import SliceSurface, ContourType

            examples_dir = tp.session.tecplot_examples_directory()
            datafile = path.join(examples_dir, 'SimpleData', 'DuctFlow.plt')
            dataset = tp.data.load_tecplot(datafile)

            plot = tp.active_frame().plot()

            plot.show_slices = True
            slice_0 = plot.slice(0)

            # Use contour(0) for Flooding and contour(2) for Lines
            plot.contour(0).variable = dataset.variable('P(N/m2)')
            plot.contour(2).variable = dataset.variable('T(K)')
            plot.contour(2).legend.show = False
            plot.contour(2).labels.show = True
            slice_0.contour.show = True
            slice_0.contour.flood_contour_group = plot.contour(0)
            slice_0.contour.line_contour_group = plot.contour(2)
            slice_0.contour.contour_type = ContourType.Overlay  # AKA "Both lines and flood"

            slice_0.show_primary_slice = False
            slice_0.show_start_and_end_slices = True
            slice_0.show_intermediate_slices = True
            slice_0.start_position = (-.21, .05, .025)
            slice_0.end_position = (1.342, .95, .475)
            slice_0.num_intermediate_slices = 3

            tp.export.save_png('slice_contour.png', 600, supersample=3)

        .. figure:: /_static/images/slice_contour.png
            :width: 300px
            :figwidth: 300px
        """
        def __init__(self, parent_slice):
            super().__init__(parent_slice, sv.CONTOUR)
            self.plot = parent_slice.plot

        @property
        def show(self):
            """Show contours on the slice.

            :type: `bool`

            Example usage::

                >>> plot.show_slices = True
                >>> plot.slice(1).contour.show = True
            """
            return self._get_style(bool, sv.SHOW)

        @show.setter
        def show(self, value):
            self._set_style(bool(value), sv.SHOW)

        @property
        def contour_type(self):
            """Contour type for the slice contours.

            :type: `ContourType`

            Example usage::

                >>> plot.show_slices = True
                >>> plot.slice(0).contour.contour_type = ContourType.AverageCell
            """
            return self._get_style(ContourType, sv.CONTOURTYPE)

        @contour_type.setter
        def contour_type(self, value):
            self._set_style(ContourType(value), sv.CONTOURTYPE)

        @property
        def line_color(self):
            """`Color` of contour lines.

            Selecting `Color.MultiColor` will color the slice contour lines
            based on the `contour group <tecplot.plot.ContourGroup>` variable.

            :type: `Color`

            Example usage::

                >>> plot.show_slices = True
                >>> plot.slice(0).contour.line_color = Color.Blue
            """
            return self._get_style(Color, sv.COLOR)

        @line_color.setter
        def line_color(self, value):
            self._set_style(Color(value), sv.COLOR)

        @property
        def line_thickness(self):
            """Contour line thickness as a percentage of frame width.

            Suggested values are one of: **.02, .1, .4, .8, 1.5**

            :type: `float`

            Example usage::

                >>> plot.show_slices = True
                >>> plot.slice(0).contour.line_thickness = .4
            """
            return self._get_style(float, sv.LINETHICKNESS)

        @line_thickness.setter
        def line_thickness(self, value):
            self._set_style(float(value), sv.LINETHICKNESS)

        @property
        def flood_contour_group_index(self):
            """The `Index` of the `ContourGroup` to use for flooding.

            :type: `Index` (zero-based index)

            This property sets and gets, by `Index`, the `ContourGroup` used for
            flooding. Changing style on this `ContourGroup` will affect all
            fieldmaps on the same `Frame` that use it.

            Example usage::

                >>> plot.show_slices = True
                >>> contour = plot.slice(0).contour
                >>> contour.flood_contour_group_index = 1
            """
            return self._get_style(Index, sv.FLOODCOLORING)

        @flood_contour_group_index.setter
        def flood_contour_group_index(self, index):
            self._set_style(Index(index), sv.FLOODCOLORING)

        @property
        def flood_contour_group(self):
            """Contour group to use for flooding.

            :type: `ContourGroup`

            Changing style on this `ContourGroup` will affect all
            fieldmaps on the same `Frame` that use it.

            Example usage::

                >>> group = plot.contour(1)
                >>> contour = plot.slice(1).contour
                >>> contour.flood_contour_group = group
            """
            return self.plot.contour(self.flood_contour_group_index)

        @flood_contour_group.setter
        def flood_contour_group(self, flood_contour_group):
            self.flood_contour_group_index = flood_contour_group.index

        @property
        def line_contour_group_index(self):
            """The `Index` of the `ContourGroup` to use for contour lines.

            :type: `integer <int>` (zero-based index)

            This property sets and gets, by `Index`, the `ContourGroup` used for
            line placement. Although all properties of the `ContourGroup` can be
            manipulated through this object, many of them (i.e., color) will not
            affect the lines unless the `FieldmapContour.line_color` is set to the
            same `ContourGroup`. Note that changing style on this `ContourGroup`
            will affect all other fieldmaps on the same `Frame` that use it.

            Example usage::

                >>> plot.show_slices = True
                >>> contour = plot.slice(0).contour
                >>> contour.line_contour_group_index = 2
            """
            return self._get_style(Index, sv.LINECONTOURGROUP)

        @line_contour_group_index.setter
        def line_contour_group_index(self, index):
            self._set_style(Index(index), sv.LINECONTOURGROUP)

        @property
        def line_contour_group(self):
            """Contour group to use for contour lines.

            :type: `ContourGroup`

            Changing style on this `ContourGroup` will affect all
            fieldmaps on the same `Frame` that use it.

            Example usage::

                >>> group = plot.contour(1)
                >>> contour = plot.slice(1).contour
                >>> contour.line_contour_group = group
            """
            return self.plot.contour(self.line_contour_group_index)

        @line_contour_group.setter
        def line_contour_group(self, line_contour_group):
            self.line_contour_group_index = line_contour_group.index

        @property
        def use_lighting_effect(self):
            """Enable lighting effect.

            .. note::
                Setting `SliceContour.use_lighting_effect` will also set
                the same value for `SliceShade.use_lighting_effect`,
                and vice-versa.

            The lighting effect is set with `SliceEffects.lighting_effect`, and may
            be one of `LightingEffect.Gouraud` or `LightingEffect.Paneled`.

            :type: `boolean <bool>`

            Example usage::

                >>> plot.show_slices = True
                >>> contour = plot.slice(0).contour
                >>> contour.use_lighting_effect = True
                >>> plot.slice(0).effects.lighting_effect = LightingEffect.Paneled
            """
            return self._get_style(bool, sv.USELIGHTINGEFFECT)

        @use_lighting_effect.setter
        def use_lighting_effect(self, value):
            self._set_style(bool(value), sv.USELIGHTINGEFFECT)

    class SliceGroup(session.Style):
        """Change attributes associated with slices.

        Slices can include lighting effects, contours, meshes, and more.
        To customize these and other attributes of slices, use this object.

        This object controls the style for a specific slice group within a
        `Frame`. Slice `contour <SliceGroup.contour>`,
        vector, edge, effects, mesh, visibility and position
        information are accessed through this class.

        .. code-block:: python
            :emphasize-lines: 19-40

            from os import path
            import tecplot as tp
            from tecplot.constant import *

            examples_dir = tp.session.tecplot_examples_directory()
            datafile = path.join(examples_dir, 'SimpleData', 'DuctFlow.plt')
            dataset = tp.data.load_tecplot(datafile)

            plot = tp.active_frame().plot()
            plot.contour(0).variable = dataset.variable('U(M/S)')
            plot.show_edge = True
            plot.fieldmap(0).edge.edge_type = EdgeType.Creases

            vectors = plot.vector
            vectors.u_variable = dataset.variable('U(M/S)')
            vectors.v_variable = dataset.variable('V(M/S)')
            vectors.w_variable = dataset.variable('W(M/S)')

            plot.show_slices = True
            slice_0 = plot.slice(0)

            slice_0.contour.show = True
            slice_0.contour.contour_type = ContourType.Overlay  # AKA "Both lines and flood"

            slice_0.effects.use_translucency = True
            slice_0.effects.surface_translucency = 30

            # Show an arbitrary slice
            slice_0.orientation = SliceSurface.Arbitrary
            slice_0.arbitrary_normal = (1, .5, 0)

            slice_0.show_primary_slice = False
            slice_0.show_start_and_end_slices = True
            slice_0.start_position = (-.21, .05, .025)
            slice_0.end_position = (1.342, .95, .475)
            slice_0.show_intermediate_slices = True
            slice_0.num_intermediate_slices = 3

            slice_0.edge.show = True
            slice_0.edge.line_thickness = 0.4

            tp.export.save_png('slice_example.png', 600, supersample=3)

        .. figure:: /_static/images/slice_example.png
            :width: 300px
            :figwidth: 300px

        Up to eight different slice groups can be set.
        Each slice group can use different slice planes or
        different ranges for the same slice plane.

            >>> slice_3 = plot.slice(3)
            >>> slice_3.contour.show = True
        """
        def __init__(self, index, plot):
            if __debug__:
                assert 0 <= index < 8, 'Slice index out of range (must be < 8)'
            self.index = Index(index)
            self.plot = plot
            super().__init__(sv.SLICEATTRIBUTES, uniqueid=self.plot.frame.uid,
                             offset1=self.index)

        def __eq__(self, other):
            return (self.index == other.index) and (self.plot == other.plot)

        def __ne__(self, other):
            return not self.__eq__(other)

        _XYZ = namedtuple('XYZ', ['x', 'y', 'z'])
        _XYZ.__new__.__defaults__ = (None, None, None)

        def _is_ijk(self):
            return self.orientation in (
                SliceSurface.IPlanes,
                SliceSurface.JPlanes,
                SliceSurface.KPlanes)

        class _SlicePosition(object):
            """Internal slice position type.

                Looks and quacks like a quasi 3-tuple
                of `float` (xyz) or `int` (ijk).

                Allows access by float 'x', 'y', 'z' if the parent slice has
                XYZ orientation, or int 'i','j','k' if the parent slice has
                IJK orientation.

                Overloads +=, -=, add/sub/neg.
            """
            # Alternatively we could subclass tuple
            def __init__(self, parent_slice, x_or_i, y_or_j, z_or_k):
                assert isinstance(parent_slice, SliceGroup)
                assert isinstance(x_or_i, (float, Integral))
                assert isinstance(y_or_j, (float, Integral))
                assert isinstance(z_or_k, (float, Integral))
                self._parent_slice = parent_slice
                self._x_or_i = x_or_i
                self._y_or_j = y_or_j
                self._z_or_k = z_or_k

            def _is_ijk(self):
                return self._parent_slice._is_ijk()

            @property
            def x(self):
                if __debug__ and self._is_ijk():
                    raise AttributeError('Cannot access "x" for IJK slice position')
                return self._x_or_i

            @property
            def y(self):
                if __debug__ and self._is_ijk():
                    raise AttributeError('Cannot access "y" for IJK slice position')
                return self._y_or_j

            @property
            def z(self):
                if __debug__ and self._is_ijk():
                    raise AttributeError('Cannot access "z" for IJK slice position')
                return self._z_or_k

            @property
            def i(self):
                if __debug__ and not self._is_ijk():
                    raise AttributeError('Cannot access "i" for XYZ slice position')
                return self._x_or_i

            @property
            def j(self):
                if __debug__ and not self._is_ijk():
                    raise AttributeError('Cannot access "j" for XYZ slice position')
                return self._y_or_j

            @property
            def k(self):
                if __debug__ and not self._is_ijk():
                    raise AttributeError('Cannot access "k" for XYZ slice position')
                return self._z_or_k

            def __neg__(self):
                self._x_or_i = -self._x_or_i
                self._y_or_j = -self._y_or_j
                self._z_or_k = -self._z_or_k
                return self

            def __iadd__(self, other):  # operator +=
                if isinstance(other, (tuple, list, SliceGroup._SlicePosition)) and (
                              len(other) == 3):
                    self._x_or_i += other[0]
                    self._y_or_j += other[1]
                    self._z_or_k += other[2]
                else:
                    raise TecplotAttributeError('Expected a 3-tuple of floats or ints')

                return self

            def __isub__(self, other):  # operator -=
                return self.__iadd__((-other[0], -other[1], -other[2]))

            def __iter__(self):  # This lets us to cast to a real tuple
                yield self._x_or_i
                yield self._y_or_j
                yield self._z_or_k

            def __getitem__(self, item):
                if not 0 <= item <= 2:
                    raise IndexError('Slice position tuple '
                                     'index must be between 0 and 2')
                return tuple(self)[item]

            def __str__(self):
                return 'Slice Position: ({x}, {y}, {z})'.format(
                    x=self._x_or_i, y=self._y_or_j, z=self._z_or_k)

            def __eq__(self, other):
                return tuple(self) == tuple(other)

            def __len__(self):
                return 3

        def _set_slice_position(self, value, style):
            if not isinstance(value, (tuple, list, SliceGroup._SlicePosition)):
                raise TecplotLogicError(
                    'Slice position must be a 3-tuple of floats or ints')
            if self._is_ijk():
                self._set_style(Index(value[0]), style, sv.I)
                self._set_style(Index(value[1]), style, sv.J)
                self._set_style(Index(value[2]), style, sv.K)
            else:
                self._set_style(float(value[0]), style, sv.X)
                self._set_style(float(value[1]), style, sv.Y)
                self._set_style(float(value[2]), style, sv.Z)

        def _get_slice_position(self, style):
            is_ijk = self._is_ijk()
            pos = (sv.I, sv.J, sv.K) if is_ijk else (sv.X, sv.Y, sv.Z)
            style_type = Index if is_ijk else float

            result = self._SlicePosition(self,
                                         self._get_style(style_type, style, pos[0]),
                                         self._get_style(style_type, style, pos[1]),
                                         self._get_style(style_type, style, pos[2]))
            return result

        @property
        def vector(self):
            """Vector attributes for this slice group.

            :type:  `SliceVector`

            Example usage::

                >>> plot.slice(0).vector.show = True
            """
            return SliceVector(self)

        @property
        def edge(self):
            """Edge attributes for this slice group.

            :type: `SliceEdge`

            Example usage::

                >>> plot.slice(0).edge.show = True
            """
            return SliceEdge(self)

        @property
        def effects(self):
            """Effects attributes for this slice group.

                :type: `SliceEffects`

                Example usage::

                    >>> plot.slice(0).effects.use_translucency = True
            """
            return SliceEffects(self)

        @property
        def shade(self):
            """Shade attributes for this slice group.

            :type: `SliceShade`

            Example usage::

                >>> plot.slice(0).shade.show = True
            """
            return SliceShade(self)

        @property
        def mesh(self):
            """Mesh attributes for this slice group.

            :type: `SliceMesh`

            Example usage::

                >>> plot.slice(0).mesh.show = True
            """
            return SliceMesh(self)

        @property
        def show(self):
            """Show slices for this slice group.

            :type: `bool`

            Example usage::

                >>> plot.slice(0).show = True
            """
            return self._get_style(bool, sv.SHOWGROUP)

        @show.setter
        def show(self, value):
            self._set_style(bool(value), sv.SHOWGROUP)

        @property
        def show_primary_slice(self):
            """Include the primary slice (first slice placed) in the `Plot`.

            :type: `bool`

            Example usage::

                >>> plot.slice(0).show = True
                >>> plot.slice(0).show_primary_slice = True

            """
            return self._get_style(bool, sv.SHOWPRIMARYSLICE)

        @show_primary_slice.setter
        def show_primary_slice(self, value):
                self._set_style(bool(value), sv.SHOWPRIMARYSLICE)

        @property
        def contour(self):
            """Contour attributes for the slice group.

            :type: `SliceContour`

            Example usage::

                >>> plot.slice(0).contour.show = True
            """
            return SliceContour(self)

        @property
        def orientation(self):
            """Select which plane the slice is drawn on (X,Y,Z, I, J, K or arbitrary).

            :type: `SliceSurface`

            You may also choose `SliceSurface.Arbitrary` to place the
            slice on an arbitrary plane.

            To orient slices in an arbitrary direction,
            choose `SliceSurface.Arbitrary`.
            As with other slices, you may specify origin points for a primary
            slice and/or for start and end slices. Slices pass through the
            indicated origin point(s), so you can easily align the edge of a
            slice or group of slices along some other feature of the plot,
            such as an axis. If intermediate slices are activated,
            they are drawn equally spaced between the slices
            defined by the start and end origins.

            Example usage::

                >>> plot.slice(0).orientation = SliceSurface.XPlanes
            """
            return self._get_style(SliceSurface, sv.SLICESURFACE)

        @orientation.setter
        def orientation(self, value):
            self._set_style(SliceSurface(value), sv.SLICESURFACE)

        @property
        def arbitrary_normal(self):
            """Normal for arbitrary slices.

            :type: 3-`tuple` of floats

            Example usage::

                >>> plot.slice(0).orientation = SliceSurface.Arbitrary
                >>> plot.slice(0).arbitrary_normal = (0.1, 0.2, 0.3)
                >>> plot.slice(0).arbitrary_normal.x
                0.1
                >>> plot.slice(0).arbitrary_normal.y
                0.2
                >>> plot.slice(0).arbitrary_normal.z
                0.3
            """
            return self._XYZ(self._get_style(float, sv.NORMAL, sv.X),
                             self._get_style(float, sv.NORMAL, sv.Y),
                             self._get_style(float, sv.NORMAL, sv.Z))

        @arbitrary_normal.setter
        def arbitrary_normal(self, value):
            self._set_style(float(value[0]), sv.NORMAL, sv.X)
            self._set_style(float(value[1]), sv.NORMAL, sv.Y)
            self._set_style(float(value[2]), sv.NORMAL, sv.Z)

        @property
        def origin(self):
            """Origin of the slice.

            :type: 3-`tuple` of `float` if `orientation` is X,Y,Z
                or zero-based `int` if `orientation` is I,J,K

            For arbitrary slice orientation, the origin can be any location.
            For axis orientations (`XPlanes`, `YPlanes`, etc.) two of
            the three components are not used.

            Example usage::

                >>> slice_0 = plot.slice(0)
                >>> slice_0.orientation = SliceSurface.IPlanes
                >>> slice_0.origin = (1, 0, 0)
                >>> dx = (1, 1, 1)
                >>> slice_0.origin += dx
                >>> slice_0.origin.i
                2
                >>> slice_0.origin.j
                1
                >>> slice_0.origin.k
                1

                >>> slice_0.orientation = SliceSurface.Arbitrary
                >>> slice_0.origin = (.5, .1, .1)
                >>> slice_0.origin += dx
                >>> slice_0.origin.x
                1.5
                >>> slice_0.origin.y
                .1
                >>> slice_0.origin.z
                .1
            """
            return self._get_slice_position(sv.PRIMARYPOSITION)

        @origin.setter
        def origin(self, value):
            self._set_slice_position(value, sv.PRIMARYPOSITION)

        @property
        def num_intermediate_slices(self):
            """Number of intermediate slicing planes.

            You may specify between 1 and 5,000 intermediate slices.

            :type: `integer <int>`

            Example usage::

                >>> # Show 2 intermediate slices
                >>> plot.slice(0).num_intermediate_slices = 2
            """
            return self._get_style(int, sv.NUMINTERMEDIATESLICES)

        @num_intermediate_slices.setter
        def num_intermediate_slices(self, value):
            self._set_style(int(value), sv.NUMINTERMEDIATESLICES)

        @property
        def show_intermediate_slices(self):
            """Show intermediate slices.

            Intermediate slices are evenly distributed between the start and end
            slices.

            Example usage::

                >>> plot.slice(0).show_intermediate_slices = True
            """
            return self._get_style(bool, sv.SHOWINTERMEDIATESLICES)

        @show_intermediate_slices.setter
        def show_intermediate_slices(self, value):
            self._set_style(bool(value), sv.SHOWINTERMEDIATESLICES)

        @property
        def obey_source_zone_blanking(self):
            """Obey source zone blanking.

            When set to `True`, slices are subject to any blanking used for
            the data. When set to `False`, slices are generated for blanked
            and unblanked regions.

            :type: `boolean <bool>`

            Example usage::

                >>> plot.slice(0).obey_source_zone_blanking = True
            """
            return self._get_style(bool, sv.OBEYSOURCEZONEBLANKING)

        @obey_source_zone_blanking.setter
        def obey_source_zone_blanking(self, value):
            self._set_style(bool(value), sv.OBEYSOURCEZONEBLANKING)

        @property
        def slice_source(self):
            """`Zones <data_access>` to slice through.

            Choose to slice through volume `Zones <data_access>`, surface `Zones
            <data_access>`, or the surfaces of volume `Zones <data_access>`.

            :type: `SliceSource`

            Example usage::

                >>> plot.slice(0).slice_source = SliceSource.SurfaceZones
            """
            return self._get_style(SliceSource, sv.SLICESOURCE)

        @slice_source.setter
        def slice_source(self, value):
            self._set_style(SliceSource(value), sv.SLICESOURCE)

        @property
        def show_start_and_end_slices(self):
            """Include start and end slices.

            :type: `boolean <bool>`

            Example usage::

                >>> plot.slice(0).show_start_and_end_slices = True
            """
            return self._get_style(bool, sv.SHOWSTARTENDSLICE)

        @show_start_and_end_slices.setter
        def show_start_and_end_slices(self, value):
            self._set_style(bool(value), sv.SHOWSTARTENDSLICE)

        @property
        def end_position(self):
            """Position of the end slice.

            `SliceGroup.show_start_and_end_slices` must be `True` to show the end
            slice.

            :type: 3-`tuple` of `float` if `orientation` is X,Y,Z
                or zero-based `int` if `orientation` is I,J,K

            Example usage::

                >>> plot.slice(0).show_start_and_end_slices = True
                >>> plot.slice(0).end_position = (1, 1, 1)
                >>> plot.slice(0).end_position.i
                1
            """
            return self._get_slice_position(sv.ENDPOSITION)

        @end_position.setter
        def end_position(self, value):
            self._set_slice_position(value, sv.ENDPOSITION)

        @property
        def start_position(self):
            """Position of the start slice.

            `SliceGroup.show_start_and_end_slices` must be `True` to show the start
            slice.

            :type: 3-`tuple` of `float` if `orientation` is X,Y,Z
                or zero-based `int` if `orientation` is I,J,K

            Example usage::

                >>> plot.slice(0).show_start_and_end_slices = True
                >>> plot.slice(0).start_position = (1, 1, 1)
                >>> plot.slice(0).start_position.i
                1
            """
            return self._get_slice_position(sv.STARTPOSITION)

        @start_position.setter
        def start_position(self, value):
            self._set_slice_position(value, sv.STARTPOSITION)

        @property
        def surface_generation_method(self):
            """Determines how the surface is generated.

                :type: `SurfaceGenerationMethod`

                May be one of:

                * `SurfaceGenerationMethod.AllTriangles`:
                    An advanced algorithm that can handle
                    complex saddle issues and guarantees that there will
                    be no holes in the final surface. As the surface is
                    composed entirely of triangles, it can be delivered
                    more efficiently to the graphics hardware.
                * `SurfaceGenerationMethod.AllowQuads`:
                    Produces quads or triangles, and the
                    resulting surface more closely resembles the shape of
                    the volume cells from the source zone. Since the quads
                    are not arbitrarily divided into triangles, no biases
                    are introduced, and the resulting surface may appear
                    smoother. Preferred when the source zone is FE-Brick
                    or IJK-Ordered and the surface is aligned with the
                    source cells.

                Example usage::

                    >>> from tecplot.constant import SurfaceGenerationMethod
                    >>> plot.slice(0).surface_generation_method = SurfaceGenerationMethod.AllowQuads
            """
            return self._get_style(SurfaceGenerationMethod,
                                   sv.SURFACEGENERATIONMETHOD)

        @surface_generation_method.setter
        def surface_generation_method(self, value):
            if __debug__:
                if version.sdk_version_info < (2017, 2):
                    msg = 'setting surface generation method requires' \
                          ' Tecplot 360 2017 R2 or later.'
                    raise TecplotOutOfDateEngineError(msg)
            self._set_style(SurfaceGenerationMethod(value),
                            sv.SURFACEGENERATIONMETHOD)

        @lock()
        def set_arbitrary_from_points(self, p1, p2, p3):
            """Set an arbitrary slice from 3 points.

            Set the normal and origin of an arbitrary slice using three points.
            The origin will be set to the 3rd point.

            The three points must not be coincident or collinear.
            The slice's origin is set to the third point and its normal
            is recalculated such that the cutting plane passes through all three
            points.

            Parameters::

                p1:  3-`tuple` of floats
                p2:  3-`tuple` of floats
                p3:  3-`tuple` of floats

            Example usage::

                >>> slice_0 = plot.slice(0)
                >>> slice_0.set_arbitrary_from_points((0,0,0), (.1,.2,.3), (.1,.1,.1))
            """
            if not _tecutil.SliceSetArbitraryUsingThreePoints(
                    self.uniqueid, self.offset1+1, *it.chain(p1, p2, p3)):
                        raise TecplotSystemError(
                            'Error creating arbitrary slice from three points')

### Navigation

- index
- modules |