001/*******************************************************************************
002 * This software is provided as a supplement to the authors' textbooks on digital
003 * image processing published by Springer-Verlag in various languages and editions.
004 * Permission to use and distribute this software is granted under the BSD 2-Clause
005 * "Simplified" License (see http://opensource.org/licenses/BSD-2-Clause).
006 * Copyright (c) 2006-2023 Wilhelm Burger, Mark J. Burge. All rights reserved.
007 * Visit https://imagingbook.com for additional details.
008 ******************************************************************************/
009package imagingbook.common.geometry.fitting.ellipse.geometric;
010
011import imagingbook.common.geometry.basic.Pnt2d;
012import imagingbook.common.geometry.ellipse.GeometricEllipse;
013
014import java.util.List;
015
016/**
017 * Interface to be implemented by all geometric ellipse fits.
018 * 
019 * @author WB
020 *
021 */
022public abstract class EllipseFitGeometric {
023        
024        public enum FitType {
025                CoordinateBased,
026                DistanceBased
027        }
028        
029        public static EllipseFitGeometric getFit(FitType type, Pnt2d[] points, GeometricEllipse initEllipse) {
030                switch (type) {
031                case CoordinateBased: return new EllipseGeometricFitCoord(points, initEllipse);
032                case DistanceBased: return new EllipseGeometricFitDist(points, initEllipse);
033                }
034                throw new RuntimeException("unknown geometric fit type: " + type);
035        }
036        
037        public static boolean VERBOSE = false;
038        public static boolean RecordHistory = false;    
039        public static int DefaultMaxIterations = 1000;
040        public static double DefaultTolerance = 1e-6;
041        
042        public abstract double[] getParameters();       
043        public abstract int getIterations();
044        public abstract List<double[]> getHistory();
045
046
047        /**
048         * Returns a geometric Ellipse or {@code null} if the fit was unsuccessful.
049         *
050         * @return the geometric ellipse or {@code null}
051         */
052        public GeometricEllipse getEllipse() {
053                double[] p = getParameters();
054                return (p != null) ? new GeometricEllipse(p) : null;
055        }
056
057}