simetri.frieze package

Submodules

simetri.frieze.frieze module

Simetri graphics library’s frieze patterns.

simetri.frieze.frieze.hop(design: Batch | Shape, vector: Sequence[float] = (1, 0), reps: int = 3) Batch[source]

p1 symmetry group.

Parameters:
  • design (Union[Batch, Shape]) – The design to be repeated.

  • vector (VecType, optional) – The direction and distance of the hop. Defaults to (1, 0).

  • reps (int, optional) – The number of repetitions. Defaults to 3.

Returns:

A Batch of Shapes with the p1 symmetry.

Return type:

Batch

simetri.frieze.frieze.jump(design: Batch | Shape, mirror_line: Sequence[Sequence], dist: float, reps: int = 3) Batch[source]

p11m symmetry group.

Parameters:
  • design (Union[Batch, Shape]) – The design to be repeated.

  • mirror_line (Line) – The line to mirror the design.

  • dist (float) – The distance between the shapes.

  • reps (int, optional) – The number of repetitions. Defaults to 3.

Returns:

A Batch of shapes with the p11m symmetry.

Return type:

Batch

simetri.frieze.frieze.jump_along(design: Batch, mirror_line: Sequence[Sequence], path: Sequence[Sequence[float]], reps: int = 3) Batch[source]

Jump along the given path.

Parameters:
  • design (Batch) – The design to be repeated.

  • mirror_line (Line) – The line to mirror the design.

  • path (Sequence[Point]) – The path along which to translate the design.

  • reps (int, optional) – The number of repetitions. Defaults to 3.

Returns:

A Batch of shapes with the jump along symmetry.

Return type:

Batch

simetri.frieze.frieze.p1(design: Batch | Shape, vector: Sequence[float] = (1, 0), reps: int = 3) Batch[source]

p1 symmetry group.

Parameters:
  • design (Union[Batch, Shape]) – The design to be repeated.

  • vector (VecType, optional) – The direction and distance of the hop. Defaults to (1, 0).

  • reps (int, optional) – The number of repetitions. Defaults to 3.

Returns:

A Batch of Shapes with the p1 symmetry.

Return type:

Batch

simetri.frieze.frieze.sidle(design: Batch, mirror_line: Sequence[Sequence], dist: float, reps: int = 3) Batch[source]

p1m1 symmetry group.

Parameters:
  • design (Batch) – The design to be repeated.

  • mirror_line (Line) – The line to mirror the design.

  • dist (float) – The distance between the shapes.

  • reps (int, optional) – The number of repetitions. Defaults to 3.

Returns:

A Batch of Shapes with the sidle symmetry.

Return type:

Batch

simetri.frieze.frieze.sidle_along(design: Batch, mirror_line: Sequence[Sequence], path: Sequence[Sequence[float]], reps: int = 3) Batch[source]

Sidle along the given path.

Parameters:
  • design (Batch) – The design to be repeated.

  • mirror_line (Line) – The line to mirror the design.

  • path (Sequence[Point]) – The path along which to translate the design.

  • reps (int, optional) – The number of repetitions. Defaults to 3.

Returns:

A Batch of shapes with the sidle along symmetry.

Return type:

Batch

simetri.frieze.frieze.spinning_hop(design: Batch, rotocenter: Sequence[float], dx: float, dy: float, reps: int = 3) Batch[source]

p2 symmetry group.

Parameters:
  • design (Batch) – The design to be repeated.

  • rotocenter (Point) – The center of rotation.

  • dx (float) – The distance to translate in the x direction.

  • dy (float) – The distance to translate in the y direction.

  • reps (int, optional) – The number of repetitions. Defaults to 3.

Returns:

A Batch of Shapes with spinning hop symmetry.

Return type:

Batch

simetri.frieze.frieze.spinning_jump(design: Batch, mirror1: Sequence[Sequence], mirror2: Sequence[Sequence], dist: float, reps: int = 3) Batch[source]

p2mm symmetry group.

Parameters:
  • design (Batch) – The design to be repeated.

  • mirror1 (Line) – The first mirror line.

  • mirror2 (Line) – The second mirror line.

  • dist (float) – The distance between the shapes along mirror1.

  • reps (int, optional) – The number of repetitions. Defaults to 3.

Returns:

A Batch of Shapes with spinning jump symmetry.

Return type:

Batch

simetri.frieze.frieze.spinning_sidle(design: Batch, mirror_line: Sequence[Sequence] | None = None, glide_line: Sequence[Sequence] | None = None, glide_dist: float | None = None, trans_dist: float | None = None, reps: int = 3) Batch[source]

p2mg symmetry group.

Parameters:
  • design (Batch) – The design to be repeated.

  • mirror_line (Line, optional) – The mirror line. Defaults to None.

  • glide_line (Line, optional) – The glide line. Defaults to None.

  • glide_dist (float, optional) – The distance of the glide. Defaults to None.

  • trans_dist (float, optional) – The distance of the translation. Defaults to None.

  • reps (int, optional) – The number of repetitions. Defaults to 3.

Returns:

A Batch of Shapes with spinning sidle symmetry.

Return type:

Batch

simetri.frieze.frieze.step(design: Batch, glide_line: Sequence[Sequence] | None = None, glide_dist: float | None = None, reps: int = 3) Batch[source]

p11g symmetry group.

Parameters:
  • design (Batch) – The design to be repeated.

  • glide_line (Line, optional) – The glide line. Defaults to None.

  • glide_dist (float, optional) – The distance of the glide. Defaults to None.

  • reps (int, optional) – The number of repetitions. Defaults to 3.

Returns:

A Batch of Shapes with step symmetry.

Return type:

Batch

simetri.frieze.frieze.step_along(design: Batch, glide_line: Sequence[Sequence] | None = None, glide_dist: float | None = None, path: Sequence[Sequence[float]] | None = None, reps: int = 3) Batch[source]

Step along a path.

Parameters:
  • design (Batch) – The design to be repeated.

  • glide_line (Line, optional) – The glide line. Defaults to None.

  • glide_dist (float, optional) – The distance of the glide. Defaults to None.

  • path (Sequence[Point], optional) – The path along which to translate the design. Defaults to None.

  • reps (int, optional) – The number of repetitions. Defaults to 3.

Returns:

A Batch of shapes with the step along symmetry.

Return type:

Batch

Module contents