Interface MHTChi2Provider<T>
- Type Parameters:
T
-
- All Known Implementing Classes:
StandardMHTChi2Provider
public interface MHTChi2Provider<T>
The MHTChi2 provider manages the mhtchi2 algorithms for each track possibility.
- Author:
- Jamie Macaulay.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addDetection
(T detection, int kcount) Called every time a new detection is added.void
clear()
Called whenever the MHTKernel is reset and/or a completely new set of click trains are to be analysed.void
clearKernelGarbage
(int newRefIndex) Called whenever a clear Kernel Garbage command is sent to start at a new data unit.Save any settings from the settings pane.newMHTChi2
(MHTChi2<T> mhtChi2) Create a new MHTChi2 instance.void
Print the settings to the consolevoid
setMHTParams
(MHTParams mhtParams) Set the MHT parameters fro the provider.
-
Method Details
-
addDetection
Called every time a new detection is added.- Parameters:
detection
- - detectionkcount
- - the total number of detection so far.
-
newMHTChi2
Create a new MHTChi2 instance. If mhtChi2 is non null then this is cloned with all current saved data and a new instance added.- Parameters:
mhtChi2
- - current instance of mhtChi2. Can be null.- Returns:
- - new instance of MHTChi2
-
getSettingsObject
MHTChi2Params getSettingsObject()Save any settings from the settings pane. -
clear
void clear()Called whenever the MHTKernel is reset and/or a completely new set of click trains are to be analysed. -
setMHTParams
Set the MHT parameters fro the provider.- Parameters:
mhtParams
- - the parameters to set.
-
getChi2Params
MHTChi2Params getChi2Params()- Returns:
-
printSettings
void printSettings()Print the settings to the console -
clearKernelGarbage
void clearKernelGarbage(int newRefIndex) Called whenever a clear Kernel Garbage command is sent to start at a new data unit. i.e. the kernel now starts from a new data unit and so some settings in the chi^2 may need to change.- Parameters:
newRefIndex
- - the index of the new reference data unit with respect to the old list.
-