UsTK : Ultrasound ToolKit
version 2.0.1 under development (2024-11-21)
|
#include <visp3/ustk_needle_modeling/usUnscentedKalmanFilter.h>
Public Types | |
enum | NoiseType : int { ADDITIVE_NOISE , GENERIC_NOISE } |
enum | SigmaPointGenerationType : int { STANDARD_COVARIANCE , FIXED_SCALING_FACTOR , LIMITED_SPREAD } |
Protected Attributes | |
unsigned int | m_stateDimension |
unsigned int | m_measureDimension |
unsigned int | m_processNoiseDimension |
unsigned int | m_measureNoiseDimension |
vpColVector | m_state |
vpMatrix | m_stateCovarianceMatrix |
NoiseType | m_processNoiseType |
vpMatrix | m_processNoiseCovarianceMatrix |
bool | m_computeProcessNoiseCovarianceMatrixAutomatically |
NoiseType | m_measureNoiseType |
vpMatrix | m_measureNoiseCovarianceMatrix |
bool | m_computeMeasureNoiseCovarianceMatrixAutomatically |
vpColVector | m_measure |
SigmaPointGenerationType | m_sigmaPointsGenerationType |
vpMatrix | m_sigmaPointsInit |
vpMatrix | m_sigmaPointsPropagated |
vpMatrix | m_sigmaPointsMeasure |
vpColVector | m_sigmaPointsMeanWeights |
vpColVector | m_sigmaPointsCovarianceWeights |
double | m_sigmaPointsScalingFactor |
double | m_sigmaPointsSpreadThreshold |
vpColVector | m_stateSigmaMean |
vpColVector | m_measureSigmaMean |
vpMatrix | m_stateSigmaCovarianceMatrix |
vpMatrix | m_stateMeasureSigmaCovarianceMatrix |
vpMatrix | m_measureSigmaCovarianceMatrix |
Definition at line 50 of file usUnscentedKalmanFilter.h.
enum usUnscentedKalmanFilter::NoiseType : int |
Enumerator | |
---|---|
ADDITIVE_NOISE | |
GENERIC_NOISE |
Definition at line 53 of file usUnscentedKalmanFilter.h.
Enumerator | |
---|---|
STANDARD_COVARIANCE | |
FIXED_SCALING_FACTOR | |
LIMITED_SPREAD |
Definition at line 54 of file usUnscentedKalmanFilter.h.
usUnscentedKalmanFilter::usUnscentedKalmanFilter | ( | ) |
Definition at line 91 of file usUnscentedKalmanFilter.cpp.
|
virtual |
Definition at line 128 of file usUnscentedKalmanFilter.cpp.
|
virtual |
Reimplemented in usTissueTranslationEstimatorUKF.
Definition at line 310 of file usUnscentedKalmanFilter.cpp.
References ADDITIVE_NOISE, m_computeMeasureNoiseCovarianceMatrixAutomatically, m_computeProcessNoiseCovarianceMatrixAutomatically, m_measureDimension, m_measureNoiseDimension, m_measureNoiseType, m_processNoiseDimension, m_processNoiseType, and m_stateDimension.
Referenced by usTissueTranslationEstimatorUKF::checkConsistency(), and filter().
void usUnscentedKalmanFilter::computeMeansAndCovarianceMatricesFromSigmaPoints | ( | ) |
Definition at line 508 of file usUnscentedKalmanFilter.cpp.
References m_measureNoiseCovarianceMatrix, m_measureNoiseType, m_measureSigmaCovarianceMatrix, m_measureSigmaMean, m_processNoiseCovarianceMatrix, m_processNoiseType, m_sigmaPointsCovarianceWeights, m_sigmaPointsMeanWeights, m_sigmaPointsMeasure, m_sigmaPointsPropagated, m_stateDimension, m_stateMeasureSigmaCovarianceMatrix, m_stateSigmaCovarianceMatrix, and m_stateSigmaMean.
Referenced by filter().
|
pure virtual |
Implemented in usTissueTranslationEstimatorUKF.
Referenced by computeSigmaMeasures(), and updateState().
|
virtual |
Reimplemented in usTissueTranslationEstimatorUKF.
Definition at line 324 of file usUnscentedKalmanFilter.cpp.
Referenced by filter().
bool usUnscentedKalmanFilter::computeMeasureNoiseCovarianceMatrixAutomatically | ( | ) | const |
Definition at line 300 of file usUnscentedKalmanFilter.cpp.
References m_computeMeasureNoiseCovarianceMatrixAutomatically.
void usUnscentedKalmanFilter::computeMeasureNoiseCovarianceMatrixAutomatically | ( | bool | flag | ) |
Definition at line 305 of file usUnscentedKalmanFilter.cpp.
References m_computeMeasureNoiseCovarianceMatrixAutomatically.
|
virtual |
Reimplemented in usTissueTranslationEstimatorUKF.
Definition at line 319 of file usUnscentedKalmanFilter.cpp.
Referenced by filter().
bool usUnscentedKalmanFilter::computeProcessNoiseCovarianceMatrixAutomatically | ( | ) | const |
Definition at line 278 of file usUnscentedKalmanFilter.cpp.
References m_computeProcessNoiseCovarianceMatrixAutomatically.
void usUnscentedKalmanFilter::computeProcessNoiseCovarianceMatrixAutomatically | ( | bool | flag | ) |
Definition at line 283 of file usUnscentedKalmanFilter.cpp.
References m_computeProcessNoiseCovarianceMatrixAutomatically.
bool usUnscentedKalmanFilter::computePropagatedSigmaPoints | ( | ) |
Definition at line 457 of file usUnscentedKalmanFilter.cpp.
References m_sigmaPointsInit, m_sigmaPointsPropagated, and propagateSigmaPoint().
Referenced by filter().
bool usUnscentedKalmanFilter::computeSigmaMeasures | ( | ) |
Definition at line 477 of file usUnscentedKalmanFilter.cpp.
References computeMeasureFromSigmaPoint(), m_measureDimension, m_sigmaPointsMeasure, m_sigmaPointsPropagated, m_state, measureLog(), and stateLog().
Referenced by filter().
bool usUnscentedKalmanFilter::filter | ( | const vpColVector & | measure | ) |
Definition at line 574 of file usUnscentedKalmanFilter.cpp.
References checkConsistency(), computeMeansAndCovarianceMatricesFromSigmaPoints(), computeMeasureNoiseCovarianceMatrix(), computeProcessNoiseCovarianceMatrix(), computePropagatedSigmaPoints(), computeSigmaMeasures(), generateSigmaPoints(), m_computeMeasureNoiseCovarianceMatrixAutomatically, m_computeProcessNoiseCovarianceMatrixAutomatically, m_measure, and updateState().
bool usUnscentedKalmanFilter::generateSigmaPoints | ( | ) |
Definition at line 329 of file usUnscentedKalmanFilter.cpp.
References m_measureNoiseCovarianceMatrix, m_measureNoiseDimension, m_measureNoiseType, m_processNoiseCovarianceMatrix, m_processNoiseDimension, m_processNoiseType, m_sigmaPointsCovarianceWeights, m_sigmaPointsGenerationType, m_sigmaPointsInit, m_sigmaPointsMeanWeights, m_sigmaPointsScalingFactor, m_sigmaPointsSpreadThreshold, m_state, m_stateCovarianceMatrix, m_stateDimension, stateLog(), and stateNorm().
Referenced by filter().
int usUnscentedKalmanFilter::getMeasureDimension | ( | ) | const |
Definition at line 150 of file usUnscentedKalmanFilter.cpp.
References m_measureDimension.
vpMatrix usUnscentedKalmanFilter::getMeasureNoiseCovarianceMatrix | ( | ) | const |
Definition at line 288 of file usUnscentedKalmanFilter.cpp.
References m_measureNoiseCovarianceMatrix.
int usUnscentedKalmanFilter::getMeasureNoiseDimension | ( | ) | const |
Definition at line 198 of file usUnscentedKalmanFilter.cpp.
References m_measureNoiseDimension.
usUnscentedKalmanFilter::NoiseType usUnscentedKalmanFilter::getMeasureNoiseType | ( | ) | const |
Definition at line 188 of file usUnscentedKalmanFilter.cpp.
References m_measureNoiseType.
vpMatrix usUnscentedKalmanFilter::getProcessNoiseCovarianceMatrix | ( | ) | const |
Definition at line 266 of file usUnscentedKalmanFilter.cpp.
References m_processNoiseCovarianceMatrix.
int usUnscentedKalmanFilter::getProcessNoiseDimension | ( | ) | const |
Definition at line 175 of file usUnscentedKalmanFilter.cpp.
References m_processNoiseDimension.
usUnscentedKalmanFilter::NoiseType usUnscentedKalmanFilter::getProcessNoiseType | ( | ) | const |
Definition at line 165 of file usUnscentedKalmanFilter.cpp.
References m_processNoiseType.
usUnscentedKalmanFilter::SigmaPointGenerationType usUnscentedKalmanFilter::getSigmaPointGenerationType | ( | ) | const |
Definition at line 211 of file usUnscentedKalmanFilter.cpp.
References m_sigmaPointsGenerationType.
double usUnscentedKalmanFilter::getSigmaPointScalingFactor | ( | ) | const |
Definition at line 221 of file usUnscentedKalmanFilter.cpp.
References m_sigmaPointsScalingFactor.
double usUnscentedKalmanFilter::getSigmaPointSpreadThreshold | ( | ) | const |
Definition at line 231 of file usUnscentedKalmanFilter.cpp.
References m_sigmaPointsSpreadThreshold.
vpColVector usUnscentedKalmanFilter::getState | ( | ) | const |
Definition at line 242 of file usUnscentedKalmanFilter.cpp.
References m_state.
vpMatrix usUnscentedKalmanFilter::getStateCovarianceMatrix | ( | ) | const |
Definition at line 254 of file usUnscentedKalmanFilter.cpp.
References m_stateCovarianceMatrix.
int usUnscentedKalmanFilter::getStateDimension | ( | ) | const |
Definition at line 133 of file usUnscentedKalmanFilter.cpp.
References m_stateDimension.
|
virtual |
Reimplemented in usTissueTranslationEstimatorUKF.
Definition at line 597 of file usUnscentedKalmanFilter.cpp.
Referenced by computeSigmaMeasures(), and updateState().
|
pure virtual |
Implemented in usTissueTranslationEstimatorUKF.
Referenced by computePropagatedSigmaPoints().
void usUnscentedKalmanFilter::setMeasureDimension | ( | int | dim | ) |
Definition at line 155 of file usUnscentedKalmanFilter.cpp.
References m_measureDimension, m_measureSigmaCovarianceMatrix, m_measureSigmaMean, m_stateDimension, and m_stateMeasureSigmaCovarianceMatrix.
Referenced by usTissueTranslationEstimatorUKF::checkConsistency(), and usTissueTranslationEstimatorUKF::setMeasureType().
void usUnscentedKalmanFilter::setMeasureNoiseCovarianceMatrix | ( | const vpMatrix & | cov | ) |
Definition at line 293 of file usUnscentedKalmanFilter.cpp.
References m_measureNoiseCovarianceMatrix, and m_measureNoiseDimension.
void usUnscentedKalmanFilter::setMeasureNoiseDimension | ( | int | dim | ) |
Definition at line 203 of file usUnscentedKalmanFilter.cpp.
References m_measureNoiseCovarianceMatrix, and m_measureNoiseDimension.
Referenced by usTissueTranslationEstimatorUKF::checkConsistency().
void usUnscentedKalmanFilter::setMeasureNoiseType | ( | NoiseType | type | ) |
Definition at line 193 of file usUnscentedKalmanFilter.cpp.
References m_measureNoiseType.
void usUnscentedKalmanFilter::setProcessNoiseCovarianceMatrix | ( | const vpMatrix & | cov | ) |
Definition at line 271 of file usUnscentedKalmanFilter.cpp.
References m_processNoiseCovarianceMatrix, and m_processNoiseDimension.
void usUnscentedKalmanFilter::setProcessNoiseDimension | ( | int | dim | ) |
Definition at line 180 of file usUnscentedKalmanFilter.cpp.
References m_processNoiseCovarianceMatrix, and m_processNoiseDimension.
void usUnscentedKalmanFilter::setProcessNoiseType | ( | NoiseType | type | ) |
Definition at line 170 of file usUnscentedKalmanFilter.cpp.
References m_processNoiseType.
void usUnscentedKalmanFilter::setSigmaPointGenerationType | ( | usUnscentedKalmanFilter::SigmaPointGenerationType | type | ) |
Definition at line 216 of file usUnscentedKalmanFilter.cpp.
References m_sigmaPointsGenerationType.
void usUnscentedKalmanFilter::setSigmaPointScalingFactor | ( | double | factor | ) |
Definition at line 226 of file usUnscentedKalmanFilter.cpp.
References m_sigmaPointsScalingFactor.
void usUnscentedKalmanFilter::setSigmaPointSpreadThreshold | ( | double | threshold | ) |
Definition at line 236 of file usUnscentedKalmanFilter.cpp.
References m_sigmaPointsSpreadThreshold.
void usUnscentedKalmanFilter::setState | ( | const vpColVector & | state | ) |
Definition at line 247 of file usUnscentedKalmanFilter.cpp.
References m_state, and m_stateDimension.
void usUnscentedKalmanFilter::setStateCovarianceMatrix | ( | const vpMatrix & | mat | ) |
Definition at line 259 of file usUnscentedKalmanFilter.cpp.
References m_stateCovarianceMatrix, and m_stateDimension.
void usUnscentedKalmanFilter::setStateDimension | ( | int | dim | ) |
Definition at line 138 of file usUnscentedKalmanFilter.cpp.
References m_measureDimension, m_state, m_stateCovarianceMatrix, m_stateDimension, m_stateMeasureSigmaCovarianceMatrix, m_stateSigmaCovarianceMatrix, and m_stateSigmaMean.
Referenced by usTissueTranslationEstimatorUKF::setStateDynamicsType(), and usTissueTranslationEstimatorUKF::usTissueTranslationEstimatorUKF().
|
virtual |
Definition at line 609 of file usUnscentedKalmanFilter.cpp.
Referenced by updateState().
|
virtual |
Definition at line 603 of file usUnscentedKalmanFilter.cpp.
Referenced by computeSigmaMeasures(), generateSigmaPoints(), and updateState().
|
virtual |
Reimplemented in usTissueTranslationEstimatorUKF.
Definition at line 592 of file usUnscentedKalmanFilter.cpp.
Referenced by generateSigmaPoints().
bool usUnscentedKalmanFilter::updateState | ( | ) |
Definition at line 554 of file usUnscentedKalmanFilter.cpp.
References computeMeasureFromSigmaPoint(), m_measure, m_measureSigmaCovarianceMatrix, m_measureSigmaMean, m_state, m_stateCovarianceMatrix, m_stateMeasureSigmaCovarianceMatrix, m_stateSigmaCovarianceMatrix, m_stateSigmaMean, measureLog(), stateExp(), and stateLog().
Referenced by filter().
|
protected |
Definition at line 72 of file usUnscentedKalmanFilter.h.
Referenced by checkConsistency(), computeMeasureNoiseCovarianceMatrixAutomatically(), filter(), and usTissueTranslationEstimatorUKF::usTissueTranslationEstimatorUKF().
|
protected |
Definition at line 68 of file usUnscentedKalmanFilter.h.
Referenced by checkConsistency(), computeProcessNoiseCovarianceMatrixAutomatically(), filter(), and usTissueTranslationEstimatorUKF::usTissueTranslationEstimatorUKF().
|
protected |
Definition at line 74 of file usUnscentedKalmanFilter.h.
Referenced by usTissueTranslationEstimatorUKF::computeMeasureFromSigmaPoint(), filter(), and updateState().
|
protected |
Definition at line 59 of file usUnscentedKalmanFilter.h.
Referenced by checkConsistency(), usTissueTranslationEstimatorUKF::computeMeasureNoiseCovarianceMatrix(), computeSigmaMeasures(), getMeasureDimension(), setMeasureDimension(), and setStateDimension().
|
protected |
Definition at line 71 of file usUnscentedKalmanFilter.h.
Referenced by computeMeansAndCovarianceMatricesFromSigmaPoints(), usTissueTranslationEstimatorUKF::computeMeasureNoiseCovarianceMatrix(), generateSigmaPoints(), getMeasureNoiseCovarianceMatrix(), setMeasureNoiseCovarianceMatrix(), and setMeasureNoiseDimension().
|
protected |
Definition at line 61 of file usUnscentedKalmanFilter.h.
Referenced by checkConsistency(), generateSigmaPoints(), getMeasureNoiseDimension(), setMeasureNoiseCovarianceMatrix(), and setMeasureNoiseDimension().
|
protected |
Definition at line 70 of file usUnscentedKalmanFilter.h.
Referenced by checkConsistency(), computeMeansAndCovarianceMatricesFromSigmaPoints(), generateSigmaPoints(), getMeasureNoiseType(), and setMeasureNoiseType().
|
protected |
Definition at line 89 of file usUnscentedKalmanFilter.h.
Referenced by computeMeansAndCovarianceMatricesFromSigmaPoints(), setMeasureDimension(), and updateState().
|
protected |
Definition at line 86 of file usUnscentedKalmanFilter.h.
Referenced by computeMeansAndCovarianceMatricesFromSigmaPoints(), setMeasureDimension(), and updateState().
|
protected |
Definition at line 67 of file usUnscentedKalmanFilter.h.
Referenced by computeMeansAndCovarianceMatricesFromSigmaPoints(), usTissueTranslationEstimatorUKF::computeProcessNoiseCovarianceMatrix(), generateSigmaPoints(), getProcessNoiseCovarianceMatrix(), setProcessNoiseCovarianceMatrix(), and setProcessNoiseDimension().
|
protected |
Definition at line 60 of file usUnscentedKalmanFilter.h.
Referenced by checkConsistency(), generateSigmaPoints(), getProcessNoiseDimension(), setProcessNoiseCovarianceMatrix(), and setProcessNoiseDimension().
|
protected |
Definition at line 66 of file usUnscentedKalmanFilter.h.
Referenced by checkConsistency(), computeMeansAndCovarianceMatricesFromSigmaPoints(), generateSigmaPoints(), getProcessNoiseType(), and setProcessNoiseType().
|
protected |
Definition at line 81 of file usUnscentedKalmanFilter.h.
Referenced by computeMeansAndCovarianceMatricesFromSigmaPoints(), and generateSigmaPoints().
|
protected |
Definition at line 76 of file usUnscentedKalmanFilter.h.
Referenced by generateSigmaPoints(), getSigmaPointGenerationType(), and setSigmaPointGenerationType().
|
protected |
Definition at line 77 of file usUnscentedKalmanFilter.h.
Referenced by computePropagatedSigmaPoints(), and generateSigmaPoints().
|
protected |
Definition at line 80 of file usUnscentedKalmanFilter.h.
Referenced by computeMeansAndCovarianceMatricesFromSigmaPoints(), and generateSigmaPoints().
|
protected |
Definition at line 79 of file usUnscentedKalmanFilter.h.
Referenced by computeMeansAndCovarianceMatricesFromSigmaPoints(), and computeSigmaMeasures().
|
protected |
Definition at line 78 of file usUnscentedKalmanFilter.h.
Referenced by computeMeansAndCovarianceMatricesFromSigmaPoints(), computePropagatedSigmaPoints(), and computeSigmaMeasures().
|
protected |
Definition at line 82 of file usUnscentedKalmanFilter.h.
Referenced by generateSigmaPoints(), getSigmaPointScalingFactor(), and setSigmaPointScalingFactor().
|
protected |
Definition at line 83 of file usUnscentedKalmanFilter.h.
Referenced by generateSigmaPoints(), getSigmaPointSpreadThreshold(), and setSigmaPointSpreadThreshold().
|
protected |
Definition at line 63 of file usUnscentedKalmanFilter.h.
Referenced by usTissueTranslationEstimatorUKF::applyStateToNeedle(), usTissueTranslationEstimatorUKF::checkConsistency(), computeSigmaMeasures(), generateSigmaPoints(), getState(), usTissueTranslationEstimatorUKF::setCurrentNeedle(), setState(), setStateDimension(), and updateState().
|
protected |
Definition at line 64 of file usUnscentedKalmanFilter.h.
Referenced by generateSigmaPoints(), getStateCovarianceMatrix(), setStateCovarianceMatrix(), setStateDimension(), and updateState().
|
protected |
Definition at line 58 of file usUnscentedKalmanFilter.h.
Referenced by checkConsistency(), computeMeansAndCovarianceMatricesFromSigmaPoints(), generateSigmaPoints(), getStateDimension(), setMeasureDimension(), setState(), setStateCovarianceMatrix(), and setStateDimension().
|
protected |
Definition at line 88 of file usUnscentedKalmanFilter.h.
Referenced by computeMeansAndCovarianceMatricesFromSigmaPoints(), setMeasureDimension(), setStateDimension(), and updateState().
|
protected |
Definition at line 87 of file usUnscentedKalmanFilter.h.
Referenced by computeMeansAndCovarianceMatricesFromSigmaPoints(), setStateDimension(), and updateState().
|
protected |
Definition at line 85 of file usUnscentedKalmanFilter.h.
Referenced by computeMeansAndCovarianceMatricesFromSigmaPoints(), setStateDimension(), and updateState().