PictureEffectsRaw Xojo Plugin

LevelsEffectRaw Class (console safe)

A class to apply levels changes to images and to generate histograms for each color channel or a combined RGB histogram.

Supports:
  • 8 bit per channel bitmaps

  • 16 bit per channel bitmaps

  • RGB color spaces

  • Gray color spaces

  • CMYK color spaces

  • Synchronous and asynchronous modes supported



    • This class supports use of multiple CPU cores.


    The control mechanism to draw the histogram and to control it is included with PictureEffects in form of a Xojo closed source class.

    The effect allows for mutating levels of in - channels and out channels. Changing the in channels discards levels from the image, while changing the out channel stretches and converts the input to different levels range. So for example a image could discard levels bellow 100 on the red channel but then let the remaining levels convert and stretch to levels 50 to 220.

    MapEffectRaw
       LevelsEffectRaw

    class LevelsEffectRaw implements

    IRawBitmapProcessor

    IRawBitmapProcessorAsync

    Constructors

    LevelsEffectRaw (console safe) Default constructor that takes no parameters.

    Properties

    AsyncCompleted (Inherited) (console safe) Returns true if asynchronous execution has completed, else false.
    AsyncResult (Inherited) (console safe) Returns the result bitmap of asynchronous execution.
    BlueHistogram (console safe) Returns the histogram for the blue channel of image passed into last call to the CreateHistograms method.
    CPUCoreCount (Inherited) (console safe) Returns number of detected CPU cores on the running machine.
    Canceled (Inherited) (console safe) If this one returns true then the effects execution was canceled by a Progress handler.
    ErrorCode (Inherited) (console safe) Returns error code after applying the effect. This value is a Constant defined in the PictureEffectsRawError module.
    ForceThreads (Inherited) (console safe) Forces use of thread when set to true even when using only one CPU core.
    GreenHistogram (console safe) Returns the histogram for the green channel of image passed into last call to the CreateHistograms method.
    InRangeBlue (console safe) Returns the In range for the blue channel.
    InRangeGreen (console safe) Returns the In range for the green channel.
    InRangeRed (console safe) Returns the In range for the red channel.
    Mask (console safe) Sets mask for the operation if masking is wanted.
    Mask (Inherited) (console safe) Sets mask for the operation if masking is wanted.
    MaximumCPUCores (Inherited) (console safe) Read only property where each effect can report maximum CPU cores it supports.
    MultiprocessingHint (Inherited) (console safe) Use this property to fine tune CPU usage for this algorithm. By default this property is set to zero (Automatic). This property accepts all constants that are defined in this class.
    OutRangeBlue (console safe) Returns the out range for the blue channel.
    OutRangeGreen (console safe) Returns the out range for the green channel.
    OutRangeRed (console safe) Returns the out range for the red channel.
    ProgressHandler (Inherited) (console safe) Use this property to use a progress class to get progress feedback from this function. This class must be a class that Implements the IProgressHandler Interface which is defined in this plugin.
    RGBHistogram (console safe) Returns the histogram for the combined RGB channels of image passed into last call to the CreateHistograms method.
    RedHistogram (console safe) Returns the histogram for the red channel of image passed into last call to the CreateHistograms method.

    Methods

    Apply (console safe) Applies the effect on a RawBitmap image with parameters that have been set on the class instance.
    Apply (Inherited) (console safe) Applies the effect on a RawBitmap image with parameters that have been set on the class instance, taking additionally the mapping channels as parameters.
    ApplyAsync (console safe) Applies the effect asynchronously on a RawBitmap image with parameters that have been set on the class instance.
    ApplyInPlace (console safe) Applies the effect on a RawBitmap image with parameters that have been set on the class instance, and the RawBitmap passed in will also get the result image.
    ApplyInPlace (Inherited) (console safe) Applies the effect on a RawBitmap image with parameters that have been set on the class instance, and the RawBitmap passed in will also get the result image.
    ApplyInPlaceAsync (console safe) Applies the effect asynchronously on a RawBitmap image with parameters that have been set on the class instance, and the RawBitmap passed in will also get the result image.
    Cancel (Inherited) (console safe) Cancels processing and waits for threads to come to full stop when in asynchronous execution.
    CreateHistograms (console safe) Creates histograms (Red, Green, Blue and combined RBG) for a given image.
    SetMaps (Inherited) (console safe) Sets the mapping parameters

    Constants

    CPU_USE_MACHINE_CORE_COUNT = -1 (Inherited)
    CPU_USE_AUTOMATIC = 0 (Inherited)
    CPU_USE_1_CORE = 1 (Inherited)
    CPU_USE_2_CORES = 2 (Inherited)
    CPU_USE_3_CORES = 3 (Inherited)
    CPU_USE_4_CORES = 4 (Inherited)
    CPU_USE_5_CORES = 5 (Inherited)
    CPU_USE_6_CORES = 6 (Inherited)
    CPU_USE_7_CORES = 7 (Inherited)
    CPU_USE_8_CORES = 8 (Inherited)

    Supported Platforms:

  • macOS Intel 64 bit
  • macOS Apple Silicon
  • Windows 32 bit
  • Windows 64 bit
  • Windows ARM 64 bit
  • Linux 32 bit
  • Linux 64 bit
  • Linux ARM 32 bit
  • Linux ARM 64 bit
  • iOS