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 based on the given data sets and parameters.
      Specified by:
      search in interface MultiDataSetAlgorithm
      Parameters:
      dataSets - The data sets to search on.
      parameters - The parameters to use for the search.
      Returns:
      A Graph object representing the search result.

    • search

      public Graph search(DataModel dataSet, Parameters parameters)
      Searches for a graph based on 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:
      A Graph object representing the search result.

    • getComparisonGraph

      public Graph getComparisonGraph(Graph graph)
      Retrieves the 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()
      Retrieves the description of the algorithm.
      Specified by:
      getDescription in interface Algorithm
      Returns:
      The description of the algorithm.

    • getDataType

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

    • getParameters

      public List<String> getParameters()
      Retrieves the parameters required by the Images algorithm.
      Specified by:
      getParameters in interface Algorithm
      Specified by:
      getParameters in interface HasParameters
      Returns:
      A list of strings representing the parameters required by the Images algorithm.

    • getKnowledge

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

    • setKnowledge

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

    • getScoreWrapper

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

    • setScoreWrapper

      public void setScoreWrapper(ScoreWrapper score)
      Sets the score wrapper associated with this instance.
      Specified by:
      setScoreWrapper in interface MultiDataSetAlgorithm
      Specified by:
      setScoreWrapper in interface UsesScoreWrapper
      Parameters:
      score - The ScoreWrapper object representing the score wrapper to be set.
      See Also:

    • setIndTestWrapper

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