Skip to content

CLASS ndi.pipeline

  TODO
  1. Get a calculation type list
  2. Pipeline edit & run button (edit: ndi.calculator.graphical_edit_calculator, waiting for updates)

Superclasses

none

Properties

none

Methods

Method Description
calculationsToChar
edit create and control a GUI to graphically edit a PIPELINE EDITOR instance
getCalcFromPipeline
getPipelines
pipeline TODO
pipelineListToChar
setDefaultCalc

Methods help

calculationsToChar - **

ndi.pipeline.calculationsToChar - read names of a CALCLIST as a list of strings

  CALCLISTCHAR = ndi.pipeline.calculationsToChar(CALCLIST)

  Input: 
    CALCLIST: a list of calculators
  Output: 
    CALCLISTCHAR: a list of strings, representing names of calculators in CALCLIST

edit - create and control a GUI to graphically edit a PIPELINE EDITOR instance

ndi.pipeline.edit (...)

  Creates and controls a graphical user interface for creating an instance of
  an pipeline.editor object.

  Usage by the user:

    S = []; % use an empty session for now
    ndi.pipeline.edit('command','new','pipelinePath',fullfile(userpath,'tools','NDI-matlab','+ndi','+test','+pipeline','test_pipeline'),'session',S);

getCalcFromPipeline - **

ndi.pipeline.getCalcFromPipeline - read a CALCLIST from PIPELINELIST

  CALCLIST = ndi.pipeline.getCalcFromPipeline(PIPELINELIST, PIPELINE_NAME)

  Input: 
    PIPELINELIST: a list of pipelines
    PIPELINE_NAME: a name string of a specific pipeline in this pipeline list
  Output: 
    CALCLIST: a list of calculators

getPipelines - **

ndi.pipeline.getPipelines - read a PIPELINE_LIST from directory READ_DIR

  PIPELINELIST = ndi.pipeline.getPipelines(READ_DIR)

  Input: 
    READ_DIR: a directory where the pipelines are stored as a PIPELINE_LIST
  Output: 
    PIPELINELIST: a list of pipelines

pipeline - TODO

1. Get a calculation type list
  2. Pipeline edit & run button (edit: ndi.calculator.graphical_edit_calculator, waiting for updates)

    Documentation for ndi.pipeline/pipeline
       doc ndi.pipeline

pipelineListToChar - **

ndi.pipeline.pipelineListToChar - read names of a PIPELINELIST as a list of strings

  PIPELINELISTCHAR = ndi.pipeline.pipelineListToChar(PIPELINELIST)

  Input: 
    PIPELINELIST: a list of pipelines
  Output: 
    PIPELINELISTCHAR: a list of strings, representing names of pipelines in PIPELINELIST

setDefaultCalc - **

ndi.pipeline.setDefaultCalc - set default parameters for a new calculator

  NEWCALC = ndi.pipeline.setDefaultCalc(CALCULATOR, NAME)

  Input
    CALCULATOR: a type of calculator (EXAMPLE: ndi.calc.stimulus.tuningcurve)
    NAME: a name string of calculator
  Output: 
    NEWCALC: a new calculator created by this function