edu.cmu.tetradapp.model.GeneralizedSemEstimatorWrapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tetrad-gui Show documentation
The newest version!
///////////////////////////////////////////////////////////////////////////////
// For information as to what this class does, see the Javadoc, below.       //
// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,       //
// 2007, 2008, 2009, 2010, 2014, 2015, 2022 by Peter Spirtes, Richard        //
// Scheines, Joseph Ramsey, and Clark Glymour.                               //
//                                                                           //
// This program is free software; you can redistribute it and/or modify      //
// it under the terms of the GNU General Public License as published by      //
// the Free Software Foundation; either version 2 of the License, or         //
// (at your option) any later version.                                       //
//                                                                           //
// This program 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.  See the             //
// GNU General Public License for more details.                              //
//                                                                           //
// You should have received a copy of the GNU General Public License         //
// along with this program; if not, write to the Free Software               //
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA //
///////////////////////////////////////////////////////////////////////////////

package edu.cmu.tetradapp.model;

import edu.cmu.tetrad.data.DataSet;
import edu.cmu.tetrad.graph.Graph;
import edu.cmu.tetrad.graph.GraphNode;
import edu.cmu.tetrad.graph.Node;
import edu.cmu.tetrad.sem.GeneralizedSemEstimator;
import edu.cmu.tetrad.sem.GeneralizedSemIm;
import edu.cmu.tetrad.sem.GeneralizedSemPm;
import edu.cmu.tetrad.util.Parameters;
import edu.cmu.tetrad.util.TetradLogger;
import edu.cmu.tetradapp.session.SessionModel;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serial;
import java.util.List;


/**
 * Wraps a Bayes Pm for use in the Tetrad application.
 *
 * @author josephramsey
 * @version $Id: $Id
 */
public class GeneralizedSemEstimatorWrapper implements SessionModel, GraphSource {
    @Serial
    private static final long serialVersionUID = 23L;

    /**
     * The data model.
     */
    private final DataSet data;

    /**
     * The name of the model.
     */
    private String name;

    /**
     * The wrapped SemPm.
     */
    private GeneralizedSemPm semPm;
    /**
     * True just in case errors should be shown in the interface.
     */
    private boolean showErrors;

    /**
     * The estimated SEM IM.
     */
    private GeneralizedSemIm estIm;

    /**
     * The report.
     */
    private String report = "";

    //==============================CONSTRUCTORS==========================//

    public GeneralizedSemEstimatorWrapper(GeneralizedSemPmWrapper semPm, Simulation simulation, Parameters parameters) {
        this(semPm, new DataWrapper(simulation, parameters));
    }

    /**
     * Constructor for GeneralizedSemEstimatorWrapper.
     *
     * @param semPm a {@link edu.cmu.tetradapp.model.GeneralizedSemPmWrapper} object
     * @param data  a {@link edu.cmu.tetradapp.model.DataWrapper} object
     */
    public GeneralizedSemEstimatorWrapper(GeneralizedSemPmWrapper semPm, DataWrapper data) {
        if (semPm == null) {
            throw new NullPointerException("SEM PM must not be null.");
        }

        this.semPm = semPm.getSemPm();
        this.data = (DataSet) data.getSelectedDataModel();

        execute();
    }

    /**
     * serializableInstance.
     *
     * @return a {@link edu.cmu.tetrad.graph.Node} object
     */
    public static Node serializableInstance() {
        return new GraphNode("X");
    }

    /**
     * execute.
     */
    public void execute() {
        GeneralizedSemEstimator estimator = new GeneralizedSemEstimator();
        this.estIm = estimator.estimate(this.semPm, this.data);
        this.report = estimator.getReport();
    }


    //============================PUBLIC METHODS=========================//

    /**
     * getSemIm.
     *
     * @return a {@link edu.cmu.tetrad.sem.GeneralizedSemIm} object
     */
    public GeneralizedSemIm getSemIm() {
        return this.estIm;
    }

    /**
     * Writes the object to the specified ObjectOutputStream.
     *
     * @param out The ObjectOutputStream to write the object to.
     * @throws IOException If an I/O error occurs.
     */
    @Serial
    private void writeObject(ObjectOutputStream out) throws IOException {
        try {
            out.defaultWriteObject();
        } catch (IOException e) {
            TetradLogger.getInstance().log("Failed to serialize object: " + getClass().getCanonicalName()
                                           + ", " + e.getMessage());
            throw e;
        }
    }

    /**
     * Reads the object from the specified ObjectInputStream. This method is used during deserialization
     * to restore the state of the object.
     *
     * @param in The ObjectInputStream to read the object from.
     * @throws IOException            If an I/O error occurs.
     * @throws ClassNotFoundException If the class of the serialized object cannot be found.
     */
    @Serial
    private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
        try {
            in.defaultReadObject();
        } catch (IOException e) {
            TetradLogger.getInstance().log("Failed to deserialize object: " + getClass().getCanonicalName()
                                           + ", " + e.getMessage());
            throw e;
        }
    }

    /**
     * getGraph.
     *
     * @return a {@link edu.cmu.tetrad.graph.Graph} object
     */
    public Graph getGraph() {
        return this.semPm.getGraph();
    }

    /**
     * Getter for the field name.
     *
     * @return a {@link java.lang.String} object
     */
    public String getName() {
        return this.name;
    }

    /**
     * {@inheritDoc}
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * isShowErrors.
     *
     * @return a boolean
     */
    public boolean isShowErrors() {
        return this.showErrors;
    }

    /**
     * Setter for the field showErrors.
     *
     * @param showErrors a boolean
     */
    public void setShowErrors(boolean showErrors) {
        this.showErrors = showErrors;
    }

    //======================= Private methods ====================//

    private void log(GeneralizedSemIm im) {
        TetradLogger.getInstance().log("Generalized SEM IM");
        String message = im.toString();
        TetradLogger.getInstance().log(message);
    }

    /**
     * getSourceGraph.
     *
     * @return a {@link edu.cmu.tetrad.graph.Graph} object
     */
    public Graph getSourceGraph() {
        return getGraph();
    }

    /**
     * getResultGraph.
     *
     * @return a {@link edu.cmu.tetrad.graph.Graph} object
     */
    public Graph getResultGraph() {
        return getGraph();
    }

    /**
     * getVariableNames.
     *
     * @return a {@link java.util.List} object
     */
    public List getVariableNames() {
        return getGraph().getNodeNames();
    }

    /**
     * getVariables.
     *
     * @return a {@link java.util.List} object
     */
    public List getVariables() {
        return getGraph().getNodes();
    }


    /**
     * The wrapped SemPm.
     *
     * @return a {@link edu.cmu.tetrad.sem.GeneralizedSemPm} object
     */
    public GeneralizedSemPm getSemPm() {
        return this.semPm;
    }

    /**
     * Setter for the field semPm.
     *
     * @param semPm a {@link edu.cmu.tetrad.sem.GeneralizedSemPm} object
     */
    public void setSemPm(GeneralizedSemPm semPm) {
        this.semPm = semPm;
    }

    /**
     * Getter for the field report.
     *
     * @return a {@link java.lang.String} object
     */
    public String getReport() {
        return this.report;
    }
}