Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
SoArithmeticImageProcessing Class Reference
ImageViz » Engines » Arithmetic And Logic » Arithmetic Operations

ImageViz SoArithmeticImageProcessing engine performs an arithmetic operation between two images. More...

#include <ImageViz/Engines/ArithmeticAndLogic/ArithmeticOperations/SoArithmeticImageProcessing.h>

+ Inheritance diagram for SoArithmeticImageProcessing:

Public Types

enum  ArithmeticOperator {
  ADD = 0 ,
  SUBTRACT = 1 ,
  MULTIPLY = 2 ,
  DIVIDE = 3 ,
  MINIMUM = 4 ,
  MAXIMUM = 5
}
 
- Public Types inherited from SoImageVizEngine
enum  ComputeMode {
  MODE_2D = 0 ,
  MODE_3D = 1 ,
  MODE_AUTO = 2
}
 Compute Mode This enum specifies whether the main input will be interpreted as a 3D volume or a stack of 2D images for processing. More...
 
enum  Neighborhood3d {
  CONNECTIVITY_6 = 0 ,
  CONNECTIVITY_18 = 1 ,
  CONNECTIVITY_26 = 2
}
 Neighborhood Connectivity 3D. More...
 

Public Member Functions

 SoArithmeticImageProcessing ()
 Constructor.
 
- Public Member Functions inherited from SoImageVizEngine
virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
virtual void startEvaluate ()
 Evaluate engine and dependencies in another thread without blocking the current one.
 
virtual void waitEvaluate ()
 Wait for the end of engine evaluation.
 
virtual void abortEvaluate ()
 Abort current processing as soon as possible.
 
virtual bool isEvaluating ()
 Returns true if the engine evaluation is in progress.
 
- Public Member Functions inherited from SoEngine
virtual int getOutputs (SoEngineOutputList &list) const
 Returns a list of outputs in this engine.
 
SoEngineOutput * getOutput (const SbName &outputName) const
 Returns a reference to the engine output with the given name.
 
SbBool getOutputName (const SoEngineOutput *output, SbName &outputName) const
 Returns (in outputName) the name of the engine output (output).
 
