mlTools.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_TOOLS_H
#define ML_TOOLS_H
 

 
// ML-includes
#include "MLToolsSystem.h"
#include <mlModuleIncludes.h>
 
// BitImage class.
#include "mlBitImage.h"
 
// VirtualVolume class.
#include "mlVirtualVolume.h"
#include "mlTVirtualVolume.h"
 
// Geometric primitives.
#include "mlDisc.h"
#include "mlSphere.h"
 
// These are included from MLLinearAlgebra:
#include "mlLine.h"
#include "mlPlane.h"
#include "mlRotation.h"
 
// Additional fields.
#include "mlMultiFields.h"
 
ML_START_NAMESPACE
 
  //----------------------------------------------------------------------
  //----------------------------------------------------------------------
  class MLTOOLS_EXPORT Tools {
 
  public:
 
    //----------------------------------------------------------------------
    //----------------------------------------------------------------------
    static MLErrorCode scanInput(Module *op, MLint inIdx,
                                 MLdouble &stdMin,  MLdouble &stdMax,
                                 MLdouble &realMin, MLdouble &realMax);
 
    //----------------------------------------------------------------------
    //----------------------------------------------------------------------
    static MLErrorCode scanOutput(Module *op, MLint outIdx,
                                  MLdouble &stdMin,  MLdouble &stdMax,
                                  MLdouble &realMin, MLdouble &realMax);
 
    //----------------------------------------------------------------------
    //----------------------------------------------------------------------
    static MLErrorCode scanImage(PagedImage &img,
                                 MLdouble &stdMin,  MLdouble &stdMax,
                                 MLdouble &realMin, MLdouble &realMax,
                                 MLRequestProgressCB* progressCallback = nullptr,
                                 void* progressCallbackUserData = nullptr);
 
    //----------------------------------------------------------------------
    //----------------------------------------------------------------------
    static MLdouble calculateImageCheckSum(MLint outNum, Module &baseOp);
 
    //----------------------------------------------------------------------
    //----------------------------------------------------------------------
    static void separate(const std::string &stri, char sep, MLuint &num, std::string *&seps);
 
    //----------------------------------------------------------------------
    //----------------------------------------------------------------------
    static void replace(std::string& s, char sch, char rep);
 
    //----------------------------------------------------------------------
    //----------------------------------------------------------------------
    static std::string toHex(MLint64 val,
                             size_t  minNumDigitSpace = 1,
                             bool    useCapitals      = true,
                             bool    isSigned         = false);
 
    //----------------------------------------------------------------------
    //----------------------------------------------------------------------
    static std::string toString(MLint64 val,
                                size_t  minFieldSize     = 1,
                                int     align            = 1,
                                size_t  preSpaces        = 0,
                                size_t  postSpaces       = 0,
                                int     hex              = 0,
                                size_t  minNumDigitSpace = 8,
                                bool    useCapitals      = true);
 
    //-------------------------------------------------------------------------------
    //-------------------------------------------------------------------------------
    static bool appendToLog(const std::string &path, const std::string &logString);
 
    //-------------------------------------------------------------------------------
    //-------------------------------------------------------------------------------
    static bool clearLogFile(const std::string &path, bool remove=false);
 
    //-------------------------------------------------------------------------------
    //-------------------------------------------------------------------------------
#ifndef BUILD_WITHOUT_DICOM_DEPENDENCY
    static bool getVoxelValueRescale (MedicalImageProperties *img,
                                      double &slope, double &intercept, bool inverse = false);
#endif
    //-------------------------------------------------------------------------------
    //-------------------------------------------------------------------------------
    static std::string getTypeInformation(MLDataType dt);
 
    //----------------------------------------------------------------------------------
    //----------------------------------------------------------------------------------
 
    static void getLoopOrder(int dim,
                             const SubImageBox& calcBox,
                             std::vector<int>& loopOrder,
                             std::vector<int>& loopStart,
                             std::vector<int>& loopEnd);
 
  protected:
    static MLErrorCode scanImageWithGetTile(PagedImage &img,
                                            MLdouble &stdMin,  MLdouble &stdMax,
                                            MLdouble &realMin, MLdouble &realMax);

    static MLErrorCode scanImageWithProcessAllPages(PagedImage &img,
                                                    MLdouble &stdMin, MLdouble &stdMax,
                                                    MLdouble &realMin, MLdouble &realMax,
                                                    MLRequestProgressCB* progressCallback = nullptr,
                                                    void* progressCallbackUserData = nullptr);
 
    //----------------------------------------------------------------------
    //----------------------------------------------------------------------
    static std::string _separateBuffer(const std::string &str,
                                       const std::string &colSep,
                                       const std::string &lineSep);
 
  };
 
ML_END_NAMESPACE
 
#endif // __mlTools_H