microstructpy.geometry.Cube

class microstructpy.geometry.Cube(**kwargs)

A cube.

This class contains a generic, 3D cube. It is derived from the Box and contains the side_length property, rather than multiple side lengths.

Without any parameters, this is a unit cube centered on the origin.

Parameters:

• side_length (float) – (optional) Side length.
• center (list, tuple, numpy.ndarray) – (optional) Center of box.
• corner (list, tuple, numpy.ndarray) – (optional) Bottom-left corner.

plot(**kwargs)

Plot the box.

This function adds an mpl_toolkits.mplot3d.art3d.Poly3DCollection to the current axes. The keyword arguments are passed through to the Poly3DCollection.

Parameters:**kwargs (dict) – Keyword arguments for Poly3DCollection.

within(points)

Test if points are within n-box.

This function tests whether a point or set of points are within the n-box. For the set of points, a list of booleans is returned to indicate which points are within the n-box.

Parameters:points (list or numpy.ndarray) – Point or list of points. Returns:Flags set to True for points in geometry. Return type:bool or numpy.ndarray

bounds

(lower, upper) bounds of the box

Type:list

corner

bottom-left corner

Type:list

limits

(lower, upper) bounds of the box

Type:list

n_dim

number of dimensions, 3

Type:int

n_vol

area, volume of n-box

Type:float

sample_limits

(lower, upper) bounds of the sampling region of the box

Type:list

side_length

length of the side of the cube.

Type:float

volume

volume of box, \(V=l_1 l_2 l_3\)

Type:float