geoparticle.shapes.SymmLines

class SymmLines(length: float, direction: str, symm_plane: str, dist_half: float, dl: float, anchor: Sequence[float] = (0, 0, 0), name=None)[source]

Bases: Geometry

Two symmetrical lines centered at origin and aligned along direction.

Shortest import: from geoparticle import SymmLines

__init__(length: float, direction: str, symm_plane: str, dist_half: float, dl: float, anchor: Sequence[float] = (0, 0, 0), name=None)[source]
Parameters:

  • length (float) – Length of each symmetrical line.

  • direction (str) – Principal axis direction (‘x’, ‘y’, or ‘z’).

  • symm_plane (str) – Symmetrical plane (‘XOY’, ‘YOZ’, or ‘XOZ’).

  • dist_half (float) – Half the distance between the two lines.

  • dl (float) – Spacing between points along the lines.

  • anchor (Sequence[float]) – The anchor coordinate to determine the absolute position of the symmetrical lines. The anchor is one of the symmetrical line ends with a smaller coordinate along the principal axis. Defaults to (0,0,0).

  • name (str, optional) – Name of the symmetrical lines. Defaults to None.

Methods

__init__(length, direction, symm_plane, ...)

param length:

Length of each symmetrical line.

check_overlap([tol])

Check if there are overlapping points in the geometry.

clip(keep, *[, plane_name, plane_normal, ...])

Clip geometry by a half-space defined by a named plane or an arbitrary plane.

coord2id(x, y, z)

Find the nearest vertex index/indices and its/their coordinates.

copy([name])

Create a deep copy of the geometry object.

equal(geo)

Check if two geometries are equal based on their coordinates.

get_and_delete(ids)

Extract points by their indices and remove them from the geometry.

get_counter()

Get the current value of the class-wide counter.

intersect(geometries[, rmax, inplace, name])

Keep points from self that are within rmax of at least one point in every other geometry.

load_from(other)

Copy coordinate arrays and dimension from another Geometry into this instance.

mirror(plane_name, plane_pos[, inplace, name])

Mirror the geometry across a principal plane.

plot([ax, ms, alpha])

Plot the geometry points in 2D.

rotate(angle_deg[, axis_direction, ...])

Rotate the geometry around a principal axis or a custom axis.

set_coord(xs, ys, zs)

Set the coordinates of the geometry, broadcasting scalars if necessary.

shift([x, y, z, inplace, name])

Translate the geometry by the given offsets.

stack(axis, n_axis, dl, dimension[, ...])

Stack a planar layer (self) along axis by repeating points at spacing dl.

subtract(geo2[, rmax, inplace, name])

Return points from self that are at least rmax away from any point in geo2.

union(geometries[, inplace, name])

Concatenate this geometry with others and return a new Geometry.

Attributes

counter

flatten_coords

Get the flattened array of coordinates.

matrix_coords

Get the coordinates as a 2D array.

size

Get the number of points in the geometry.
counter = 0