Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #37187 from mantidproject/37013-new-idaaas-data-ca…
…che-index New IDAaaS data cache index file loading
- Loading branch information
Showing
14 changed files
with
457 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| // Mantid Repository : https://github.com/mantidproject/mantid | ||
| // | ||
| // Copyright © 2024 ISIS Rutherford Appleton Laboratory UKRI, | ||
| // NScD Oak Ridge National Laboratory, European Spallation Source, | ||
| // Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS | ||
| // SPDX - License - Identifier: GPL - 3.0 + | ||
| #pragma once | ||
|
|
||
| //---------------------------------------------------------------------- | ||
| // Includes | ||
| //---------------------------------------------------------------------- | ||
| #include "MantidAPI/DllConfig.h" | ||
| #include <string> | ||
|
|
||
| namespace Mantid { | ||
| namespace API { | ||
|
|
||
| class MANTID_API_DLL ISISInstrumentDataCache { | ||
| public: | ||
| ISISInstrumentDataCache(const std::string &path) : m_dataCachePath(path) {} | ||
| std::string getFileParentDirectoryPath(const std::string &filename) const; | ||
|
|
||
| private: | ||
| std::pair<std::string, std::string> validateInstrumentAndNumber(const std::string &filename) const; | ||
| std::pair<std::string, std::string> splitIntoInstrumentAndNumber(const std::string &filename) const; | ||
| std::string m_dataCachePath; | ||
| }; | ||
| } // namespace API | ||
| } // namespace Mantid |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| #include "MantidAPI/ISISInstrumentDataCache.h" | ||
| #include "MantidAPI/FileFinder.h" | ||
| #include "MantidKernel/ConfigService.h" | ||
| #include "MantidKernel/Exception.h" | ||
| #include "MantidKernel/InstrumentInfo.h" | ||
| #include "MantidKernel/Logger.h" | ||
| #include <fstream> | ||
| #include <json/reader.h> | ||
|
|
||
| namespace { | ||
| Mantid::Kernel::Logger g_log("ISISInstrumentDataCache"); | ||
| } // namespace | ||
|
|
||
| std::string Mantid::API::ISISInstrumentDataCache::getFileParentDirectoryPath(const std::string &fileName) const { | ||
| g_log.debug() << "ISISInstrumentDataCache::getFileParentDirectoryPath(" << fileName << ")" << std::endl; | ||
|
|
||
| auto [instrName, runNumber] = validateInstrumentAndNumber(fileName); | ||
|
|
||
| // Open index json file | ||
| std::string jsonPath = m_dataCachePath + "/" + instrName + "/" + instrName + "_index.json"; | ||
| std::ifstream ifstrm{jsonPath}; | ||
| if (!ifstrm) { | ||
| throw std::invalid_argument("Could not open index file: " + jsonPath); | ||
| } | ||
|
|
||
| // Read directory path from json file | ||
| Json::Value json; | ||
| ifstrm >> json; | ||
| std::string relativePath = json[runNumber].asString(); | ||
|
|
||
| if (relativePath.empty()) { | ||
| throw std::invalid_argument("Run number " + runNumber + " not found for instrument " + instrName + "."); | ||
| } | ||
|
|
||
| std::string dirPath = m_dataCachePath + "/" + instrName + "/" + relativePath; | ||
|
|
||
| g_log.debug() << "Opened instrument index file: " << jsonPath << ". Found path to search: " << dirPath << "." | ||
| << std::endl; | ||
| return dirPath; | ||
| } | ||
|
|
||
| std::pair<std::string, std::string> | ||
| Mantid::API::ISISInstrumentDataCache::validateInstrumentAndNumber(const std::string &fileName) const { | ||
|
|
||
| // Check if suffix eg. -add is present in filename | ||
| std::string fileNameCopy = fileName; | ||
| std::string suffix = FileFinder::Instance().extractAllowedSuffix(fileNameCopy); | ||
| if (!suffix.empty()) { | ||
| throw std::invalid_argument("Unsuported format: Suffix detected: " + suffix); | ||
| } | ||
|
|
||
| auto [instrName, runNumber] = splitIntoInstrumentAndNumber(fileName); | ||
|
|
||
| if (runNumber.empty() || !std::all_of(runNumber.begin(), runNumber.end(), ::isdigit)) { // Check run number | ||
| throw std::invalid_argument("Filename not in correct format."); | ||
| } | ||
| runNumber.erase(0, runNumber.find_first_not_of('0')); // Remove padding zeros | ||
|
|
||
| try { // Expand instrument name | ||
| instrName = FileFinder::Instance().getInstrument(instrName, false).name(); | ||
| } catch (const Kernel::Exception::NotFoundError &) { | ||
| throw std::invalid_argument("Instrument name not recognized."); | ||
| } | ||
|
|
||
| return std::pair(instrName, runNumber); | ||
| } | ||
|
|
||
| std::pair<std::string, std::string> | ||
| Mantid::API::ISISInstrumentDataCache::splitIntoInstrumentAndNumber(const std::string &fileName) const { | ||
|
|
||
| // Find the last non-digit as the instrument name can contain numbers | ||
| const auto itRev = std::find_if(fileName.rbegin(), fileName.rend(), std::not_fn(isdigit)); | ||
| const auto nChars = std::distance(itRev, fileName.rend()); | ||
| std::string runNumber = fileName.substr(nChars); | ||
|
|
||
| std::string fileNameUpperCase = fileName; | ||
| std::transform(fileNameUpperCase.begin(), fileNameUpperCase.end(), fileNameUpperCase.begin(), toupper); | ||
| std::string instrName = fileNameUpperCase.substr(0, nChars); | ||
|
|
||
| return std::pair(instrName, runNumber); | ||
| } |
Oops, something went wrong.