is_ellipse_good#

pyxem.utils.ransac_ellipse_tools.is_ellipse_good(ellipse_model, data, xf, yf, rf_lim, semi_len_min=None, semi_len_max=None, semi_len_ratio_lim=None)[source]#

Check if an ellipse model is within parameters.

Parameters:

ellipse_model (skimage EllipseModel)
data (Not used)
xf, yf (scalar) – Focus of the ellipse
rf_lim (scalar) – If the distance from (xf, yf) and the centre of the ellipse is larger than rf_lim, False is returned.
semi_len_min, semi_len_max (scalar) – Minimum and maximum semi length values for the ellipse, if any of the two semi lengths are outside this range, False is returned.
semi_len_ratio_lim (scalar) – If the ratio between the largest and smallest semi length is larger than semi_len_ratio_lim, False is returned

Returns:

is_good

Return type:

bool

Examples

>>> import pyxem.utils.ransac_ellipse_tools as ret
>>> model = ret.EllipseModel()
>>> model.params = ret._make_ellipse_model_params_focus(30, 50, 30, 20, 0)
>>> is_good = ret.is_ellipse_good(
...         ellipse_model=model, data=None, xf=30, yf=50, rf_lim=5)