Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
SoIntensityStatisticsQuantification Class Reference

ImageViz SoIntensityStatisticsQuantification engine advanced basic statistics of an image. More...

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

+ Inheritance diagram for SoIntensityStatisticsQuantification:

Classes

class  SbStatisticsDetail
 Results details of statistics global measure. More...
 

Public Types

enum  RangeMode {
  MIN_MAX = 0 ,
  OTHER = 1
}
 
- 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

 SoIntensityStatisticsQuantification ()
 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.
 
SoEngineOutputgetOutput (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).
 
SoEnginecopy () 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 SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (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.
 
SoSFEnum rangeMode
 Select the input intensity range mode.
 
SoSFVec2i32 intensityRangeInput
 The input intensity range.
 
SoImageVizEngineAnalysisOutput< SbStatisticsDetailoutResult
 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 SoEnginegetByName (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 SoIntensityStatisticsQuantification engine advanced basic statistics of an image.

For an introduction to global measurements, see section Image Analysis Operations.

The SoIntensityStatisticsQuantification engine gives some of the image characteristics such as: the total number of pixels/voxels, the minimum and maximum gray levels, the mean, the range, the standard deviation, the kurtosis and the skewness.

  • \[range = Max ~-~ Min ~+~ 1\]

  • \[\mu_k = \sum{(I(i,j)-mean)}^{k}\]

  • \[stddev = \sigma=\sqrt{\mu_2}\]

  • \[skewness = \frac{\mu_3}{\sigma^3}\]

  • \[kurtosis = (\frac{\mu_4}{\sigma^4})-3\]

The SKEWNESS is the degree of asymmetry of a distribution. If the distribution has a tail length smaller than the maximum, the function has negative skewness. Otherwise, it has positive skewness.

The KURTOSIS is the degree of peakedness of a distribution, also called the "excess" or "excess coefficient." Kurtosis is a normalized form of the fourth central moment of a distribution.

FILE FORMAT/DEFAULT

    IntensityStatisticsQuantification {
    computeMode MODE_AUTO
    inImage NULL
    rangeMode MIN_MAX
    intensityRangeInput 0 255
    }


Library references: statistics

Definition at line 83 of file SoIntensityStatisticsQuantification.h.

Member Enumeration Documentation

◆ RangeMode

Enumerator
MIN_MAX 

The measurements are computed between the minimum and the maximum of the image.

The SoIntensityStatisticsQuantification::intensityRangeInput field is ignored using this mode

OTHER 

The measurements are computed between the bounds defined in the SoIntensityStatisticsQuantification::intensityRangeInput field.

SEE ALSO

SoIntensityExtremaQuantification, SoMaskedStatisticsQuantification.

Definition at line 158 of file SoIntensityStatisticsQuantification.h.

Constructor & Destructor Documentation

◆ SoIntensityStatisticsQuantification()

SoIntensityStatisticsQuantification::SoIntensityStatisticsQuantification ( )

Constructor.

Member Data Documentation

◆ computeMode

SoSFEnum SoIntensityStatisticsQuantification::computeMode

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

Default is MODE_AUTO

Definition at line 95 of file SoIntensityStatisticsQuantification.h.

◆ inImage

SoSFImageDataAdapter SoIntensityStatisticsQuantification::inImage

The input image.

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

Definition at line 153 of file SoIntensityStatisticsQuantification.h.

◆ intensityRangeInput

SoSFVec2i32 SoIntensityStatisticsQuantification::intensityRangeInput

The input intensity range.

Default value is SbVec2i32(0,255).

Definition at line 180 of file SoIntensityStatisticsQuantification.h.

◆ outResult

SoImageVizEngineAnalysisOutput<SbStatisticsDetail> SoIntensityStatisticsQuantification::outResult

The output measure result.

Default value is NULL.

Definition at line 183 of file SoIntensityStatisticsQuantification.h.

◆ rangeMode

SoSFEnum SoIntensityStatisticsQuantification::rangeMode

Select the input intensity range mode.

Use enum RangeMode. Default is MIN_MAX

Definition at line 177 of file SoIntensityStatisticsQuantification.h.


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