ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | List of all members
itk::Statistics::RandomVariateGeneratorBase Class Referenceabstract

#include <itkRandomVariateGeneratorBase.h>

Detailed Description

Defines common interfaces for random variate generators.

Definition at line 33 of file itkRandomVariateGeneratorBase.h.

+ Inheritance diagram for itk::Statistics::RandomVariateGeneratorBase:
+ Collaboration diagram for itk::Statistics::RandomVariateGeneratorBase:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = RandomVariateGeneratorBase
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

const char * GetNameOfClass () const override
 
virtual double GetVariate ()=0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 RandomVariateGeneratorBase ()
 
 ~RandomVariateGeneratorBase () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

Definition at line 40 of file itkRandomVariateGeneratorBase.h.

◆ Pointer

Definition at line 39 of file itkRandomVariateGeneratorBase.h.

◆ Self

Standard class type aliases.

Definition at line 37 of file itkRandomVariateGeneratorBase.h.

◆ Superclass

Definition at line 38 of file itkRandomVariateGeneratorBase.h.

Constructor & Destructor Documentation

◆ RandomVariateGeneratorBase()

itk::Statistics::RandomVariateGeneratorBase::RandomVariateGeneratorBase ( )
protected

◆ ~RandomVariateGeneratorBase()

itk::Statistics::RandomVariateGeneratorBase::~RandomVariateGeneratorBase ( )
overrideprotected

Member Function Documentation

◆ GetNameOfClass()

const char* itk::Statistics::RandomVariateGeneratorBase::GetNameOfClass ( ) const
overridevirtual

◆ GetVariate()

virtual double itk::Statistics::RandomVariateGeneratorBase::GetVariate ( )
pure virtual

get a variate using FastNorm function

Implemented in itk::Statistics::MersenneTwisterRandomVariateGenerator, and itk::Statistics::NormalVariateGenerator.


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