SoEngine * copy () const
 Creates and returns an exact copy of the engine.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool set (const char *fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
SbBool set (const SbString &fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoField * getField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoField * getEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoField * getEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Public Attributes

SoSFEnum arithmeticOperator
 Select operator to apply.
 
SoSFImageDataAdapter inImage1
 The 1st input image.
 
SoSFImageDataAdapter inImage2
 The 2nd input image.
 
SoImageVizEngineOutput< SoSFImageDataAdapter, SoImageDataAdapter * > outImage
 The output image.
 
- Public Attributes inherited from SoImageVizEngine
SbEventHandler< EventArg & > onBegin
 Event raised when the processing begins.
 
SbEventHandler< EventArg & > onEnd
 Event raised when processing ends and the result is available.
 
SbEventHandler< EventArg & > onProgress
 Event raised while processing is running.
 

Additional Inherited Members

- Static Public Member Functions inherited from SoImageVizEngine
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoEngine
static SoType getClassTypeId ()
 Returns the type identifier for the SoEngine class.
 
static SoEngine * getByName (const SbName &name)
 Looks up engine(s) by name.
 
static int getByName (const SbName &name, SoEngineList &list)
 Looks up engine(s) by name.
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Detailed Description

ImageViz SoArithmeticImageProcessing engine performs an arithmetic operation between two images.

SoArithmeticImageFiltering performs an arithmetic operation between an image and another image.

SEE ALSO

SoArithmeticValueProcessing, SoLogicalImageProcessing, SoAbsoluteValueProcessing.

FILE FORMAT/DEFAULT

    ArithmeticImageProcessing {
    arithmeticOperator ADD
    inImage1 NULL
    inImage2 NULL
    }


Library references: addimage divideimage maximumimage minimumimage multiplyimage subtractimage

Definition at line 61 of file SoArithmeticImageProcessing.h.

Member Enumeration Documentation

◆ ArithmeticOperator

enum SoArithmeticImageProcessing::ArithmeticOperator
Enumerator
ADD 

The ADD arithmetic operator adds two images $I_1$ and $I_2$.

The formula is:

$O(n,m)=I_1(n,m)+I_2(n,m)$
Remarks:

  • Overflows may occur.
  • Be careful with negative values and the way they are visualized.

See also: SoArithmeticValueProcessing, SoLogicalImageProcessing, SoAbsoluteImageProcessing.

SUBTRACT 

The SUBTRACT arithmetic operator subtract an image $I_2$ from $I_1$.

The formula is:

$O(n,m)=I_1(n,m)-I_2(n,m)$
Remarks:

  • Overflows may occur.
  • The result of a subtraction between two binary images is a short integer image; this operation is not equivalent to a logical difference.
  • Be careful with negative values and the way they are visualized.
MULTIPLY 

The MULTIPLY arithmetic operator multiplies an image $I_1$ by another $I_2$.

The formula is:

$O(n,m)=I_1(n,m) \times I_2(n,m)$
Remarks:

  • Overflows may occur.
  • Be careful with negative values and the way they are visualized.
  • Multiplying a binary image by a grayscale image is equivalent to a masking operation.
DIVIDE 

The DIVIDE arithmetic operator divides an image $I_1$ by another $I_2$.

The formula is:

$O(n,m)=I_1(n,m)\div I_2(n,m)$
Remarks:

  • Overflows may occur.
  • Be careful with negative values and the way they are visualized.
  • If $I_2(n,m)=0$ then $O(n,m)=I_1(n,m)$
MINIMUM 

The MINIMUM arithmetic operator computes the minimum value between two images $I_1$ and $I_2$.

The formula is: $O(n,m)=\min\left\{I_1(n,m),I_2(n,m)\right\}$

For binary images, the MINIMUM operator is equivalent to a logical AND.

\[ \begin{array}{|c|c|c|} \hline I_1 & I_2 & I_1 ~ \Lambda ~ I_2\\ \hline 1 & 1 & 1 \\ 1 & 0 & 0 \\ 0 & 1 & 0 \\ 0 & 0 & 0 \\ \hline \end{array} \]

MAXIMUM 

The MAXIMUM arithmetic operator computes the maximum value between two images $I_1$ and $I_2$.

The formula is: $O(n,m)=\max\left\{I_1(n,m),I_2(n,m)\right\}$

For binary images, the MAXIMUM operator is equivalent to a logical OR.

\[ \begin{array}{|c|c|c|} \hline I_1 & I_2 & I_1 ~ \Delta ~ I_2\\ \hline 1 & 1 & 1 \\ 1 & 0 & 1 \\ 0 & 1 & 1 \\ 0 & 0 & 0 \\ \hline \end{array} \]

Definition at line 73 of file SoArithmeticImageProcessing.h.

Constructor & Destructor Documentation

◆ SoArithmeticImageProcessing()

SoArithmeticImageProcessing::SoArithmeticImageProcessing ( )

Constructor.

Member Data Documentation

◆ arithmeticOperator

SoSFEnum SoArithmeticImageProcessing::arithmeticOperator

Select operator to apply.

Use enum ArithmeticOperator. Default is ADD

Definition at line 167 of file SoArithmeticImageProcessing.h.

◆ inImage1

SoSFImageDataAdapter SoArithmeticImageProcessing::inImage1

The 1st input image.

Default value is NULL. Supported types include: grayscale binary label color image.

Definition at line 170 of file SoArithmeticImageProcessing.h.

◆ inImage2

SoSFImageDataAdapter SoArithmeticImageProcessing::inImage2

The 2nd input image.

Default value is NULL. Supported types include: grayscale binary label color image.

Definition at line 173 of file SoArithmeticImageProcessing.h.

◆ outImage

SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter*> SoArithmeticImageProcessing::outImage

The output image.

Default value is NULL. Supported types include: grayscale binary label color image.

Definition at line 176 of file SoArithmeticImageProcessing.h.

The documentation for this class was generated from the following file: