lar_content::RPhiFeatureTool::KernelEstimate Class Reference

Kernel estimate class. More...

Public Types
typedef std::multimap< float, float >	ContributionList
	Map from x coord to weight, ATTN avoid map.find, etc. with float key. More...

Public Member Functions
	KernelEstimate (const float sigma)
	Constructor. More...
float	Sample (const float x) const
	Sample the parameterised distribution at a specified x coordinate. More...
const ContributionList &	GetContributionList () const
	Get the contribution list. More...
float	GetSigma () const
	Get the assigned width. More...
void	AddContribution (const float x, const float weight)
	Add a contribution to the distribution. More...

Private Attributes
ContributionList	m_contributionList
	The contribution list. More...
const float	m_sigma
	The assigned width. More...

Detailed Description

Kernel estimate class.

Definition at line 49 of file RPhiFeatureTool.h.

Member Typedef Documentation

typedef std::multimap<float, float> lar_content::RPhiFeatureTool::KernelEstimate::ContributionList

Map from x coord to weight, ATTN avoid map.find, etc. with float key.

Definition at line 68 of file RPhiFeatureTool.h.

Constructor & Destructor Documentation

lar_content::RPhiFeatureTool::KernelEstimate::KernelEstimate ( const float  sigma )

inline

Constructor.

Parameters

sigma

the width associated with the kernel estimate

Definition at line 183 of file RPhiFeatureTool.h.

                                                                      : m_sigma(sigma)
{
    if (m_sigma < std::numeric_limits<float>::epsilon())
        throw pandora::StatusCodeException(pandora::STATUS_CODE_INVALID_PARAMETER);
}

Member Function Documentation

void lar_content::RPhiFeatureTool::KernelEstimate::AddContribution	(	const float	x,
		const float	weight
	)

Add a contribution to the distribution.

Parameters

x	the position
weight	the weight

Definition at line 236 of file RPhiFeatureTool.cc.

{
    m_contributionList.insert(ContributionList::value_type(x, weight));
}

const RPhiFeatureTool::KernelEstimate::ContributionList & lar_content::RPhiFeatureTool::KernelEstimate::GetContributionList ( ) const

inline

Get the contribution list.

Returns

the contribution list

Definition at line 191 of file RPhiFeatureTool.h.

{
    return m_contributionList;
}

float lar_content::RPhiFeatureTool::KernelEstimate::GetSigma ( ) const

inline

Get the assigned width.

Returns

the assigned width

Definition at line 198 of file RPhiFeatureTool.h.

{
    return m_sigma;
}

float lar_content::RPhiFeatureTool::KernelEstimate::Sample

(

const float

x

)

const

Sample the parameterised distribution at a specified x coordinate.

Parameters

x	the position at which to sample

Returns

the sample value

Definition at line 215 of file RPhiFeatureTool.cc.

{
    const ContributionList &contributionList(this->GetContributionList());
    ContributionList::const_iterator lowerIter(contributionList.lower_bound(x - 3.f * m_sigma));
    ContributionList::const_iterator upperIter(contributionList.upper_bound(x + 3.f * m_sigma));

    float sample(0.f);
    const float gaussConstant(1.f / std::sqrt(2.f * M_PI * m_sigma * m_sigma));

    for (ContributionList::const_iterator iter = lowerIter; iter != upperIter; ++iter)
    {
        const float deltaSigma((x - iter->first) / m_sigma);
        const float gaussian(gaussConstant * std::exp(-0.5f * deltaSigma * deltaSigma));
        sample += iter->second * gaussian;
    }

    return sample;
}

Member Data Documentation

ContributionList lar_content::RPhiFeatureTool::KernelEstimate::m_contributionList

private

The contribution list.

Definition at line 93 of file RPhiFeatureTool.h.

const float lar_content::RPhiFeatureTool::KernelEstimate::m_sigma

private

The assigned width.

Definition at line 94 of file RPhiFeatureTool.h.

---

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

• RPhiFeatureTool.h
• RPhiFeatureTool.cc