IMP logo
Public Member Functions | Protected Member Functions | Protected Attributes
IMP::em::KernelParameters Class Reference

Detailed Description

Calculates and stores Gaussian kernel parameters as a function of a specufuc radius.

List of all members.

Public Member Functions

 KernelParameters (float resolution)
float get_inv_rsigsq () const
 Get the inverse of sigma sqaured.
float get_lim () const
 Gets the value of lim parameter.
const
RadiusDependentKernelParameters
get_params (float radius, float eps=0.001)
 Finds the precomputed parameters given a particle radius.
float get_rkdist () const
 Get the lenght of the Gaussian (sigma*number_of_sigmas_used)
float get_rnormfac () const
 Get the Gaussian normalization factor.
float get_rsig () const
float get_rsigsq () const
float get_sq2pi3 () const
 Get the non-sigma portion of the Gaussian normalization factor.
float get_timessig () const
 Gets the number of sigma used.
const
RadiusDependentKernelParameters
set_params (float radius)
 Sets the parameters that depend on the radius of a given particle.
void show (std::ostream &out=std::cout) const

Protected Member Functions

void init (float resolution)

Protected Attributes

bool initialized_
float inv_rsigsq_
float lim_
std::map< float, const
RadiusDependentKernelParameters * > 
radii2params_
float rkdist_
float rnormfac_
float rsig_
float rsigsq_
float sq2pi3_
float timessig_

Member Function Documentation

float IMP::em::KernelParameters::get_inv_rsigsq ( ) const

Get the inverse of sigma sqaured.

float IMP::em::KernelParameters::get_lim ( ) const

Gets the value of lim parameter.

const RadiusDependentKernelParameters& IMP::em::KernelParameters::get_params ( float  radius,
float  eps = 0.001 
)

Finds the precomputed parameters given a particle radius.

Parameters:
[in]radiussearching for parameters of this radius
[in]epsused for numerical stability
Note:
The parameters are indexes by the radius. To maintain numeratical stability, look for a radius within +-eps from the queried radius.
if parameters for this radius were not found, a warning is printed and the parameters are calculated using set_params().
float IMP::em::KernelParameters::get_rkdist ( ) const

Get the lenght of the Gaussian (sigma*number_of_sigmas_used)

float IMP::em::KernelParameters::get_rnormfac ( ) const

Get the Gaussian normalization factor.

float IMP::em::KernelParameters::get_rsig ( ) const

Get sigma as a function of the resolution according to th Full width at half maximum criterion

float IMP::em::KernelParameters::get_rsigsq ( ) const

Get squared sigma as a function of the resolution accroding to the Full width at half maximum criterion

float IMP::em::KernelParameters::get_sq2pi3 ( ) const

Get the non-sigma portion of the Gaussian normalization factor.

float IMP::em::KernelParameters::get_timessig ( ) const

Gets the number of sigma used.

Note:
We use 3, which means that 99% of the density is considered
const RadiusDependentKernelParameters& IMP::em::KernelParameters::set_params ( float  radius)

Sets the parameters that depend on the radius of a given particle.

The other variables of the parameters (rsigsq,timessig,sq2pi3,inv_rsigsq,rnormfac,rkdist) must have been set.

Parameters:
[in]radiusthe radius
Returns:
the radius based parameters

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

Generated on Tue May 22 2012 23:33:34 for IMP by doxygen 1.8.1