ruler

photonforge.stencil.ruler(unit, minor_marker_length, marker_width, num_markers=11, medium_marker_steps=5, medium_marker_length=0, major_marker_steps=10, major_marker_length=0, triangular_marker=False, layer=(0, 0))

Create a ruler.

Parameters:

  • unit (float) – Distance between markers.

  • minor_marker_length (float) – Length of the minor scale markers.

  • marker_width (float) – Width of the scale markers.

  • num_markers (int) – Number of markers in the ruler.

  • medium_marker_steps (int) – Steps between medium markers. If 0, medium markers are disabled.

  • medium_marker_length (float) – Length of the medium markers. If 0, defaults to 1.5 times the minor marker length.

  • major_marker_steps (int) – Steps between major markers. If 0, major markers are disabled.

  • major_marker_length (float) – Length of the major markers. If 0, defaults to 2 times the minor marker length.

  • triangular_marker (bool) – Flag indicating the use of triangular markers.

Returns:

Ruler markers.

Return type:

list[Rectangle | Polygon]

ruler_10um = ruler(10, 10, 2)

ruler_20um = ruler(20, 10, 2, num_markers=6, medium_marker_steps=0, major_marker_steps=5)
ruler