SoRandomImageGeneration engine creates a new image with random values. More...

#include <ImageViz/Engines/ImageManipulation/SyntheticImages/SoRandomImageGeneration.h>

Inheritance diagram for SoRandomImageGeneration:

Public Types
enum	Distribution { UNIFORM = 0 , GAUSSIAN = 1 }

enum	DataType { UNSIGNED_CHAR = 0 , SIGNED_CHAR = 1 , SHORT_INTEGER = 2 , UNSIGNED_SHORT = 3 , LABEL = 4 , BINARY = 5 , LONG_INTEGER = 6 , FLOATING_POINT = 7 }

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
	SoRandomImageGeneration ()
	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.

SoSFVec3i32	imageSize
	The size of the new image.

SoSFEnum	distribution
	Select the distribution mode.

SoSFEnum	dataType
	Select the output arithmetic format.

SoSFFloat	intensityMean
	The output intensity range of random values.

SoSFFloat	intensityRangeOutput
	The standard deviation.

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

SoRandomImageGeneration engine creates a new image with random values.

The SoRandomImageGeneration engine creates a new image with random values following a uniform or gaussian distribution.

Remark:

If the third component of the imageSize parameter is set to a value greater than 1, the output image will be a 3d image, otherwise the output image will be a 2d image.

FILE FORMAT/DEFAULT

computeMode	MODE_AUTO
imageSize	1024 1024 256
distribution	UNIFORM
dataType	UNSIGNED_CHAR
intensityMean	80.0f
intensityRangeOutput	20.0f

Library references: randomgauss randomgauss3d random random3d

Definition at line 70 of file SoRandomImageGeneration.h.

Member Enumeration Documentation

◆ DataType

enum SoRandomImageGeneration::DataType

Enumerator
UNSIGNED_CHAR	1 byte depth. Intensity range: unsigned integer from 0 to 255.
SIGNED_CHAR	1 byte depth. Intensity range: signed integer from -128 to 127.
SHORT_INTEGER	2 bytes depth. Intensity range: signed integer from -32,768 to 32,767.
UNSIGNED_SHORT
LABEL	2 bytes depth. Intensity range: unsigned integer from 0 to 65,535.
BINARY	2 bytes depth. Intensity range: unsigned integer from 0 to 1.
LONG_INTEGER	4 bytes depth. Intensity range: signed integer from $-2^{31}$ to $2^{31}-1$ .
FLOATING_POINT	4 bytes depth. Intensity range: signed integer from to .

Definition at line 109 of file SoRandomImageGeneration.h.

◆ Distribution

enum SoRandomImageGeneration::Distribution

Enumerator
UNIFORM	This mode generates random values following a uniform distribution.
GAUSSIAN	This mode generates random values following a gaussian distribution.

Definition at line 90 of file SoRandomImageGeneration.h.

Constructor & Destructor Documentation

◆ SoRandomImageGeneration()

SoRandomImageGeneration::SoRandomImageGeneration ( )

Constructor.

Member Data Documentation

◆ computeMode

SoSFEnum SoRandomImageGeneration::computeMode

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

Default is MODE_AUTO

Definition at line 82 of file SoRandomImageGeneration.h.

◆ dataType

SoSFEnum SoRandomImageGeneration::dataType

Select the output arithmetic format.

Use enum DataType. Default is UNSIGNED_CHAR

Definition at line 148 of file SoRandomImageGeneration.h.

◆ distribution

SoSFEnum SoRandomImageGeneration::distribution

Select the distribution mode.

Use enum Distribution. Default is UNIFORM

Definition at line 104 of file SoRandomImageGeneration.h.

◆ imageSize

SoSFVec3i32 SoRandomImageGeneration::imageSize

The size of the new image.

Default value is SbVec3i32(1024,1024,256)

Definition at line 85 of file SoRandomImageGeneration.h.

◆ intensityMean

SoSFFloat SoRandomImageGeneration::intensityMean

The output intensity range of random values.

Default value is 80.0f.

Definition at line 151 of file SoRandomImageGeneration.h.

◆ intensityRangeOutput

SoSFFloat SoRandomImageGeneration::intensityRangeOutput

The standard deviation.

Default value is 20.0f.

Definition at line 154 of file SoRandomImageGeneration.h.

◆ outImage

SoImageVizEngineOutput<SoSFImageDataAdapter,SoImageDataAdapter*> SoRandomImageGeneration::outImage

The output image.

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

Definition at line 157 of file SoRandomImageGeneration.h.

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

ImageViz/Engines/ImageManipulation/SyntheticImages/SoRandomImageGeneration.h

Open Inventor Release 2023.2.3

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members