Standard Centroiding Processing Recipe. More...

#include <recipeCentroid.hpp>

Inheritance diagram for ccf::stdrecipe::RecipeCentroid:

Public Member Functions
	RecipeCentroid (const uint16_t proc_thread_nb, const uint16_t recipe_nb, const std::string &recipe_name)

	RecipeCentroid ()

virtual	~RecipeCentroid ()

virtual void	InitialiseUser ()
	Initialise the recipe object. See "Initialise()". More...

virtual void	EnableUser ()

virtual void	DisableUser ()

virtual void	ProcessUser (ccf::common::DataFrame &frame)
	User specific processing. More...

virtual void	CreateObjectUser (const uint16_t proc_thread_nb, const uint16_t recipe_nb, const std::string &recipe_name, ccf::common::RecipeBase **new_object)
	Instantiate a specific instance of the object. More...

Public Member Functions inherited from ccf::common::RecipeBase
	RecipeBase (const uint16_t proc_thread_nb, const uint16_t recipe_nb, const std::string &recipe_name)
	Constructor instantiating a recipe object with the given Processing Thread and Recipe number and recipe name. More...

	RecipeBase ()

virtual	~RecipeBase ()

void	Initialise ()
	Initalise the object. Invoked after creating a new object from the factory object. More...

bool	GetInitialised () const
	Return flag indicating if the recipe object has been initialised. More...

const std::string &	GetRecipeId () const
	Get the ID of the recipe. More...

const std::string &	GetRecipeName () const
	Get the name of the recipe. More...

uint16_t	GetProcThreadNb () const
	Return the number of the Processing Thread to which this recipe object belongs. More...

uint16_t	GetRecipeNb () const
	Return the number of the Recipe to. More...

const std::string &	GetDbPath () const
	Get the reference to the DB base path for ths recipe. More...

const std::string &	GetKeyPrefix () const
	Get the key prefix for this recipe, e.g. "proc1.recipe1". More...

const std::string	GenKey (const std::string &name) const
	Generate a fully qualified key name, e.g. "proc1.recipe1.par". More...

void	Process (DataFrame &frame)
	Execute the processing of the given frame. More...

void	Enable ()
	Enable the recipe so that it will be invoked by the Processing Thread to which it belongs. More...

void	Disable ()
	Disable the recipe so that it will no longer be invoked by the Processing Thread to which it belongs. More...

bool	GetEnabled () const
	Return the enabled status of the recipe. More...

void	SetStatus (const ProcStatus status)
	Update status for a given Publisher Thread in the OLDB. More...

ProcStatus	GetStatus () const
	Get status of the recipe object. More...

Public Member Functions inherited from ccf::common::Base
	Base ()

	~Base ()

const std::string &	GetClassName () const
	Return the allocated name of the class. More...

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 ccf::common::RecipeBase
static const std::string &	GenId (const uint16_t proc_thread_nb, const uint16_t recipe_nb)
	Generate the ID for this recipe from the Processing Thread and Recipe number. More...

static void	AddRecipeFactoryObj (RecipeBase &recipe_factory_obj)
	Static method to register a Data Publisher factory object in the internal registry. More...

static void	GetRecipeFactoryObjs (std::vector< RecipeBase * > &recipe_factory_objs)
	Statis method to retrieve references to the Recipe Factory Objects. More...

static void	CreateRecipeObj (const std::string &class_name, const uint16_t proc_thread_nb, const uint16_t recipe_nb, const std::string recipe_name, RecipeBase **new_obj)

static void	GetRecipeObj (const uint16_t proc_thread_nb, const uint16_t recipe_nb, RecipeBase **recipe_obj, const bool initialise=true)

static void	GetRecipeObjs (std::vector< RecipeBase * > &recipe_objs)
	Get reference to all Processing Recipe objects registered. More...

static bool	HasRecipeObj (const uint16_t proc_thread_nb, const uint16_t recipe_nb, RecipeBase **recipe_obj)
	Check if a Proc Recipe object is defined. More...

static void	FreeRecipeObjs ()

static void	FreeRecipeFactoryObjs ()

Static Public Member Functions inherited from ccf::common::Base
static ccf::mptk::Manager &	Mptk ()
	Return reference to internal MPTK instance (singleton). More...

static void	SetLogLevel (const ccf::common::LogLevel log_level)
	Set the log level. More...

static ccf::common::LogLevel	GetLogLevel ()
	Return the current CCF log level. More...

Protected Member Functions inherited from ccf::common::RecipeBase
void	SetEnabled (const bool enabled)
	Set the enabled status flag of the recipe object. More...

void	DisableRecipe ()
	Disable the recipe so that it will not be invoked. More...

Protected Member Functions inherited from ccf::common::Base
void	SetClassName (const std::string &class_name)
	Set the name of the class in question. More...

Detailed Description

Standard Centroiding Processing Recipe.

Constructor & Destructor Documentation

◆ RecipeCentroid() [1/2]

ccf::stdrecipe::RecipeCentroid::RecipeCentroid	(	const uint16_t	proc_thread_nb,
		const uint16_t	recipe_nb,
		const std::string &	recipe_name
	)

◆ RecipeCentroid() [2/2]

ccf::stdrecipe::RecipeCentroid::RecipeCentroid ( )

◆ ~RecipeCentroid()

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

virtual

Member Function Documentation

◆ CreateObjectUser()

void ccf::stdrecipe::RecipeCentroid::CreateObjectUser	(	const uint16_t	proc_thread_nb,
		const uint16_t	recipe_nb,
		const std::string &	recipe_name,
		ccf::common::RecipeBase **	new_object
	)

virtual

Instantiate a specific instance of the object.

Reimplemented from ccf::common::RecipeBase.

◆ DisableUser()

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

virtual

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

Reimplemented from ccf::common::RecipeBase.

◆ EnableUser()

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

virtual

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

Reimplemented from ccf::common::RecipeBase.

◆ InitialiseUser()

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

virtual

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

Reimplemented from ccf::common::RecipeBase.

◆ ProcessUser()

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

virtual

User specific processing.

Reimplemented from ccf::common::RecipeBase.

Member Data Documentation

◆ m_centre

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

protected

◆ m_centre_error

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

protected

◆ m_centre_intensity

double ccf::stdrecipe::RecipeCentroid::m_centre_intensity

protected

◆ m_centroid_error

bool ccf::stdrecipe::RecipeCentroid::m_centroid_error

protected

◆ m_cpl_error

cpl_error_code ccf::stdrecipe::RecipeCentroid::m_cpl_error

protected

◆ m_sigma

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

protected

◆ m_sigma_error

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

protected

◆ m_window

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

protected

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RecipeCentroid() [1/2]

◆ RecipeCentroid() [2/2]

◆ ~RecipeCentroid()

Member Function Documentation

◆ CreateObjectUser()

◆ DisableUser()

◆ EnableUser()

◆ InitialiseUser()

◆ ProcessUser()

Member Data Documentation

◆ m_centre

◆ m_centre_error

◆ m_centre_intensity

◆ m_centroid_error

◆ m_cpl_error

◆ m_sigma

◆ m_sigma_error

◆ m_window