chrono::sensor::ChFilterGrayscale Class Reference

Description

A filter that, when applied to a sensor, changes the RGB buffer to grayscale.

#include <ChFilterGrayscale.h>

Inheritance diagram for chrono::sensor::ChFilterGrayscale:
Collaboration diagram for chrono::sensor::ChFilterGrayscale:

Public Member Functions

 ChFilterGrayscale (std::string name={})
 Class constructor. More...
 
virtual void Apply (std::shared_ptr< ChSensor > pSensor, std::shared_ptr< SensorBuffer > &bufferInOut)
 Apply function. More...
 
virtual void Initialize (std::shared_ptr< ChSensor > pSensor)
 Initializes all data needed by the filter apply function. More...
 
- Public Member Functions inherited from chrono::sensor::ChFilter
virtual ~ChFilter ()
 Virtual class desctructor.
 
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...
 

Constructor & Destructor Documentation

◆ ChFilterGrayscale()

chrono::sensor::ChFilterGrayscale::ChFilterGrayscale ( std::string  name = {})

Class constructor.

Parameters
nameString name of the filter

Member Function Documentation

◆ Apply()

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

Apply function.

Converts RGB to Greyscale data.

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.

◆ Initialize()

virtual void chrono::sensor::ChFilterGrayscale::Initialize ( std::shared_ptr< ChSensor pSensor)
inlinevirtual

Initializes all data needed by the filter apply function.

Parameters
pSensorA pointer to the sensor.

Implements chrono::sensor::ChFilter.


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