chrono::sensor::ChFilterPhysCameraNoise Class Reference

Description

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

#include <ChFilterPhysCameraNoise.h>

Inheritance diagram for chrono::sensor::ChFilterPhysCameraNoise:
Collaboration diagram for chrono::sensor::ChFilterPhysCameraNoise:

Public Member Functions

 ChFilterPhysCameraNoise (float expsr_time, ChVector3f dark_current_vec, ChVector3f noise_gain_vec, ChVector3f STD_read_vec, unsigned int FPN_seed, std::string name="Noise Model Filter in Phys Camera")
 Class constructor. More...
 
virtual void Apply ()
 Apply function.
 
void SetFilterCtrlParameters (float expsr_time)
 Set control parameters in the filter. More...
 
void SetFilterModelParameters (ChVector3f dark_current_vec, ChVector3f noise_gain_vec, ChVector3f STD_read_vec)
 Set model parameters in the filter. 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

◆ ChFilterPhysCameraNoise()

chrono::sensor::ChFilterPhysCameraNoise::ChFilterPhysCameraNoise ( float  expsr_time,
ChVector3f  dark_current_vec,
ChVector3f  noise_gain_vec,
ChVector3f  STD_read_vec,
unsigned int  FPN_seed,
std::string  name = "Noise Model Filter in Phys Camera" 
)

Class constructor.

Parameters
expsr_time(t) exposure time
dark_current_vecChVector of temporal means of dark currents
noise_gain_vecChVector of temporal noise gains
STD_read_vecChVector of standard deviations of read and FPN noises, equivalent [electrons]
FPN_seedseed of random number generator for getting read and FPN noises
nameThe string name of the filter

Member Function Documentation

◆ Initialize()

CH_SENSOR_API void chrono::sensor::ChFilterPhysCameraNoise::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::ChFilterPhysCameraNoise::SetFilterCtrlParameters ( float  expsr_time)

Set control parameters in the filter.

Parameters
expsr_time(t) exposure time

◆ SetFilterModelParameters()

CH_SENSOR_API void chrono::sensor::ChFilterPhysCameraNoise::SetFilterModelParameters ( ChVector3f  dark_current_vec,
ChVector3f  noise_gain_vec,
ChVector3f  STD_read_vec 
)

Set model parameters in the filter.

Parameters
dark_current_vecChVector of temporal means of dark currents
noise_gain_vecChVector of temporal noise gains
STD_read_vecChVector of standard deviations of read and FPN noises, equivalent [electrons]

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