Medical Imaging Interaction Toolkit
2024.06.99-35a6d053
Medical Imaging Interaction Toolkit
|
The LevelWindow class Class to store level/window values. More...
#include <mitkLevelWindow.h>
Public Member Functions | |
LevelWindow (ScalarType level=127.5, ScalarType window=255.0) | |
LevelWindow (const mitk::LevelWindow &levWin) | |
virtual | ~LevelWindow () |
ScalarType | GetLevel () const |
method that returns the level value, i.e. the center of the current grey value interval More... | |
ScalarType | GetWindow () const |
returns the current window size, i.e the range size of the current grey value interval More... | |
ScalarType | GetDefaultLevel () const |
method returns the default level value for the image More... | |
ScalarType | GetDefaultWindow () const |
returns the default window size for the image More... | |
void | ResetDefaultLevelWindow () |
Resets the level and the window value to the default values. More... | |
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 () |
the default min and max range for image will be reset More... | |
ScalarType | GetRange () const |
returns the size of the grey value range More... | |
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) |
sets level/window to optimize the contrast of the given Image More... | |
void | SetToImageRange (const Image *image) |
sets level/window to the min/max greyvalues of the given Image More... | |
void | SetFixed (bool fixed) |
bool | GetFixed () const |
bool | IsFixed () const |
virtual bool | operator== (const LevelWindow &levWin) const |
equality operator implementation that allows to compare two level windows More... | |
virtual bool | operator!= (const LevelWindow &levWin) const |
non equality operator implementation that allows to compare two level windows More... | |
virtual LevelWindow & | operator= (const LevelWindow &levWin) |
implementation necessary because operator made private in itk::Object More... | |
bool | IsFloatingValues () const |
Shows if floating values are accepted. More... | |
void | SetFloatingValues (bool value) |
Sets the floating image value. More... | |
Protected Member Functions | |
void | EnsureConsistency () |
The LevelWindow class Class to store level/window values.
Current min and max value are stored in m_LowerWindowBound and m_UpperWindowBound. 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.
The finite maximum and minimum of valid value range is stored in m_RangeMin and m_RangeMax. If deduced from an image by default the minimum or maximum of it statistics is used. If one of these values are infinite the 2nd extrimum (which is guaranteed to be finite), will be used.
See documentation of SetAuto for information on how the level window is initialized from an image.
Definition at line 45 of file mitkLevelWindow.h.
mitk::LevelWindow::LevelWindow | ( | ScalarType | level = 127.5 , |
ScalarType | window = 255.0 |
||
) |
mitk::LevelWindow::LevelWindow | ( | const mitk::LevelWindow & | levWin | ) |
|
virtual |
|
inlineprotected |
confidence tests
if m_LowerWindowBound > m_UpperWindowBound, then the values for m_LowerWindowBound and m_UpperWindowBound will be exchanged
if m_LowerWindowBound < m_RangeMin, m_LowerWindowBound will be set to m_RangeMin. m_UpperWindowBound will be decreased the same as m_LowerWindowBound will be increased, but minimum value for m_UpperWindowBound is also m_RangeMin.
if m_UpperWindowBound > m_RangeMax, m_UpperWindowBound will be set to m_RangeMax. m_LowerWindowBound will be increased the same as m_UpperWindowBound will be decreased, but maximum value for m_LowerWindowBound is also m_RangeMax.
ScalarType mitk::LevelWindow::GetDefaultLevel | ( | ) | const |
method returns the default level value for the image
ScalarType mitk::LevelWindow::GetDefaultLowerBound | ( | ) | const |
Get the default range minimum value
ScalarType mitk::LevelWindow::GetDefaultUpperBound | ( | ) | const |
Get the default range maximum value
ScalarType mitk::LevelWindow::GetDefaultWindow | ( | ) | const |
returns the default window size for the image
bool mitk::LevelWindow::GetFixed | ( | ) | const |
Returns whether the level window settings are fixed (
ScalarType mitk::LevelWindow::GetLevel | ( | ) | const |
method that returns the level value, i.e. the center of the current grey value interval
ScalarType mitk::LevelWindow::GetLowerWindowBound | ( | ) | const |
Returns the minimum Value of the window
ScalarType mitk::LevelWindow::GetRange | ( | ) | const |
returns the size of the grey value range
!
ScalarType mitk::LevelWindow::GetRangeMax | ( | ) | const |
Get the range maximum value
ScalarType mitk::LevelWindow::GetRangeMin | ( | ) | const |
Get the range minimum value
ScalarType mitk::LevelWindow::GetUpperWindowBound | ( | ) | const |
Returns the upper window bound value of the window
ScalarType mitk::LevelWindow::GetWindow | ( | ) | const |
returns the current window size, i.e the range size of the current grey value interval
bool mitk::LevelWindow::IsFixed | ( | ) | const |
Returns whether the level window settings are fixed (
bool mitk::LevelWindow::IsFloatingValues | ( | ) | const |
Shows if floating values are accepted.
|
virtual |
non equality operator implementation that allows to compare two level windows
|
virtual |
implementation necessary because operator made private in itk::Object
|
virtual |
equality operator implementation that allows to compare two level windows
void mitk::LevelWindow::ResetDefaultLevelWindow | ( | ) |
Resets the level and the window value to the default values.
void mitk::LevelWindow::ResetDefaultRangeMinMax | ( | ) |
the default min and max range for image will be reset
void mitk::LevelWindow::SetAuto | ( | const Image * | image, |
bool | tryPicTags = true , |
||
bool | guessByCentralSlice = true , |
||
unsigned | selectedComponent = 0 |
||
) |
sets level/window to optimize the contrast of the given Image
!
void mitk::LevelWindow::SetDefaultBoundaries | ( | ScalarType | low, |
ScalarType | up | ||
) |
set the default Boundaries
void mitk::LevelWindow::SetDefaultLevelWindow | ( | ScalarType | level, |
ScalarType | window | ||
) |
set the default level and window value
void mitk::LevelWindow::SetFixed | ( | bool | fixed | ) |
If a level window is set to fixed, the set and get methods won't accept modifications to the level window settings anymore. This behaviour can be turned of by setting fixed to false;
void mitk::LevelWindow::SetFloatingValues | ( | bool | value | ) |
Sets the floating image value.
void mitk::LevelWindow::SetLevelWindow | ( | ScalarType | level, |
ScalarType | window, | ||
bool | expandRangesIfNecessary = true |
||
) |
To set the level and the window value
void mitk::LevelWindow::SetRangeMinMax | ( | ScalarType | min, |
ScalarType | max | ||
) |
Set the range minimum and maximum value
void mitk::LevelWindow::SetToImageRange | ( | const Image * | image | ) |
sets level/window to the min/max greyvalues of the given Image
!
void mitk::LevelWindow::SetToMaxWindowSize | ( | ) |
sets the window to its maximum Size in scaleRange
void mitk::LevelWindow::SetWindowBounds | ( | ScalarType | lowerBound, |
ScalarType | upperBound, | ||
bool | expandRangesIfNecessary = true |
||
) |
Set the lower and upper bound of the window, restricted to the range from -10^300 to 10^300. Higher/lower values are clamped to these boundaries.
|
protected |
default minimum gray value of the window
Definition at line 228 of file mitkLevelWindow.h.
|
protected |
default maximum gray value of the window
Definition at line 233 of file mitkLevelWindow.h.
|
protected |
Defines whether the level window settings may be changed after initialization or not.
Definition at line 244 of file mitkLevelWindow.h.
|
protected |
Image with floating values
Definition at line 238 of file mitkLevelWindow.h.
|
protected |
lower bound of current window
Definition at line 208 of file mitkLevelWindow.h.
|
protected |
maximum gray value of the window
Definition at line 223 of file mitkLevelWindow.h.
|
protected |
minimum gray value of the window
Definition at line 218 of file mitkLevelWindow.h.
|
protected |
upper bound of current window
Definition at line 213 of file mitkLevelWindow.h.