IMP logo
IMP Reference Guide  2.5.0
The Integrative Modeling Platform
IMP::em::KernelParameters Class Reference

#include <IMP/em/KernelParameters.h>

Detailed Description

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

Definition at line 75 of file KernelParameters.h.

Public Member Functions

 KernelParameters (float resolution)
 
float get_inv_rsigsq () const
 Get the inverse of sigma squared. More...
 
float get_lim () const
 Gets the value of lim parameter. More...
 
const
RadiusDependentKernelParameters
get_params (float radius, float eps=0.001)
 Finds the precomputed parameters given a particle radius. More...
 
float get_rkdist () const
 Get the length of the Gaussian (sigma*number_of_sigmas_used) More...
 
float get_rnormfac () const
 Get the Gaussian normalization factor. More...
 
float get_rsig () const
 
float get_rsigsq () const
 
float get_sq2pi3 () const
 Get the non-sigma portion of the Gaussian normalization factor. More...
 
float get_timessig () const
 Gets the number of sigma used. More...
 
const
RadiusDependentKernelParameters
set_params (float radius)
 Sets the parameters that depend on the radius of a given particle. More...
 
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 squared.

Definition at line 114 of file KernelParameters.h.

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

Gets the value of lim parameter.

Definition at line 127 of file KernelParameters.h.

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 numerical 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 length of the Gaussian (sigma*number_of_sigmas_used)

Definition at line 125 of file KernelParameters.h.

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

Get the Gaussian normalization factor.

Definition at line 123 of file KernelParameters.h.

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

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

Definition at line 109 of file KernelParameters.h.

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

Get squared sigma as a function of the resolution according to the full width at half maximum criterion

Definition at line 112 of file KernelParameters.h.

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

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

Definition at line 121 of file KernelParameters.h.

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

Definition at line 119 of file KernelParameters.h.

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: