Virtual Class representing all Mixture particle filters. More...

#include <mixtureParticleFilter.h>

Inheritance diagram for BFL::MixtureParticleFilter< StateVar, MeasVar >:

Public Member Functions
	MixtureParticleFilter (Mixture< StateVar > prior, ConditionalPdf< StateVar, StateVar > proposal, int resampleperiod=0, double resamplethreshold=0, int resamplescheme=DEFAULT_RS, int maintainMixturePeriod=1)
	Constructor.
	MixtureParticleFilter (Mixture< StateVar > prior, Mixture< StateVar > post, ConditionalPdf< StateVar, StateVar > *proposal, int resampleperiod=0, double resamplethreshold=0, int resamplescheme=DEFAULT_RS, int maintainMixturePeriod=1)
	Constructor.
	MixtureParticleFilter (const MixtureParticleFilter< StateVar, MeasVar > &filt)
	Copy Constructor.
virtual Mixture< StateVar > *	PostGet ()
	Get Posterior density.
ConditionalPdf< StateVar, StateVar > *	ProposalGet ()
	Get a pointer to the proposal density.
virtual void	ProposalSet (ConditionalPdf< StateVar, StateVar > *const cpdf)
	Set the proposal density.
virtual void	Reset (Mixture< StateVar > *prior)
	Reset Filter.
virtual	~MixtureParticleFilter ()
	Destructor.
Protected Member Functions
virtual bool	DynamicResampleStep ()
	Resample if necessary.
virtual bool	DynamicResampleStepOne (int component)
	Resampling for one component.
virtual bool	MaintainMixture ()
	Actual mixture maintainance happens here;.
virtual bool	MaintainMixtureStep ()
	Maintain Mixture if wanted.
virtual bool	ProposalStepInternal (SystemModel< StateVar > const sysmodel, const StateVar &u, MeasurementModel< MeasVar, StateVar > const measmodel, const MeasVar &z, const StateVar &s)
	Proposal step.
virtual bool	ProposalStepInternalOne (int component, SystemModel< StateVar > const sysmodel, const StateVar &u, MeasurementModel< MeasVar, StateVar > const measmodel, const MeasVar &z, const StateVar &s)
	Proposal step for one component.
virtual bool	Resample ()
	Actual Resampling happens here;.
virtual bool	ResampleOne (int component)
	Actual Resampling for one component;.
virtual bool	StaticResampleStep ()
	Resample if wanted.
virtual bool	UpdateInternal (SystemModel< StateVar > const sysmodel, const StateVar &u, MeasurementModel< MeasVar, StateVar > const measmodel, const MeasVar &z, const StateVar &s)
	Actual implementation of Update, varies along filters.
virtual bool	UpdateWeightsInternal (SystemModel< StateVar > const sysmodel, const StateVar &u, MeasurementModel< MeasVar, StateVar > const measmodel, const MeasVar &z, const StateVar &s)
	Update Weights.
virtual bool	UpdateWeightsInternalOne (int component, SystemModel< StateVar > const sysmodel, const StateVar &u, MeasurementModel< MeasVar, StateVar > const measmodel, const MeasVar &z, const StateVar &s)
	Update Weights for one component.
Protected Attributes
bool	_created_post
	created own post
bool	_dynamicResampling
	Dynamic resampling or fixed period resampling?
int	_maintainMixturePeriod
	Number of timestep between mixture maintainance of the Posterior.
vector< vector< Sample < StateVar > > >	_new_samples_unweightedVec
	While resampling.
vector< vector< WeightedSample < StateVar > > >	_new_samplesVec
	While updating store list of new samples.
vector< Probability >	_newMixtureWeights
	Vector containing the new mixture weights during update step.
vector< WeightedSample < StateVar > >::iterator	_ns_it
	Iterator for new list of samples.
vector< vector< WeightedSample < StateVar > > >	_old_samplesVec
	While updating store list of old samples.
vector< WeightedSample < StateVar > >::iterator	_os_it
	Iterator for old list of samples.
ConditionalPdf< StateVar, StateVar > *	_proposal
	Pointer to the Proposal Density.
bool	_proposal_depends_on_meas
	Proposal depends on last measurement?
