This class is designed to manage the different image processing modules and to apply them. More...

#include <oImageProcessingManager.hh>

Collaboration diagram for oImageProcessingManager:

Public Member Functions
	oImageProcessingManager ()
	The constructor of oImageProcessingManager. More...

	~oImageProcessingManager ()
	The destructor of oImageProcessingManager. More...

int	CheckParameters ()
	A function used to check the parameters settings. More...

int	Initialize ()
	A function used to initialize the manager and all image processing modules it manages. More...

int	ApplyProcessingForward (oImageSpace *ap_ImageSpace)

int	ApplyProcessingIntra (oImageSpace *ap_ImageSpace)

int	ApplyProcessingPost (oImageSpace *ap_ImageSpace)

void	SetVerbose (int a_verboseLevel)

void	SetImageDimensionsAndQuantification (oImageDimensionsAndQuantification *ap_ImageDimensionsAndQuantification)

void	SetOptions (vector< string > a_options)

	oImageProcessingManager ()

	~oImageProcessingManager ()

int	CheckParameters ()

int	Initialize ()

int	ApplyProcessingForward (oImageSpace *ap_ImageSpace)

int	ApplyProcessingIntra (oImageSpace *ap_ImageSpace)

int	ApplyProcessingPost (oImageSpace *ap_ImageSpace)

void	SetVerbose (int a_verboseLevel)

void	SetImageDimensionsAndQuantification (oImageDimensionsAndQuantification *ap_ImageDimensionsAndQuantification)

void	SetOptions (vector< string > a_options)

Static Public Member Functions
static void	ShowCommonHelp ()
	This function does not take any parameter and is used to display some help about the syntax of the options describing the image processing module that should be used. It is static so that it can be called without any object initialization. More...

static void	ShowCommonHelp ()

Private Member Functions
int	ParseOptionsAndInitializeImageProcessingModules ()
	A function used to parse options and initialize image processing modules. More...

int	ParseOptionsAndInitializeImageProcessingModules ()

Private Attributes
oImageDimensionsAndQuantification *	mp_ImageDimensionsAndQuantification

vector< string >	m_options

int	m_nbImageProcessingModules

vImageProcessingModule **	m2p_ImageProcessingModules

bool *	mp_applyForward

bool *	mp_applyIntra

bool *	mp_applyPost

bool	m_checked

bool	m_initialized

int	m_verbose

Detailed Description

This class is designed to manage the different image processing modules and to apply them.

This manager class is supposed to be created and initialized in the main program. To do so, the following steps must be used: (i) The empty constructor is called which affect all members with default values. (ii) All parameters are set through the use of SetXXX() functions. (iii) The CheckParameters() function is called to check that everything mandatory has been set. (iv) The Initialize() function is called to initialize everything. (v) Now the action functions of the manager can be called to apply the different image processing modules. In a few words, based on supplied options, the manager will create children of the abstract vImageProcessingModule class which are specific image processing modules. As an example, see the iImageProcessingTemplate child class that illustrates how a specific image processing module should be implemented.

Definition at line 29 of file code/include/image/oImageProcessingManager.hh.

Constructor & Destructor Documentation

◆ oImageProcessingManager() [1/2]

oImageProcessingManager::oImageProcessingManager ( )

The constructor of oImageProcessingManager.

This is the default and unique constructor. It does not take any parameter and its role is only to affect default values to each member of the class.

Definition at line 16 of file code/src/image/oImageProcessingManager.cc.

◆ ~oImageProcessingManager() [1/2]

oImageProcessingManager::~oImageProcessingManager ( )

The destructor of oImageProcessingManager.

This is the default and unique destructor. It does not take any parameter and its role is only to free or delete all structures that were build by this class.

Definition at line 40 of file code/src/image/oImageProcessingManager.cc.

◆ oImageProcessingManager() [2/2]

oImageProcessingManager::oImageProcessingManager ( )

◆ ~oImageProcessingManager() [2/2]

oImageProcessingManager::~oImageProcessingManager ( )

Member Function Documentation

◆ ApplyProcessingForward() [1/2]

int oImageProcessingManager::ApplyProcessingForward ( oImageSpace * ap_ImageSpace )

Definition at line 330 of file code/src/image/oImageProcessingManager.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ApplyProcessingForward() [2/2]

