Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 2.02 KB

README.md

File metadata and controls

65 lines (40 loc) · 2.02 KB
Raw

Wave Function Collapse

This is an implementation of the WaveFunctionCollapse in Python that was created by Issac Karth (iKarth). We attempted to use this implementation for the procedural generation of EBSD maps.

For more general-purpose WFC information, the original reference repository by Maxim Gumin (mxgmm) remains the best resource.

The repository from iKarth might also be a useful resource.

Running WFC

The file I used to run the WFC is called deformed_iron_wfc_run.py.

The arguments it accepts are:

  • tile_size=1: size of the tiles it uses (1 is fine for pixel images, larger is for things like a Super Metroid map)
  • pattern_width=2: size of the patterns; usually 2 or 3 because bigger gets slower and
  • output_size=[32,32]: how big the output image is
  • attempt_limit=100: stop after this many tries
  • output_periodic=True: the output wraps at the edges
  • input_periodic=False: the input wraps at the edges
  • visualize=False: write intermediate images to disk? requires filename.
  • backtracking=True: do we use backtracking if we run into a contradiction?
  • log_filename="out_log": what should the log file be named?
  • logging=True: should we write to a log file? requires filename.

The specific input that I used is called "Deformed Iron EBSD" and can be found at images/Inputs/Deformed Iron EBSD.png.

It's a cropped version of the IPF-X image in the original dataset by Thomas B. Britton and Jim Hickey.

Test

pytest

Documentation

python setup.py build_sphinx

With linux the documentation can be displayed with:

xdg-open build/sphinx/index.html

Acknowledgments

This research was funded by the Army Educational Outreach Program (AEOP) and the Hopkins Extreme Materials Institute (HEMI) at Johns Hopkins University.