Skip to content

scchannel

  scchannel constructor for sigTOOL channel object

  Example:
  obj=scchannel(s)
  returns an scschannel object given a sigTOOL channel structure as input

  scchannel object methods fall into 4 classes:
    convXXXXXXXX
    getXXXXXXXXX
    findXXXXXXXX
    and
    extractXXXXXXXX

  When the input is a time, or time range conv and get methods will convert
  the supplied start time(s) to the next time coincident with a sample on
  the channel.
  The find methods work similarly to the get methods, but there are
  restrictions on the supplied inputs.  Generally they require the supplied
  start or trigger times to fall within an epoch if data are episodic.
  If they do not, find methods will either:
            [1] return zero, typically e.g. when the expected returned
                    value is an epoch number
            or
            [2] throw an error e.g. when the expected value is an index.

  extractXXXXXX methods are higher level, convenience, methods used to
  extract data from the scchannel objects

  findMaxPreTime
  findVectorIndices
  getPhysicalTriggers
  getValidTriggers
  convIndex2Time

    Documentation for scchannel
       doc scchannel