chrono::sensor::ChFilterPhysCameraAggregator Class Reference

Description

A filter that adjust the brightness of the image according to exposure time and sensitivity coefficients.

#include <ChFilterPhysCameraAggregator.h>

Inheritance diagram for chrono::sensor::ChFilterPhysCameraAggregator:
Collaboration diagram for chrono::sensor::ChFilterPhysCameraAggregator:

Public Member Functions

 ChFilterPhysCameraAggregator (float aperture_num, float expsr_time, float pixel_size, float max_scene_light_amount, ChVector3f rgb_QE_vec, float aggregator_gain, std::string name="Aggregation Filter in Phys Camera")
 Class constructor. More...
 
virtual void Apply ()
 Apply function.
 
void SetFilterCtrlParameters (float aperture_num, float expsr_time)
 Set control parameters in the filter function. More...
 
void SetFilterModelParameters (float pixel_size, float max_scene_light_amount, ChVector3f rgb_QE_vec, float aggregator_gain)
 Set model parameters in the filter function. More...
 
virtual void Initialize (std::shared_ptr< ChSensor > pSensor, std::shared_ptr< SensorBuffer > &bufferInOut)
 Initializes all data needed by the filter access apply function. More...
 
- Public Member Functions inherited from chrono::sensor::ChFilter
virtual ~ChFilter ()
 Virtual class destructor.
 
std::string & Name ()
 Accesses the name of the filter. More...
 

Additional Inherited Members

- Protected Member Functions inherited from chrono::sensor::ChFilter
 ChFilter (std::string name)
 protected constructor for the filter which requires a name as input. More...
 
void InvalidFilterGraphNullBuffer (std::shared_ptr< ChSensor > pSensor)
 Error function for invalid filter graph: null buffer found.
 
void InvalidFilterGraphBufferTypeMismatch (std::shared_ptr< ChSensor > pSensor)
 Error function for invalid filter graph: type mismatch in graph.
 
void InvalidFilterGraphSensorTypeMismatch (std::shared_ptr< ChSensor > pSensor)
 Error function for invalid filter graph: type mismatch in graph.
 

Constructor & Destructor Documentation

◆ ChFilterPhysCameraAggregator()

chrono::sensor::ChFilterPhysCameraAggregator::ChFilterPhysCameraAggregator ( float  aperture_num,
float  expsr_time,
float  pixel_size,
float  max_scene_light_amount,
ChVector3f  rgb_QE_vec,
float  aggregator_gain,
std::string  name = "Aggregation Filter in Phys Camera" 
)

Class constructor.

Parameters
aperture_num(N) aperture number = focal_length / aperture_diameter
expsr_time(t) exposure time
pixel_size(C) pixel size
max_scene_light_amount(P) maximum brightness amount of a light source in the scene
rgb_QE_vecvector of RGB quantum efficiencies
aggregator_gain(G_aggregator) proportional gain
nameThe string name of the filter

Member Function Documentation

◆ Initialize()

CH_SENSOR_API void chrono::sensor::ChFilterPhysCameraAggregator::Initialize ( std::shared_ptr< ChSensor pSensor,
std::shared_ptr< SensorBuffer > &  bufferInOut 
)
virtual

Initializes all data needed by the filter access apply function.

Parameters
pSensorA pointer to the sensor on which the filter is attached.
bufferInOutA buffer that is passed into the filter. This data is what will be made available for the user.

Implements chrono::sensor::ChFilter.

◆ SetFilterCtrlParameters()

CH_SENSOR_API void chrono::sensor::ChFilterPhysCameraAggregator::SetFilterCtrlParameters ( float  aperture_num,
float  expsr_time 
)

Set control parameters in the filter function.

Parameters
aperture_num(N) aperture number = focal_length / aperture_diameter
expsr_time(t) exposure time

◆ SetFilterModelParameters()

CH_SENSOR_API void chrono::sensor::ChFilterPhysCameraAggregator::SetFilterModelParameters ( float  pixel_size,
float  max_scene_light_amount,
ChVector3f  rgb_QE_vec,
float  aggregator_gain 
)

Set model parameters in the filter function.

Parameters
pixel_size(C) pixel size
max_scene_light_amount(P) maximum brightness amount of a light source in the scene
rgb_QE_vecvector of RGB quantum efficiencies
aggregator_gain(G_aggregator) proportional gain

The documentation for this class was generated from the following files:
  • /builds/uwsbel/chrono/src/chrono_sensor/filters/ChFilterPhysCameraAggregator.h
  • /builds/uwsbel/chrono/src/chrono_sensor/filters/ChFilterPhysCameraAggregator.cpp