int oImageProcessingManager::ApplyProcessingForward ( oImageSpace * ap_ImageSpace )

◆ ApplyProcessingIntra() [1/2]

int oImageProcessingManager::ApplyProcessingIntra ( oImageSpace * ap_ImageSpace )

Definition at line 363 of file code/src/image/oImageProcessingManager.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ApplyProcessingIntra() [2/2]

int oImageProcessingManager::ApplyProcessingIntra ( oImageSpace * ap_ImageSpace )

◆ ApplyProcessingPost() [1/2]

int oImageProcessingManager::ApplyProcessingPost ( oImageSpace * ap_ImageSpace )

◆ ApplyProcessingPost() [2/2]

int oImageProcessingManager::ApplyProcessingPost ( oImageSpace * ap_ImageSpace )

Definition at line 396 of file code/src/image/oImageProcessingManager.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckParameters() [1/2]

int oImageProcessingManager::CheckParameters ( )

A function used to check the parameters settings.

This function does not take any parameter and is used to check that all mandatory members were correctly parameterized.

Returns: An integer reflecting the check status; 0 if no problem, another value otherwise.

Definition at line 55 of file code/src/image/oImageProcessingManager.cc.

Here is the caller graph for this function:

◆ CheckParameters() [2/2]

int oImageProcessingManager::CheckParameters ( )

◆ Initialize() [1/2]

int oImageProcessingManager::Initialize ( )

A function used to initialize the manager and all image processing modules it manages.

This function does not take any parameter and is used to initialize everything that should be initialized. In a few words, it parses the options, then creates and initializes all image processing modules based on the provided options.

Returns: An integer reflecting the initialization status; 0 if no problem, another value otherwise.

Definition at line 113 of file code/src/image/oImageProcessingManager.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Initialize() [2/2]

int oImageProcessingManager::Initialize ( )

◆ ParseOptionsAndInitializeImageProcessingModules() [1/2]

int oImageProcessingManager::ParseOptionsAndInitializeImageProcessingModules ( )

private

A function used to parse options and initialize image processing modules.

This function first parses the options contained in the member m_options. Each string of the vector describes an image processing module to be used. Based on a specific syntax, the options are parsed to get the name of the processing module, its associated parameters and the steps of application. Based on this, the image processing modules are initialized. This function is private because it is called by the Initialize() function.

Returns: An integer reflecting the parsing and initialization status; 0 if no problem, another value otherwise.

Definition at line 146 of file code/src/image/oImageProcessingManager.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseOptionsAndInitializeImageProcessingModules() [2/2]

int oImageProcessingManager::ParseOptionsAndInitializeImageProcessingModules ( )

private

◆ SetImageDimensionsAndQuantification() [1/2]

void oImageProcessingManager::SetImageDimensionsAndQuantification ( oImageDimensionsAndQuantification * ap_ImageDimensionsAndQuantification )

inline

Definition at line 135 of file code/include/image/oImageProcessingManager.hh.

Here is the caller graph for this function:

◆ SetImageDimensionsAndQuantification() [2/2]

void oImageProcessingManager::SetImageDimensionsAndQuantification ( oImageDimensionsAndQuantification * ap_ImageDimensionsAndQuantification )

inline

Definition at line 135 of file include/image/oImageProcessingManager.hh.

◆ SetOptions() [1/2]

void oImageProcessingManager::SetOptions ( vector< string > a_options )

inline

Definition at line 142 of file code/include/image/oImageProcessingManager.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetOptions() [2/2]

void oImageProcessingManager::SetOptions ( vector< string > a_options )

inline

Definition at line 142 of file include/image/oImageProcessingManager.hh.

Here is the call graph for this function:

◆ SetVerbose() [1/2]

void oImageProcessingManager::SetVerbose ( int a_verboseLevel )

inline

Definition at line 128 of file code/include/image/oImageProcessingManager.hh.

Here is the caller graph for this function:

◆ SetVerbose() [2/2]

void oImageProcessingManager::SetVerbose ( int a_verboseLevel )

inline

Definition at line 128 of file include/image/oImageProcessingManager.hh.

◆ ShowCommonHelp() [1/2]

static void oImageProcessingManager::ShowCommonHelp ( )

