Skip to content

CLASS vlt.file.dirstruct

  vlt.file.dirstruct - Manage experimental data organized in directories

  This class is intended to manage experimental data. The data are organized
  into separate test directories, with each directory containing one epoch
  of recording. Each such directory has a file called 'reference.txt' that
  contains information about the signals that were acquired during that epoch.

  properties:
    pathname - The path to the directory being managed
    nameref_str - Struct array of name/ref pairs
    dir_str - Struct array of directories
    nameref_list - Struct array of name/ref pairs (simplified)
    dir_list - Cell array of directory names
    extractor_list - Struct array of extractors
    autoextractor_list - Struct array of auto-extractors
    active_dir_list - Cell array of active directories

  methods:
    dirstruct - Constructor
    update - Update the structure by scanning the directory
    getactive - Get active directories
    getallnamerefs - Get all name/ref pairs
    getalltests - Get all test directories
    getcells - Get cells from the experiment
    getexperimentfile - Get the experiment file path
    getextractors - Get extractors
    getnamerefs - Get name/refs for a specific test directory
    getpathname - Get the pathname
    getscratchdirectory - Get the scratch directory
    getstimscript - Get the stimscript
    getstimscripttimestruct - Get the stimscript time struct
    gettag - Get a tag
    gettagvalue - Get a tag value
    gettests - Get test directories for a name/ref pair
    hastag - Check if a tag exists
    isactive - Check if a directory is active
    neuter - Disable a directory
    newtestdir - Get a suitable new test directory name
    addtag - Add a tag
    removetag - Remove a tag
    saveexpvar - Save an experiment variable
    deleteexpvar - Delete an experiment variable
    setactive - Set active directories

Superclasses

none

Properties

Property Description
pathname
nameref_str
dir_str
nameref_list
dir_list
extractor_list
autoextractor_list
active_dir_list

Methods

Method Description
addtag Add a tag to a dirstruct directory
deleteexpvar Delete a variable from the experiment.mat file
dirstruct Constructor for vlt.file.dirstruct
disp Display the object
getactive Returns a cell list of the active directories
getallnamerefs Returns a structure with all name/ref pairs
getalltests Returns a list of all test directories
getcells Returns cells from the experiment
getexperimentfile Returns the experiment data filename
getextractors Get extractor info
getnamerefs Return namerefs from a given test directory
getpathname Returns the pathname
getscratchdirectory Returns the scratch directory path
getstimscript Gets the stimscript and MTI
getstimscripttimestruct Gets stimscript as stimscripttimestruct
gettag Get tag(s) from a directory
gettagvalue Get a value of a named tag
gettests Returns the list of directories for name/ref
hastag Returns TRUE if a given tagname is present
isactive Returns 1 if dirname is an active directory
neuter Disable directory without removing data
newtestdir Returns a suitable new test directory name
removetag Remove a tag from a dirstruct directory
saveexpvar Saves an experiment variable
setactive Sets the active directories
update Examines the path and updates all structures

Methods help

addtag - Add a tag to a dirstruct directory

deleteexpvar - Delete a variable from the experiment.mat file

dirstruct - Constructor for vlt.file.dirstruct

OBJ = vlt.file.dirstruct(PATHNAME)

  Returns a DIRSTRUCT object.

    Documentation for vlt.file.dirstruct/dirstruct
       doc vlt.file.dirstruct

disp - Display the object

getactive - Returns a cell list of the active directories

getallnamerefs - Returns a structure with all name/ref pairs

getalltests - Returns a list of all test directories

getcells - Returns cells from the experiment

getexperimentfile - Returns the experiment data filename

getextractors - Get extractor info

getnamerefs - Return namerefs from a given test directory

getpathname - Returns the pathname

getscratchdirectory - Returns the scratch directory path

getstimscript - Gets the stimscript and MTI

getstimscripttimestruct - Gets stimscript as stimscripttimestruct

gettag - Get tag(s) from a directory

gettagvalue - Get a value of a named tag

gettests - Returns the list of directories for name/ref

hastag - Returns TRUE if a given tagname is present

isactive - Returns 1 if dirname is an active directory

neuter - Disable directory without removing data

newtestdir - Returns a suitable new test directory name

removetag - Remove a tag from a dirstruct directory

saveexpvar - Saves an experiment variable

setactive - Sets the active directories

update - Examines the path and updates all structures

OBJ = UPDATE(OBJ)