Package edu.cmu.tetrad.sem

Class SemEstimator

java.lang.Object
edu.cmu.tetrad.sem.SemEstimator
All Implemented Interfaces:
TetradSerializable, Serializable
public final class SemEstimator extends Object implements TetradSerializable
Estimates a SemIm given a CovarianceMatrix and a SemPm. (A DataSet may be substituted for the CovarianceMatrix.)
Version:
$Id: $Id
Author:
Frank Wimberly, Ricardo Silva, Don Crimbchin, josephramsey
See Also:

  • Constructor Details

    • SemEstimator

      public SemEstimator(DataSet dataSet, SemPm semPm)
      Constructs a Sem Estimator that does default estimation.
      Parameters:
      dataSet - a DataSet, all of whose variables are contained in the given SemPm. (They are identified by name.)
      semPm - a SemPm specifying the graph and parameterization for the model.

    • SemEstimator

      public SemEstimator(ICovarianceMatrix covMatrix, SemPm semPm)
      Constructs a SEM estimator that does default estimation.
      Parameters:
      covMatrix - a CovarianceMatrix, all of whose variables are contained in the given SemPm. (They are identified by name.)
      semPm - a SemPm specifying the graph and parameterization for the model.

    • SemEstimator

      public SemEstimator(DataSet dataSet, SemPm semPm, SemOptimizer semOptimizer)
      Constructs a new SemEstimator that uses the specified optimizer.
      Parameters:
      dataSet - a DataSet, all of whose variables are contained in the given SemPm. (They are identified by name.)
      semPm - a SemPm specifying the graph and parameterization for the model.
      semOptimizer - the optimizer that optimizes the Sem.

    • SemEstimator

      public SemEstimator(ICovarianceMatrix covMatrix, SemPm semPm, SemOptimizer semOptimizer)
      Constructs a new SemEstimator that uses the specified optimizer.
      Parameters:
      covMatrix - a covariance matrix, all of whose variables are contained in the given SemPm. (They are identified by name.)
      semPm - a SemPm specifying the graph and parameterization for the model.
      semOptimizer - the optimizer that optimizes the Sem.

  • Method Details

    • serializableInstance

      public static SemEstimator serializableInstance()
      Generates a simple exemplar of this class to test serialization.
      Returns:
      a SemEstimator object

    • estimate

      public SemIm estimate()
      Runs the estimator on the data and SemPm passed in through the constructor.
      Returns:
      a SemIm object

    • getEstimatedSem

      public SemIm getEstimatedSem()

      Getter for the field estimatedSem.

      Returns:
      the estimated SemIm. If the estimate method has not yet been called, null is returned.

    • getDataSet

      public DataSet getDataSet()

      Getter for the field dataSet.

      Returns:
      a DataSet object

    • getSemPm

      public SemPm getSemPm()

      Getter for the field semPm.

      Returns:
      a SemPm object

    • getCovMatrix

      public ICovarianceMatrix getCovMatrix()

      Getter for the field covMatrix.

      Returns:
      a ICovarianceMatrix object

    • setSemOptimizer

      public void setSemOptimizer(SemOptimizer semOptimizer)

      Setter for the field semOptimizer.

      Parameters:
      semOptimizer - a SemOptimizer object

    • toString

      public String toString()

      toString.

      Overrides:
      toString in class Object
      Returns:
      a string representation of the Sem.

    • setScoreType

      public void setScoreType(ScoreType scoreType)

      Setter for the field scoreType.

      Parameters:
      scoreType - a ScoreType object

    • setNumRestarts

      public void setNumRestarts(int numRestarts)

      Setter for the field numRestarts.

      Parameters:
      numRestarts - a int