LimbMatchingOptions

giant.relative_opnav.estimators.limb_matching:

class giant.relative_opnav.estimators.limb_matching.LimbMatchingOptions(extraction_method=LimbExtractionMethods.EDGE_DETECTION, limb_edge_detection_options=None, limb_scanner_options=None, state_atol=1e-06, state_rtol=0.0001, residual_atol=1e-10, residual_rtol=0.0001, max_iters=10, recenter=True, discard_outliers=True, create_gif=False, gif_file='limb_match_summary_{}_{}.gif')[source]
Parameters:

  • extraction_method (LimbExtractionMethods) – The method to use to extract the observed limbs from the image. Should be 'LIMB_SCANNING' or 'EDGE_DETECTION'. See LimbExtractionMethods for details.

  • limb_edge_detection_options (LimbEdgeDetectionOptions | None) – The options to use to configure the limb edge detector

  • limb_scanner_options (LimbScannerOptions | None) – The options to use to configure the limb scanner

  • state_atol (float) – the absolute tolerance state convergence criteria (np.abs(update) < state_atol).all())

  • state_rtol (float) – the relative tolerance state convergence criteria (np.abs(update)/state < state_rtol).all())

  • residual_atol (float) – the absolute tolerance residual convergence criteria

  • residual_rtol (float) – the relative tolerance residual convergence criteria

  • max_iters (int) – maximum number of iterations for iterative horizon relative navigation

  • recenter (bool) – A flag to estimate the center using the moment algorithm to get a fast rough estimate of the center-of-figure

  • discard_outliers (bool) – A flag to use Median Absolute Deviation to find outliers and get rid of them

  • create_gif (bool) – A flag specifying whether to build a gif of the iterations.

  • gif_file (str) – the file to save the gif to, optionally with 2 positional format arguments for the image date and target name being processed

  • interpolator – The type of image interpolator to use if the extraction method is set to LIMB_SCANNING.

state_atol: float = 1e-06

The absolute tolerance state convergence criteria (np.abs(update) < state_atol).all())

state_rtol: float = 0.0001

The relative tolerance state convergence criteria (np.abs(update)/state < state_rtol).all())

residual_atol: float = 1e-10

The absolute tolerance convergence criteria for residuals (abs(new_resid_ss - old_resid_ss) < residual_atol).all())

residual_rtol: float = 0.0001

The relative tolerance convergence criteria for residuals (abs(new_resid_ss - old_resid_ss)/old_resid_ss < residual_rtol).all())

max_iters: int = 10

The maximum number of iterations to attempt in the limb-matching algorithm.

recenter: bool = True

A flag to estimate the center using the moment algorithm to get a fast rough estimate of the center-of-figure

discard_outliers: bool = True

A flag specifying whether to attempt to remove outliers in the limb pairs each iteration.

For most targets this flag is strongly encouraged.

create_gif: bool = False

A flag specifying whether to create a gif of the iteration process for review.

gif_file: str = 'limb_match_summary_{}_{}.gif'

The file to save the gif to.

This can optionally can include 2 format locators for the image date and target name to distinguish the gif files from each other. The image date will be supplied as the first argument to format and the target name will be supplied as the second argument.

extraction_method: LimbExtractionMethods = 'EDGE_DETECTION'

The method to use to extract the observed limbs from the image. Should be 'LIMB_SCANNING' or 'EDGE_DETECTION'. See LimbExtractionMethods for details.

limb_edge_detection_options: LimbEdgeDetectionOptions | None = None

The options to use to configure the limb edge detector (if being used)

limb_scanner_options: LimbScannerOptions | None = None

The options to use to configure the limb scanner (if being used)