SMS_BP
Single Molecule Simulations -BP
Loading...
Searching...
No Matches
SMS_BP.probability_functions.multiple_top_hat_probability Class Reference

Public Member Functions

None __init__ (self, int num_subspace, np.ndarray subspace_centers, np.ndarray subspace_radius, float density_dif, np.ndarray space_size)
 
float __call__ (self, np.ndarray position, **kwargs)
 
None update_parameters (self, int num_subspace=None, np.ndarray subspace_centers=None, np.ndarray subspace_radius=None, float density_dif=None, np.ndarray space_size=None)
 
int num_subspace (self)
 
None num_subspace (self, int value)
 
np.ndarray subspace_centers (self)
 
None subspace_centers (self, np.ndarray value)
 
np.ndarray subspace_radius (self)
 
None subspace_radius (self, np.ndarray value)
 
float density_dif (self)
 
None density_dif (self, float value)
 
np.ndarray space_size (self)
 
None space_size (self, np.ndarray value)
 
float subspace_probability (self)
 
None subspace_probability (self, float value)
 
float non_subspace_probability (self)
 
None non_subspace_probability (self, float value)
 

Public Attributes

 num_subspace
 
 subspace_centers
 
 subspace_radius
 
 density_dif
 
 space_size
 
 subspace_probability
 
 non_subspace_probability
 

Protected Member Functions

 _calculate_subspace_probability (self, np.ndarray space_size, float density_dif)
 
 _calculate_non_subspace_probability (self, np.ndarray space_size, float density_dif, int num_subspace, np.ndarray subspace_radius)
 

Protected Attributes

 _num_subspace
 
 _subspace_centers
 
 _subspace_radius
 
 _density_dif
 
 _space_size
 
 _subspace_probability
 
 _non_subspace_probability
 

Detailed Description

 Class for the probability function of multiple top hats.
Once initalized an object of this class can be called to return the probability at a given position.

!!!--DO NOT CHANGE THE PARAMETERS AFTER INITALIZATION DIRECTLY. USE THE UPDATE_PARAMETERS METHOD--!!!

Constructor & Destructor Documentation

◆ __init__()

None SMS_BP.probability_functions.multiple_top_hat_probability.__init__ ( self,
int num_subspace,
np.ndarray subspace_centers,
np.ndarray subspace_radius,
float density_dif,
np.ndarray space_size )

Member Function Documentation

◆ __call__()

float SMS_BP.probability_functions.multiple_top_hat_probability.__call__ ( self,
np.ndarray position,
** kwargs )
 Returns the probability given a coordinate

◆ _calculate_non_subspace_probability()

SMS_BP.probability_functions.multiple_top_hat_probability._calculate_non_subspace_probability ( self,
np.ndarray space_size,
float density_dif,
int num_subspace,
np.ndarray subspace_radius )
protected

◆ _calculate_subspace_probability()

SMS_BP.probability_functions.multiple_top_hat_probability._calculate_subspace_probability ( self,
np.ndarray space_size,
float density_dif )
protected

◆ density_dif() [1/2]

float SMS_BP.probability_functions.multiple_top_hat_probability.density_dif ( self)
 Returns the difference in density between the subspaces and the rest of the space.

◆ density_dif() [2/2]

None SMS_BP.probability_functions.multiple_top_hat_probability.density_dif ( self,
float value )

◆ non_subspace_probability() [1/2]

float SMS_BP.probability_functions.multiple_top_hat_probability.non_subspace_probability ( self)
 Returns the probability of the non-subspaces.

◆ non_subspace_probability() [2/2]

None SMS_BP.probability_functions.multiple_top_hat_probability.non_subspace_probability ( self,
float value )

◆ num_subspace() [1/2]

int SMS_BP.probability_functions.multiple_top_hat_probability.num_subspace ( self)
 Returns the number of subspaces.

◆ num_subspace() [2/2]

None SMS_BP.probability_functions.multiple_top_hat_probability.num_subspace ( self,
int value )

◆ space_size() [1/2]

np.ndarray SMS_BP.probability_functions.multiple_top_hat_probability.space_size ( self)
 Returns the size of the space.

◆ space_size() [2/2]

None SMS_BP.probability_functions.multiple_top_hat_probability.space_size ( self,
np.ndarray value )

◆ subspace_centers() [1/2]

np.ndarray SMS_BP.probability_functions.multiple_top_hat_probability.subspace_centers ( self)
 Returns the centers of the subspaces.

◆ subspace_centers() [2/2]

None SMS_BP.probability_functions.multiple_top_hat_probability.subspace_centers ( self,
np.ndarray value )

◆ subspace_probability() [1/2]

float SMS_BP.probability_functions.multiple_top_hat_probability.subspace_probability ( self)

◆ subspace_probability() [2/2]

None SMS_BP.probability_functions.multiple_top_hat_probability.subspace_probability ( self,
float value )

◆ subspace_radius() [1/2]

np.ndarray SMS_BP.probability_functions.multiple_top_hat_probability.subspace_radius ( self)
 Returns the radius of the subspaces.

◆ subspace_radius() [2/2]

None SMS_BP.probability_functions.multiple_top_hat_probability.subspace_radius ( self,
np.ndarray value )

◆ update_parameters()

None SMS_BP.probability_functions.multiple_top_hat_probability.update_parameters ( self,
int num_subspace = None,
np.ndarray subspace_centers = None,
np.ndarray subspace_radius = None,
float density_dif = None,
np.ndarray space_size = None )
 Updates the parameters of the probability function.

Member Data Documentation

◆ _density_dif

SMS_BP.probability_functions.multiple_top_hat_probability._density_dif
protected

◆ _non_subspace_probability

SMS_BP.probability_functions.multiple_top_hat_probability._non_subspace_probability
protected

◆ _num_subspace

SMS_BP.probability_functions.multiple_top_hat_probability._num_subspace
protected

◆ _space_size

SMS_BP.probability_functions.multiple_top_hat_probability._space_size
protected

◆ _subspace_centers

SMS_BP.probability_functions.multiple_top_hat_probability._subspace_centers
protected

◆ _subspace_probability

SMS_BP.probability_functions.multiple_top_hat_probability._subspace_probability
protected

◆ _subspace_radius

SMS_BP.probability_functions.multiple_top_hat_probability._subspace_radius
protected

◆ density_dif

SMS_BP.probability_functions.multiple_top_hat_probability.density_dif

◆ non_subspace_probability

SMS_BP.probability_functions.multiple_top_hat_probability.non_subspace_probability

◆ num_subspace

SMS_BP.probability_functions.multiple_top_hat_probability.num_subspace

◆ space_size

SMS_BP.probability_functions.multiple_top_hat_probability.space_size

◆ subspace_centers

SMS_BP.probability_functions.multiple_top_hat_probability.subspace_centers

◆ subspace_probability

SMS_BP.probability_functions.multiple_top_hat_probability.subspace_probability

◆ subspace_radius

SMS_BP.probability_functions.multiple_top_hat_probability.subspace_radius

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