• Install needed packages
• Introduction
• Results
• Run the script
• How it works
  • create_photomosaic
  • get_best
  • treat_images
  • treat_all_images
  • create_all_folder
  • clean_best_folders
• Possible errors

pip3 install -r requirements.txt

This program allows you to create a photomosaic from a set of images.

You can use the preset sets/folders of images or you can upload your own folders to the images folder.

Call the desired functions in this part of the main.py file:

#########################################################################################
startTime = time.time()
#########################################################################################
# Your calls go here

create_photomosaic( 
    main_image= "lion-h.jpg", 
    images_folder= "$b_$all",
    new_name= "photomosaic",
    num_images= False,
    save_fullres= False,
    save_lowres= True,
    save_gif= False,
    save_gif_reversed= False,
    save_vid= False,
    save_vid_reversed= True,
    save_zooms= False,
    resize_main= False,
    images_size= 50,
    quality= 85,
    max_zoomed_images= 5,
    zoom_incr= 1.02,
    frame_duration= 30
)
#########################################################################################
print(f'{Fore.CYAN}Done in: {round(time.time() - startTime,4)}s{Fore.RESET}')
#########################################################################################

Open the terminal, go to this path and type:

python3 main.py

Then, after the script runs, the result should appear in the output folder.

Creates a photomosaic from a set of images

1. Creates the needed folders
2. If resize_main != False, resizes the main_image to resize_main, a tuple with the width and the height.
3. If num_images != False, it will obtain the best images to create the photomosaic, based on the palette of colors of the main image.
4. Sorts the files in the images_folder folder
5. Gets the average color of each image in the images_folder folder
6. Creates a list with all the numpy arrays of the images in the images_folder folder, resized to images_size
7. Creates an empty numpy array (new_img_arr) with the size of the main image multiplied by images_size
8. For each pixel in the main_image array, it will add to the new_img_arr the image whose average color matches best with the pixel's color
9. Creates a folder to store the created images, with the name new_name
10. Saves the result in the output folder with quality quality:
    • If save_fullres == True, it will save the photomosaic in the full resolution
    • If save_lowres == True, it will save the photomosaic in the same resolution as the main image
    • If save_zooms == True, it will save zoomed images of the photomosaic
    • If save_gif == True, it will save the photomosaic as a GIF, created by zooming into the photomosaic
    • If save_gif_reversed == True, it will save the photomosaic as a GIF, created by zooming out the photomosaic
    • If save_vid == True or, it will save the photomosaic as a video, created by zooming into the photomosaic
    • If save_vid_reversed == True, it will save the photomosaic as a video, created by zooming out of the photomosaic

# Default
create_photomosaic( 
    main_image= "lion-h.jpg", 
    images_folder= "$b_$all",
    new_name= "photomosaic",
    num_images= False,
    save_fullres= False,
    save_lowres= True,
    save_gif= False,
    save_gif_reversed= False,
    save_vid= False,
    save_vid_reversed= True,
    save_zooms= False,
    resize_main= False,
    images_size= 50,
    quality= 85,
    max_zoomed_images= 5,
    zoom_incr= 1.02,
    frame_duration= 30
)

create_photomosaic( 
    main_image= "elephant-h.jpg", 
    images_size= 50,
    images_folder= "$b_animals",
    new_name= "elephant",
    num_images= 255,
    save_zooms= True,
)

create_photomosaic( 
    main_image= "tiger-m.jpg", 
    images_size= 50,
    new_name= "tiger",
)

Gets the best images from the folder folder

1. Creates a new folder inside the images folder, with the name of the folder argument preceded by $b_
2. Sorts the files in the folder folder
3. Gets the average color of each image in the folder folder
4. Checks each image in the folder folder. If it meets the requirements (check_contrasts(...) == True and check_color_deviation(...) == True), it will be added to the new folder:

# Default
get_best(
    folder= "$all",
    max_avg_color_deviation= 765,
    max_contrast= 765,
    size= 1000
)

get_best(
    folder= "animals",
    max_avg_color_deviation= 120,
    max_contrast= 150,
    size= 200
)

Resizes and eliminates duplicates from every folder

# Default
treat_all_images(
    size= 1000
)

Creates a new folder called $all inside the images folder, with all the images of the folders (not including the "best folders" (that start with $b_)) inside the images folder

# Default
create_all_folder(
    size= 200
)

create_all_folder(
    size= 100
)

Deletes the best folders (the ones that start with $b_)

clean_best_folders()

If you get the error: zsh: killed python3 main.py, it means that the program is taking too much memory.

To solve it, you can try to reduce the images_size in create_photomosaic or the size of the main_image.