auviewer.api module

Python API for working with AUViewer.

auviewer.api.downsampleFile(filepath, destinationpath)

Downsamples an original file, placing the processed file in the destination folder. Raises an exception in case of error. :param filepath: path to the original file :param destinationpath: path to the destination folder :return: None

Parameters:

• filepath (str)

• destinationpath (str)

Return type:

bool

auviewer.api.getProject(id)

Returns the project with matching ID. :return: the project instance belonging to the id, or None if not found

Return type:

Project | None

auviewer.api.getProjects()

Returns loaded projects as a dict. :return: dict mapped from project ID to project instance of all loaded projects

Return type:

Dict[int, Project]

auviewer.api.getProjectsPayload(user_id)

Returns a list of project information accessible to a given user. :return: list of objects containing project information

Return type:

List[Dict]

auviewer.api.instantiatePool(pool)

auviewer.api.listAvailableProjects()

Returns list of available projects (ID, name, path) from the database. These projects are not necessarily loaded in memory (that is done using loadProjects() or loadProject(). :return:

Return type:

List[List[str]]

auviewer.api.listLoadedProjects()

Returns list of projects loaded in memory (ID, name, path). :return: list of lists

Return type:

List[List[str]]

auviewer.api.listUsers()

Returns list of users (ID, email, first name, last name) :return: list of lists

Return type:

List[List[str]]

auviewer.api.loadProject(id)

Load a project into memory. Returns the project instance if successful. :return: the project instance, or None

Return type:

Project | None

auviewer.api.loadProjects()

Load or reload projects into memory. If new projects are found on disk, they will be added to the database & loaded as well. Returns the same output as getProjects(). :return: dict mapped from project ID to project of all loaded projects

Return type:

Dict[int, Project]

auviewer.api.scaffoldProjectFolder(projDirPathObj)

Generate the baseline project folder contents as needed

auviewer.api.setDataPath(path, load_projects=False)

Loads a data path for use via Python (instead of as a web server). If the optional load_projects parameter is False, then projects must be loaded manually using loadProject() or loadProjects().

Return type:

None

auviewer.api.validateProjectFolder(projDirPathObj)

Raises an exception if the project folder is invalid