blenderproc.python.modules.renderer.FlowRenderer module

class blenderproc.python.modules.renderer.FlowRenderer.FlowRenderer(config)[source]

Bases: blenderproc.python.modules.renderer.RendererInterface.RendererInterface

Renders optical flow between consecutive keypoints.

Parameter Description Type
forward_flow_output_key The key which should be used for storing forward optical flow values. Default: “forward_flow”. string
backward_flow_output_key The key which should be used for storing backward optical flow values. Default: “backward_flow”. string
forward_flow Whether to render forward optical flow. Default: True. bool
backward_flow Whether to render backward optical flow. Default: True. bool
blender_image_coordinate_style Whether to specify the image coordinate system at the bottom left (blender default; True) or top left (standard convention; False). Default: False bool
forward_flow_output_file_prefix The file prefix that should be used when writing forward flow to a file. Default: “forward_flow_” string
backward_flow_output_file_prefix The file prefix that should be used when writing backward flow to a file. Default: “backward_flow_” string
samples The amount of samples rendered, this value should be 1. Only change it when you know what you are doing. Default: 1 int
run()[source]