Birds Eye View/Calibration Guide: Difference between revisions

Birds Eye View/Calibration Guide (view source)

Revision as of 17:44, 15 January 2025

2,032 bytes added , 15 January

no edit summary

Mmontero

901

edits

❯

@@ Line 80: / Line 80: @@
 == The Calibration Tool GUI ==
-Once you have the calibration images available, head up to https://bev.ridgerun.com to start the calibration process. This section guides you on the process on how to perform it.
+Once you have the calibration images available, use RidgeRun’s Calibration Tool  to start the calibration process. This section guides you on the process on how to perform it.
 <center>
@@ Line 90: / Line 90: @@
 </div>
 </html>
-</center>
+</center>Once you launch the tool,  the '''Home Screen''' will appear, displaying the available calibration’s tools. For this wiki, we will focus on the BEV calibration tool. Simply click on it to proceed.
+[[File:Calibration home screen.png|alt=Ridgerun's Calibration Tools home screen, showing links to bev and undistort tools |center|thumb|900x900px|Ridgerun's Calibration Tools home screen]]
-Once you launch the tool, you're met with the '''Main Window'''. This window is composed by three sections, which you can resize at will by dragging the vertical separators.
-[[File:bev-tool-main-window.png|thumbnail|center|1280px|alt=Calibration tool main window|Calibration tool main window]]
+After selecting the BEV Calibration Tool, you will be greeted by its Home Screen, which includes:
-;Image Bar
+* A brief description of the BEV Calibration Tool.
-:Here you'll find the thumbnails of the different image you have loaded into the system, as well as a thumbnail of the Birds Eye View canvas. You may click through the different thumbnails to change the currently active image. The active image will be highlighted by a subtle shadow beneath it.
+* A Start Calibrating button to get into the actual calibration tool.
-;Working Area
+* A card linking to the full documentation for BEV and Libpanorama.
-:In this area you will interact with the images and the different calibration tools currently active. You may switch between images and your current progress won't be lost.
-;Control Area
-:Here you'll find instructions and helper accompanying components for the currently active tool. In is contextual, meaning that it will change according to the currently active tool.
-The next sections delve into more details about these sections.
+[[File:BEV Calibration Tool Home Screen.png|alt=RidgeRun's BEV Calibration Tool home screen, showing a brief description, start calibration button and card link to documentation|center|thumb|900x900px|BEV Calibration Tool home screen]]
-=== Image Bar ===
-The image bar allows you to import new images, select the currently active one, reorder them and control certain behavior.
+To continue, click '''Start Calibrating.''' This opens the '''Main Window'''  of the BEV Calibration Tool, which is composed of four main sections:
+[[File:BEV Calibration Tool Main Window.png|alt=BEV Calibration Tool Main Window. Indicates header, control panel, cameras panel and working area location.|center|thumb|900x900px|BEV Calibration Tool main window]]
-[[File:bev-tool-image-bar.png|thumbnail|center|320px|alt=Calibration tool image bar|Calibration tool image bar]]
+# '''Header:''' Tools header. Click on the RidgeRun's logo to return to the Home Screen.
+# '''Control Panel:''' Contains the primary controls for managing the calibration process, from loading the calibration images to exporting the calibration results.
+# '''Cameras Panel:''' Shows thumbnails of the loaded images and provides some image-specific controls that change based on the current calibration step.
+# '''Working Area:''' In this area, you will interact with the images and active calibration tools. Allows seamless switching between images without losing your progress.
-;1. Birds Eye View Thumbnail
+== Control Panel ==
-:Clicking this thumbnail will activate the '''Birds Eye View working space'''. In there, you can combine individual images into a single, composite view.
-;2. Add Images
-:As the name implies, clicking this button will open a file selection dialog that will allow you to import your calibration images. You can import several images at once by holding ''shift'' or ''ctrl'' and selecting multiple files.
-;3. Image Thumbnail
-:Clicking this thumbnail will activate the '''Inverse Perspective Transform working space'''. In there, you will work with the square pattern to transform the image into an aerial view.
-;4. Reordering Controls
-:Click on the up or down arrows to bring an image to the front or back in the '''Birds Eye View working space'''.
-; 5. Solo
-:Clicking this icon will immediately hide all the other images. You will need to manually enable the visibility of each one of them by clicking the '''Visibility''' control.
-;6. Lock
-:Clicking this icon will lock the image in place in the '''Birds Eye View working space''' so you don't accidentally move it. Clicking it again will toggle this behavior.
-;7. Visibility
-:Clicking this icon will hide the image. Clicking it again will toggle this behavior.
-;8. Delete
-:Remove an image from the project. All its configuration will be lost and cannot be undone.
-=== Working Area and Control Bar ===
+# '''Hide/Show:''' You can hide/show this panel by clicking this button.
+# '''Save Project:''' Save the project to continue later.
+# '''Open Project:''' Load existing project.
+# '''Add Source:''' Add the pictures you will use for calibration.
+# '''Export Calibration:''' Export your calibration.
+# '''View Cameras''': The tool has 2 different views. The first one is the Cameras View, click here to change to this view.  Use it to change the perspective of the individual pictures.
+# '''View Bev:''' The second view is the BEV (Birds Eye View), click here to change to this view.  Once you get the perspective of all the pictures, you can go to the BEV View to start generating your BEV.
+# '''Settings:''' Open the Settings Panel (see Settings Panel section for more details)
+# '''Take a Tour:''' Take an interactive tour through the GUI interface.
+# '''Help:''' Link to the RidgeRun’s BEV calibrator documentation.
+# '''Contact Us:''' Contact RidgeRun for additional support.
-The working area is contextual. This means that its content will vary according to the current '''Image Bar''' selection. Currently, there are two working spaces:
+== Cameras Panel ==
-* '''Birds Eye View''': activated when you click on the Birds Eye View thumbnail.
+The Cameras Panel allows you to add the calibration images. Once added here you will find a preview thumbnail of all your pictures.
-* '''Inverse Perspective Transform''': activated when you click on any of the individual image thumbnails. Each image has its own Inverse Perspective Transform view.
-==== Birds Eye View ====
+# '''Add Images:''' Click this button to open a file selection dialog and select your calibration images. You can import several images at once by holding ''shift'' or ''ctrl'' and selecting multiple files.
-This view will be activated when you click on the Birds Eye View thumbnail in the '''Image Bar'''. It holds all the individual images for you to move around, scale and rotate, select their regions of interest, and finally export the calibration file. At the top of the working space, you'll see a small toolbar that allows you to select the currently active tool, as described below.
+# '''Thumbnail:''' Each thumbnail contains a preview of the picture, its name, and more. You can click any of the thumbnails to set it as the active picture and start editing.
-[[File:bev-tool-working-space.png|thumbnail|center|1280px|alt=Calibration tool working space|Calibration tool Birds Eye View working space]]
+# '''Thumbnail Toolbar:''' Contains controls for the image. The toolbar changes based on the current view. (See Thumbnail Toolbar section below for more details).
+# '''Thumbnail Title:''' Indicates the name of the picture it represents. By clicking this button the Thumbnail Menu appears (See Thumbnail Menu section below for more details).
-{{ambox|type=notice|text=It may not seem that the BEV workspace contains all the images. It does, the topmost images are hiding the rest! Go ahead and try to move the image}}
+=== Thumbnail Toolbar ===
+The thumbnail toolbar contains controls specific to an image. It changes depending on the current view , check out below the toolbar appearance for Cameras View and Bev View.
+# '''Delete Picture:''' Delete the current image (available in both views).
+# '''Picture Reload: ''' Undo any modification to the picture and start from scratch.
+# '''Picture Lock:''' Lock the picture and avoid any accidental editing. When enabled you can’t move, scale, rotate, or change the roi.
+# '''Picture Filter:''' Use this button to show only this picture.
+# '''Picture Visibility:''' Show/Hide current picture.
-;1. Canvas
+=== Thumbnail Menu ===
-:The canvas is where you'll see all the images combined together and, potentially, interact with them. The behavior of the canvas changes according to the selected tool. The gray area is what is going to be visible in the final Birds Eye View scene. Everything outside of it will be cropped. The z-ordering of the images in the canvas (which image is on top and in the back) is controlled by the order of the images in the '''Image Bar'''. The topmost image in the bar will be the topmost image on the canvas. You can hide images momentarily by using the '''Solo''' and '''Visibility''' controls.
+The thumbnail dropdown menu appears when you click on the thumbnail title, it contains controls to modify the image results. The controls change with the view, below are shown the appearance for Cameras View and BEV View.
-;2. Free Image Control
-:When this tool is active, you can click on images, drag them around, scale them and rotate them. You may lock the image using the '''Lock''' control to inhibit this behaviour.
-;3. Region of Interest Selection
-:When this tool is active, you can no longer interact with the images. Instead, you are prompted to define a region of interest (ROI) for the active image. The ROI is defined by placing a series of points that form a polygon. The active image is the topmost image, and each image must have it's own ROI.
-;4. Calibration Export
-:With this control, you can view, instead of the canvas, the generated JSON with the calibration parameters. You can copy it and use it with the Birds Eye View project.
-;5. Control Bar
-:In the bar, you will see extra information about the currently active tool. By switching between 'Free Image Control', 'Region of Interest Selection', or 'Calibration Export', the information here will change. Additionally, there are some helper controls that will help you in the application of the tool.
-==== Inverse Perspective Transform ====
+# '''Scale:''' Scale the transformed image results for this factor. Reflected until you click the Apply button in the Main Toolbar. (Cameras View)
+# '''X Offset:''' Normalized offset in the horizontal axis of the transformed image, can be positive or negative. This moves the result image left or right, changing the visible area of the transformed image, anything outside the visible area may not be available for BEV depending on the output resolution.  Reflected until you click the Apply button in the Main Toolbar. (Cameras View)
+# '''Y Offset:''' Normalized offset in the vertical axis of the transformed image, can be positive or negative. This moves the resulting image up or down, changing the visible area of the transformed image; anything outside the visible area may not be available for BEV depending on the output resolution.  Reflected until you click the Apply button in the Main Toolbar. (Cameras View)
+# '''Width:''' Adjust the width of the image in the Main View. Also reflects the current width when you modify it with the mouse. (BEV View)
+# '''Height:''' Adjust the height of the image in the Main View. Also reflects the current height when you modify it with the mouse. (BEV View)
+# '''Angle:''' Change the image rotation in degrees. The rotation is performed from the center of the image. Also reflects the current angle when you modify it with the mouse. (BEV View)
-This view will be activated when you click on an individual image thumbnail. Each image will have its own view. As its name suggests, this working space allows you to perform the Inverse Perspective Transform (IPT) to each image. The transformed image will be immediately reflected in the '''Birds Eye View''' workspace.
+== Working Area ==
-[[File:bev-tool-inverse-perspective-transform.png|thumbnail|center|1280px|alt=Calibration tool inverse perspective transform|Calibration tool Inverse Perspective Transform working space]]
+# '''Title Bar:''' Indicates the current view and the active picture name.
+# '''Main View:''' Main view is where you will edit your pictures and compose the BEV.
+# '''Results View:''' Whenever you apply the modifications to a picture, the result will be shown here.
+# '''Main Toolbar:''' Contains controls to edit your pictures, changes depending on the current view.
+# '''Zoom Bar:''' More controls to change the size and position of the pictures.
+# '''Position Bar:''' Shows the pointer position relative to the picture and relative to the view window.
-;1. Canvas
+=== Main Toolbar ===
-:The canvas is where you'll identify the square pattern. The pattern is identified by placing markers in the four corners of the pattern. The image will be automatically warped once 4 points are placed. Points can be adjusted afterwards.
-;2. Transformed Image
+# '''Delete Tool:''' Deletes the square vertices points of the active image for Cameras View and removes the ROI in the active image for BEV View.
-:In this section you'll se the transformed image. It will be automatically updated when the pattern is identified.
+# '''Polygon Tool:'''
-;3. Zoom Control
+## '''Cameras View:''' Use the Polygon Tool to mark the position of the square pattern for each picture.
-:This control allows you to zoom in or out the transformed image. Zooming in will lose the information outside of the visible area, but it will be easier to handle in the '''Birds Eye View''' workspace.
+## '''Bev View:'''  Use the tool  to draw a Region of interest (ROI) in each picture. Any areas outside of the ROI will be ignored. '''Shortcut Tip:''' You can hide/show the areas outside the ROI by pressing Shift + Click.
-;4. Precision Visualization
+# '''Scale Tool:''' Allows to scale and rotate the pictures.
-:A helper tool that allows you to select, with finer detail, the calibration pattern corner.
+# '''Apply:''' Executes the image perspective transformation in the Cameras View and generates the BEV composition in the BEV View, the results will be shown in the Results View.
+=== Zoom Bar ===
+# '''Zoom Controls:''' Zoom in and zoom out in any view. You can also write the zoom percentage manually.
+# '''Fit to Screen:''' Automatically adjust the view content to the view window visible area.
+# '''Fullscreen:''' Toggle to and out of fullscreen, when enabled the current view window will occupy the space of the full working area.
+=== Position Bar ===
+# Pointer position relative to the picture top/left corner.
+# Pointer position relative to the view window.
+== Settings Panel ==
+# '''Opacity:''' Sets the opacity of the images in the BEV Main View, 100 for full opacity and 0 for full transparency.
+# '''Overlay:''' Define overlay image for the BEV Composition
+# '''Grid:''' Define a grid of vertical and horizontal lines overlaid over the Main and Results View.
+# '''Output Resolution:''' Define the output size of the BEV image. This changes the frame displayed in the BEV Main View.
+# '''Close Settings:''' Closes the Settings Panel.
+# '''Overlay Check:''' Show/Hide overlay image in the BEV Main View.
+# '''Overlay File:''' Shows current overlay image or “Overlay File” as a placeholder
+# '''Add Overlay:''' Selects the overlay image file, when hit it opens a file dialog window.
+# '''Grid Width:''' Number of divisions along the horizontal axis.
+# '''Grid Height:''' Number of divisions along the vertical axis.
+# '''Output Width: ''' Bev output image width.
+# '''Output Height:''' Bev output image height.
+:
 == Performing the Calibration ==