maltcms.commands.distances.dtwng.AlignmentFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maltcms-commands Show documentation

Similarities for Feature Vectors and Time Series thereof, such as Cosine and Dynamic Time Warping.

The newest version!

/*
 * Maltcms, modular application toolkit for chromatography-mass spectrometry.
 * Copyright (C) 2008-2014, The authors of Maltcms. All rights reserved.
 *
 * Project website: http://maltcms.sf.net
 *
 * Maltcms may be used under the terms of either the
 *
 * GNU Lesser General Public License (LGPL)
 * http://www.gnu.org/licenses/lgpl.html
 *
 * or the
 *
 * Eclipse Public License (EPL)
 * http://www.eclipse.org/org/documents/epl-v10.php
 *
 * As a user/recipient of Maltcms, you may choose which license to receive the code
 * under. Certain files or entire directories may not be covered by this
 * dual license, but are subject to licenses compatible to both LGPL and EPL.
 * License exceptions are explicitly declared in all relevant files or in a
 * LICENSE file in the relevant directories.
 *
 * Maltcms is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. Please consult the relevant license documentation
 * for details.
 */
package maltcms.commands.distances.dtwng;

import java.awt.geom.Area;

/**
 * AlignmentFactory class.
 *
 * @author Nils Hoffmann
 * 
 */
public class AlignmentFactory {

    /**
     * Returns a new DTW instance, configured by ObjectFactory.
     *
     * @return a {@link maltcms.commands.distances.dtwng.IAlignment} object.
     */
    public IAlignment getDTWInstance() {
        IAlignment ia = new DTW();
        return ia;
    }

    /**
     * getDTWInstance.
     *
     * @param iof a {@link maltcms.commands.distances.dtwng.IOptimizationFunction} object.
     * @param tfvo a {@link maltcms.commands.distances.dtwng.TwoFeatureVectorOperation} object.
     * @param constraints a {@link java.awt.geom.Area} object.
     * @return a {@link maltcms.commands.distances.dtwng.IAlignment} object.
     */
    public IAlignment getDTWInstance(IOptimizationFunction iof,
            TwoFeatureVectorOperation tfvo, Area constraints) {
        IAlignment ia = getDTWInstance();
        ia.setOptimizationFunction(iof);
        ia.setPairwiseFeatureVectorOperation(tfvo);
        ia.setConstraints(constraints);
        return ia;
    }
}