mlReleaseToolsIO.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------
#pragma once
 
// Local includes
#include "MLReleaseToolsSystem.h"
 
// ML includes
#include <mlModuleIncludes.h>
#include <mlAPI.h>
 
// Calculates transformation from one directory to another.
#include "mlDirectoryMatching.h"
 
#include <list>
 
ML_START_NAMESPACE
 
// Forward of internally used classes.
class MLImageFormat;
class ProgressLogger;
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
namespace ReleaseToolsIO {
 
  //--------------------------------
  // File suffix and type checks. 
  //--------------------------------
  MLRELEASE_TOOLS_EXPORT bool        isDICOMTiffPair(const std::string &oneFile, 
                                                     std::string *otherFile=nullptr, 
                                                     std::string *dcmFile=nullptr, 
                                                     std::string *tiffFile=nullptr);
 
  MLRELEASE_TOOLS_EXPORT bool        hasMLImageSuffix(const std::string &filePathWithName) ML_RETURN_VALUE_SHOULD_BE_USED;
 
  MLRELEASE_TOOLS_EXPORT bool        isFileOrSuffixInList(const std::string &fileNamePath,
                                                          const std::vector<std::string> sufList) ML_RETURN_VALUE_SHOULD_BE_USED;

  MLRELEASE_TOOLS_EXPORT std::string searchFileTypeInBinaryHeader(const std::string &fullFilePath) ML_RETURN_VALUE_SHOULD_BE_USED;
 
  
  //--------------------------------
  // Some simple path handling. 
  //--------------------------------
  MLRELEASE_TOOLS_EXPORT std::string buildRelativePath(bool               useRelativePaths, 
                                                       const std::string &fileRootDirPath, 
                                                       const std::string &fNamePath,
                                                       bool               allowBranchedSubDirs=false,
                                                       bool               allowMultiFrameHandles=false) ML_RETURN_VALUE_SHOULD_BE_USED;

  MLRELEASE_TOOLS_EXPORT std::string removeRedundantPathComponents(const std::string &pathAndFileNameStr) ML_RETURN_VALUE_SHOULD_BE_USED;

  MLRELEASE_TOOLS_EXPORT void removeRedundantPathComponents(const std::string &pathToSimplify, std::string &simplifiedPath);

  MLRELEASE_TOOLS_EXPORT void removeRedundantPathComponentsInPlace(std::string &pathToSimplify);

  MLRELEASE_TOOLS_EXPORT std::string buildAbsolutePath(bool               allowMakeAbsolute, 
                                                       const std::string &fileRootDirPath, 
                                                       const std::string &relativeFileNameStr,
                                                       bool               simplifyPaths=false,
                                                       bool               allowMultiFrameHandles=false) ML_RETURN_VALUE_SHOULD_BE_USED;
  
  MLRELEASE_TOOLS_EXPORT void buildAbsolutePath(bool               allowMakeAbsolute, 
                                                const std::string  fileRootDirPath, 
                                                const std::string &relativeFileNameStrIn,
                                                bool               simplifyPaths,
                                                bool               allowMultiFrameHandles,
                                                std::string       &relPathFileName);
  
  MLRELEASE_TOOLS_EXPORT std::string appendSingleSlash(const std::string &srcStr) ML_RETURN_VALUE_SHOULD_BE_USED;

  MLRELEASE_TOOLS_EXPORT std::vector<std::string> splitFilePath(const std::string &pathLikeString) ML_RETURN_VALUE_SHOULD_BE_USED;

  MLRELEASE_TOOLS_EXPORT void splitFilePath(const std::string &pathLikeString, std::vector<std::string> &retPath);

  MLRELEASE_TOOLS_EXPORT void splitPathAndName(std::string fullPathAndName,
                                               std::string &fPath,
                                               std::string &fName);

  MLRELEASE_TOOLS_EXPORT std::string substituteNonPathLikeChars(std::string strToCorrect) ML_RETURN_VALUE_SHOULD_BE_USED;
 
  
  //--------------------------------
  // Save/load tool functions.
  //--------------------------------
  MLRELEASE_TOOLS_EXPORT MLErrorCode loadStringFile(const std::string &strFileName, 
                                                    std::string       &readString) ML_RETURN_VALUE_SHOULD_BE_USED;

  MLRELEASE_TOOLS_EXPORT MLErrorCode reformatColorChannels(const std::vector<SubImage> &frameSubImgs,
                                                           MLint                       frameOffset,
                                                           SubImage                    &outSubImg,
                                                           size_t                      dimIdx,
                                                           bool                        isInterleaved,
                                                           MLint                       timeUnrollSteps) ML_RETURN_VALUE_SHOULD_BE_USED;
    
  MLRELEASE_TOOLS_EXPORT bool        scanDirectoriesForFiles(ProgressLogger                 *progressLogger,
                                                             const std::string              &sourceDir,
                                                             const std::vector<std::string> *suppressedFilesAndSuffixes,
                                                             bool                           recursively,
                                                             std::vector<std::string>       &resultFileVector,
                                                             std::vector<std::string>       *resultDirVector=nullptr,
                                                             bool                           returnRelativePaths=false,
                                                             bool                           alsoSuppressDirectories=false,
                                                             bool                           warnNoSourceSourceDir=false,
                                                             float                          progressMinimum=0.0,
                                                             float                          progressMaximum=1.0,
                                                             std::vector<std::string>      *checkForFileExtensions = nullptr,
                                                             bool                          *checkForFileExtensionsFound = nullptr);
  
  MLRELEASE_TOOLS_EXPORT MLErrorCode deleteListOfFiles(std::list<std::string> *fileNameList,
                                                       ProgressLogger         *progressLogger = nullptr);
 
};
 
ML_END_NAMESPACE