mitkLevelWindow.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
#ifndef mitkLevelWindow_h
#define mitkLevelWindow_h
 
#include "mitkNumericTypes.h"
#include <MitkCoreExports.h>
#include <nlohmann/json_fwd.hpp>
 
namespace mitk
{
  class Image;
 
  class MITKCORE_EXPORT LevelWindow
  {
  public:
    LevelWindow(ScalarType level = 127.5, ScalarType window = 255.0);
    LevelWindow(const mitk::LevelWindow &levWin);
    virtual ~LevelWindow();
 
    ScalarType GetLevel() const;
 
    ScalarType GetWindow() const;
 
    ScalarType GetDefaultLevel() const;
 
    ScalarType GetDefaultWindow() const;
 
    void ResetDefaultLevelWindow();
 
    ScalarType GetLowerWindowBound() const;
 
    ScalarType GetUpperWindowBound() const;
 
    void SetLevelWindow(ScalarType level, ScalarType window, bool expandRangesIfNecessary = true);
 
    void SetWindowBounds(ScalarType lowerBound, ScalarType upperBound, bool expandRangesIfNecessary = true);
 
    void SetToMaxWindowSize();
 
    void SetRangeMinMax(ScalarType min, ScalarType max);
 
    ScalarType GetRangeMin() const;
 
    ScalarType GetRangeMax() const;
 
    ScalarType GetDefaultLowerBound() const;
 
    ScalarType GetDefaultUpperBound() const;
 
    void ResetDefaultRangeMinMax();
 
    ScalarType GetRange() const;
 
    void SetDefaultLevelWindow(ScalarType level, ScalarType window);
 
    void SetDefaultBoundaries(ScalarType low, ScalarType up);
 
    void SetAuto(const Image *image,
                 bool tryPicTags = true,
                 bool guessByCentralSlice = true,
                 unsigned selectedComponent = 0);
 
    void SetToImageRange(const Image *image);
 
    void SetFixed(bool fixed);
 
    bool GetFixed() const;
 
    bool IsFixed() const;
 
    virtual bool operator==(const LevelWindow &levWin) const;
 
    virtual bool operator!=(const LevelWindow &levWin) const;
 
    virtual LevelWindow &operator=(const LevelWindow &levWin);
 
    bool IsFloatingValues() const;
 
    void SetFloatingValues(bool value);
 
  protected:
    ScalarType m_LowerWindowBound;
 
    ScalarType m_UpperWindowBound;
 
    ScalarType m_RangeMin;
 
    ScalarType m_RangeMax;
 
    ScalarType m_DefaultLowerBound;
 
    ScalarType m_DefaultUpperBound;
 
    bool m_IsFloatingImage;
 
    bool m_Fixed;
 
    inline void EnsureConsistency();
  };
 
  MITKCORE_EXPORT void to_json(nlohmann::json& j, const LevelWindow& lw);
  MITKCORE_EXPORT void from_json(const nlohmann::json& j, LevelWindow& lw);
 
} // namespace mitk
#endif