#include <PoppeFootball.h>

Inheritance diagram for PoppeFootball:

Public Member Functions
	PoppeFootball (Datapool *i_data)
	PoppeFootball::PoppeFootball PoppeFootball module. This is an implementation for "Multi-Camera Analysis of Soccer Sequences" from Chris Poppe et. al paper, used to tracking football players with a single-view camera. More...

	~PoppeFootball ()
	PoppeFootball::~PoppeFootball Destructor.

bool	setParameters (QDomNode &config)
	PoppeFootball::setParameters Inherited from ModuleInterface class virtual method. SetParameters reads the XML configuration file (default_config.xml?) and allows to pass those parameters to our variables. Please refer to this class reference to see what XML configuration is needed. More...

bool	init ()
	PoppeFootball::init This is first called when the module is initialized. More...

bool	run ()
	PoppeFootball::run This is run for each frame. The main processing is made here. More...

bool	updateParameters ()
	PoppeFootball::updateParameters I have absolutely no idea what does this function do. More...

void	retrieveFGMask ()
	PoppeFootball::retrieveFGMask Run operation to get the segmentation image. It is based in a codebook model whose parameters you can adjust using the XML config file (see the class description for more details). It's important to set those parameters properly in order to get a good FG mask. If relatively too much foreground is detected, the Codebook model is considered stale and learned again. This function also takes care of resetting the variables in order to resume that cycle in the run function. The output of this function is the segmentation: the Datapool (m_data->fgImage) foreground mask is updated for a Connected Components algorithm to be applied to it.

void	prepareStructuralElem (cv::Mat &output, morpho_param par)
	PoppeFootball::prepareStructuralElem Prepares a Mat with a structural element for morphology operations. More...

cv::Scalar	colorName (QString colorcode, bool *convsuccess=NULL)
	PoppeFootball::colorName Transforms a "#RRGGBB" string into a scalar. Support for color names intended, but not implemented. More...

cv::Scalar	colorToHSV (cv::Scalar BGRinput)

Public Member Functions inherited from ModuleInterface
	ModuleInterface (Datapool *i_data)

void	addParameter (QString name, QString value, QString type)

void	addParameterChild (QString name, QString value, QString type, parameter *parent)

parameter *	getParameter (QString name)

parameter *	getParameter (QString name, parameter *parent)

parameter *	getParameter (QString name, std::multimap< QString, parameter > subList)

Parameter2 *	getParameterFromTree (const QString name)

Parameter2 *	getParameterFromTree (const QString name, Parameter2 *parent)

Parameter2 *	getParameterFromTree (const QString name, std::multimap< QString, Parameter2 > subList)

void	addParameterToTree (const QString name, const QString value, const QString defaultValue, const ParameterDataType &type)

void	addChildParameterToTree (const QString &name, const QString &value, const QString &defaultValue, const ParameterDataType &type, Parameter2 *parent)

bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const bool &defaulValue, bool &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const char &defaulValue, char &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const uchar &defaulValue, uchar &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const int &defaulValue, int &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const uint &defaulValue, uint &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const long &defaulValue, long &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const ulong &defaulValue, ulong &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const float &defaulValue, float &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const double &defaulValue, double &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	getParameterValueFromXml (const QDomNode &rootNode, const QString &parameterName, const QString &defaulValue, QString &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const bool defaulValue, bool &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const int defaulValue, int &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const char defaulValue, char &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const uchar defaulValue, uchar &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const uint defaulValue, uint &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const long defaulValue, long &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const ulong defaulValue, ulong &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const float defaulValue, float &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const double defaulValue, double &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setNodeParameterModule (const QDomNode &rootNode, const QString &parameterName, const QString defaulValue, QString &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const bool defaulValue, bool &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const int defaulValue, int &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const char defaulValue, char &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const uchar defaulValue, uchar &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const uint defaulValue, uint &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const long defaulValue, long &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const ulong defaulValue, ulong &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const float defaulValue, float &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const double defaulValue, double &outParameter, QDomNode &parameterNode, bool appendWarning=false)

bool	setChildParameterModule (const QDomNode &rootNode, const QString &parameterName, const QString defaulValue, QString &outParameter, QDomNode &parameterNode, bool appendWarning=false)

Additional Inherited Members
Public Attributes inherited from ModuleInterface
std::deque< QString >	nameParameters

std::deque< QString >	valueParameters

std::deque< QString >	typeParameters

std::deque< parameter >	listParameters

std::deque< Parameter2 >	parametersTree

std::string	name

ModuleType	type

Protected Attributes inherited from ModuleInterface
Datapool *	m_data

Detailed Description

It's a VAT Module, so it inherits from ModuleInterface for it to be integrated with the workbench.

How to integrate this module into VAT: It's a rather simple task. All we have to do is:

Go to VAT modules.cpp file, and incorpore our class using the corresponding #include, and putting all the necessary ADD_MODULE and REGISTER_MODULE macros with the name of our class, and we're ready to use it.
Write "PoppeFootball" as a new line in default_module_sequence.txt.
In the log, should appear "POPPEFOOTBALL: Module armed and ready."

This module relies on a lot of external functions, declared in CommonImage and CodebookModel classes. As interaction between Qt and OpenCV's image formats sure gave us more than one headache, we hope these will be useful for another projects besides ours.

TODO:

Calibrating the field using Tsai's algorithm.
This module was NOT performance-profiled, nor intensily debugged. Memory leaks, some bugs and strangely high-memory-consuming functions should not be surprising.
Prepare more coffee.
Seriously. This is my sixth cup.

TO VIEW OUR RESULTS:

Modify "view_config.xml". The tag <afterModule> tells "after" what module the picture is taken.
Then write children to the tag <sequence value="true">, indicating what operations will be shown. These operations are all the classes available in DRAW folder. If we want to add an operation, create a class in DRAW folder, and register in "draw.cpp"

XML CONFIG PARAMETERS:

verbose tag [Boolean]: Its value attribute should be set to "true" if you want this module to throw up information for almost everything in the console. "false" if you want it to remain silent.
segmentation tree:
- codebookmodel tree:
  - startingparams tree:
    - Y tag: "min" attribute [Integer], "max" attribute [Integer], and "bound" attribute [Integer] sets the initial parameters for the Codebook model. For rule of thumb, the default value for each is 3, 10 and 10 respectively.
    - U tag, and V tag: Work pretty much the same as the Y tag, except that set the starting Codebook model initial conditions for those other channels.
  - learningframes tag: "value" attibute [Integer] sets how long (in frames) should last the codebook learning period. A higher value should give a more robust model, but longer idle periods.
  - learnagain_percentage tag: "min" and "max" attributes [Percentage]. "min" tells how much of the image should be considered as Foreground in order to re-learn the codebook model. "max" attribute is used to define a linear learning function. If the foreground percentage goes beyond the "max" value, the Codebook model is wiped entirely and learned again. Otherwise, the model is learned a proportional number of frames more.
- morphologyorder tree: This tree defines the morphology operations made to filter little details in the codebook results.
  - erosion -and- dilation tags: These define a morphology operation to be made, in order. The attributes of these tags are "size" [Integer] and "shape". These values define the structural element used in each morphology operation. "size" is its diameter, and "shape" can be either "cross", "circle" or "square".

RECOMMENDED USE OF THIS MODULE: This is a segmentation module, it should be used after an adquisition module (like a camera or a video file). Blobs must be taken from the results of this module. Then, the order should be the following:

Constructor & Destructor Documentation

PoppeFootball::PoppeFootball ( Datapool * i_data )

PoppeFootball::PoppeFootball PoppeFootball module. This is an implementation for "Multi-Camera Analysis of Soccer Sequences" from Chris Poppe et. al paper, used to tracking football players with a single-view camera.

Parameters

i_data Module parameter for VAT, centralizes every captured frame.

Member Function Documentation

Scalar PoppeFootball::colorName	(	QString	colorcode,
		bool *	convsuccess = `NULL`
	)

PoppeFootball::colorName Transforms a "#RRGGBB" string into a scalar. Support for color names intended, but not implemented.

Parameters

colorcode

Returns

bool PoppeFootball::init ( )

virtual

PoppeFootball::init This is first called when the module is initialized.

Returns

Implements ModuleInterface.

void PoppeFootball::prepareStructuralElem	(	cv::Mat &	output,
		morpho_param	par
	)

PoppeFootball::prepareStructuralElem Prepares a Mat with a structural element for morphology operations.

Parameters

output	Output Mat
par	Structural element parameters

bool PoppeFootball::run ( )

virtual

PoppeFootball::run This is run for each frame. The main processing is made here.

Returns

Implements ModuleInterface.

bool PoppeFootball::setParameters ( QDomNode & config )

virtual

PoppeFootball::setParameters Inherited from ModuleInterface class virtual method. SetParameters reads the XML configuration file (default_config.xml?) and allows to pass those parameters to our variables. Please refer to this class reference to see what XML configuration is needed.

Parameters

config Holds the config XML nodes.

Returns: False if some required parameters (like player template route) are undefined.

Implements ModuleInterface.

bool PoppeFootball::updateParameters ( )

virtual

PoppeFootball::updateParameters I have absolutely no idea what does this function do.

Returns: No idea either.

Implements ModuleInterface.

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

MODULES/PoppeFootball.h
MODULES/PoppeFootball.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation