Description

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

#include <ChFilterPhysCameraVignetting.h>

Inheritance diagram for chrono::sensor::ChFilterPhysCameraVignetting:

Collaboration diagram for chrono::sensor::ChFilterPhysCameraVignetting:

Public Member Functions
	ChFilterPhysCameraVignetting (float focal_length, float sensor_width, float vignetting_gain, std::string name="Vignetting Filter in Phys Camera")
	Class constructor. More...

virtual void	Apply ()
	Apply function.

void	SetFilterCtrlParameters (float focal_length)
	Set control parameters in the filter function. More...

void	SetFilterModelParameters (float sensor_width, float vignetting_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

chrono::sensor::ChFilterPhysCameraVignetting::ChFilterPhysCameraVignetting	(	float	focal_length,
		float	sensor_width,
		float	vignetting_gain,
		std::string	name = `"Vignetting Filter in Phys Camera"`
	)

Class constructor.

Parameters

focal_length	(f) focal length
sensor_width	(L) sensor width
vignetting_gain	(G_vignet) proportional gain of irradiance falloff
name	The string name of the filter

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

virtual

Initializes all data needed by the filter access apply function.

Parameters

pSensor	A pointer to the sensor on which the filter is attached.
bufferInOut	A buffer that is passed into the filter. This data is what will be made available for the user.

CH_SENSOR_API void chrono::sensor::ChFilterPhysCameraVignetting::SetFilterCtrlParameters ( float focal_length )

Set control parameters in the filter function.

Parameters

focal_length (f) focal length

CH_SENSOR_API void chrono::sensor::ChFilterPhysCameraVignetting::SetFilterModelParameters	(	float	sensor_width,
		float	vignetting_gain
	)

Set model parameters in the filter function.

Parameters

sensor_width	(L) sensor width
vignetting_gain	(P_vignet) proportional gain of irradiance falloff

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

/builds/uwsbel/chrono/src/chrono_sensor/filters/ChFilterPhysCameraVignetting.h
/builds/uwsbel/chrono/src/chrono_sensor/filters/ChFilterPhysCameraVignetting.cpp