Class Box

Create a box object

Parameters:

• vertices (list) - A six item list that defines the min and max value of X, Y and Z. The six values in order are: Xmin, Xmax, Ymin, Ymax, Zmin, Zmax

Overrides: object.__init__

Get the min and max values for axis

Parameters:

• axis (int) - One of the class constants X, Y or Z

Returns: (float, float)

The min and max value for the requested axis

Get the largest span of the box in the X, Y or Z direction

Returns: float

The largest span (delta between the min and max value)

Get the centroid of the box

Returns: numpy.array

The centoid of the box - a numpy array of 3 items (x, y, z)

Get a point in a random position in the box

Returns: list

[x, y, z] coordinates of a random point in the box

Is the given point inside the box

Parameters:

• point (iterable) - An iterable of length 3 floats that gives the x, y and z values of the point in question

Returns: bool

Whether the point falls within the box

Return the mirror image of point that lies within the box

Parameters:

• point (iterable) - An iterable of length 3 floats that gives the x, y and z values of the point in question

Returns: list

A list of 3 floats that gives the x, y and z coordinates of the mirror image of point that lies within the box

Check if point is a valid point - the default implementation just returns True. Subclasses may use this to weed out points that violate custom box conditions