ConnectTool
 All Classes Namespaces Files Functions Variables Pages
Classes | Functions | Variables
module_connectivity Namespace Reference

Module for computing connectivity maps probabilities. More...

Classes

class  ConnectivityError
 Error returned by module_connectivity. More...
 
class  ConnectivityPoint
 Associate a Coordinate element (point) with a float (density). More...
 
class  ConnectivityMap
 Contains the list of ConnectivityPoint objects on a given grid. More...
 

Functions

def point_distribution
 Giving a seed point, computes distrib_n other points on the same radial surface using some probability distribution. More...
 
def point_distribution_gaussian
 Giving a seed point, computes distrib_n other points on the same radial surface using a gaussian probability distribution. More...
 
def build_density
 Giving a list of points, computes the number of points in each bin of an hardcoded grid (ndens x ndens). More...
 
def reverse_sort
 Sort a ConnectPoint list with density and return another. More...
 
def proba2alpha
 From a list of probability densities (in [dens_min,dens_max]) return a list of coefficient in [0,1]. More...
 

Variables

int nproba = 1000
 Probability cloud point number. More...
 
int ndens = 360
 Density grid point number. More...
 

Detailed Description

Module for computing connectivity maps probabilities.

Assess heliospheric model uncertainty by computing a distribution of probable point around the source surface point result.
Given a point distribution, build the map of point density in an hardcoded grid.

Todo:
Add Rui's uncertainty method.

Function Documentation

def module_connectivity.build_density (   points)

Giving a list of points, computes the number of points in each bin of an hardcoded grid (ndens x ndens).

Parameters
pointsList of Coordinate objects
Returns
ConnectivityMap object with this grid bin used:
  • interface xi=[0:360:dx]
  • interface yi=[-90:90:dy]
  • center of cells xc=[0.5:359.5:dx]
  • center of cells yc=[-89.5:89.5:dy]
where $dx=\dfrac{360}{ndens}$ and $dy=\dfrac{180}{ndens}$
def module_connectivity.point_distribution (   distrib_type,
  distrib_n,
  seed_point 
)

Giving a seed point, computes distrib_n other points on the same radial surface using some probability distribution.

Parameters
distrib_typeDistribution type chosen in the following:
  • GAUSSIAN
distrib_nDistribution type of output points
seed_pointCoordinate input object
Returns
List of Coordinate objects.

Here is the call graph for this function:

def module_connectivity.point_distribution_gaussian (   distrib_n,
  seed_point 
)

Giving a seed point, computes distrib_n other points on the same radial surface using a gaussian probability distribution.

Parameters
distrib_nDistribution type of output points
seed_pointCoordinate input object
Returns
List of Coordinate objects.
Todo:

Input checking

Check if seed_point is well given

Here is the call graph for this function:

Here is the caller graph for this function:

def module_connectivity.proba2alpha (   densities)

From a list of probability densities (in [dens_min,dens_max]) return a list of coefficient in [0,1].

Used for plotting densities.

Here is the caller graph for this function:

def module_connectivity.reverse_sort (   connect_points)

Sort a ConnectPoint list with density and return another.

Parameters
connect_pointsConnectPoint list
Returns
List of ordered ConnectPoint objects

Here is the caller graph for this function:

Variable Documentation

module_connectivity.ndens = 360

Density grid point number.

Number of points in each axis of the hardcoded grid used by module_connectivity.build_density.

module_connectivity.nproba = 1000

Probability cloud point number.

Number of output points derived from a source surface point in Probability section of connect_sc or connect_all.