int	_resamplePeriod
	Number of timestep between resampling from the Posterior Pdf.
int	_resampleScheme
	Which resample algorithm (see top of particle.h for #defines)
double	_resampleThreshold
	Threshold used when dynamic resampling.
WeightedSample< StateVar >	_sample
	While updating use sample<StateVar>
vector< Probability >	_sumWeights
	Vector containing the sum of weights during update step.

Detailed Description

template<typename StateVar, typename MeasVar>
class BFL::MixtureParticleFilter< StateVar, MeasVar >

Virtual Class representing all Mixture particle filters.

This is a virtual class representing the family of all mixture particle filters. Mixture Particle filters are filters in which the Posterior density is represented by a mixture (class Mixture) of Monte Carlo Pdfs (class MCPdf).

However, the updating of the Posterior density can still be done in several ways, that's why the System and Measurement update members are still pure virtual functions.

This class is the base class for all sorts of mixture particle filters.

See also:: Mixture; MCPdf; Sample; WeightedSample

Bug:: Resampling is not implemented generically enough yet. There's only the possibility to choose between static period resampling and dynamic resampling as proposed by Jun Liu. The correct way of implementing this would be to create a virtual function that has to be implemented by the user, but this creates more hassle for the user (a different particle filter for each scheme).

Definition at line 153 of file mixtureParticleFilter.h.

Constructor & Destructor Documentation

template<typename StateVar, typename MeasVar>

BFL::MixtureParticleFilter< StateVar, MeasVar >::MixtureParticleFilter	(	Mixture< StateVar > *	prior,
		ConditionalPdf< StateVar, StateVar > *	proposal,
		int	resampleperiod = `0`,
		double	resamplethreshold = `0`,
		int	resamplescheme = `DEFAULT_RS`,
		int	maintainMixturePeriod = `1`
	)

Constructor.

Precondition:: you created the necessary models and the prior

Parameters:

prior	pointer to the mixture of Monte Carlo Pdfs prior density
proposal	pointer to the proposal density to use
resampleperiod	fixed resampling period (if desired)
resamplethreshold	threshold used when dynamic resampling
resamplescheme	resampling scheme, see header file for different defines and their meaning
maintainMixturePeriod	fixed mixture maintainance period

Bug:

prior should be of type pdf and not mcpdf. See also notes with implementation

let the user implement her/his own resamplescheme

template<typename StateVar, typename MeasVar>

BFL::MixtureParticleFilter< StateVar, MeasVar >::MixtureParticleFilter	(	Mixture< StateVar > *	prior,
		Mixture< StateVar > *	post,
		ConditionalPdf< StateVar, StateVar > *	proposal,
		int	resampleperiod = `0`,
		double	resamplethreshold = `0`,
		int	resamplescheme = `DEFAULT_RS`,
		int	maintainMixturePeriod = `1`
	)

Constructor.

Precondition:: you created the necessary models and the prior

Parameters:

prior	pointer to the mixture of Monte Carlo Pdfs prior density
post	pointer to the mixture of Monte Carlo Pdfs post density
proposal	pointer to the proposal density to use
resampleperiod	fixed resampling period (if desired)
resamplethreshold	threshold used when dynamic resampling
resamplescheme	resampling scheme, see header file for different defines and their meaning
maintainMixturePeriod	fixed mixture maintainance period

Bug:

prior should be of type pdf and not mcpdf. See also notes with implementation

let the user implement her/his own resamplescheme

template<typename SV , typename MV >

BFL::MixtureParticleFilter< SV, MV >::~MixtureParticleFilter ( ) [virtual]

Destructor.

Definition at line 136 of file mixtureParticleFilter.cpp.

template<typename StateVar, typename MeasVar>

BFL::MixtureParticleFilter< StateVar, MeasVar >::MixtureParticleFilter ( const MixtureParticleFilter< StateVar, MeasVar > & filt )

Copy Constructor.

Bug:: implementation probably contains a bug

Member Function Documentation

template<typename SV , typename MV >

bool BFL::MixtureParticleFilter< SV, MV >::DynamicResampleStep ( ) [protected, virtual]

Resample if necessary.

Definition at line 356 of file mixtureParticleFilter.cpp.

template<typename SV , typename MV >

bool BFL::MixtureParticleFilter< SV, MV >::DynamicResampleStepOne ( int component ) [protected, virtual]

Resampling for one component.

Parameters:

component component number of component to update

Bug:: let the user implement her/his own resamplescheme

Definition at line 368 of file mixtureParticleFilter.cpp.

template<typename SV , typename MV >

bool BFL::MixtureParticleFilter< SV, MV >::MaintainMixture ( ) [protected, virtual]

Actual mixture maintainance happens here;.

Definition at line 517 of file mixtureParticleFilter.cpp.

template<typename SV , typename MV >

bool BFL::MixtureParticleFilter< SV, MV >::MaintainMixtureStep ( ) [protected, virtual]

Maintain Mixture if wanted.

Bug:: let the user implement her/his own mixture maintaince scheme

Definition at line 508 of file mixtureParticleFilter.cpp.

template<typename SV , typename MV >

Mixture< SV > * BFL::MixtureParticleFilter< SV, MV >::PostGet ( ) [virtual]

Get Posterior density.

Get the current Posterior density

Returns:: a pointer to the current posterior

Reimplemented from BFL::Filter< StateVar, MeasVar >.

Definition at line 502 of file mixtureParticleFilter.cpp.

template<typename SV , typename MV >

ConditionalPdf< SV, SV > * BFL::MixtureParticleFilter< SV, MV >::ProposalGet ( )

Get a pointer to the proposal density.

Returns:: a pointer to the proposal density

Definition at line 170 of file mixtureParticleFilter.cpp.

template<typename StateVar, typename MeasVar>

void BFL::MixtureParticleFilter< SV, MV >::ProposalSet ( ConditionalPdf< StateVar, StateVar > *const cpdf ) [virtual]

Set the proposal density.

Parameters:

cpdf	the new proposal density. The order of the conditional arguments is fixed and should be: x (state), u (input), z (measurement), s (sensor param). Off course all of them are optional

Definition at line 164 of file mixtureParticleFilter.cpp.

template<typename StateVar, typename MeasVar>

bool BFL::MixtureParticleFilter< SV, MV >::ProposalStepInternal	(	SystemModel< StateVar > *const	sysmodel,
		const StateVar &	u,
		MeasurementModel< MeasVar, StateVar > *const	measmodel,
		const MeasVar &	z,
		const StateVar &	s
	)		`[protected, virtual]`

Proposal step.

Implementation of proposal step

Parameters:

sysmodel	pointer to the used system model
u	input param for proposal density
measmodel	pointer to the used measurementmodel
z	measurement param for proposal density
s	sensor param for proposal density

Bug:: Make sampling method variable. See implementation.

Definition at line 177 of file mixtureParticleFilter.cpp.

template<typename StateVar, typename MeasVar>

bool BFL::MixtureParticleFilter< SV, MV >::ProposalStepInternalOne	(	int	component,
		SystemModel< StateVar > *const	sysmodel,
		const StateVar &	u,
		MeasurementModel< MeasVar, StateVar > *const	measmodel,
		const MeasVar &	z,
		const StateVar &	s
	)		`[protected, virtual]`

Proposal step for one component.

Implementation of proposal step

Parameters:

component	component number of component to update
sysmodel	pointer to the used system model
u	input param for proposal density
measmodel	pointer to the used measurementmodel
z	measurement param for proposal density
s	sensor param for proposal density

Bug:: Make sampling method variable. See implementation.

Definition at line 193 of file mixtureParticleFilter.cpp.

template<typename SV , typename MV >

bool BFL::MixtureParticleFilter< SV, MV >::Resample ( ) [protected, virtual]

Actual Resampling happens here;.

Definition at line 445 of file mixtureParticleFilter.cpp.

template<typename SV , typename MV >

bool BFL::MixtureParticleFilter< SV, MV >::ResampleOne ( int component ) [protected, virtual]

Actual Resampling for one component;.

Parameters:

component component number of component to update

Definition at line 457 of file mixtureParticleFilter.cpp.

template<typename StateVar, typename MeasVar>

void BFL::MixtureParticleFilter< SV, MV >::Reset ( Mixture< StateVar > * prior ) [virtual]

Reset Filter.

Definition at line 154 of file mixtureParticleFilter.cpp.

template<typename SV , typename MV >

bool BFL::MixtureParticleFilter< SV, MV >::StaticResampleStep ( ) [protected, virtual]

Resample if wanted.

Bug:: let the user implement her/his own resamplescheme

Definition at line 404 of file mixtureParticleFilter.cpp.

template<typename SV , typename MV >

bool BFL::MixtureParticleFilter< SV, MV >::UpdateInternal	(	SystemModel< StateVar > *const	sysmodel,
		const StateVar &	u,
		MeasurementModel< MeasVar, StateVar > *const	measmodel,
		const MeasVar &	z,
		const StateVar &	s
	)		`[protected, virtual]`

Actual implementation of Update, varies along filters.

Parameters:

sysmodel	pointer to the used system model
u	input param for proposal density
measmodel	pointer to the used measurementmodel
z	measurement param for proposal density
s	sensor param for proposal density

Implements BFL::Filter< StateVar, MeasVar >.

Reimplemented in BFL::MixtureBootstrapFilter< StateVar, MeasVar >.

Definition at line 414 of file mixtureParticleFilter.cpp.

template<typename StateVar, typename MeasVar>

bool BFL::MixtureParticleFilter< SV, MV >::UpdateWeightsInternal	(	SystemModel< StateVar > *const	sysmodel,
		const StateVar &	u,
		MeasurementModel< MeasVar, StateVar > *const	measmodel,
		const MeasVar &	z,
		const StateVar &	s
	)		`[protected, virtual]`

Update Weights.

Parameters:

sysmodel	pointer to the used system model
u	input param for proposal density
measmodel	pointer to the used measurementmodel
z	measurement param for proposal density
s	sensor param for proposal density

Definition at line 248 of file mixtureParticleFilter.cpp.

template<typename StateVar, typename MeasVar>

bool BFL::MixtureParticleFilter< SV, MV >::UpdateWeightsInternalOne	(	int	component,
		SystemModel< StateVar > *const	sysmodel,
		const StateVar &	u,
		MeasurementModel< MeasVar, StateVar > *const	measmodel,
		const MeasVar &	z,
		const StateVar &	s
	)		`[protected, virtual]`

Update Weights for one component.

Parameters:

component	component number of component to update
sysmodel	pointer to the used system model
u	input param for proposal density
measmodel	pointer to the used measurementmodel
z	measurement param for proposal density
s	sensor param for proposal density

Definition at line 275 of file mixtureParticleFilter.cpp.

Member Data Documentation

template<typename StateVar, typename MeasVar>

bool BFL::MixtureParticleFilter< StateVar, MeasVar >::_created_post [protected]

created own post

Definition at line 206 of file mixtureParticleFilter.h.

template<typename StateVar, typename MeasVar>

bool BFL::MixtureParticleFilter< StateVar, MeasVar >::_dynamicResampling [protected]

Dynamic resampling or fixed period resampling?

Definition at line 200 of file mixtureParticleFilter.h.

template<typename StateVar, typename MeasVar>

int BFL::MixtureParticleFilter< StateVar, MeasVar >::_maintainMixturePeriod [protected]

Number of timestep between mixture maintainance of the Posterior.

By choosing this period, one can execute period maintainance of mixtures. You can implement maintainMixture such that target splitting, appearing and disappearing is handled

Definition at line 213 of file mixtureParticleFilter.h.

template<typename StateVar, typename MeasVar>

vector< vector<Sample<StateVar> > > BFL::MixtureParticleFilter< StateVar, MeasVar >::_new_samples_unweightedVec [protected]

While resampling.

Definition at line 177 of file mixtureParticleFilter.h.

template<typename StateVar, typename MeasVar>

vector<vector<WeightedSample<StateVar> > > BFL::MixtureParticleFilter< StateVar, MeasVar >::_new_samplesVec [protected]

While updating store list of new samples.

Definition at line 175 of file mixtureParticleFilter.h.

template<typename StateVar, typename MeasVar>

vector<Probability> BFL::MixtureParticleFilter< StateVar, MeasVar >::_newMixtureWeights [protected]

Vector containing the new mixture weights during update step.