post_process¶

honeybee-vtk post_process¶

Command to post-process media generated by honeybee-vtk.

honeybee-vtk post_process [OPTIONS] COMMAND [ARGS]...

gif¶

Write a gif from a set of images.

Args:

images_folder: Path to the folder containing images to create GIF from.

folder: Path to target folder where the GIF will be written.

gradient_transparency: Whether to use a gradient transparency. or not. If

chosen a gradient of transparency will be used. Which will make the image
in the back more transparent compared to the image in the front. Defaults
to False which will use a flat transparency. which means the all images
will have same amount of transparency. Defaults to using a flat transparency.

duration: Duration of each frame in milliseconds. Default is 1000.

loop_count: Number of times to loop the gif. Default is 0 which means loop

forever.

linger_last_frame: An integer that will make the last frame linger for

longer than the duration. If set to 0, the last frame will not linger.
Setting it to 3 will make the last frame linger for 3 times the duration.
Defaults to 3.

honeybee-vtk post_process gif [OPTIONS] IMAGES_FOLDER

Options

-f, --folder <folder>¶

Path to target folder.

Default: .

--gradient-transparency, --no-gradient-transparency¶

Whether to use a gradient transparency. or not. If chosen a gradient of transparency will be used. Which will make the image in the back more transparent compared to the image in the front. Defaults to False which will use a flat transparency. which means the all images will have same amount of transparency. Defaults to using a flat transparency.

Default: False

-d, --duration <duration>¶

Duration of each frame in milliseconds. Default is 1000.

Default: 1000

-lc, --loop-count <loop_count>¶

Number of times to loop the gif. Default is 0 which means loop forever.

Default: 0

-llf, --linger-last-frame <linger_last_frame>¶

An integer that will make the last frame linger for longer than the duration. If set to 0, the last frame will not linger. Setting it to 3 will make the last frame linger for 3 times the duration. Defaults to 3.

Default: 3

-th, --text-height <text_height>¶

An integer to set the text height for date and time on the image. Default is set to 20.

Default: 20

Arguments

IMAGES_FOLDER¶: Required argument

transparent-images¶

Write an overlappable transparent image for each images in the images folder.

Args:

images_folder: Path to the folder containing images to transform.

folder: Path to target folder where the transparent images will be written.

transparency: The transparency value to use. Acceptable values are decimal point

numbers between 0 and 1 inclusive. 0 is completely transparent and 1 is

completely opaque. Defaults to 0.5.

honeybee-vtk post_process transparent-images [OPTIONS] IMAGES_FOLDER

Options

-f, --folder <folder>¶

Path to target folder.

Default: .

-t, --transparency <transparency>¶

The transparency value to use. Acceptable values are decimal point numbers between 0 and 1 inclusive. 0 is completely transparent and 1 is completely opaque. Defaults to 0.5.

Default: 0.5

Arguments

IMAGES_FOLDER¶: Required argument