Package edu.cmu.tetrad.algcomparison.algorithm.oracle.pag

Class SvarGfci

java.lang.Object
edu.cmu.tetrad.algcomparison.algorithm.AbstractBootstrapAlgorithm
edu.cmu.tetrad.algcomparison.algorithm.oracle.pag.SvarGfci
All Implemented Interfaces:
Algorithm, ReturnsBootstrapGraphs, TakesCovarianceMatrix, HasKnowledge, HasParameters, TakesIndependenceWrapper, UsesScoreWrapper, TetradSerializable, Serializable
@Algorithm(name="SvarGFCI", command="svar-gfci", algoType=allow_latent_common_causes) @TimeSeries @Bootstrapping public class SvarGfci extends AbstractBootstrapAlgorithm implements Algorithm, HasKnowledge, TakesIndependenceWrapper, UsesScoreWrapper, ReturnsBootstrapGraphs, TakesCovarianceMatrix
SvarGfci class is an implementation of the SVAR GFCI algorithm. It is used to learn causal relationships from time series data.
See Also:

  • Constructor Details

  • Method Details

    • runSearch

      public Graph runSearch(DataModel dataModel, Parameters parameters)
      Runs a search algorithm on the given data set using the specified parameters.
      Parameters:
      dataModel - the data set containing the variables to search over
      parameters - the parameters specifying the search configuration
      Returns:
      the resulting graph representing the discovered relationships

    • getComparisonGraph

      public Graph getComparisonGraph(Graph graph)
      Returns a comparison graph based on the given true directed graph.
      Specified by:
      getComparisonGraph in interface Algorithm
      Parameters:
      graph - The true directed graph, if there is one.
      Returns:
      The comparison graph.

    • getDescription

      public String getDescription()
      Returns a description of this method.
      Specified by:
      getDescription in interface Algorithm
      Returns:
      The description of this method.

    • getDataType

      public DataType getDataType()
      Returns the data type that this method requires, whether continuous, discrete, or mixed.
      Specified by:
      getDataType in interface Algorithm
      Returns:
      The data type required by this method.

    • getParameters

      public List<String> getParameters()
      Returns the list of parameters required by this method. The parameters include: - FAITHFULNESS_ASSUMED - MAX_INDEGREE - TIME_LAG - VERBOSE
      Specified by:
      getParameters in interface HasParameters
      Returns:
      the list of parameters required by this method

    • getKnowledge

      public Knowledge getKnowledge()
      Returns the knowledge associated with this object.
      Specified by:
      getKnowledge in interface HasKnowledge
      Returns:
      The knowledge object.

    • setKnowledge

      public void setKnowledge(Knowledge knowledge)
      Sets the knowledge associated with this object.
      Specified by:
      setKnowledge in interface HasKnowledge
      Parameters:
      knowledge - the knowledge object to set

    • getIndependenceWrapper

      public IndependenceWrapper getIndependenceWrapper()
      Retrieves the IndependenceWrapper object associated with this algorithm.
      Specified by:
      getIndependenceWrapper in interface TakesIndependenceWrapper
      Returns:
      The IndependenceWrapper object.

    • setIndependenceWrapper

      public void setIndependenceWrapper(IndependenceWrapper test)
      Sets the independence wrapper for the algorithm.
      Specified by:
      setIndependenceWrapper in interface TakesIndependenceWrapper
      Parameters:
      test - the independence wrapper to set

    • getScoreWrapper

      public ScoreWrapper getScoreWrapper()
      Retrieves the ScoreWrapper object associated with this algorithm.
      Specified by:
      getScoreWrapper in interface UsesScoreWrapper
      Returns:
      The ScoreWrapper object.

    • setScoreWrapper

      public void setScoreWrapper(ScoreWrapper score)
      Sets the score wrapper for the algorithm.
      Specified by:
      setScoreWrapper in interface UsesScoreWrapper
      Parameters:
      score - the score wrapper to set