Geometric

Overview

StructuralGT.geometric.Nematic

Computes the nematic tensor of the graph.

Details

StructuralGT.geometric.largest_rotating_crop(image_shape)

Returns the crop coordinates for the largest square that would remain inside during any rotation of the image. Supports 2D images only.

Args:

image_shape (tuple): The dimensions of the image to be cropped.

Returns:

(list): The coordinates of the crop in the format [L1,L2,L3,L4], where L1 and L2 are the lower and upper x-coordinates of the crop, and L3 and L4 are the lower and upper y-coordinates of the crop.

StructuralGT.geometric.vector_to_angle(vector)

Converts 2D orientation vector to angle that the vector makes with the x-axis, in degrees. Function range is 0 to 180 degrees.

Args:

vector (tuple): Orientation of a 2D edge

Returns:

angle (float): Angle that vector makes with the x-axis (i.e. 0th dimension of the vector).

class StructuralGT.geometric.Nematic(*args, **kwargs)

Bases: _Compute

Computes the nematic tensor of the graph. For details on how it quantifies orientational anisotropy, see [MN14]. If the edge occupies a single voxel (and therefore has a zero vector orientation), it is not used in calculating the nematic tensor. However it is still returned as past of the orientations array so that the length of the orientations array is equal to the edge count.

compute(network)

Computes the nematic tensor of the graph.

property nematic

The freud.order.Nematic compute module, populated with the nematic attributes. See the freud documentation for more information.

property nematic_order_parameter

The nematic order parameter.

property nematic_tensor

The nematic tensor.

property director

The director.

property orientations

The edge orientations.

property angles

The angles that each edge makes with the x-axis. Only supported for 2D networks.