Class FaskVote

java.lang.Object
edu.cmu.tetrad.algcomparison.algorithm.multi.FaskVote
All Implemented Interfaces:
Algorithm, MultiDataSetAlgorithm, AcceptsKnowledge, HasParameters, TakesExternalGraph, TakesScoreWrapper, TetradSerializable, Serializable

Wraps the MultiFask algorithm for continuous variables.

Requires that the parameter 'randomSelectionSize' be set to indicate how many datasets should be taken at a time (randomly). This cannot given multiple values.

Version:
$Id: $Id
Author:
mglymour, josephramsey
See Also:
  • Constructor Details

    • FaskVote

      public FaskVote()

      Constructor for FaskVote.

    • FaskVote

      public FaskVote(ScoreWrapper score)

      Constructor for FaskVote.

      Parameters:
      score - a ScoreWrapper object
  • Method Details

    • search

      public Graph search(List<DataModel> dataSets, Parameters parameters) throws InterruptedException
      Runs the search.
      Specified by:
      search in interface MultiDataSetAlgorithm
      Parameters:
      dataSets - The data sets.
      parameters - The parameters.
      Returns:
      The graph.
      Throws:
      InterruptedException - if any.
    • search

      public Graph search(DataModel dataSet, Parameters parameters) throws InterruptedException
      Runs the search.
      Specified by:
      search in interface Algorithm
      Parameters:
      dataSet - The data set to run to the search on.
      parameters - The paramters of the search.
      Returns:
      The result graph.
      Throws:
      InterruptedException - if any.
    • getComparisonGraph

      public Graph getComparisonGraph(Graph graph)
      Returns that graph that the result should be compared to.
      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 short, one-line description of this algorithm. This will be printed in the report.
      Specified by:
      getDescription in interface Algorithm
      Returns:
      This description.
    • getDataType

      public DataType getDataType()
      Returns the data type that the search requires, whether continuous, discrete, or mixed.
      Specified by:
      getDataType in interface Algorithm
      Returns:
      This type.
    • getParameters

      public List<String> getParameters()
      Returns the list of parameter names that are used. These are looked up in ParamMap, so if they're not

      Returns the IMaGES parameters, minus OUTPUT_CPDAG (only adjacencies are used from the adjacency-stage graph), plus the adjacency-method parameters shared with FASK-Pool (FASK_POOL_ADJACENCY selects the adjacency search; ALPHA and DEPTH govern the FAS-style tests; THRESHOLD_B and the FastICA parameters govern the LiNG stage) and SKEW_EDGE_THRESHOLD, which the per-dataset FASK runs use.

      Specified by:
      getParameters in interface HasParameters
      Returns:
      Returns the list of parameter names that are used. These are looked up in ParamMap, so if they're not already defined they'll need to be defined there.
    • setExternalGraph

      public void setExternalGraph(Algorithm algorithm)

      setExternalGraph.

      Sets the algorithm supplying the external graph (in the GUI, the source graph of a parent graph box). Null is accepted: the external graph is optional for FASK-Vote, and without one the adjacency search selected by FASK_POOL_ADJACENCY runs as before.

      Specified by:
      setExternalGraph in interface TakesExternalGraph
      Parameters:
      algorithm - a Algorithm object
    • getKnowledge

      public Knowledge getKnowledge()
      Returns a knowledge object.
      Specified by:
      getKnowledge in interface AcceptsKnowledge
      Returns:
      a knowledge object.
    • setKnowledge

      public void setKnowledge(Knowledge knowledge)
      Sets a knowledge object.
      Specified by:
      setKnowledge in interface AcceptsKnowledge
      Parameters:
      knowledge - a knowledge object.
    • getScoreWrapper

      public ScoreWrapper getScoreWrapper()
      Returns the score wrapper.
      Specified by:
      getScoreWrapper in interface TakesScoreWrapper
      Returns:
      the score wrapper.
    • setScoreWrapper

      public void setScoreWrapper(ScoreWrapper score)
      Sets a score wrapper if not null.
      Specified by:
      setScoreWrapper in interface MultiDataSetAlgorithm
      Specified by:
      setScoreWrapper in interface TakesScoreWrapper
      Parameters:
      score - The wrapper