boofcv.struct.feature.ScalePoint Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2011-2019, Peter Abeles. All Rights Reserved.
 *
 * This file is part of BoofCV (http://boofcv.org).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package boofcv.struct.feature;

import georegression.struct.point.Point2D_F64;

/**
 * Where a point of interest was detected and at what scale.
 *
 * @author Peter Abeles
 */
public class ScalePoint extends Point2D_F64 {
	/**
	 * The scale the feature was detected at.  Exact meaning of "scale" is implementation dependent
	 */
	public double scale;
	// does the blob correspond to a black or white region
	public boolean white;

	public ScalePoint(double x, double y, double scale) {
		super(x, y);
		this.scale = scale;
	}

	public ScalePoint(double x, double y,
					  double scale, boolean white ) {
		set(x, y, scale, white);
	}

	public ScalePoint() {
	}

	public void set(double x, double y, double scale) {
		set(x, y);
		this.scale = scale;
	}

	public void set(double x, double y, double scale, boolean white ) {
		set(x, y);
		this.scale = scale;
		this.white = white;
	}

	public boolean isWhite() {
		return white;
	}

	public double getScale() {
		return scale;
	}

	public void setScale(double scale) {
		this.scale = scale;
	}

	public void setWhite(boolean white) {
		this.white = white;
	}

	public ScalePoint copy() {
		return new ScalePoint(x,y, scale,white);
	}

	public void set(ScalePoint p) {
		this.scale = p.scale;
		this.x = p.x;
		this.y = p.y;
		this.white = p.white;
	}

	@Override
	public String toString() {
		return "ScalePoint{" +
				"scale=" + scale +
				", white=" + white +
				", x=" + x +
				", y=" + y +
				'}';
	}
}