ifw::ccf::stdrecipe::RecipeCentroid Class Reference

Standard Centroiding Processing Recipe. More...

#include <recipeCentroid.hpp>

Inheritance diagram for ifw::ccf::stdrecipe::RecipeCentroid:

Public Member Functions
	RecipeCentroid (const std::string &proc_thread_name, const std::string &recipe_name)
	RecipeCentroid ()
virtual	~RecipeCentroid ()
virtual void	InitialiseUser ()
	Initialise the recipe object. See "Initialise()".
virtual void	EnableUser ()
virtual void	DisableUser ()
virtual void	ProcessUser (ifw::ccf::common::DataFrame &frame)
	User specific processing.
virtual void	CreateObjectUser (const std::string &proc_thread_name, const std::string &recipe_name, std::shared_ptr< RecipeBase > &new_object)
Public Member Functions inherited from ifw::ccf::common::RecipeBase
	RecipeBase (const std::string &proc_thread_name, const std::string &recipe_name)
	RecipeBase ()
virtual	~RecipeBase ()
void	Initialise ()
	Initalise the object. Invoked after creating a new object from the factory object.
bool	GetInitialised () const
	Return flag indicating if the recipe object has been initialised.
const std::string &	GetRecipeId () const
	Get the ID of the recipe.
const std::string &	GetProcThreadName () const
	Get the name of the Processing Thread, hosting the Recipe instance.
const std::string &	GetRecipeName () const
	Get the name of the recipe.
const std::string &	GetDbPath () const
	Generate DB path for this recipe.
void	Process (DataFrame &frame)
	Execute the processing of the given frame.
void	Enable ()
	Enable the recipe so that it will be invoked by the Processing Thread to which it belongs.
void	Disable ()
bool	GetEnabled () const
	Return the enabled status of the recipe.
virtual void	CreateObjectUser (const std::string &proc_thread_name, const std::string &recipe_name, std::shared_ptr< RecipeBase > &new_object)
	Instantiate a specific instance of the object.
void	SetStatus (const ProcStatus status)
	Update status for a given Publisher Thread in the OLDB.
ProcStatus	GetStatus () const
	Get status of the recipe object.
Public Member Functions inherited from ifw::ccf::Base
	Base ()
	~Base ()
const std::string &	GetClassName () const
	Return the allocated name of the class.

Public Attributes
const std::string	SETUP_KEY_MAX_CENTRE_ERROR = "max_centre_error"
const std::string	SETUP_KEY_MAX_SIGMA_ERROR = "max_sigma_error"
const std::string	SETUP_KEY_ROBUSTNESS = "robustness"

Protected Attributes
bool	m_centroid_error
double	m_centre_intensity
cpl_size	m_window [4]
double	m_centre [2]
double	m_sigma [2]
double	m_centre_error [2]
double	m_sigma_error [2]
cpl_error_code	m_cpl_error

Additional Inherited Members
Static Public Member Functions inherited from ifw::ccf::common::RecipeBase
static const std::string &	GenId (const std::string &proc_thread_name, const std::string &recipe_name)
	Generate the ID for this recipe from the Processing Thread and Recipe number.
template<class TYPE >
static void	AddRecipeFactoryObj (TYPE &recipe_factory_obj)
	Static method to register a Data Publisher factory object in the internal registry.
static const std::map< std::string, std::shared_ptr< RecipeBase > > &	GetRecipeFactoryObjs ()
	Statis method to retrieve references to the Recipe Factory Objects.
static void	CreateRecipeObj (const std::string &class_name, const std::string &proc_thread_name, const std::string &recipe_name, std::shared_ptr< RecipeBase > &new_obj)
static void	GetRecipeObj (const std::string &class_name, const std::string &proc_thread_name, std::shared_ptr< RecipeBase > &recipe_obj, const bool initialise=true)
static const std::map< std::string, std::shared_ptr< RecipeBase > > &	GetRecipeObjs ()
	Get reference to all Processing Recipe objects registered.
static bool	HasRecipeObj (const std::string &class_name, const std::string &proc_thread_name, std::shared_ptr< RecipeBase > &recipe_obj)
	Check if a Proc Recipe object is defined.
