|
VTK
9.0.1
|
Gaussian sequence of pseudo random numbers implemented with the Box-Mueller transform. More...
#include <vtkBoxMuellerRandomSequence.h>
Public Types | |
| typedef vtkGaussianRandomSequence | Superclass |
Public Types inherited from vtkGaussianRandomSequence | |
| typedef vtkRandomSequence | Superclass |
| Standard methods for type information and printing. More... | |
Public Types inherited from vtkRandomSequence | |
| typedef vtkObject | Superclass |
| Standard methods for type information and printing. More... | |
Public Member Functions | |
| virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
| vtkBoxMuellerRandomSequence * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| void | Initialize (vtkTypeUInt32 vtkNotUsed(seed)) override |
| Satisfy general API of vtkRandomSequence superclass. More... | |
| double | GetValue () override |
| Current value. More... | |
| void | Next () override |
| Move to the next number in the random sequence. More... | |
| vtkRandomSequence * | GetUniformSequence () |
| Return the uniformly distributed sequence of random numbers. More... | |
| void | SetUniformSequence (vtkRandomSequence *uniformSequence) |
| Set the uniformly distributed sequence of random numbers. More... | |
Public Member Functions inherited from vtkGaussianRandomSequence | |
| vtkGaussianRandomSequence * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual double | GetScaledValue (double mean, double standardDeviation) |
| Convenient method to return a value given the mean and standard deviation of the Gaussian distribution from the Gaussian distribution of mean=0 and standard deviation=1.0. More... | |
Public Member Functions inherited from vtkRandomSequence | |
| vtkRandomSequence * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | Initialize (vtkTypeUInt32 seed)=0 |
| Initialize the sequence with a seed. More... | |
Public Member Functions inherited from vtkObject | |
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
| virtual void | DebugOn () |
| Turn debugging output on. More... | |
| virtual void | DebugOff () |
| Turn debugging output off. More... | |
| bool | GetDebug () |
| Get the value of the debug flag. More... | |
| void | SetDebug (bool debugFlag) |
| Set the value of the debug flag. More... | |
| virtual void | Modified () |
| Update the modification time for this object. More... | |
| virtual vtkMTimeType | GetMTime () |
| Return this object's modified time. More... | |
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| vtkCommand * | GetCommand (unsigned long tag) |
| void | RemoveObserver (vtkCommand *) |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| void | RemoveObservers (const char *event, vtkCommand *) |
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| void | RemoveObserver (unsigned long tag) |
| void | RemoveObservers (unsigned long event) |
| void | RemoveObservers (const char *event) |
| void | RemoveAllObservers () |
| vtkTypeBool | HasObserver (unsigned long event) |
| vtkTypeBool | HasObserver (const char *event) |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
| int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| int | InvokeEvent (const char *event, void *callData) |
| int | InvokeEvent (unsigned long event) |
| int | InvokeEvent (const char *event) |
Public Member Functions inherited from vtkObjectBase | |
| const char * | GetClassName () const |
| Return the class name as a string. More... | |
| virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
| Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More... | |
| virtual void | Delete () |
| Delete a VTK object. More... | |
| virtual void | FastDelete () |
| Delete a reference to this object. More... | |
| void | InitializeObjectBase () |
| void | Print (ostream &os) |
| Print an object to an ostream. More... | |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object). More... | |
| virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object). More... | |
| int | GetReferenceCount () |
| Return the current reference count of this object. More... | |
| void | SetReferenceCount (int) |
| Sets the reference count. More... | |
| void | PrintRevisions (ostream &) |
| Legacy. More... | |
Static Public Member Functions | |
| static vtkBoxMuellerRandomSequence * | New () |
| Standard methods for instantiation, type information, and printing. More... | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkBoxMuellerRandomSequence * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkGaussianRandomSequence | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkGaussianRandomSequence * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkRandomSequence | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkRandomSequence * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkObject | |
| static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
| static void | BreakOnError () |
| This method is called when vtkErrorMacro executes. More... | |
| static void | SetGlobalWarningDisplay (int val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOn () |
| static void | GlobalWarningDisplayOff () |
| static int | GetGlobalWarningDisplay () |
Static Public Member Functions inherited from vtkObjectBase | |
| static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
| static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
| Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More... | |
| static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkBoxMuellerRandomSequence () | |
| ~vtkBoxMuellerRandomSequence () override | |
Protected Member Functions inherited from vtkGaussianRandomSequence | |
| vtkGaussianRandomSequence () | |
| ~vtkGaussianRandomSequence () override | |
Protected Member Functions inherited from vtkRandomSequence | |
| vtkRandomSequence () | |
| ~vtkRandomSequence () override | |
Protected Member Functions inherited from vtkObject | |
| vtkObject () | |
| ~vtkObject () override | |
| void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods allow a command to exclusively grab all events. More... | |
| void | InternalReleaseFocus () |
Protected Member Functions inherited from vtkObjectBase | |
| vtkObjectBase () | |
| virtual | ~vtkObjectBase () |
| virtual void | CollectRevisions (ostream &) |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| vtkObjectBase (const vtkObjectBase &) | |
| void | operator= (const vtkObjectBase &) |
Protected Attributes | |
| vtkRandomSequence * | UniformSequence |
| double | Value |
Protected Attributes inherited from vtkObject | |
| bool | Debug |
| vtkTimeStamp | MTime |
| vtkSubjectHelper * | SubjectHelper |
Protected Attributes inherited from vtkObjectBase | |
| std::atomic< int32_t > | ReferenceCount |
| vtkWeakPointerBase ** | WeakPointers |
Gaussian sequence of pseudo random numbers implemented with the Box-Mueller transform.
vtkGaussianRandomSequence is a sequence of pseudo random numbers distributed according to the Gaussian/normal distribution (mean=0 and standard deviation=1).
It based is calculation from a uniformly distributed pseudo random sequence. The initial sequence is a vtkMinimalStandardRandomSequence.
Definition at line 32 of file vtkBoxMuellerRandomSequence.h.
Definition at line 40 of file vtkBoxMuellerRandomSequence.h.
|
protected |
|
overrideprotected |
|
static |
Standard methods for instantiation, type information, and printing.
|
static |
|
virtual |
Return 1 if this class is the same type of (or a subclass of) the named class.
Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkGaussianRandomSequence.
|
static |
|
protectedvirtual |
Reimplemented from vtkGaussianRandomSequence.
| vtkBoxMuellerRandomSequence* vtkBoxMuellerRandomSequence::NewInstance | ( | ) | const |
|
overridevirtual |
Methods invoked by print to print information about the object including superclasses.
Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkObjectBase.
|
inlineoverride |
Satisfy general API of vtkRandomSequence superclass.
Initialize the sequence with a seed.
Definition at line 48 of file vtkBoxMuellerRandomSequence.h.
|
overridevirtual |
Current value.
Implements vtkRandomSequence.
|
overridevirtual |
Move to the next number in the random sequence.
Implements vtkRandomSequence.
| vtkRandomSequence* vtkBoxMuellerRandomSequence::GetUniformSequence | ( | ) |
Return the uniformly distributed sequence of random numbers.
| void vtkBoxMuellerRandomSequence::SetUniformSequence | ( | vtkRandomSequence * | uniformSequence | ) |
Set the uniformly distributed sequence of random numbers.
Default is a .
|
protected |
Definition at line 75 of file vtkBoxMuellerRandomSequence.h.
|
protected |
Definition at line 76 of file vtkBoxMuellerRandomSequence.h.
1.8.17