From 00b09ef5a095b8047db3bbf8e703ef01da4e481f Mon Sep 17 00:00:00 2001
From: jackw01 <jackw01@users.noreply.github.com>
Date: Fri, 27 Aug 2021 10:19:28 -0700
Subject: [PATCH] animation pattern name changes, readme

---
 README.md                       | 2 +-
 TODO.md                         | 2 +-
 ledcontrol/animationpatterns.py | 8 ++++----
 3 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 750b8ad..76f9ccc 100644
--- a/README.md
+++ b/README.md
@@ -149,7 +149,7 @@ Returns the instantaneous value of a 1Hz triangle wave at time `t`.
 Returns the instantaneous value of a 1Hz pulse wave of the specified duty cycle (range 0 to 1) at time `t`.
 
 ##### `plasma_sines_octave(x, y, t, octaves, lacunarity, persistence)`
-Custom optimized "plasma" implementation that returns a sum of several octaves of sinusoid-based waveforms creating a non-random noise effect. This creates more detailed and better looking plasma effects than simpler implementations. For each successive octave, the frequency (how fast the wave changes with space and time) is multiplied by `lacunarity`, and the amplitude is multiplied by `persistence`. `octaves` must be an integer. See the usage notes below.
+Custom optimized "plasma" implementation that returns a sum of several octaves of sinusoid-based waveforms creating a non-random noise effect. Essentially fractal noise, but using sinusoid functions as a basis instead of pseudorandom noise. This creates more detailed and better looking plasma effects than simpler implementations. For each successive octave, the frequency (how fast the wave changes with space and time) is multiplied by `lacunarity`, and the amplitude is multiplied by `persistence`. `octaves` must be an integer. See the usage notes below.
 
 ##### `plasma_sines(x, y, t, coeff_x, coeff_y, coeff_x_y, coeff_mag_xy)`
 Basic optimized function for creating RGB plasma animations (see [https://www.bidouille.org/prog/plasma](https://www.bidouille.org/prog/plasma)). Returns `sin((x + t) * coeff_x) + sin((y + t) * coeff_y) + sin((x + y + t) * coeff_x_y) + sin((sqrt(x * x + y * y) + t) * coeff_mag_xy)`. Not recommended unless you want it, `plasma_sines_octave` generally looks better.
diff --git a/TODO.md b/TODO.md
index d3a45b7..b848a63 100644
--- a/TODO.md
+++ b/TODO.md
@@ -83,6 +83,6 @@
 - [x] palette based - plasma
 - [ ] DMX
 - [ ] pixel mapping
-
+- [ ] render animations to images for readme
 
 sudo ledcontrol --led_count 150 --led_pixel_order GRBW --led_color_correction "#FFA8FF"
diff --git a/ledcontrol/animationpatterns.py b/ledcontrol/animationpatterns.py
index 90b8f3b..dcf6ca9 100644
--- a/ledcontrol/animationpatterns.py
+++ b/ledcontrol/animationpatterns.py
@@ -28,7 +28,7 @@ def pattern(t, dt, x, y, prev_state):
 '''
     },
     1: {
-        'name': 'Static Gradient',
+        'name': 'Static Gradient 1D',
         'primary_speed': 0.0,
         'primary_scale': 1.0,
         'source': '''
@@ -37,7 +37,7 @@ def pattern(t, dt, x, y, prev_state):
 '''
     },
     2: {
-        'name': 'Static Gradient Mirrored',
+        'name': 'Static Gradient Mirrored 1D',
         'primary_speed': 0.0,
         'primary_scale': 1.0,
         'source': '''
@@ -212,7 +212,7 @@ def pattern(t, dt, x, y, prev_state):
 '''
     },
     180: {
-        'name': 'Palette Octave Plasma 2D',
+        'name': 'Palette Fractal Plasma 2D',
         'primary_speed': 0.2,
         'primary_scale': 1.0,
         'source': '''
@@ -309,7 +309,7 @@ def pattern(t, dt, x, y, prev_state):
 '''
     },
     350: {
-        'name': 'RGB Octave Plasma (Fire Sines) 2D',
+        'name': 'RGB Fractal Plasma (Fire Sines) 2D',
         'primary_speed': 0.2,
         'primary_scale': 1.0,
         'source': '''