mitkLevelWindow.h

Go to the documentation of this file.

/*=========================================================================

Program:   Medical Imaging & Interaction Toolkit
Language:  C++
Date:      $Date$
Version:   $Revision$

Copyright (c) German Cancer Research Center, Division of Medical and
Biological Informatics. All rights reserved.
See MITKCopyright.txt or https://www.mitk.org/copyright.html for details.

This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.  See the above copyright notices for more information.

=========================================================================*/


#ifndef LEVELWINDOW_H_HEADER_INCLUDED_C1F4F02C
#define LEVELWINDOW_H_HEADER_INCLUDED_C1F4F02C

#include "mitkVector.h"
#include "mitkCommon.h"

struct mitkIpPicDescriptor;

namespace mitk {

class Image;

//##Documentation
//## @brief Class to store level/window values
//##
//## Current min and max value are stored in m_LowerWindowBound and m_UpperWindowBound.
//## The maximum and minimum of valid value range is stored in
//## m_RangeMin and m_RangeMax.
//## m_DefaultLevel amd m_DefaultWindow store the initial Level/Window values for the image.
//## m_DefaultRangeMin and m_DefaultRangeMax store the initial minrange and maxrange for the image.
//##
//## See documentation of SetAuto for information on how the
//## level window is initialized from an image.
//##
//## @ingroup DataManagement
class MITK_CORE_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);

  void SetWindowBounds(ScalarType lowerBound, ScalarType upperBound);

  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 mitk::Image* image, bool tryPicTags = true, bool guessByCentralSlice = true);
  
  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);

protected:

  bool SetAutoByPicTags(const mitkIpPicDescriptor* pic);

  ScalarType m_LowerWindowBound;

  ScalarType m_UpperWindowBound;

  ScalarType m_RangeMin;

  ScalarType m_RangeMax;

  ScalarType m_DefaultLowerBound;

  ScalarType m_DefaultUpperBound;


  bool m_Fixed;


  inline void EnsureConsistency();
  
};

} // namespace mitk
#endif /* LEVELWINDOW_H_HEADER_INCLUDED_C1F4F02C */