s3dlib.surface.PlanarSurface

class s3dlib.surface.PlanarSurface(rez=0, basetype=None, name=None, **kwargs)

Bases: Surface3DCollection

Flat square 3D surface in Cartesian coordinates.

Methods are inherited from the Surface3DCollection. Planar surface geometries are created in this subclass.

Create flat square surface of 2 x 2 units.

Parameters:

• rez (integer, optional, default: 0) – Number of recursive subdivisions of the triangulated base faces. Rez values range from 0 to 7.

• basetype ({'quad','oct1','oct2','squ'}, optional, default: 'quad') – Starting surface geometries from which the surface is constructed using recursive subdivisions of the faces.

• name (string, optional, default: None.) – Descriptive identifier for the geometry.

• **kwargs – All other parameters are passed on to ‘s3dlib.surface.Surface3DCollection’.

Raises:

ValueError – If rez is not an integer in range 0 to 7. If basetype is not recognized for this surface constructor.

domain(xlim=None, ylim=None, zcoor=None)

Set the domain of the planar surface.

Used for setting the limits of the base plane.

Parameters:

• xlim (2d arrays) – Minimum and maximum values of the arrays are used to scale and translate the surface from an intial domains of [ -1, 1 ] If set to None, the domains are unchanged.

• ylim (2d arrays) – Minimum and maximum values of the arrays are used to scale and translate the surface from an intial domains of [ -1, 1 ] If set to None, the domains are unchanged.

• zcoor (number, default : 0) – Z offset of the plane. If set to None, the Z offset is unchanged.

Returns:

self (PlanarSurface object)

classmethod grid(xdiv, ydiv, basetype='r', minrad=None, name=None, **kwargs)

PlanarSurface with X and Y rectangular faces.

Parameters:

• xdiv (integer, required.) – Number of X divisions.

• ydiv (integer, required.) – Number of Y divisions.

• basetype ({'d','r'}, optional, default: 'r') – Starting surface geometries from which the surface is constructed indicating face shape.

• minrad (placeholder, not used.) –

• name (string, optional, default: None.) – Descriptive identifier.

• **kwargs – All other parameters are passed on to ‘s3dlib.surface.Surface3DCollection’.

Raises:

ValueError – If xdiv is not an integer greater or equal to 1. If ydiv is not an integer greater or equal to 1.

Returns:

surface (PlanarSurface object.)

static meshgrid(X, Y, Z, revnormal=False, grid=False, name=None)

PlanarSurface object based on a meshgrid.

Parameters:

• X (N x M arrays) – Cartesian x,y,z coordinate values.

• Y (N x M arrays) – Cartesian x,y,z coordinate values.

• Z (N x M arrays) – Cartesian x,y,z coordinate values.

• revnormal ({ True, False }, boolean, default: False) – Reverse the face normal directions if True.

• grid ({ True, False }, boolean, default: False) – If True, polygon faces are rectangular. If False, polygon faces are triangular.

• name (string, optional, default: None.) – Descriptive identifier for the mesh surface.

Returns:

surface (PlanarSurface object)

classmethod pntsurf(xyz_points, name=None, **kargs)

PlanarSurface from points in Cartesian coordinates.

Parameters:

• xyz_points (array, required.) – An N X 3, or N X 4, array of N Cartesian coordinate points. For an N X 4 array, the 4th is the vertex scalar value.

• name (string, optional, default: None.) – Descriptive identifier for the point surface.

Returns:

surface (PlanarSurface object)

static rand(rez=0, seed=None, name=None, kind=None, **kargs)

PlanarSurface with random triangular faces.

Parameters:

• rez (number, optional, default: 0) – Number of ‘recursive’ subdivisions of the triangulated base faces. Rez values range from 0 to 7.

• seed (integer, optional, default: None) – An initialization seed for random generation.

• name (string, optional, default: None.) – Descriptive identifier for the geometry.

• kind (string, optional, default: None) – (reserved, not implemented)

• **kwargs – All other parameters are passed on to ‘s3dlib.surface.Surface3DCollection’.

Raises:

ValueError – If rez is not an integer in range 0 to 7. If basetype is not recognized for this surface constructor.

Returns:

surface (PlanarSurface object.)

scale_dataframe(X, Y, Z)

Scaling the surface geometry based on a datagrid.

Parameters:

• X (N x M arrays) – Minimum and maximum values of the arrays are used to scale and translate the surface from an intial domain of [ (-1,1), (-1,1), (0,1) ]

• Y (N x M arrays) – Minimum and maximum values of the arrays are used to scale and translate the surface from an intial domain of [ (-1,1), (-1,1), (0,1) ]

• Z (N x M arrays) – Minimum and maximum values of the arrays are used to scale and translate the surface from an intial domain of [ (-1,1), (-1,1), (0,1) ]

Returns:

self (PlanarSurface object)

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, sort_zpos=<UNSET>, surface_alpha=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, verts_and_codes=<UNSET>, vertvals=<UNSET>, visible=<UNSET>, zorder=<UNSET>, zsort=<UNSET>)

Set multiple properties at once.

Supported properties are

Properties:

agg_filter: a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alpha: array-like or scalar or None animated: bool antialiased or aa or antialiaseds: bool or list of bools array: array-like or None capstyle: .CapStyle or {‘butt’, ‘projecting’, ‘round’} clim: (vmin: float, vmax: float) clip_box: .Bbox clip_on: bool clip_path: Patch or (Path, Transform) or None cmap: .Colormap or str or None color: color or list of rgba tuples edgecolor or ec or edgecolors: unknown facecolor or facecolors or fc: unknown figure: .Figure gid: str hatch: {‘/’, ‘\’, ‘|’, ‘-’, ‘+’, ‘x’, ‘o’, ‘O’, ‘.’, ‘*’} in_layout: bool joinstyle: .JoinStyle or {‘miter’, ‘round’, ‘bevel’} label: object linestyle or dashes or linestyles or ls: str or tuple or list thereof linewidth or linewidths or lw: float or list of floats norm: .Normalize or None offset_transform: .Transform offsets: (N, 2) or (2,) array-like path_effects: .AbstractPathEffect paths: list of array-like picker: None or bool or float or callable pickradius: float rasterized: bool sizes: ndarray or None sketch_params: (scale: float, length: float, randomness: float) snap: bool or None sort_zpos: unknown surface_alpha: scalar transform: .Transform url: str urls: list of str or None verts: unknown verts_and_codes: unknown vertvals: list or array of length N, where N is the visible: bool zorder: float zsort: {‘average’, ‘min’, ‘max’}