\(\renewcommand\AA{\unicode{x212B}}\)

CatalogGetDataSets v1

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Obtains information of the datasets associated to a specific investigation.

See Also

CatalogGetDataFiles, CatalogDownloadDataFiles, CatalogLogin

Properties

Name	Direction	Type	Default	Description
InvestigationId	Input	string	Mandatory	ID of the selected investigation
Session	Input	string		The session information of the catalog to use.
OutputWorkspace	Output	TableWorkspace	Mandatory	The name of the workspace to store the results.

Description

This algorithm retrieves the information of the datasets associated to an investigation, and saves the results to a workspace.

Usage

Example - obtain the datasets for a given catalog investigation.

# Assumes you have logged in and stored the session information that is
# returned from CatalogLogin() inside the session variable.
datasets = CatalogGetDataSets(InvestigationId = '1193002', Session = session.getPropertyValue("Session"))

# Verify that we have any datafiles in the returned workspace.
print("The number of datasets for this investigation is: {}".format(len(datasets)))

Output:

The number of datafiles in this investigation is: 2

Categories: AlgorithmIndex | DataHandling\Catalog

Source

C++ header: CatalogGetDataSets.h

C++ source: CatalogGetDataSets.cpp