geoparticle.ops.Shift

class Shift(geo: Geometry, x: float | None = None, y: float | None = None, z: float | None = None, name=None)

Bases: Geometry

Shift geometry by given offsets in x, y, z directions.

Shortest import: from geoparticle import Shift

__init__(geo: Geometry, x: float | None = None, y: float | None = None, z: float | None = None, name=None)

Initialize a Shift object that shifts a geometry by specified offsets.

Parameters:

• geo (Geometry) – The source geometry to shift.

• x (float | None) – Shift in the x-direction. Defaults to None.

• y (float | None) – Shift in the y-direction. Defaults to None.

• z (float | None) – Shift in the z-direction. Defaults to None.

• name (str, optional) – Name of the resulting geometry. Defaults to None.

Methods

__init__(geo[, x, y, z, name])	Initialize a Shift object that shifts a geometry by specified offsets.
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