InverseFORM

class otrobopt.InverseFORM(*args)

Inverse FORM.

Parameters:

eventRandomVector

Event we are computing the probability of.

parameterNamestr

The optimized parameter

physicalStartingPointsequence of float

Optimization starting point

Methods

getBetaConvergence()	Beta convergence criterion accessor.
getClassName()	Accessor to the object's name.
getFixedStep()	Fixed-step mode accessor.
getFixedStepValue()	Fixed-step value accessor.
getId()	Accessor to the object's id.
getLimitStateConvergence()	Limit-state convergence criterion accessor.
getMaximumIteration()	Maximum iteration accessor.
getName()	Accessor to the object's name.
getResult()	Result accessor.
getShadowedId()	Accessor to the object's shadowed id.
getTargetBeta()	Target beta accessor.
getVariableConvergence()	Variable convergence criterion accessor.
getVariableStepMaxIterations()	Line search maximum iteration accessor.
getVisibility()	Accessor to the object's visibility state.
hasName()	Test if the object is named.
hasVisibleName()	Test if the object has a distinguishable name.
run()	Run algorithm.
setBetaConvergence(betaConvergence)	Beta convergence criterion accessor.
setFixedStep(fixedStep)	Fixed-step mode accessor.
setFixedStepValue(fixedStepValue)	Fixed-step value accessor.
setLimitStateConvergence(limitStateConvergence)	Limit-state convergence criterion accessor.
setMaximumIteration(maximumIteration)	Maximum iteration accessor.
setName(name)	Accessor to the object's name.
setResult(result)	Result accessor.
setShadowedId(id)	Accessor to the object's shadowed id.
setTargetBeta(targetBeta)	Target beta accessor.
setVariableConvergence(variableConvergence)	Variable convergence criterion accessor.
setVariableStepMaxIterations(...)	Line search maximum iteration accessor.
setVisibility(visible)	Accessor to the object's visibility state.

__init__(*args)

getBetaConvergence()

Beta convergence criterion accessor.

getClassName()

Accessor to the object’s name.

Returns:

class_namestr

The object class name (object.__class__.__name__).

getFixedStep()

Fixed-step mode accessor.

getFixedStepValue()

Fixed-step value accessor.

getId()

Accessor to the object’s id.

Returns:

idint

Internal unique identifier.

getLimitStateConvergence()

Limit-state convergence criterion accessor.

getMaximumIteration()

Maximum iteration accessor.

getName()

Accessor to the object’s name.

Returns:

namestr

The name of the object.

getResult()

Result accessor.

Returns:

resultInverseFORMResult

Result.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

idint

Internal unique identifier.

getTargetBeta()

Target beta accessor.

getVariableConvergence()

Variable convergence criterion accessor.

getVariableStepMaxIterations()

Line search maximum iteration accessor.

getVisibility()

Accessor to the object’s visibility state.

Returns:

visiblebool

Visibility flag.

hasName()

Test if the object is named.

Returns:

hasNamebool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:

hasVisibleNamebool

True if the name is not empty and not the default one.

run()

Run algorithm.

setBetaConvergence(betaConvergence)

Beta convergence criterion accessor.

setFixedStep(fixedStep)

Fixed-step mode accessor.

setFixedStepValue(fixedStepValue)

Fixed-step value accessor.

setLimitStateConvergence(limitStateConvergence)

Limit-state convergence criterion accessor.

setMaximumIteration(maximumIteration)

Maximum iteration accessor.

setName(name)

Accessor to the object’s name.

Parameters:

namestr

The name of the object.

setResult(result)

Result accessor.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:

idint

Internal unique identifier.

setTargetBeta(targetBeta)

Target beta accessor.

setVariableConvergence(variableConvergence)

Variable convergence criterion accessor.

setVariableStepMaxIterations(variableStepMaxIterations)

Line search maximum iteration accessor.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:

visiblebool

Visibility flag.