BoundingRegionsMixin

class sknano.core.atoms.mixins.BoundingRegionsMixin[source] [edit on github][source]

Bases: object

Mixin Atoms class for computing bounding regions.

Attributes

bounding_box Axis-aligned bounding box of Atoms.
bounding_region Bounding Geometric3DRegion.
bounding_sphere Bounding Sphere of Atoms.
bounds Alias for bounding_region.
coordinates_bounding_box Bounding box of atom coordinates.
lattice_region lattice region.
volume Volume of region containing atoms.

Methods

within_region(region) Returns new Atoms object containing atoms within region.

Attributes Summary

bounding_box Axis-aligned bounding box of Atoms.
bounding_region Bounding Geometric3DRegion.
bounding_sphere Bounding Sphere of Atoms.
bounds Alias for bounding_region.
coordinates_bounding_box Bounding box of atom coordinates.
lattice_region lattice region.
volume Volume of region containing atoms.

Methods Summary

within_region(region) Returns new Atoms object containing atoms within region.

Attributes Documentation

bounding_box

Axis-aligned bounding box of Atoms.

Returns:
Return type:Cuboid
bounding_region

Bounding Geometric3DRegion.

Returns:The Parallelepiped attached to the Crystal3DLattice of the LatticeAtoms class.
Return type:Geometric3DRegion
bounding_sphere

Bounding Sphere of Atoms.

Returns:
Return type:Sphere
bounds

Alias for bounding_region.

coordinates_bounding_box

Bounding box of atom coordinates.

lattice_region

lattice region.

Returns:The Parallelepiped attached to the Crystal3DLattice of the LatticeAtoms class.
Return type:Parallelepiped
volume

Volume of region containing atoms.

Methods Documentation

within_region(region)[source] [edit on github][source]

Returns new Atoms object containing atoms within region.

Similar to XYZAtom.clip_bounds, but returns a new Atoms object.

Parameters:region (Geometric3DRegion) –