ML Reference
|
Class to define a first order linear transformation. More...
#include <mlScaleShiftData.h>
Public Types | |
enum | ReorderMode { NoReordering = 0, ReorderColorPlanesToInterleaved = 1 } |
Mode that indicates if copySubImage should reorder the color from planes (from x,y,z,c,t,u) to interleaved format (c,x,y,z,c,t,u). More... | |
Public Member Functions | |
ReorderMode | getReorderMode () const |
Get the reorder mode. | |
void | setReorderMode (ReorderMode mode) |
Set the reorder mode. | |
Initialization | |
TScaleShiftData () | |
Default constructor, i.e., builds identity transformation. | |
TScaleShiftData (const TScaleShiftData< DT > &ssd) | |
Copy constructor. | |
TScaleShiftData (DT scale, DT shift) | |
Constructor: Sets scale and shift to define a transformation so that a scaled value v' is v' = v*scale + shift. | |
TScaleShiftData (DT fromMin, DT fromMax, DT toMin, DT toMax) | |
Values from interval [fromMin , fromMax ] are transformed linearly into [toMin , toMax ]. | |
Assignment. | |
TScaleShiftData & | operator= (const TScaleShiftData< DT > &ssd) |
Assignment operator from an existing object to get an identical copy. | |
Comparison. | |
bool | operator== (const TScaleShiftData< DT > &ssd) const |
Returns true if all members are equal. | |
bool | operator!= (const TScaleShiftData< DT > &ssd) const |
Returns true if any members differ. | |
Set transformation | |
void | setScaleOffset (DT scale, DT shift) |
Sets scale and shift: values are multiplied with scale and then shift is added. | |
void | setFromMinMaxToMinMax (DT fromMin, DT fromMax, DT toMin, DT toMax) |
Values from interval [fromMin , fromMax ] are transformed linearly into [toMin , toMax ]. | |
void | setFromMinMaxToMinMax (MLDataType fromType, DT fromMin, DT fromMax, MLDataType toType, DT toMin, DT toMax) |
Values from interval [fromMin , fromMax ] are transformed linearly into [toMin , toMax ]. | |
void | unset () |
Sets default, i.e., identity transformation. | |
Query transformation values. | |
DT | getScale () const |
Returns scale constant from transformation y=scale*x+offset. | |
DT | getShift () const |
Returns addition constant shift from transformation y=scale*x+shift. |
Class to define a first order linear transformation.
It is used as container for the parameters scale and shift of a linear transformation y=scale*x+shift.
Notes:
Definition at line 47 of file mlScaleShiftData.h.
enum ml::TScaleShiftData::ReorderMode |
Mode that indicates if copySubImage should reorder the color from planes (from x,y,z,c,t,u) to interleaved format (c,x,y,z,c,t,u).
Note that a SubImage with interleaved color data will not be fully functional, since it will not have correct internal strides etc. Typically ReorderMode::ReorderColorPlanesToInterleaved is used to convert color images for usage with OpenGL or other APIs that require RGBRGBRGB... or RGBARGBA... data.
NoReordering |
< no reodering is done |
ReorderColorPlanesToInterleaved |
< reorders the color planes to interleaved format. |
Definition at line 58 of file mlScaleShiftData.h.
ml::TScaleShiftData< DT >::TScaleShiftData | ( | ) | [inline] |
Default constructor, i.e., builds identity transformation.
Definition at line 69 of file mlScaleShiftData.h.
ml::TScaleShiftData< DT >::TScaleShiftData | ( | const TScaleShiftData< DT > & | ssd | ) | [inline] |
Copy constructor.
Definition at line 78 of file mlScaleShiftData.h.
ml::TScaleShiftData< DT >::TScaleShiftData | ( | DT | scale, |
DT | shift | ||
) | [inline] |
Constructor: Sets scale
and shift
to define a transformation so that a scaled value v' is v' = v*scale + shift.
Definition at line 88 of file mlScaleShiftData.h.
ml::TScaleShiftData< DT >::TScaleShiftData | ( | DT | fromMin, |
DT | fromMax, | ||
DT | toMin, | ||
DT | toMax | ||
) | [inline] |
Values from interval [fromMin
, fromMax
] are transformed linearly into [toMin
, toMax
].
If necessary, interval borders are swapped to guarantee that minimum values are smaller or equal than maximum values. In case that fromMin
and fromMax
are identical, _scale is set to 1 and _shift is set to toMin
- fromMin
. So the only value from that interval is projected to the minimum value of the target interval. ATTENTION: This transformation defines no clipping/clamping. If values outside [fromMin
, fromMax
] are transformed they will be transformed to values outside [toMin
, toMax
].
Definition at line 103 of file mlScaleShiftData.h.
ReorderMode ml::TScaleShiftData< DT >::getReorderMode | ( | ) | const [inline] |
Get the reorder mode.
Definition at line 315 of file mlScaleShiftData.h.
Referenced by ml::TSubImage< DATATYPE >::copySubImageTyped().
DT ml::TScaleShiftData< DT >::getScale | ( | ) | const [inline] |
Returns scale constant from transformation y=scale*x+offset.
Definition at line 308 of file mlScaleShiftData.h.
Referenced by ml::TSubImage< DATATYPE >::copySubImageReorderColorPlanesToInterleaved(), and ml::TSubImage< DATATYPE >::copySubImageTyped().
DT ml::TScaleShiftData< DT >::getShift | ( | ) | const [inline] |
Returns addition constant shift from transformation y=scale*x+shift.
Definition at line 311 of file mlScaleShiftData.h.
Referenced by ml::TSubImage< DATATYPE >::copySubImageReorderColorPlanesToInterleaved(), and ml::TSubImage< DATATYPE >::copySubImageTyped().
bool ml::TScaleShiftData< DT >::operator!= | ( | const TScaleShiftData< DT > & | ssd | ) | const [inline] |
Returns true
if any members differ.
Definition at line 147 of file mlScaleShiftData.h.
TScaleShiftData& ml::TScaleShiftData< DT >::operator= | ( | const TScaleShiftData< DT > & | ssd | ) | [inline] |
Assignment operator from an existing object to get an identical copy.
Definition at line 119 of file mlScaleShiftData.h.
bool ml::TScaleShiftData< DT >::operator== | ( | const TScaleShiftData< DT > & | ssd | ) | const [inline] |
Returns true
if all members are equal.
Definition at line 138 of file mlScaleShiftData.h.
void ml::TScaleShiftData< DT >::setFromMinMaxToMinMax | ( | DT | fromMin, |
DT | fromMax, | ||
DT | toMin, | ||
DT | toMax | ||
) | [inline] |
Values from interval [fromMin
, fromMax
] are transformed linearly into [toMin
, toMax
].
If necessary then interval borders are swapped to guarantee that minimum values are smaller or equal than maximum values. In case that fromMin
and fromMax
are identical, _scale is set to 1 and _shift is set to toMin
- fromMin
. So the only value from that interval is projected to the minimum value of the target interval. ATTENTION: This transformation defines no clipping/clamping. If values outside [fromMin
, fromMax
] are transformed they will be transformed to values outside [toMin
, toMax
].
Definition at line 181 of file mlScaleShiftData.h.
void ml::TScaleShiftData< DT >::setFromMinMaxToMinMax | ( | MLDataType | fromType, |
DT | fromMin, | ||
DT | fromMax, | ||
MLDataType | toType, | ||
DT | toMin, | ||
DT | toMax | ||
) | [inline] |
Values from interval [fromMin
, fromMax
] are transformed linearly into [toMin
, toMax
].
If necessary then interval borders are swapped to guarantee that minimum values are smaller or equal than maximum values.
This method handles float/integer datatype combinations differently:
Float -> Integer
Adds 0.99 to the integer toMax, since that is almost the case like adding 1. and avoids having to clamp the result to the int max value. (like described in 'Zen of Graphics Programming, Michael Abrash')
Integer -> Integer
Adds 1 to the fromMax and toMax ranges (which is the same as shifting for power-of-two differences in range).
Integer -> Float
Use range as given. Rationale: Use fromMax int value, and not fromMax+1, so that the maximum integer value will get the maximum float value (like in OpenGL, where the maximum integer value is mapped to 1.)
Float -> Float
Use range as given.
In case that fromMin
and fromMax
are identical, _scale is set to 1 and _shift is set to toMin
- fromMin
. So the only value from that interval is projected to the minimum value of the target interval. ATTENTION: This transformation defines no clipping/clamping. If values outside [fromMin
, fromMax
] are transformed they will be transformed to values outside [toMin
, toMax
].
Definition at line 241 of file mlScaleShiftData.h.
void ml::TScaleShiftData< DT >::setReorderMode | ( | ReorderMode | mode | ) | [inline] |
Set the reorder mode.
Definition at line 318 of file mlScaleShiftData.h.
void ml::TScaleShiftData< DT >::setScaleOffset | ( | DT | scale, |
DT | shift | ||
) | [inline] |
Sets scale
and shift:
values are multiplied with scale
and then shift
is added.
Definition at line 163 of file mlScaleShiftData.h.
void ml::TScaleShiftData< DT >::unset | ( | ) | [inline] |
Sets default, i.e., identity transformation.
Definition at line 291 of file mlScaleShiftData.h.