com.irurueta.ar.sfm.KnownBaselineSparseReconstructorConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of irurueta-ar Show documentation

Augmented Reality and 3D reconstruction library

There is a newer version: 1.3.0

/*
 * Copyright (C) 2017 Alberto Irurueta Carro ([email protected])
 *
 * 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 com.irurueta.ar.sfm;

import java.io.Serializable;

/**
 * Contains configuration for a multiple view sparse re-constructor assuming that the
 * initial baseline (separation between initial cameras) is known.
 */
public class KnownBaselineSparseReconstructorConfiguration extends
        BaseSparseReconstructorConfiguration
        implements Serializable {

    /**
     * Default camera baseline (expressed in a unit of distance such as meters).
     * Methods such as DIAC or Essential assume that the camera baseline is 1.0,
     * which yields a reconstruction up to scale, unless the real baseline is provided.
     */
    public static final double DEFAULT_BASELINE = 1.0;

    /**
     * Camera baseline (expressed in a unit of distance such as meters).
     * Contains the real separation between camera centers so that the real scale of
     * cameras and reconstructed points can be retrieved.
     */
    private double mBaseline = DEFAULT_BASELINE;

    /**
     * Creates an instance of a multiple view sparse re-constructor configuration with
     * known camera baseline.
     *
     * @return configuration instance.
     */
    public static KnownBaselineSparseReconstructorConfiguration make() {
        return new KnownBaselineSparseReconstructorConfiguration();
    }

    /**
     * Gets camera baseline (expressed in a unit of distance such as meters).
     * Contains the real separation between camera centers so that the real scale of
     * cameras and reconstructed points can be retrieved.
     *
     * @return camera baseline.
     */
    public double getBaseline() {
        return mBaseline;
    }

    /**
     * Sets camera baseline (expressed in a unit of distance such as meters).
     * Contains the real separation between camera centers so that the real scale
     * of cameras and reconstructed points can be retrieved.
     *
     * @param baseline camera baseline.
     * @return this instance so that methods can be easily chained.
     */
    public KnownBaselineSparseReconstructorConfiguration setBaseline(final double baseline) {
        mBaseline = baseline;
        return this;
    }
}