Helios++
Helios software for LiDAR simulations
ScannerSettings Class Reference

Scanner settings class. More...

#include <ScannerSettings.h>

Inheritance diagram for ScannerSettings:
Collaboration diagram for ScannerSettings:

Public Member Functions

 ScannerSettings ()=default
 Scanner settings default constructor.
 
 ScannerSettings (ScannerSettings *other)
 
bool hasTemplate ()
 Check if this ScannerSettings has an associated template (true) or not (false) More...
 
ScannerSettingsgetTemplate ()
 Obtain template by reference. More...
 
- Public Member Functions inherited from Asset
std::string getLocationString ()
 Obtain asset location string. More...
 

Public Attributes

std::string id = "#nullid#"
 The ID for this scanner settings. It does not make sense for all scanner settings, but it is specially useful when it comes to handling XML templates.
 
std::shared_ptr< ScannerSettingsbaseTemplate = nullptr
 Template defining default values which was used to build the ScannerSettings object.
 
bool active = true
 Flag to specify if scanner is active (true) or not (false) More...
 
int beamSampleQuality = 5
 Beam sample quality.
 
double headRotatePerSec_rad = 0
 Amount of rotation (radians) per second for the scanner head.
 
double headRotateStart_rad = 0
 Starting angle (radians) for the scanner head.
 
double headRotateStop_rad = 0
 Ending angle (radians) for the scanner head.
 
int pulseFreq_Hz = 0
 Pulse frequency (hertz)
 
double scanAngle_rad = 0
 Scan angle (radians)
 
double verticalAngleMin_rad = 0
 Minimum vertical angle (radians)
 
double verticalAngleMax_rad = 0
 Maximum vertical angle (radians)
 
int scanFreq_Hz = 0
 Scanning frequency (hertz)
 
double beamDivAngle = 0.003
 Beam divergence angle (radians)
 
double pulseLength_ns = 0
 Pulse length (nanoseconds)
 
double trajectoryTimeInterval = 0.0
 Time interval between trajectory recollections (seconds)
 
- Public Attributes inherited from Asset
std::string id = ""
 Asset identifier.
 
std::string name = "Unnamed Asset"
 Asset name.
 
std::string sourceFilePath = ""
 Path to asset file.
 

Detailed Description

Scanner settings class.

Member Function Documentation

◆ getTemplate()

ScannerSettings& ScannerSettings::getTemplate ( )
inline

Obtain template by reference.

Returns
Reference to template associated to this ScannerSettings
See also
ScannerSettings::baseTemplate
ScannerSettings::hasTemplate

◆ hasTemplate()

bool ScannerSettings::hasTemplate ( )
inline

Check if this ScannerSettings has an associated template (true) or not (false)

Returns
True when there is an associated template, false otherwise
See also
ScannerSettings::baseTemplate
ScannerSettings::hasTemplate

Member Data Documentation

◆ active

bool ScannerSettings::active = true

Flag to specify if scanner is active (true) or not (false)

When a scanner is not active, no points will be captured


The documentation for this class was generated from the following file: