Package edu.cmu.tetrad.algcomparison.algorithm.multi

Class Images

java.lang.Object
edu.cmu.tetrad.algcomparison.algorithm.multi.Images
All Implemented Interfaces:
Algorithm, MultiDataSetAlgorithm, HasKnowledge, HasParameters, UsesScoreWrapper, TetradSerializable, Serializable
@Algorithm(name="IMaGES", command="images", algoType=forbid_latent_common_causes, dataType=All) @Bootstrapping public class Images extends Object implements MultiDataSetAlgorithm, HasKnowledge, UsesScoreWrapper
Wraps the IMaGES 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:
josephramsey
See Also:

  • Constructor Details

    • Images

      public Images(ScoreWrapper score)

      Constructor for Images.

      Parameters:
      score - a ScoreWrapper object

    • Images

      public Images()

      Constructor for Images.

  • Method Details

    • search

      public Graph search(List<DataModel> dataSets, Parameters parameters)
      Searches for a graph using the given data sets and parameters.
      Specified by:
      search in interface MultiDataSetAlgorithm
      Parameters:
      dataSets - The data sets to search on.
      parameters - The parameters for the search.
      Returns:
      The resulting graph.
      Throws:
      IllegalArgumentException - If the meta option is unrecognized.

    • search

      public Graph search(DataModel dataSet, Parameters parameters)
      Searches for a graph using the given data set and parameters.
      Specified by:
      search in interface Algorithm
      Parameters:
      dataSet - The data set to run the search on.
      parameters - The parameters of the search.
      Returns:
      The resulting graph.

    • getComparisonGraph

      public Graph getComparisonGraph(Graph graph)
      Returns a comparison graph based on the true directed graph, if there is one.
      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 the description of this method.
      Specified by:
      getDescription in interface Algorithm
      Returns:
      the description of this method.

    • getDataType

      public DataType getDataType()
      Returns the type of the data set.
      Specified by:
      getDataType in interface Algorithm
      Returns:
      the type of the data set

    • getParameters

      public List<String> getParameters()
      Retrieves the list of parameters required for the algorithm.
      Specified by:
      getParameters in interface HasParameters
      Returns:
      The list of parameters required for the algorithm.

    • getKnowledge

      public Knowledge getKnowledge()
      Retrieves the knowledge of the current instance.
      Specified by:
      getKnowledge in interface HasKnowledge
      Returns:
      The knowledge of the current instance.

    • setKnowledge

      public void setKnowledge(Knowledge knowledge)
      Sets the knowledge object for this instance.
      Specified by:
      setKnowledge in interface HasKnowledge
      Parameters:
      knowledge - The knowledge object to be set. Cannot be null.

    • getScoreWrapper

      public ScoreWrapper getScoreWrapper()
      Retrieves the score wrapper object.
      Specified by:
      getScoreWrapper in interface UsesScoreWrapper
      Returns:
      The score wrapper object.

    • setScoreWrapper

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

    • setIndTestWrapper

      public void setIndTestWrapper(IndependenceWrapper test)
      Sets the IndependenceWrapper for this algorithm.
      Specified by:
      setIndTestWrapper in interface MultiDataSetAlgorithm
      Parameters:
      test - The IndependenceWrapper object to be set. Cannot be null.