Order parameters for specific membrane region

class gorder.geometry.Cuboid(xdim=Ellipsis, ydim=Ellipsis, zdim=Ellipsis, reference=None)

Calculate order parameters inside a cuboid.

Parameters:

• xdim (Optional[Sequence[float]]) – Span of the cuboid along the x-axis [nm]. Defaults to infinite if not specified.

• ydim (Optional[Sequence[float]]) – Span of the cuboid along the y-axis [nm]. Defaults to infinite if not specified.

• zdim (Optional[Sequence[float]]) – Span of the cuboid along the z-axis [nm]. Defaults to infinite if not specified.

• reference (Optional[Union[Sequence[float],str]]) – Reference point for the cuboid position. Defaults to [0.0, 0.0, 0.0].

Raises:

ConfigError – If any dimension is invalid.

class gorder.geometry.Cylinder(radius, orientation, span=Ellipsis, reference=None)

Calculate order parameters inside a cylinder.

Parameters:

• radius (float) – Radius of the cylinder [nm].

• orientation (str) – Orientation of the cylinder’s main axis. Expected values are x, y, or z.

• span (Optional[Sequence[float]]) – Span along the main axis [nm]. Defaults to infinite if not specified.

• reference (Optional[Union[Sequence[float],str]]) – Reference point for position and size. Defaults to [0.0, 0.0, 0.0].

Raises:

ConfigError – If radius is not positive, span is invalid, or orientation is not recognized.

class gorder.geometry.Sphere(radius, reference=None)

Calculate order parameters inside a sphere.

Parameters:

• radius (float) – Radius of the sphere [nm].

• reference (Optional[Union[Sequence[float],str]]) – Center of the sphere. Defaults to [0.0, 0.0, 0.0].

Raises:

ConfigError – If radius is not positive.