tube_mask#

tube_mask(shape, symmetry_axis, base_center, inner_radius, outer_radius, height)[source]#

Creates a tube mask.

Parameters:

shapetuple: Shape of the mask to be created.
symmetry_axisint: The axis of symmetry for the tube.
base_centertuple: Center of the tube.
inner_radiusfloat: Inner radius of the tube.
outer_radiusfloat: Outer radius of the tube.
heightint: Height of the tube.

Returns:

NDArray: The created tube mask.

Raises:

ValueError: If inner_radius is larger than outer_radius. If height is larger than the symmetry axis. If base_center and shape do not have the same length.