Skip to content

Add barnsley fern #12274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions fractals/barnsley_farn.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
"""
Barnsley Fern

The Barnsley fern is a fractal that uses an iterated function system (IFS)
to generate a realistic-looking fern shape.

Reference:
https://en.wikipedia.org/wiki/Barnsley_fern

Requirements:
- matplotlib
- numpy
"""

import matplotlib.pyplot as plt
import numpy as np


def barnsley_fern(n_points: int = 100000) -> np.ndarray:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As there is no test file in this pull request nor any test function or class in the file fractals/barnsley_farn.py, please provide doctest for the function barnsley_fern

"""
Generates the points of the Barnsley fern.

Args:
n_points (int): Number of points to generate.

Returns:
np.ndarray: An array of shape (n_points, 2) containing the x and y coordinates.
"""
x, y = 0.0, 0.0
points = np.zeros((n_points, 2), dtype=np.float64)

rng = np.random.default_rng()

for i in range(n_points):
r = rng.random()
if r < 0.01:
x, y = 0.0, 0.16 * y
elif r < 0.86:
x_new = 0.85 * x + 0.04 * y
y = -0.04 * x + 0.85 * y + 1.6
x = x_new
elif r < 0.93:
x_new = 0.20 * x - 0.26 * y
y = 0.23 * x + 0.22 * y + 1.6
x = x_new
else:
x_new = -0.15 * x + 0.28 * y
y = 0.26 * x + 0.24 * y + 0.44
x = x_new
points[i] = [x, y]

return points


def plot_barnsley_fern(points: np.ndarray) -> None:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As there is no test file in this pull request nor any test function or class in the file fractals/barnsley_farn.py, please provide doctest for the function plot_barnsley_fern

"""
Plots the Barnsley fern using matplotlib.

Args:
points (np.ndarray): An array of shape (n_points, 2) containing coordinates.
"""
x, y = points[:, 0], points[:, 1]
plt.figure(figsize=(6, 10))
plt.scatter(x, y, s=0.1, color="green", marker="o")
plt.title("Barnsley Fern")
plt.axis("off") # Hide the axes for better visualization
plt.show()


if __name__ == "__main__":
fern_points = barnsley_fern()
plot_barnsley_fern(fern_points)