Notation used in Ruby API documentation
Module: lay
Description: A structure describing the data mapping of an image object
Data mapping is the process of transforming the data into RGB pixel values. This implementation provides four adjustment steps: first, in the case of monochrome data, the data is converted to a RGB triplet using the color map. The default color map will copy the value to all channels rendering a gray scale. After having normalized the data to 0..1 cooresponding to the min_value and max_value settings of the image, a color channel-independent brightness and contrast adjustment is applied. Then, a per-channel multiplier (red_gain, green_gain, blue_gain) is applied. Finally, the gamma function is applied and the result converted into a 0..255 pixel value range and clipped.
| new ImageDataMapping ptr | new | Create a new data mapping object with default settings |
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly destroys the object | ||
| [const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
| [const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
| void | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. | ||
| void | add_colormap_entry | (double value, unsigned int color) | Add a colormap entry for this data mapping object. | |
| void | add_colormap_entry | (double value, unsigned int lcolor, unsigned int rcolor) | Add a colormap entry for this data mapping object. | |
| void | assign | (const ImageDataMapping other) | Assigns another object to self | |
| [const] | double | blue_gain | The blue channel gain | |
| void | blue_gain= | (double blue_gain) | Set the blue_gain | |
| [const] | double | brightness | The brightness value | |
| void | brightness= | (double brightness) | Set the brightness | |
| void | clear_colormap | The the color map of this data mapping object. | ||
| [const] | unsigned int | colormap_color | (unsigned long n) | Returns the color for a given color map entry. |
| [const] | unsigned int | colormap_lcolor | (unsigned long n) | Returns the left-side color for a given color map entry. |
| [const] | unsigned int | colormap_rcolor | (unsigned long n) | Returns the right-side color for a given color map entry. |
| [const] | double | colormap_value | (unsigned long n) | Returns the value for a given color map entry. |
| [const] | double | contrast | The contrast value | |
| void | contrast= | (double contrast) | Set the contrast | |
| [const] | new ImageDataMapping ptr | dup | Creates a copy of self | |
| [const] | double | gamma | The gamma value | |
| void | gamma= | (double gamma) | Set the gamma | |
| [const] | double | green_gain | The green channel gain | |
| void | green_gain= | (double green_gain) | Set the green_gain | |
| [const] | unsigned long | num_colormap_entries | Returns the current number of color map entries. | |
| [const] | double | red_gain | The red channel gain | |
| void | red_gain= | (double red_gain) | Set the red_gain |
| void | create | Use of this method is deprecated. Use _create instead | ||
| void | destroy | Use of this method is deprecated. Use _destroy instead | ||
| [const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
_create | Signature: void _create Description: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. | |||||
_destroy | Signature: void _destroy Description: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. | |||||
_destroyed? | Signature: [const] bool _destroyed? Description: Returns a value indicating whether the object was already destroyed This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. | |||||
_is_const_object? | Signature: [const] bool _is_const_object? Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. | |||||
_manage | Signature: void _manage Description: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. | |||||
_unmanage | Signature: void _unmanage Description: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. | |||||
add_colormap_entry | (1) Signature: void add_colormap_entry (double value, unsigned int color) Description: Add a colormap entry for this data mapping object.
This settings establishes a color mapping for a given value in the monochrome channel. The color must be given as a 32 bit integer, where the lowest order byte describes the blue component (0 to 255), the second byte the green component and the third byte the red component, i.e. 0xff0000 is red and 0x0000ff is blue. | |||||
(2) Signature: void add_colormap_entry (double value, unsigned int lcolor, unsigned int rcolor) Description: Add a colormap entry for this data mapping object.
This settings establishes a color mapping for a given value in the monochrome channel. The colors must be given as a 32 bit integer, where the lowest order byte describes the blue component (0 to 255), the second byte the green component and the third byte the red component, i.e. 0xff0000 is red and 0x0000ff is blue. In contrast to the version with one color, this version allows specifying a color left and right of the value - i.e. a discontinuous step. This variant has been introduced in version 0.27. | ||||||
assign | Signature: void assign (const ImageDataMapping other) Description: Assigns another object to self | |||||
blue_gain | Signature: [const] double blue_gain Description: The blue channel gain This value is the multiplier by which the blue channel is scaled after applying false color transformation and contrast/brightness/gamma. 1.0 is a neutral value. The gain should be >=0.0. Python specific notes: | |||||
blue_gain= | Signature: void blue_gain= (double blue_gain) Description: Set the blue_gain See blue_gain for a description of this property. Python specific notes: | |||||
brightness | Signature: [const] double brightness Description: The brightness value The brightness is a double value between roughly -1.0 and 1.0. Neutral (original) brightness is 0.0. Python specific notes: | |||||
brightness= | Signature: void brightness= (double brightness) Description: Set the brightness See brightness for a description of this property. Python specific notes: | |||||
clear_colormap | Signature: void clear_colormap Description: The the color map of this data mapping object. | |||||
colormap_color | Signature: [const] unsigned int colormap_color (unsigned long n) Description: Returns the color for a given color map entry.
NOTE: this version is deprecated and provided for backward compatibility. For discontinuous nodes this method delivers the left-sided color. | |||||
colormap_lcolor | Signature: [const] unsigned int colormap_lcolor (unsigned long n) Description: Returns the left-side color for a given color map entry.
This method has been introduced in version 0.27. | |||||
colormap_rcolor | Signature: [const] unsigned int colormap_rcolor (unsigned long n) Description: Returns the right-side color for a given color map entry.
This method has been introduced in version 0.27. | |||||
colormap_value | Signature: [const] double colormap_value (unsigned long n) Description: Returns the value for a given color map entry.
| |||||
contrast | Signature: [const] double contrast Description: The contrast value The contrast is a double value between roughly -1.0 and 1.0. Neutral (original) contrast is 0.0. Python specific notes: | |||||
contrast= | Signature: void contrast= (double contrast) Description: Set the contrast See contrast for a description of this property. Python specific notes: | |||||
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. | |||||
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. | |||||
destroyed? | Signature: [const] bool destroyed? Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. | |||||
dup | Signature: [const] new ImageDataMapping ptr dup Description: Creates a copy of self Python specific notes: | |||||
gamma | Signature: [const] double gamma Description: The gamma value The gamma value allows one to adjust for non-linearities in the display chain and to enhance contrast. A value for linear intensity reproduction on the screen is roughly 0.5. The exact value depends on the monitor calibration. Values below 1.0 give a "softer" appearance while values above 1.0 give a "harder" appearance. Python specific notes: | |||||
gamma= | Signature: void gamma= (double gamma) Description: Set the gamma See gamma for a description of this property. Python specific notes: | |||||
green_gain | Signature: [const] double green_gain Description: The green channel gain This value is the multiplier by which the green channel is scaled after applying false color transformation and contrast/brightness/gamma. 1.0 is a neutral value. The gain should be >=0.0. Python specific notes: | |||||
green_gain= | Signature: void green_gain= (double green_gain) Description: Set the green_gain See green_gain for a description of this property. Python specific notes: | |||||
is_const_object? | Signature: [const] bool is_const_object? Description: Returns a value indicating whether the reference is a const reference Use of this method is deprecated. Use _is_const_object? instead This method returns true, if self is a const reference. In that case, only const methods may be called on self. | |||||
new | Signature: [static] new ImageDataMapping ptr new Description: Create a new data mapping object with default settings Python specific notes: | |||||
num_colormap_entries | Signature: [const] unsigned long num_colormap_entries Description: Returns the current number of color map entries.
| |||||
red_gain | Signature: [const] double red_gain Description: The red channel gain This value is the multiplier by which the red channel is scaled after applying false color transformation and contrast/brightness/gamma. 1.0 is a neutral value. The gain should be >=0.0. Python specific notes: | |||||
red_gain= | Signature: void red_gain= (double red_gain) Description: Set the red_gain See red_gain for a description of this property. Python specific notes: |