Static Public Member Functions inherited from ifw::ccf::Base
static ifw::ccf::mptk::Manager &	Mptk ()
	Return reference to internal MPTK instance (singleton).
Protected Member Functions inherited from ifw::ccf::common::RecipeBase
void	SetEnabled (const bool enabled)
	Set the enabled status flag of the recipe object.
void	DisableRecipe ()
	Disable the recipe so that it will not be invoked.
Protected Member Functions inherited from ifw::ccf::Base
void	SetClassName (const std::string &class_name)
	Set the name of the class in question.

Detailed Description

Standard Centroiding Processing Recipe.

Constructor & Destructor Documentation

RecipeCentroid() [1/2]

ifw::ccf::stdrecipe::RecipeCentroid::RecipeCentroid	(	const std::string &	proc_thread_name,
		const std::string &	recipe_name )

RecipeCentroid() [2/2]

ifw::ccf::stdrecipe::RecipeCentroid::RecipeCentroid

(

)

~RecipeCentroid()

ifw::ccf::stdrecipe::RecipeCentroid::~RecipeCentroid ( )

virtual

Member Function Documentation

CreateObjectUser()

void ifw::ccf::stdrecipe::RecipeCentroid::CreateObjectUser ( const std::string & proc_thread_name, const std::string & recipe_name, std::shared_ptr< RecipeBase > & new_object )

virtual

DisableUser()

void ifw::ccf::stdrecipe::RecipeCentroid::DisableUser ( )

virtual

Specific implement of disable method. Need normally not be implemented by the user.

Reimplemented from ifw::ccf::common::RecipeBase.

EnableUser()

void ifw::ccf::stdrecipe::RecipeCentroid::EnableUser ( )

virtual

Specific implement of enable method. Need normally not be implemented by the user.

Reimplemented from ifw::ccf::common::RecipeBase.

InitialiseUser()

void ifw::ccf::stdrecipe::RecipeCentroid::InitialiseUser ( )

virtual

Initialise the recipe object. See "Initialise()".

Reimplemented from ifw::ccf::common::RecipeBase.

ProcessUser()

void ifw::ccf::stdrecipe::RecipeCentroid::ProcessUser ( ifw::ccf::common::DataFrame & frame )

virtual

User specific processing.

Reimplemented from ifw::ccf::common::RecipeBase.

Member Data Documentation

m_centre

double ifw::ccf::stdrecipe::RecipeCentroid::m_centre[2]

protected

m_centre_error

double ifw::ccf::stdrecipe::RecipeCentroid::m_centre_error[2]

protected

m_centre_intensity

double ifw::ccf::stdrecipe::RecipeCentroid::m_centre_intensity

protected

m_centroid_error

bool ifw::ccf::stdrecipe::RecipeCentroid::m_centroid_error

protected

m_cpl_error

cpl_error_code ifw::ccf::stdrecipe::RecipeCentroid::m_cpl_error

protected

m_sigma

double ifw::ccf::stdrecipe::RecipeCentroid::m_sigma[2]

protected

m_sigma_error

double ifw::ccf::stdrecipe::RecipeCentroid::m_sigma_error[2]

protected

m_window

cpl_size ifw::ccf::stdrecipe::RecipeCentroid::m_window[4]

protected

SETUP_KEY_MAX_CENTRE_ERROR

const std::string ifw::ccf::stdrecipe::RecipeCentroid::SETUP_KEY_MAX_CENTRE_ERROR = "max_centre_error"

SETUP_KEY_MAX_SIGMA_ERROR

const std::string ifw::ccf::stdrecipe::RecipeCentroid::SETUP_KEY_MAX_SIGMA_ERROR = "max_sigma_error"

SETUP_KEY_ROBUSTNESS

const std::string ifw::ccf::stdrecipe::RecipeCentroid::SETUP_KEY_ROBUSTNESS = "robustness"

---

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

• stdrecipe/src/include/ifw/ccf/stdrecipe/recipeCentroid.hpp
• stdrecipe/src/recipeCentroid.cpp