Commit d5d1b62d authored by Nick Laurenson's avatar Nick Laurenson
Browse files

Rename VeloView -> LidarView

parent 0904654f
......@@ -85,8 +85,8 @@ stages:
${CI_PROJECT_DIR}/Superbuild
# compile
- make -j8
# remove Veloview
- rm -rf common-superbuild/veloview
# remove lidarview
- rm -rf common-superbuild/lidarview
# - cd ${CI_PROJECT_DIR}
# create a symbolic link, inside the source tree else "push" will not work
# - ln -s ../Superbuild-build Superbuild-build # not working witth
......@@ -111,7 +111,7 @@ stages:
script:
- git submodule update --init Superbuild/common-superbuild
- cd ../Superbuild-build/ # created by extracting cache in "unix_get_superbuild"
- make veloview -j8
- make lidarview -j8
.linux_test: &linux_test
stage: test
......@@ -121,8 +121,8 @@ stages:
- git submodule update --init Superbuild/common-superbuild
- git submodule update --init TestData
- cd ../Superbuild-build/ # created by extracting cache in "unix_get_superbuild"
- make veloview -j8
- cd ../Superbuild-build/common-superbuild/veloview/build
- make lidarview -j8
- cd ../Superbuild-build/common-superbuild/lidarview/build
- cmake . -DBUILD_TESTING=True
- make
# excluding packaging test targets (packaging is done later)
......@@ -136,8 +136,8 @@ stages:
script:
- git submodule update --init Superbuild/common-superbuild
- cd ../Superbuild-build/ # created by extracting cache in "unix_get_superbuild"
- make veloview -j8
- ctest -R cpack-veloview-TGZ -V
- make lidarview -j8
- ctest -R cpack-lidarview-TGZ -V
.linux_package_manual: &linux_package_manual
when: manual
......@@ -213,8 +213,8 @@ ubuntu16.04_package_schedule:
${CI_PROJECT_DIR}/Superbuild
# compile
- make -j8
# remove Veloview
- rm -rf common-superbuild/veloview
# remove lidarview
- rm -rf common-superbuild/lidarview
# upload superbuild, Apple's Zip Utility, which I guess is use by gilab-ci
# produce corrupted file for large file, so we need to upload the cache manually
- cd ..
......@@ -237,10 +237,10 @@ ubuntu16.04_package_schedule:
before_script: *unix_get_superbuild
script:
- cd Superbuild-build/
- make veloview -j8
- make lidarview -j8
artifacts:
paths:
- Superbuild-build/veloview
- Superbuild-build/lidarview
expire_in: 1 hr
.OSX_test: &OSX_test
......@@ -337,8 +337,8 @@ ubuntu16.04_package_schedule:
- chmod +x superbuild.bat
- ./superbuild.bat
- echo "build terminated"
- echo "removing common-superbuild/veloview"
- rm -rf common-superbuild/veloview
- echo "removing common-superbuild/lidarview"
- rm -rf common-superbuild/lidarview
- echo "compressing and uploading Superbuild. This take some time..."
- cd ..
- tar zcf archive Superbuild-build/
......@@ -366,7 +366,7 @@ windows_build:
- git submodule update --init Superbuild/common-superbuild
- cd /cygdrive/c/Superbuild-build # provided by windows_get_superbuild
- echo "call \"C:\\Users\\vagrant\\Desktop\\cmd-env-variables.cmd\"" > build.bat
- echo "ninja veloview" >> build.bat
- echo "ninja lidarview" >> build.bat
- chmod +x build.bat
- ./build.bat
......@@ -383,10 +383,10 @@ windows_test:
- git submodule update --init TestData
- cd /cygdrive/c/Superbuild-build # provided by windows_get_superbuild
- echo "call \"C:\\Users\\vagrant\\Desktop\\cmd-env-variables.cmd\"" > test.bat
- echo "ninja veloview" >> test.bat
- echo "ninja lidarview" >> test.bat
- chmod +x test.bat
- ./test.bat
- cd common-superbuild/veloview/build
- cd common-superbuild/lidarview/build
- echo "call \"C:\\Users\\vagrant\\Desktop\\cmd-env-variables.cmd\"" > test.bat
- echo "cmake -DBUILD_TESTING=True ." >> test.bat
- echo "ninja install" >> test.bat
......@@ -406,7 +406,7 @@ windows_test:
- git submodule update --init Superbuild/common-superbuild
- cd /cygdrive/c/Superbuild-build # provided by windows_get_superbuild
- echo "call \"C:\\Users\\vagrant\\Desktop\\cmd-env-variables.cmd\"" > package.bat
- echo "ninja veloview" >> package.bat
- echo "ninja lidarview" >> package.bat
- echo "ctest -V -R cpack" >> package.bat
- chmod +x package.bat
- ./package.bat
......
# Continuous Integration
[![pipeline status](https://gitlab.kitware.com/bjacquet/VeloView-kwinternal/badges/master/pipeline.svg)](https://gitlab.kitware.com/bjacquet/VeloView-kwinternal/commits/master)
[![pipeline status](https://gitlab.kitware.com/bjacquet/LidarView-kwinternal/badges/master/pipeline.svg)](https://gitlab.kitware.com/bjacquet/LidarView-kwinternal/commits/master)
## Important note
......@@ -37,7 +37,7 @@ GitLab CI/CD is the fully integrated continuous integration service offered by G
A `.gitlab-ci.yml` file describe an [Integration Pipeline] which describe different [Jobs], in our case:
- a **superbuild** job per OS
- a (veloview) **build** job per OS
- a (lidarview) **build** job per OS
- a **test** job per OS
- a (superbuild) **package** job per OS
- ...
......@@ -90,7 +90,7 @@ sudo apt-get install gitlab-runner
> It's very important to set **builds_dir** and **cache_dir**, otherwise you would have a weird error like ***Skipping cache extraction due to empty cache key***
The [Runners] are describe in the `.gitlab-runner/config.toml` file
KEU one can be found on Wheezy/Project/VeloView/Internal/CI/.gitlab-runner/config.toml
KEU one can be found on Wheezy/Project/LidarView/Internal/CI/.gitlab-runner/config.toml
```bash
concurrent = 1
......@@ -119,7 +119,7 @@ check_interval = 0
Path = "minio"
Shared = true
```
Then you need to add the machine [tags](https://docs.gitlab.com/ee/ci/yaml/#tags) via [Runners settings](https://gitlab.kitware.com/bjacquet/VeloView-kwinternal/settings/ci_cd) in section
Then you need to add the machine [tags](https://docs.gitlab.com/ee/ci/yaml/#tags) via [Runners settings](https://gitlab.kitware.com/bjacquet/LidarView-kwinternal/settings/ci_cd) in section
### Create a new Minio server
......
......@@ -37,7 +37,7 @@ Vagrant.configure("2") do |config|
SHELL
# Install packages
config.vm.provision "shell", name: "Install Veloview dependencies", inline: <<-SHELL
config.vm.provision "shell", name: "Install LidarView dependencies", inline: <<-SHELL
apt-get install -y -q \
git \
cmake-curses-gui \
......@@ -53,4 +53,4 @@ Vagrant.configure("2") do |config|
byacc
SHELL
end
\ No newline at end of file
end
......@@ -14,7 +14,7 @@
cmake_minimum_required(VERSION 3.1 FATAL_ERROR)
include("SoftwareInformation/branding.cmake")
project(VeloView)
project(LidarView)
set (CMAKE_CXX_STANDARD 14)
......@@ -27,7 +27,7 @@ else()
endif()
# Disallow in-source build
if ("${VeloView_SOURCE_DIR}" STREQUAL "${VeloView_BINARY_DIR}")
if ("${LidarView_SOURCE_DIR}" STREQUAL "${LidarView_BINARY_DIR}")
message(FATAL_ERROR
"${SOFTWARE_NAME} requires an out of source Build. "
"Please create a separate binary directory and run CMake there.")
......@@ -71,15 +71,15 @@ if(BUILD_DOC)
endif()
#-------------------------------------------------------------------------------
set (VeloView_CMAKE_DIR "${VeloView_SOURCE_DIR}/CMake")
set (CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${VeloView_CMAKE_DIR})
set (LidarView_CMAKE_DIR "${LidarView_SOURCE_DIR}/CMake")
set (CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${LidarView_CMAKE_DIR})
include(Git)
include(ParaViewDetermineVersion)
# Sets VV_VERSION_{MAJOR,MINOR,PATCH} using PARAVIEW determine_version
file(STRINGS version.txt version_txt)
extract_version_components("${version_txt}" "VV")
determine_version(${VeloView_SOURCE_DIR} ${GIT_EXECUTABLE} "VV")
determine_version(${LidarView_SOURCE_DIR} ${GIT_EXECUTABLE} "VV")
# Is this a 32 bit or 64bit build. Display this in about dialog.
if ("${CMAKE_SIZEOF_VOID_P}" EQUAL 8)
......@@ -121,10 +121,10 @@ if (WIN32)
set(VV_INSTALL_LIBRARY_DIR bin)
else()
set(VV_INSTALL_LIBRARY_DIR
lib/veloview-${VV_VERSION_MAJOR}.${VV_VERSION_MINOR})
lib/lidarview-${VV_VERSION_MAJOR}.${VV_VERSION_MINOR})
endif()
set(VV_INSTALL_ARCHIVE_DIR
lib/veloview-${VV_VERSION_MAJOR}.${VV_VERSION_MINOR})
lib/lidarview-${VV_VERSION_MAJOR}.${VV_VERSION_MINOR})
# Find and include PythonQt
find_package(PythonQt REQUIRED)
......@@ -183,8 +183,8 @@ if (APPLE)
endif()
# Add the reader plugin and any other plugins.
set(VV_PLUGIN_LIBRARY LidarPlugin) # veloview plugin
set(VV_NONE_PLUGIN_LIBRARY LidarPythonQT) # code needed by veloview but that is not part of the plugin
set(VV_PLUGIN_LIBRARY LidarPlugin) # lidarview plugin
set(VV_NONE_PLUGIN_LIBRARY LidarPythonQT) # code needed by lidarview but that is not part of the plugin
add_subdirectory(LidarPlugin)
include_directories(LidarPlugin)
......@@ -224,7 +224,7 @@ if (WIN32)
install(DIRECTORY "${Qt5_DIR}/../../../plugins/platforms"
DESTINATION "bin"
)
# see comment in: Superbuild/Projects/win32/veloview.bundle.cmake
# see comment in: Superbuild/Projects/win32/lidarview.bundle.cmake
install(DIRECTORY "${Qt5_DIR}/../../../plugins/styles"
DESTINATION "bin"
)
......@@ -244,7 +244,7 @@ build_paraview_client(${SOFTWARE_NAME}
PVMAIN_WINDOW vvMainWindow
PVMAIN_WINDOW_INCLUDE vvMainWindow.h
SPLASH_IMAGE "${CMAKE_CURRENT_SOURCE_DIR}/SoftwareInformation/${PARAVIEW_SPLASH_IMAGE}"
# right now the bundle's logo.icns file must be at the root of VeloView sources
# right now the bundle's logo.icns file must be at the root of LidarView sources
# this problem is due to paraview/src/CMake/ParaViewBranding.cmake,
# on line: GET_FILENAME_COMPONENT(bundle_icon_file "${BPC_BUNDLE_ICON}" NAME)
BUNDLE_ICON "${CMAKE_CURRENT_SOURCE_DIR}/${PARAVIEW_BUNDLE_ICON}"
......
This diff is collapsed.
This diff is collapsed.
......@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME = VeloView
PROJECT_NAME = LidarView
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
......
# Table of contents
1. [VeloView dependencies](#dependencies)
1. [LidarView dependencies](#dependencies)
1. [PCAP library](#pcap-library)
2. [Boost library](#boost-library)
3. [Qt library](#qt-library)
......@@ -13,8 +13,8 @@
2. [Linux dependencies](#linux-dependencies)
3. [Linux build instructions](#linux-build-instructions)
## VeloView dependencies <a name="dependencies"></a>
The VeloView application and libraries have several external library dependencies. As explained in [Superbuild Overview](#superbuild-overview), **most of the dependencies will be downloaded and compiled automatically** during the build step. See [Configure and build instructions](#configure-build).
## LidarView dependencies <a name="dependencies"></a>
The LidarView application and libraries have several external library dependencies. As explained in [Superbuild Overview](#superbuild-overview), **most of the dependencies will be downloaded and compiled automatically** during the build step. See [Configure and build instructions](#configure-build).
### PCAP library <a name="pcap-library"></a>
The required pcap version is 1.4.
......@@ -32,8 +32,8 @@ Qt is a desktop widget library that is used to provide user interface elements l
### Python <a name="python"></a>
The required Python version is 2.7.
VeloView uses libpython to embed a Python interpreter in the VeloView application.
The core VeloView features are implemented in C++ libraries, and the libraries are wrapped for Python using VTK's Python wrapping tools.
LidarView uses libpython to embed a Python interpreter in the LidarView application.
The core LidarView features are implemented in C++ libraries, and the libraries are wrapped for Python using VTK's Python wrapping tools.
### PythonQt <a name="python-qt-library"></a>
PythonQt version is "patch_8" (see Superbuild/version.txt).
......@@ -50,10 +50,10 @@ The commits added are those that resolve some issues with the Python console and
The PythonQtPlugin is a small plugin that initializes the PythonQt library and makes it available in the ParaView Python console.
## Configure and build instructions <a name="configure-build"></a>
The VeloView software is hosted in git repositories that live on github.com (public version) and gitlab.kitware.com (internal version).
The LidarView software is hosted in git repositories that live on github.com (public version) and gitlab.kitware.com (internal version).
### Superbuild Overview <a name="superbuild-overview"></a>
VeloView can use a cmake *superbuild* to download and compile third party projects that are dependencies of VeloView.
LidarView can use a cmake *superbuild* to download and compile third party projects that are dependencies of LidarView.
The superbuild is not mandatory but it is recommended. It eases building a lot for new developers.
The superbuild will give you the option to use system installations of third party projects instead of compiling them as a superbuild step.
Some dependencies, on certain platforms, must be compiled by the superbuild, and for them there is no option to use a system version.
......@@ -66,11 +66,11 @@ Some dependencies, on certain platforms, must be compiled by the superbuild, and
- Qt 5.10.0 *(this dependency will be built automatically in the future)*. You can download the installer here: <https://download.qt.io/official_releases/qt/5.10/5.10.0/qt-opensource-windows-x86-5.10.0.exe>. When installing you can keep the suggested installation path. Here is a walkthrough of the installer: click "Next" > "Skip" > "Next" > keep default install path (advised) and click "Next" > Unfold "Qt" then unfold "Qt 5.10.0" and tick "**MSVC 2015 64-bits**" then click "Next" > "Next" > "Install" > wait for it to install then click "Next" > untick "Launch Qt Creator" and click "Finish"
### Windows build instructions <a name="windows-build-instructions"></a>
1. clone VeloView's source code repository to a directory of your chosing, for example:
1. clone LidarView's source code repository to a directory of your chosing, for example:
`cd <work-directory>`
`git clone <git url to VeloView repository> VeloView-source`
`git clone <git url to LidarView repository> LidarView-source`
* you will have to know the path to this directory for step 6.
* moving this directoy in the future will break all build environnements that were using it (you will have to redo steps 6. and 7.)
......@@ -78,7 +78,7 @@ Some dependencies, on certain platforms, must be compiled by the superbuild, and
2. clone the submodule that is used to provide the Superbuild:
`cd VeloView-source`
`cd LidarView-source`
`git submodule update --init Superbuild/common-superbuild`
......@@ -86,11 +86,11 @@ Some dependencies, on certain platforms, must be compiled by the superbuild, and
3. create a new directory to store the build.
`mkdir C:\VeloView-build`
`mkdir C:\LidarView-build`
* You can use the Windows file explorer to create this directory
* **This directory must not be inside the VeloView source code directory**
* **the path to this directory must be short** because Windows has limitations on the maximum length of file paths. We suggest that you use a directory at the root of a drive, like *C:\\VeloView-build*
* **This directory must not be inside the LidarView source code directory**
* **the path to this directory must be short** because Windows has limitations on the maximum length of file paths. We suggest that you use a directory at the root of a drive, like *C:\\LidarView-build*
4. open the appropriate command prompt:
......@@ -104,7 +104,7 @@ Some dependencies, on certain platforms, must be compiled by the superbuild, and
5. inside the command prompt, go to the build directory you created in step 3 by entering the command
`cd /d "C:\VeloView-build"`
`cd /d "C:\LidarView-build"`
* Adapt the path to your own build directory created in step 3.
* `/d` is allows to `cd` to a directory that is not on the same drive as your current path
......@@ -112,12 +112,12 @@ Some dependencies, on certain platforms, must be compiled by the superbuild, and
6. inside the command prompt configure the build by entering:
`cmake <work-directory>\Veloview-source\Superbuild -GNinja -DCMAKE_BUILD_TYPE=Release -DUSE_SYSTEM_qt5=True -DQt5_DIR="C:/Qt/Qt5.10.0/5.10.0/msvc2015_64/lib/cmake/Qt5"`
`cmake <work-directory>\LidarView-source\Superbuild -GNinja -DCMAKE_BUILD_TYPE=Release -DUSE_SYSTEM_qt5=True -DQt5_DIR="C:/Qt/Qt5.10.0/5.10.0/msvc2015_64/lib/cmake/Qt5"`
* Take note that this command mentions the subdirectory "Superbuild" inside the source directory and not the source directory itself.
* Take note that the Qt5_DIR path must use **forward slashes** (like if it was an Unix PATH), because MSVC would otherwise take "\\Q" as a build option.
* If you changed the default Qt installation path, you will have to adapt this command.
* You can use absolute or relative path to point to the VeloView source directory.
* You can use absolute or relative path to point to the LidarView source directory.
* Should you want to build in RelWithDebInfo mode (in order to attach a debugger for instance), replace "Release" by "RelWithDebInfo".
* This command should show no errors, else they must be fixed.
......@@ -130,9 +130,9 @@ Some dependencies, on certain platforms, must be compiled by the superbuild, and
* By default ninja will use all cores on your machine, but you can restrict the number of cores used by using `ninja -jN` (replace N by the number of cores to use).
9. if you modified only VeloView and want to rebuild incrementally (incrementaly = only modified files are rebuilded), enter the commands:
9. if you modified only LidarView and want to rebuild incrementally (incrementaly = only modified files are rebuilded), enter the commands:
`cd common-superbuild/veloview/build`
`cd common-superbuild/lidarview/build`
`ninja install`
......@@ -164,18 +164,18 @@ The following packages are needed to build on Ubuntu 16.04:
### Linux build instructions <a name="linux-build-instructions"></a>
1. clone VeloView's source code repository to a directory of your chosing, for example:
1. clone LidarView's source code repository to a directory of your chosing, for example:
`cd <work-directory>`
`git clone <git url to VeloView repository> VeloView-source`
`git clone <git url to LidarView repository> LidarView-source`
* moving this directoy in the future will break all build environnements that were using it (you will have to redo steps 6. and 7.)
2. clone the submodule that is used to provide the Superbuild:
`cd VeloView-source`
`cd LidarView-source`
`git submodule update --init Superbuild/common-superbuild`
......@@ -184,16 +184,16 @@ The following packages are needed to build on Ubuntu 16.04:
3. create a new directory to store the build.
`mkdir <work-directory>/VeloView-build`
`mkdir <work-directory>/LidarView-build`
* **This directory must not be inside the VeloView source code directory**
* **This directory must not be inside the LidarView source code directory**
4. configure the build by entering:
`cd <work-directory>/VeloView-build`
`cd <work-directory>/LidarView-build`
`cmake <work-directory>/VeloView-source/Superbuild -DCMAKE_BUILD_TYPE=Release`
`cmake <work-directory>/LidarView-source/Superbuild -DCMAKE_BUILD_TYPE=Release`
* by default the generator used is **make**, if you prefer to use **ninja**, add the option `-GNinja`
* Take note that this command mentions the subdirectory "Superbuild" inside the source directory and not the source directory itself.
......@@ -206,9 +206,9 @@ The following packages are needed to build on Ubuntu 16.04:
* replace `<N>` by the number of cores you want to use
9. if you modified only VeloView and want to rebuild incrementally (incrementaly = only modified files are rebuilded), enter the commands:
9. if you modified only LidarView and want to rebuild incrementally (incrementaly = only modified files are rebuilded), enter the commands:
`cd common-superbuild/veloview/build`
`cd common-superbuild/lidarview/build`
`make install`
......
========================
VeloView User Guide
========================
---------------------------------------------------------------------------
User documentation for the VeloView application and libraries
---------------------------------------------------------------------------
:copyright: Copyright (c) 2013, Velodyne Lidar. All rights reserved.
:version: 1.0.8
.. contents:: Table of Contents
.. section-numbering::
.. target-notes::
For user documentation contact
Wolfgang Juchmann
wjuchmann@velodyne.com
......@@ -347,7 +347,7 @@ set(plugin_include_dirs
# give default target name if not specify otherwise
if (NOT VV_PLUGIN_LIBRARY)
set(VV_PLUGIN_LIBRARY LidarPlugin) # veloview plugin
set(VV_PLUGIN_LIBRARY LidarPlugin) # lidarview plugin
endif()
# create pluging
......@@ -455,11 +455,11 @@ if (APPLE)
install(FILES ${python_libs} DESTINATION ${VV_INSTALL_RUNTIME_DIR}/${SOFTWARE_NAME}.app/Contents/Libraries)
# install some pdf
install(FILES ${VeloView_SOURCE_DIR}/Documentation/VeloView_Developer_Guide.pdf DESTINATION ${VV_INSTALL_RUNTIME_DIR}/${SOFTWARE_NAME}.app/Contents/Resources)
configure_file(${VeloView_SOURCE_DIR}/Documentation/VeloView_Developer_Guide.pdf ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${SOFTWARE_NAME}.app/Contents/Resources/VeloView_Developer_Guide.pdf)
install(FILES ${LidarView_SOURCE_DIR}/Documentation/LidarView_Developer_Guide.pdf DESTINATION ${VV_INSTALL_RUNTIME_DIR}/${SOFTWARE_NAME}.app/Contents/Resources)
configure_file(${LidarView_SOURCE_DIR}/Documentation/LidarView_Developer_Guide.pdf ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${SOFTWARE_NAME}.app/Contents/Resources/LidarView_Developer_Guide.pdf)
install(FILES ${VeloView_SOURCE_DIR}/Documentation/VeloView_User_Guide.pdf DESTINATION ${VV_INSTALL_RUNTIME_DIR}/${SOFTWARE_NAME}.app/Contents/Resources)
configure_file(${VeloView_SOURCE_DIR}/Documentation/VeloView_User_Guide.pdf ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${SOFTWARE_NAME}.app/Contents/Resources/VeloView_User_Guide.pdf)
install(FILES ${LidarView_SOURCE_DIR}/Documentation/LidarView_User_Guide.pdf DESTINATION ${VV_INSTALL_RUNTIME_DIR}/${SOFTWARE_NAME}.app/Contents/Resources)
configure_file(${LidarView_SOURCE_DIR}/Documentation/LidarView_User_Guide.pdf ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${SOFTWARE_NAME}.app/Contents/Resources/LidarView_User_Guide.pdf)
else()
# install target
......
......@@ -285,8 +285,8 @@ void vtkLidarReader::SaveFrame(int startFrame, int endFrame, const std::string &
// Here we see that the first separation between two frame happens in the
// first packet. We do need to see one more separation than the number of
// packets to write. This is due to the fact that the first incomplete frame
// is hidden by VeloView.
// A possible improvement to VeloView would be to not always hide this first
// is hidden by LidarView.
// A possible improvement to LidarView would be to not always hide this first
// frame, depending on a flag set on the reader.
// *if you are very lucky the first frame will start at the begining of the
// first packet, and there will be no "incomplete frame".
......
......@@ -37,7 +37,7 @@
* - yaw : expresses the sensor rotation around the Z axis and is in degree
* - the rotation matrix can be recomposed this way: R = Rz(z)*Ry(y)*Rx(x)
*
* Remark: if you get from VeloView UI the error:
* Remark: if you get from LidarView UI the error:
* "vtkSIProxyDefinitionManager: No proxy that matches: group= and proxy= were found."
* when you tried to open a file with a ".csv" extension and was asked to chose
* between standard "Delimited Text" and "pose trajectory" then it means you
......
# HOW TO: Use VeloView testing
# HOW TO: Use LidarView testing
### Reader tests definition
......@@ -8,17 +8,17 @@ The tests are based on the comparaison of the processing of a reference recordin
**pcap** file with the baseline **vtp** file, that have been generate on a **stable version** of the Reader.
### Enable VeloView testing
### Enable LidarView testing
In VeloView CMAKE options, enable option `BUILD_TESTING`. Then rebuild Veloview.
In LidarView CMAKE options, enable option `BUILD_TESTING`. Then rebuild LidarView.
### Get test data and baseline
The Test Data (**.pcap** file) and the baseline (**.vtp** file) are store on another
gitlab repository. This repository is a submodule of Veloview, to get this data simply run:
gitlab repository. This repository is a submodule of LidarView, to get this data simply run:
```
git submodule update --init
```
......@@ -27,7 +27,7 @@ This may took some minutes. Finally the test data and baseline could be found in
### Run the tests
To launch a test, use the program CTest. CTest needs to be run from the VeloView
To launch a test, use the program CTest. CTest needs to be run from the LidarView
build directory.
To use CTest from the command line on Linux or MacOS, do:
......@@ -45,25 +45,25 @@ ctest -R <REGEX_TEST_NAME> [-VV]
### Update test data
**Disclaimer:** In some rare cases, the functionality added to VeloView modifies
**Disclaimer:** In some rare cases, the functionality added to LidarView modifies
some properties of the 3D points tested above, and thus the tests will return a
failure even if the values tested match the ones intended. Please run all the
tests and ensure that just the one intended to fail fails for your modifications
before generating updated test data.
To generate updated test data automatically, go to your VeloView build directory
and launch VeloView with the option --script.
To generate updated test data automatically, go to your LidarView build directory
and launch LidarView with the option --script.
On Linux:
```
BUILD_DIR/veloview/src/veloview-build/bin/VeloView --script=BUILD_DIR/veloview/src/veloview-build/bin/generateTestData.py
BUILD_DIR/lidarview/src/lidarview-build/bin/LidarView --script=BUILD_DIR/lidarview/src/lidarview-build/bin/generateTestData.py
```
On Windows:
```
INSTALL_DIR/bin/VeloView.exe --script=INSTALL_DIR/bin/generateTestData.py
INSTALL_DIR/bin/LidarView.exe --script=INSTALL_DIR/bin/generateTestData.py
```
On MacOS:
```
open PACKAGE_DIR/VeloView.app --args --script=BUILD_DIR/veloview/src/veloview-build/bin/generateTestData.py
open PACKAGE_DIR/LidarView.app --args --script=BUILD_DIR/lidarview/src/lidarview-build/bin/generateTestData.py
```
Updated test data will be generated in `/TestData`. Commit your changes in the
submodule `TestData` fisrt and then commit them on this repository.
......@@ -72,12 +72,12 @@ submodule `TestData` fisrt and then commit them on this repository.
### Adding new test data
Adding new test data means adding a PCAP file and associated VTP baseline files to
VeloView-TestData. It has to be saved under `TestData`. If you need a custom
LidarView-TestData. It has to be saved under `TestData`. If you need a custom
calibration file, it has to be in the `share` directory. Then, edit
`generateTestData.py.in` in order to add your PCAP and its associated calibration
file to the list of tests data to generate.
Finaly re generate Veloview with cmake, in order to create a new 'generateTestData.py' file
Finaly re generate LidarView with cmake, in order to create a new 'generateTestData.py' file
and add a new test in the `CMakeList.txt`.
Don't forget to commit your change!
......@@ -87,5 +87,5 @@ Don't forget to commit your change!
least 12480 packets for it to works. The live calibration mode computes the
calibration from appended received data packet and it's the minimum required
to compute it correctly (the rolling calibration data span 4160 datapacket, but
VeloView requires some redondancy to be on the safe side).
LidarView requires some redondancy to be on the safe side).
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment