-
Notifications
You must be signed in to change notification settings - Fork 122
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add HDFDescriptor class that will describe HDF files.
The checks for the headers at the start of HDF4 & HDF5 files have been put in a static isHDF member to encapsulate the details about checking for a HDF file and make it reusable. It will not retain an open file handle to the file so does not inherit from the standard FileDescriptor. Refs #7263
- Loading branch information
1 parent
79e6051
commit 6568320
Showing
4 changed files
with
391 additions
and
0 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
91 changes: 91 additions & 0 deletions
91
Code/Mantid/Framework/Kernel/inc/MantidKernel/HDFDescriptor.h
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,91 @@ | ||
#ifndef MANTID_KERNEL_HIERARCHICALFILEDESCRIPTOR_H_ | ||
#define MANTID_KERNEL_HIERARCHICALFILEDESCRIPTOR_H_ | ||
|
||
#include "MantidKernel/ClassMacros.h" | ||
#include "MantidKernel/DllConfig.h" | ||
|
||
#include <string> | ||
|
||
namespace Mantid | ||
{ | ||
namespace Kernel | ||
{ | ||
|
||
/** | ||
Defines a wrapper around a file whose internal structure is stored in a hierarchy, e.g NeXus. | ||
On construction the simple details about the layout of the file are cached for faster querying later. | ||
Copyright © 2013 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory | ||
This file is part of Mantid. | ||
Mantid is free software; you can redistribute it and/or modify | ||
it under the terms of the GNU General Public License as published by | ||
the Free Software Foundation; either version 3 of the License, or | ||
(at your option) any later version. | ||
Mantid is distributed in the hope that it will be useful, | ||
but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
GNU General Public License for more details. | ||
You should have received a copy of the GNU General Public License | ||
along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
File change history is stored at: <https://github.com/mantidproject/mantid> | ||
Code Documentation is available at: <http://doxygen.mantidproject.org> | ||
*/ | ||
class MANTID_KERNEL_DLL HDFDescriptor | ||
{ | ||
public: | ||
/// Enumerate HDF possible versions | ||
enum Version { Version4, Version5, AnyVersion }; | ||
|
||
static const size_t HDFMagicSize; | ||
/// HDF cookie that is stored in the first 4 bytes of the file. | ||
static const unsigned char HDFMagic[4]; | ||
/// Size of HDF5 signature | ||
static size_t HDF5SignatureSize; | ||
/// signature identifying a HDF5 file. | ||
static const unsigned char HDF5Signature[8]; | ||
|
||
/// Returns true if the file is considered to store data in a hierarchy | ||
static bool isHDF(const std::string & filename, const Version version = AnyVersion); | ||
|
||
public: | ||
/// Constructor accepting a filename | ||
HDFDescriptor(const std::string & filename); | ||
/** | ||
* Access the filename | ||
* @returns A reference to a const string containing the filename | ||
*/ | ||
inline const std::string & filename() const { return m_filename; } | ||
/** | ||
* Access the file extension. Defined as the string after and including the last period character | ||
* @returns A reference to a const string containing the file extension | ||
*/ | ||
inline const std::string & extension() const { return m_extension; } | ||
|
||
/// Query if a path exists | ||
bool pathExists(const std::string&) const; | ||
|
||
private: | ||
DISABLE_DEFAULT_CONSTRUCT(HDFDescriptor); | ||
DISABLE_COPY_AND_ASSIGN(HDFDescriptor); | ||
|
||
/// Initialize object with filename | ||
void initialize(const std::string& filename); | ||
|
||
|
||
/// Full filename | ||
std::string m_filename; | ||
/// Extension | ||
std::string m_extension; | ||
}; | ||
|
||
|
||
} // namespace Kernel | ||
} // namespace Mantid | ||
|
||
#endif /* MANTID_KERNEL_HIERARCHICALFILEDESCRIPTOR_H_ */ |
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,161 @@ | ||
#include "MantidKernel/HDFDescriptor.h" | ||
#include "MantidKernel/Exception.h" | ||
|
||
#include <nexus/NeXusFile.hpp> | ||
#include <nexus/NeXusException.hpp> | ||
|
||
#include <Poco/File.h> | ||
#include <Poco/Path.h> | ||
|
||
#include <cstring> | ||
|
||
namespace Mantid | ||
{ | ||
namespace Kernel | ||
{ | ||
//--------------------------------------------------------------------------------------------------------------------------- | ||
// static HDFDescriptor constants | ||
//--------------------------------------------------------------------------------------------------------------------------- | ||
/// Size of HDF magic number | ||
const size_t HDFDescriptor::HDFMagicSize = 4; | ||
/// HDF cookie that is stored in the first 4 bytes of the file. | ||
const unsigned char HDFDescriptor::HDFMagic[4] = {'\016','\003','\023','\001'}; // From HDF4::hfile.h | ||
|
||
/// Size of HDF5 signature | ||
size_t HDFDescriptor::HDF5SignatureSize = 8; | ||
/// signature identifying a HDF5 file. | ||
const unsigned char HDFDescriptor::HDF5Signature[8] = { 137, 'H', 'D', 'F', '\r', '\n', '\032', '\n' }; | ||
|
||
namespace | ||
{ | ||
//--------------------------------------------------------------------------------------------------------------------------- | ||
// Anonymous helper methods to use isHDF methods to use an open file handle | ||
//--------------------------------------------------------------------------------------------------------------------------- | ||
|
||
/** | ||
* Currently simply checks for the HDF signatures and returns true if one of them is found | ||
* @param fileHandle A file handled opened and pointing at the start of the file. On return the | ||
* fileHandle is left at the start of the file | ||
* @param version One of the HDFDescriptor::Version enumerations specifying the required version | ||
* @return True if the file is considered hierarchical, false otherwise | ||
*/ | ||
bool isHDFHandle(FILE *fileHandle, HDFDescriptor::Version version) | ||
{ | ||
if(!fileHandle) throw std::invalid_argument("HierarchicalFileDescriptor::isHierarchical - Invalid file handle"); | ||
|
||
bool result(false); | ||
|
||
// HDF4 check requires 4 bytes, HDF5 check requires 8 bytes | ||
// Use same buffer and waste a few bytes if only checking HDF4 | ||
unsigned char buffer[8] = {'0','0','0','0','0','0','0','0'}; | ||
std::fread(static_cast<void*>(&buffer), sizeof(unsigned char), HDFDescriptor::HDF5SignatureSize, fileHandle); | ||
// Number of bytes read doesn't matter as if it is not enough then the memory simply won't match | ||
// as the buffer has been "zeroed" | ||
if(version == HDFDescriptor::Version5 || version == HDFDescriptor::AnyVersion ) | ||
{ | ||
result = (std::memcmp(&buffer, &HDFDescriptor::HDF5Signature, HDFDescriptor::HDF5SignatureSize) == 0); | ||
} | ||
if(!result && (version == HDFDescriptor::Version4 || version == HDFDescriptor::AnyVersion) ) | ||
{ | ||
result = (std::memcmp(&buffer, &HDFDescriptor::HDFMagic, HDFDescriptor::HDFMagicSize) == 0); | ||
} | ||
|
||
// Return file stream to start of file | ||
std::rewind(fileHandle); | ||
return result; | ||
} | ||
} | ||
|
||
//--------------------------------------------------------------------------------------------------------------------------- | ||
// static HDFDescriptor methods | ||
//--------------------------------------------------------------------------------------------------------------------------- | ||
|
||
/** | ||
* Checks for the HDF signatures and returns true if one of them is found | ||
* @param filename A string filename to check | ||
* @param version One of the HDFDescriptor::Version enumerations specifying the required version | ||
* @return True if the file is considered hierarchical, false otherwise | ||
*/ | ||
bool HDFDescriptor::isHDF(const std::string & filename, const Version version) | ||
{ | ||
FILE *fd = fopen(filename.c_str(), "rb"); | ||
if(!fd) | ||
{ | ||
throw std::invalid_argument("HierarchicalFileDescriptor::isHierarchical - Unable to open file '" + filename + "'"); | ||
} | ||
const bool result = isHDFHandle(fd, version); // use anonymous helper | ||
fclose(fd); | ||
return result; | ||
} | ||
|
||
//--------------------------------------------------------------------------------------------------------------------------- | ||
// HDFDescriptor public methods | ||
//--------------------------------------------------------------------------------------------------------------------------- | ||
/** | ||
* Constructs the wrapper | ||
* @param filename A string pointing to an existing file | ||
* @throws std::invalid_argument if the file is not identified to be hierarchical. This currently | ||
* involves simply checking for the signature if a HDF file at the start of the file | ||
*/ | ||
HDFDescriptor::HDFDescriptor(const std::string & filename) | ||
: m_filename(), m_extension() | ||
{ | ||
if(filename.empty()) | ||
{ | ||
throw std::invalid_argument("HDFDescriptor() - Empty filename '" + filename + "'"); | ||
} | ||
if(!Poco::File(filename).exists()) | ||
{ | ||
throw std::invalid_argument("HDFDescriptor() - File '" + filename + "' does not exist"); | ||
} | ||
initialize(filename); | ||
} | ||
|
||
/** | ||
* @param path A string giving a path using UNIX-style path separators (/), e.g. /raw_data_1, /entry/bank1 | ||
* @return True if the path exists in the file, false otherwise | ||
*/ | ||
bool HDFDescriptor::pathExists(const std::string& path) const | ||
{ | ||
return true; | ||
} | ||
|
||
//--------------------------------------------------------------------------------------------------------------------------- | ||
// HDFDescriptor private methods | ||
//--------------------------------------------------------------------------------------------------------------------------- | ||
|
||
/** | ||
* Creates the internal cached structure of the file as a tree of nodes | ||
*/ | ||
void HDFDescriptor::initialize(const std::string& filename) | ||
{ | ||
m_filename = filename; | ||
m_extension = "." + Poco::Path(filename).getExtension(); | ||
|
||
try | ||
{ | ||
::NeXus::File file(this->filename()); | ||
} | ||
catch(::NeXus::Exception &) | ||
{ | ||
throw std::invalid_argument("HDFDescriptor::initialize - File '" + filename + "' does not look like a HDF file."); | ||
} | ||
// // Root node has no type and is named "/" | ||
// m_root->name = "/"; | ||
// | ||
// addChildren(file, "/", m_root); | ||
// | ||
|
||
// auto rootEntries = file.getEntries(); | ||
// for(auto it = rootEntries.begin(); rootEntries.end(); ++it) | ||
// { | ||
// auto node = boost::make_shared<Node>(); | ||
// node->name = it->first; | ||
// node->type = it->second; | ||
// m_roots.insert(std::make_pair(it->first, node)); | ||
// } | ||
} | ||
|
||
|
||
} // namespace Kernel | ||
} // namespace Mantid |
Oops, something went wrong.