Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
SoCompareValueQuantification Class Reference
ImageViz » Engines » Image Analysis » Statistics

ImageViz SoCompareValueQuantification engine applies a comparison test between an image and a constant value. More...

#include <ImageViz/Engines/ImageAnalysis/Statistics/SoCompareValueQuantification.h>

+ Inheritance diagram for SoCompareValueQuantification:

Classes

class  SbCompareDetail
 Results details of comparison between two images. More...
 

Public Types

enum  ComparisonCriterion {
  LESS_THAN = 0 ,
  LESS_OR_EQUAL = 1 ,
  EQUAL_TO = 2 ,
  GREATER_OR_EQUAL = 3 ,
  GREATER_THAN = 4 ,
  NOT_EQUAL_TO = 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

 SoCompareValueQuantification ()
 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 computeMode
 Select the compute Mode (2D or 3D or AUTO) Use enum ComputeMode.
 
SoSFImageDataAdapter inImage
 The input image operand.
 
SoSFFloat operandValue
 The floating value to compare.
 
SoSFEnum comparisonCriterion
 Select the comparison test to perform between image and value.
 
SoImageVizEngineAnalysisOutput< SbCompareDetail > outResult
 The output measure result.
 
- 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 SoCompareValueQuantification engine applies a comparison test between an image and a constant value.

The SoCompareValueQuantification engine computes the number of pixels which pass a comparison test between between an image $I_1$ and a constant value $C$. The comparison criteria include: Less-than, Less-or-Equal, Equal-to, Greater-or-Equal, Greater-Than Not-Equalto.

FILE FORMAT/DEFAULT

    CompareValueQuantification {
    computeMode MODE_AUTO
    inImage NULL
    operandValue 0.0f
    comparisonCriterion NOT_EQUAL_TO
    }


Library references: comparevalue

Definition at line 65 of file SoCompareValueQuantification.h.

Member Enumeration Documentation

◆ ComparisonCriterion

enum SoCompareValueQuantification::ComparisonCriterion
Enumerator
LESS_THAN 

The engine computes in $I_1$ the number of pixels/voxels which intensity is strictly less than $C$.

LESS_OR_EQUAL 

The engine computes in $I_1$ the number of pixels/voxels which intensity is less than or equal to $C$.

EQUAL_TO 

The engine computes in $I_1$ the number of pixels/voxels which intensity is equal to $C$.

GREATER_OR_EQUAL 

The engine computes in $I_1$ the number of pixels/voxels which intensity is greater than or equal to $C$.

GREATER_THAN 

The engine computes in $I_1$ the number of pixels/voxels which intensity is strictly greater than $C$.

NOT_EQUAL_TO 

The engine computes in $I_1$ the number of pixels/voxels which intensity is not equal to $C$.

Definition at line 108 of file SoCompareValueQuantification.h.

Constructor & Destructor Documentation

◆ SoCompareValueQuantification()

SoCompareValueQuantification::SoCompareValueQuantification ( )

Constructor.

Member Data Documentation

◆ comparisonCriterion

SoSFEnum SoCompareValueQuantification::comparisonCriterion

Select the comparison test to perform between image and value.

Use enum ComparisonCriterion. Default is NOT_EQUAL_TO

Definition at line 144 of file SoCompareValueQuantification.h.

◆ computeMode

SoSFEnum SoCompareValueQuantification::computeMode

Select the compute Mode (2D or 3D or AUTO) Use enum ComputeMode.

Default is MODE_AUTO

Definition at line 77 of file SoCompareValueQuantification.h.

◆ inImage

SoSFImageDataAdapter SoCompareValueQuantification::inImage

The input image operand.

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

Definition at line 100 of file SoCompareValueQuantification.h.

◆ operandValue

SoSFFloat SoCompareValueQuantification::operandValue

The floating value to compare.

Default value is 0.0f.

Definition at line 103 of file SoCompareValueQuantification.h.

◆ outResult

SoImageVizEngineAnalysisOutput<SbCompareDetail> SoCompareValueQuantification::outResult

The output measure result.

Default value is NULL.

Definition at line 147 of file SoCompareValueQuantification.h.

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