Particle

class Particle(point=array([], shape=(1, 0), dtype=float64), uncertainty=array([], shape=(1, 0), dtype=float64), sigmaPoints=None)

Bases: object

Helper class for defining single particles in a particle distribution.

point

The location of the particle.

Type:

N x 1 numpy array

uncertainty

The uncertainty of the point, this does not always need to be specified. Check with the filter if this is needed.

Type:

N x N numpy array, optional

sigmaPoints

Sigma points used to represent the particle. This is not always needed, check with the filter to determine if this is necessary.

Type:

distributions.SigmaPoints, optional

__init__(point=array([], shape=(1, 0), dtype=float64), uncertainty=array([], shape=(1, 0), dtype=float64), sigmaPoints=None)

Methods

__init__

Attributes

mean	Read only mean value of the particle.

property mean

Read only mean value of the particle.

If no sigma points are used then it is the same as point. Otherwise it is the mean of the sigma points.

Returns:

The mean value.

Return type:

N x 1 numpy array