itasca.ball.thermal

Functions and classes for working with Itasca thermal balls.

Functions

itasca.ball.thermal.count() int.

Get the number of thermal balls.

itasca.ball.thermal.find(id: int) Thermal ball object.

Get the ball thermal object with the given ID number.

itasca.ball.thermal.inbox(lower_bound: vec, upper_bound: vec, intersect=True) Tuple of thermal ball objects.

Get a tuple of thermal balls with extents intersecting a box. The extent is the axis-aligned bounding box of the thermal ball. The if the optional keyword argument intersect is False then only balls with positions falling in the box are returned.

itasca.ball.thermal.list() Thermal ball iterator object.

Get a ball thermal iterator object.

itasca.ball.thermal.maxid() int.

Get the maximum thermal ball ID.

itasca.ball.thermal.near(point: vec, radius=0.0) Thermal ball object.

Find the closest thermal ball to a point. If the optional keyword argument radius is non-zero, only search within this radius.

Classes