ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::Statistics::SigmoidTransferFunction< TScalar > Class Template Reference

#include <itkSigmoidTransferFunction.h>

+ Inheritance diagram for itk::Statistics::SigmoidTransferFunction< TScalar >:
+ Collaboration diagram for itk::Statistics::SigmoidTransferFunction< TScalar >:

Detailed Description

template<typename TScalar>
class itk::Statistics::SigmoidTransferFunction< TScalar >

This is the itkSigmoidTransferFunction class.

Definition at line 34 of file itkSigmoidTransferFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef NumericTraits
< ScalarType >::RealType 
RealType
 
typedef TScalar ScalarType
 
typedef SigmoidTransferFunction Self
 
typedef TransferFunctionBase
< TScalar > 
Superclass
 
- Public Types inherited from itk::Statistics::TransferFunctionBase< TScalar >
typedef Array< TScalar > ArrayType
 
typedef SmartPointer< const SelfConstPointer
 
typedef TScalar InputType
 
typedef TScalar OutputType
 
typedef SmartPointer< SelfPointer
 
typedef TransferFunctionBase Self
 
typedef FunctionBase< TScalar,
TScalar > 
Superclass
 
- Public Types inherited from itk::FunctionBase< TScalar, TScalar >
typedef SmartPointer< const SelfConstPointer
 
typedef TScalar InputType
 
typedef TScalar OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual ScalarType Evaluate (const ScalarType &input) const override
 
virtual ScalarType EvaluateDerivative (const ScalarType &input) const override
 
virtual const char * GetNameOfClass () const
 
virtual void SetAlpha (RealType _arg)
 
virtual RealType GetAlpha ()
 
virtual void SetBeta (RealType _arg)
 
virtual RealType GetBeta ()
 
virtual void SetOutputMinimum (ScalarType _arg)
 
virtual ScalarType GetOutputMinimum ()
 
virtual void SetOutputMaximum (ScalarType _arg)
 
virtual ScalarType GetOutputMaximum ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 SigmoidTransferFunction ()
 
virtual ~SigmoidTransferFunction () override
 
- Protected Member Functions inherited from itk::Statistics::TransferFunctionBase< TScalar >
 TransferFunctionBase ()
 
 ~TransferFunctionBase () override
 
- Protected Member Functions inherited from itk::FunctionBase< TScalar, TScalar >
 FunctionBase ()
 
 ~FunctionBase () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~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 ()
 

Private Attributes

RealType m_Alpha
 
RealType m_Beta
 
ScalarType m_OutputMaximum
 
ScalarType m_OutputMinimum
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TScalar >
typedef SmartPointer<const Self> itk::Statistics::SigmoidTransferFunction< TScalar >::ConstPointer

Definition at line 42 of file itkSigmoidTransferFunction.h.

template<typename TScalar >
typedef SmartPointer<Self> itk::Statistics::SigmoidTransferFunction< TScalar >::Pointer

Definition at line 41 of file itkSigmoidTransferFunction.h.

template<typename TScalar >
typedef NumericTraits< ScalarType >::RealType itk::Statistics::SigmoidTransferFunction< TScalar >::RealType

Definition at line 45 of file itkSigmoidTransferFunction.h.

template<typename TScalar >
typedef TScalar itk::Statistics::SigmoidTransferFunction< TScalar >::ScalarType

Definition at line 44 of file itkSigmoidTransferFunction.h.

template<typename TScalar >
typedef SigmoidTransferFunction itk::Statistics::SigmoidTransferFunction< TScalar >::Self

Standard class typedefs.

Definition at line 39 of file itkSigmoidTransferFunction.h.

template<typename TScalar >
typedef TransferFunctionBase<TScalar> itk::Statistics::SigmoidTransferFunction< TScalar >::Superclass

Definition at line 40 of file itkSigmoidTransferFunction.h.

Constructor & Destructor Documentation

template<typename TScalar >
itk::Statistics::SigmoidTransferFunction< TScalar >::SigmoidTransferFunction ( )
protected
template<typename TScalar >
virtual itk::Statistics::SigmoidTransferFunction< TScalar >::~SigmoidTransferFunction ( )
overrideprotectedvirtual

Member Function Documentation

template<typename TScalar >
virtual::itk::LightObject::Pointer itk::Statistics::SigmoidTransferFunction< TScalar >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<typename TScalar >
virtual ScalarType itk::Statistics::SigmoidTransferFunction< TScalar >::Evaluate ( const ScalarType input) const
overridevirtual

Evaluate at the specified input position

Implements itk::Statistics::TransferFunctionBase< TScalar >.

template<typename TScalar >
virtual ScalarType itk::Statistics::SigmoidTransferFunction< TScalar >::EvaluateDerivative ( const ScalarType input) const
overridevirtual

Evaluate the derivative at the specified input position

Implements itk::Statistics::TransferFunctionBase< TScalar >.

template<typename TScalar >
virtual RealType itk::Statistics::SigmoidTransferFunction< TScalar >::GetAlpha ( )
virtual

Set/Get macros

template<typename TScalar >
virtual RealType itk::Statistics::SigmoidTransferFunction< TScalar >::GetBeta ( )
virtual

Set/Get macros

template<typename TScalar >
virtual const char* itk::Statistics::SigmoidTransferFunction< TScalar >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Statistics::TransferFunctionBase< TScalar >.

template<typename TScalar >
virtual ScalarType itk::Statistics::SigmoidTransferFunction< TScalar >::GetOutputMaximum ( )
virtual

Set/Get macros

template<typename TScalar >
virtual ScalarType itk::Statistics::SigmoidTransferFunction< TScalar >::GetOutputMinimum ( )
virtual

Set/Get macros

template<typename TScalar >
static Pointer itk::Statistics::SigmoidTransferFunction< TScalar >::New ( )
static

Method for creation through the object factory.

template<typename TScalar >
virtual void itk::Statistics::SigmoidTransferFunction< TScalar >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Method to print the object.

Reimplemented from itk::Statistics::TransferFunctionBase< TScalar >.

template<typename TScalar >
virtual void itk::Statistics::SigmoidTransferFunction< TScalar >::SetAlpha ( RealType  _arg)
virtual

Set/Get macros

template<typename TScalar >
virtual void itk::Statistics::SigmoidTransferFunction< TScalar >::SetBeta ( RealType  _arg)
virtual

Set/Get macros

template<typename TScalar >
virtual void itk::Statistics::SigmoidTransferFunction< TScalar >::SetOutputMaximum ( ScalarType  _arg)
virtual

Set/Get macros

template<typename TScalar >
virtual void itk::Statistics::SigmoidTransferFunction< TScalar >::SetOutputMinimum ( ScalarType  _arg)
virtual

Set/Get macros

Member Data Documentation

template<typename TScalar >
RealType itk::Statistics::SigmoidTransferFunction< TScalar >::m_Alpha
private

Definition at line 80 of file itkSigmoidTransferFunction.h.

template<typename TScalar >
RealType itk::Statistics::SigmoidTransferFunction< TScalar >::m_Beta
private

Definition at line 81 of file itkSigmoidTransferFunction.h.

template<typename TScalar >
ScalarType itk::Statistics::SigmoidTransferFunction< TScalar >::m_OutputMaximum
private

Definition at line 83 of file itkSigmoidTransferFunction.h.

template<typename TScalar >
ScalarType itk::Statistics::SigmoidTransferFunction< TScalar >::m_OutputMinimum
private

Definition at line 82 of file itkSigmoidTransferFunction.h.


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