Into

Modules

Documentation

classPiiRgbNormalizer

#include <PiiRgbNormalizer.h>

An operation that converts images to normalized RGB.

Inherits PiiDefaultOperation

Description

See PiiColors::normalizedRgb() for details.

Inputs

imageany color image

Outputs

channel0first normalized color channel (red, by default)
channel1second normalized color channel (green, by default)

Properties

The normalized color channels the operation will emit through channel0 and channel1.

double

The maximum value a normalized color channel can attain.

Public types

enum
{ RedGreen, RedBlue, GreenBlue }

Allowed channel pairs.

Constructors and destructor

Public member functions

double
void
( )
void
(
  • double maxValue
)

Protected member functions

virtual void

Executes one round of processing.

Property details

  • ChannelPair channels

    [read, write]

    The normalized color channels the operation will emit through channel0 and channel1.

  • double maxValue

    [read, write]

    The maximum value a normalized color channel can attain.

    The default is 255. This allows simultaneous quantization and normalization.

Enumeration details

  • enum ChannelPair

    Allowed channel pairs.

    • RedGreen - normalized RG. channel0 will emit the red channel and channel1 the green channel.

    • RedBlue - normalized RB

    • GreenBlue - normalized GB

Function details

  • PiiRgbNormalizer

    ()
  • ChannelPair channels

    ()
  • double maxValue

    ()
  • void setChannels

    ( )
  • void setMaxValue

    (
    • double maxValue
    )
  • virtual void process

    ()
    [protected, virtual]

    Executes one round of processing.

    This function is invoked by the processor if the necessary preconditions for a new processing round are met. This function does all the necessary calculations to create output objects and sends them to output sockets.

    Calls to process(), syncEvent(), and setProperty() are synchronized and cannot occur simultaneously. PiiDefaultOperation ensures this by locking processLock() for reading before calling process().

    Note: With time-consuming operations, one should occasionally check that the operation hasn't been interrupted, i.e. that state() returns Running.

    Exceptions
    PiiExecutionException

    whenever an unrecoverable error occurs during a processing round, the operation is interrupted, or finishes execution due to end of input data.

    Reimplemented from PiiDefaultOperation.

Notes (0)

Add a note

Not a single note added yet. Be the first, add yours.