Python

writeGif()

---

Create a .gif file animation. See Using_SaveFiles.ipynb for a notebook of examples.

Syntax

---

writeGif(filenameG, filenames)

writeGif(filenameG, filenames, Name=Value)

Description

---

A

writeGif(filenameG, filenames) saves a .gif file labeled filenameG that animates files in filenames. example

B

writeGif(filenameG, filenames, Name=Value) saves a .gif file with additional options specified by one or more name-value pair arguments. For example, you can save to a supplemental folder. example

Examples

---

Simple example

Sine wave gif.

# import libraries
import numpy as np 
import matplotlib.pyplot as plt

x_end = np.linspace(2*np.pi, 4*np.pi, 100) # make look bigger 
fnamesSIN = [] # storing file names for gif

for xE in x_end:
    x = np.linspace(0, xE, 100)

    # make a figure (sine)
    fig1 = plt.figure()
    plt.plot(x, np.sin(x), lw=3)

    # iteratively define filename 
    filename1 = f'{xE}SIN.png'
    fnamesSIN.append(filename1) # store file names 
    best_save(fig1, filename1) # save 

# write figure files to a gif
writeGif('testGif1', fnamesSIN)

Save to supplemental

Cosine wave gif

# import libraries
import numpy as np 
import matplotlib.pyplot as plt

x_end = np.linspace(2*np.pi, 4*np.pi, 100) # make look bigger 
fnamesCOS = [] # storing file names for gif

for xE in x_end:
    x = np.linspace(0, xE, 100)

    # make a figure (cosine)
    fig2 = plt.figure()
    plt.plot(x, np.cos(x), lw=3)

    # iteratively define filename 
    filename2 = f'{xE}COS.png'
    fnamesCOS.append(filename2) # store file names 
    best_save(fig2, filename2, supplemental=True) # save 

# write figure files to a gif
writeGif('testGif2', fnamesCOS, supplemental=True)

Input Arguments

---

filenameG

Filename for .gif file.

Desired name of gif file. Final gif file = filenameG + .gif

Data Types: (str)

filenames

List of filenames to be written as a gif

Names of files that will be appended together to create animation.

Data Types: (list, vector)

Name-Value Arguments

Specified optional pairs of Name=Value arguments. Name is the is the argument name and Value is the corresponding value. You can specify several name and value pair arguments in any order as Name1=Value1,...,NameN=ValueN.

Example: supplemental=False specifies a gif file to be saved in regular figure location (code_folder/figures/MM_DD_YYYY.

supplemental

Save to supplemental folder (default=False)

Whether or not to save .gif file to supplemental folder.

If this option is used, one must save all files in filenames in the supplemental folder as well.

Data Types: (boolean)

More About

---

This function uses methodology best_save() extensively.

Tips

---

See also

---

best_save()

Issues and Discussion

---

Issues and Discussion.

If you don’t know how to use github (or don’t want to), just send me an email.