static

◆ ShowCommonHelp() [2/2]

void oImageProcessingManager::ShowCommonHelp ( )

static

This function does not take any parameter and is used to display some help about the syntax of the options describing the image processing module that should be used. It is static so that it can be called without any object initialization.

Definition at line 80 of file code/src/image/oImageProcessingManager.cc.

Here is the caller graph for this function:

Member Data Documentation

◆ m2p_ImageProcessingModules

vImageProcessingModule ** oImageProcessingManager::m2p_ImageProcessingModules

private

The actual image processing modules (as many as m_nbImageProcessingModules)

Definition at line 172 of file code/include/image/oImageProcessingManager.hh.

◆ m_checked

bool oImageProcessingManager::m_checked

private

A boolean that says if the function CheckParameters() has been called

Definition at line 176 of file code/include/image/oImageProcessingManager.hh.

◆ m_initialized

bool oImageProcessingManager::m_initialized

private

A boolean that says if the function Initialize() has been called

Definition at line 177 of file code/include/image/oImageProcessingManager.hh.

◆ m_nbImageProcessingModules

int oImageProcessingManager::m_nbImageProcessingModules

private

The number of image processing modules managed by this manager

Definition at line 170 of file code/include/image/oImageProcessingManager.hh.

◆ m_options

vector< string > oImageProcessingManager::m_options

private

A vector containing strings of options, each string is associated to an image processing module

Definition at line 169 of file code/include/image/oImageProcessingManager.hh.

◆ m_verbose

int oImageProcessingManager::m_verbose

private

The verbose level associated to this class

Definition at line 178 of file code/include/image/oImageProcessingManager.hh.

◆ mp_applyForward

bool * oImageProcessingManager::mp_applyForward

private

As many booleans as m_nbImageProcessingModules specifying if each module should be apply within the ConvolveForward function

Definition at line 173 of file code/include/image/oImageProcessingManager.hh.

◆ mp_applyIntra

bool * oImageProcessingManager::mp_applyIntra

private

As many booleans as m_nbImageProcessingModules specifying if each module should be apply within the ConvolveIntra function

Definition at line 174 of file code/include/image/oImageProcessingManager.hh.

◆ mp_applyPost

bool * oImageProcessingManager::mp_applyPost

private

As many booleans as m_nbImageProcessingModules specifying if each module should be apply within the ConvolvePost function

Definition at line 175 of file code/include/image/oImageProcessingManager.hh.

◆ mp_ImageDimensionsAndQuantification

oImageDimensionsAndQuantification * oImageProcessingManager::mp_ImageDimensionsAndQuantification

private

The image dimensions

Definition at line 168 of file code/include/image/oImageProcessingManager.hh.

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ oImageProcessingManager() [1/2]

◆ ~oImageProcessingManager() [1/2]

◆ oImageProcessingManager() [2/2]

◆ ~oImageProcessingManager() [2/2]

Member Function Documentation

◆ ApplyProcessingForward() [1/2]

◆ ApplyProcessingForward() [2/2]

◆ ApplyProcessingIntra() [1/2]

◆ ApplyProcessingIntra() [2/2]

◆ ApplyProcessingPost() [1/2]

◆ ApplyProcessingPost() [2/2]

◆ CheckParameters() [1/2]

◆ CheckParameters() [2/2]

◆ Initialize() [1/2]

◆ Initialize() [2/2]

◆ ParseOptionsAndInitializeImageProcessingModules() [1/2]

◆ ParseOptionsAndInitializeImageProcessingModules() [2/2]

◆ SetImageDimensionsAndQuantification() [1/2]

◆ SetImageDimensionsAndQuantification() [2/2]

◆ SetOptions() [1/2]

◆ SetOptions() [2/2]

◆ SetVerbose() [1/2]

◆ SetVerbose() [2/2]

◆ ShowCommonHelp() [1/2]

◆ ShowCommonHelp() [2/2]

Member Data Documentation

◆ m2p_ImageProcessingModules

◆ m_checked

◆ m_initialized

◆ m_nbImageProcessingModules

◆ m_options

◆ m_verbose

◆ mp_applyForward

◆ mp_applyIntra

◆ mp_applyPost

◆ mp_ImageDimensionsAndQuantification