GeometricRegion

class sknano.core.geometric_regions.GeometricRegion[source] [edit on github][source]

Bases: sknano.core.meta.BaseClass, sknano.core.strings.TabulateMixin

Abstract base class for all geometric regions.

points

Points

Collection of all Point objects defining the GeometricRegion.

vectors

Vectors

Collection of all Vector objects defining the GeometricRegion

Attributes

center Alias for centroid.
centroid Centroid of geometric region.
fmtstr Format string.
measure Measure of geometric region.
ndim Dimensions of of geometric region.
pmax Point at maximum extent.
pmin Point at minimum extent.

Methods

center_centroid() Center centroid on origin.
contains(point) Test region membership of point in GeometricRegion.
get_points() Return list of points from GeometricRegion.points and GeometricRegion.vectors
todict() Return dict of constructor parameters.

Attributes Summary

center Alias for centroid.
centroid Centroid of geometric region.
measure Measure of geometric region.
ndim Dimensions of of geometric region.
pmax Point at maximum extent.
pmin Point at minimum extent.

Methods Summary

center_centroid() Center centroid on origin.
contains(point) Test region membership of point in GeometricRegion.
get_points() Return list of points from GeometricRegion.points and GeometricRegion.vectors

Attributes Documentation

center

Alias for centroid.

centroid

Centroid of geometric region.

measure

Measure of geometric region.

ndim

Dimensions of of geometric region.

pmax

Point at maximum extent.

pmin

Point at minimum extent.

Methods Documentation

center_centroid()[source] [edit on github][source]

Center centroid on origin.

contains(point)[source] [edit on github][source]

Test region membership of point in GeometricRegion.

get_points()[source] [edit on github][source]

Return list of points from GeometricRegion.points and GeometricRegion.vectors