boofcv.abst.geo.bundle.BundleAdjustmentCamera Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of boofcv-geo Show documentation
BoofCV is an open source Java library for real-time computer vision and robotics applications.
There is a newer version: 1.1.7
/*
 * Copyright (c) 2023, 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.abst.geo.bundle;

import georegression.struct.point.Point2D_F64;
import org.jetbrains.annotations.Nullable;

import java.util.Map;

/**
 * Generalized camera model for bundle adjustment. By implementing this function you can swap in and out
 * arbitrary camera models.
 *
 * @author Peter Abeles
 */
public interface BundleAdjustmentCamera {

	/**
	 * Specifies the intrinsic camera parameters.
	 *
	 * @param parameters Array containing the parameters
	 * @param offset Location of first index in the array which the parameters are stored
	 */
	void setIntrinsic( double[] parameters, int offset );

	/**
	 * Copies the intrinsic camera into the array.
	 *
	 * @param parameters Array containing the parameters
	 * @param offset Location of first index in the array which the parameters are stored
	 */
	void getIntrinsic( double[] parameters, int offset );

	/**
	 * Measured / known state of the camera when observations were made. This can indicate the camera's
	 * zoom level when a mechanical zoom is available. If the model has a fixed state then this function is
	 * optional.
	 *
	 * @param state Camera's state.
	 */
	default void setCameraState( BundleCameraState state ) {}

	/**
	 * Project the 3D point in the camera reference frame onto the camera's image plane.
	 *
	 * @param camX 3D point in camera reference frame
	 * @param camY 3D point in camera reference frame
	 * @param camZ 3D point in camera reference frame
	 * @param output Storage for projected point.
	 */
	void project( double camX, double camY, double camZ, Point2D_F64 output );

	/**
	 * Computes the gradient for the projected pixel coordinate with partials for the input 3D point in camera
	 * reference frame and camera intrinsic parameters. [x',y']  is the projected pixel coordinate of
	 * the 3D point in camera reference frame.
	 *
	 * @param camX (Input) 3D point in camera reference frame
	 * @param camY (Input) 3D point in camera reference frame
	 * @param camZ (Input) 3D point in camera reference frame
	 * @param pointX (Output) Partial of projected x' relative to input camera point.[@x'/@camX, @ x' / @ camY, @ x' / @ camZ] length 3
	 * @param pointY (Output) Partial of projected y' relative to input camera point.[@y'/@camX, @ y' / @ camY, @ y' / @ camZ] length 3
	 * @param computeIntrinsic If true the calibX and calibY is computed. Otherwise they are ignored and can be null
	 * @param calibX (Output) Partial of projected x' relative to calibration parameters. length N
	 * @param calibY (Output) Partial of projected y' relative to calibration parameters. length N
	 */
	void jacobian( double camX, double camY, double camZ,
				   double[] pointX, double[] pointY,
				   boolean computeIntrinsic,
				   @Nullable double[] calibX, @Nullable double[] calibY );

	/**
	 * Returns the number of intrinsic parameters for this model. If the camera is known then the number of parameters
	 * is zero
	 *
	 * @return number of intrinsic parameters.
	 */
	int getIntrinsicCount();

	/**
	 * Set's the classes state to the value contained in this map. Used when deserializing.
	 */
	BundleAdjustmentCamera setTo( Map src );

	/**
	 * Convert's the values into a map format where each class's field has a corresponding key with the same name and
	 * primitive value or primitive array. This is used for serialization to YAML.
	 */
	Map toMap();
}