SurfaceFeature.not_found

giant.relative_opnav.estimators.sfn.surface_features:

SurfaceFeature.not_found()[source]

This method is called when the feature is not found in an image.

It increments the n_not_found counter by 1. If the n_not_found counter is then greater than the stale_count_unload_threshold, the shape data will be unloaded from memory. Additionally, if the memory footprint of the current process is using more than memory_percent_unload_threshold then, regardless of how long its been since this feature was last used, the shape data will be unloaded from memory.

Typically a user will not use this method directly as it is automatically called by the VisualFeatureFinder class.

If the instance of this class was provided the shape object directly, instead of the file containing the shape data then this method will not try to unload, though it will still increase the counter for posterity.