ArPLS Type

Constructors

Constructor Description

ArPLS(original)

Full Usage: ArPLS(original)

Parameters:

original : ArPLS

ArPLS()

Full Usage: ArPLS()

Instance members

Instance member Description

this.ActualNumberOfIterations

Full Usage: this.ActualNumberOfIterations

Gets the number of iterations that were executed during the last call to !:Execute(IEnumerable).

this.EqualityContract

Full Usage: this.EqualityContract

Returns: Type
Modifiers: abstract

Returns: Type

this.Equals

Full Usage: this.Equals

Parameters:
    obj : obj

Returns: bool
Modifiers: abstract

obj : obj
Returns: bool

this.Equals

Full Usage: this.Equals

Parameters:
Returns: bool
Modifiers: abstract

other : ALSBase
Returns: bool

this.Equals

Full Usage: this.Equals

Parameters:
Returns: bool
Modifiers: abstract

other : ArPLS
Returns: bool

this.Execute

Full Usage: this.Execute

Parameters:
    xArray : float[]
    yArray : float[]

Returns: float[]
Modifiers: abstract

xArray : float[]
yArray : float[]
Returns: float[]

this.GetHashCode

Full Usage: this.GetHashCode

Returns: int
Modifiers: abstract

Returns: int

this.Lambda

Full Usage: this.Lambda

Gets or sets the smoothing parameter lambda. The higher lambda is, the smoother the resulting curve will be.

ArgumentException Value must be > 0

this.MaximumNumberOfIterations

Full Usage: this.MaximumNumberOfIterations

Gets or sets the maximum number of iterations. The default value is 100. Usually, the number of iterations is determined by the ArPLS.TerminationRatio, but with this value, the maximum number of iterations can be limited to a smaller value.

ArgumentOutOfRangeException Value must be >=1

this.Order

Full Usage: this.Order

this.ScaleLambdaWithXUnits

Full Usage: this.ScaleLambdaWithXUnits

If true, lambda is scaled with the x units, so that the effect of baseline estimation is independent on the resolution of the spectrum.

this.TerminationRatio

Full Usage: this.TerminationRatio

Gets or sets the criterion for terminating the iteration (0..1). Default is 0.05. The iterations stops, if the L2 norm of the differences between actual and previous weights falls below (TerminationRatio x L2 norm of the previous weights). The lower the value is, the more iterations will be executed.

ArgumentException Value must be > 0 and < 1

this.ToString

Full Usage: this.ToString

Returns: string
Modifiers: abstract

Returns: string

this.``$``

Full Usage: this.``$``

Returns: ArPLS
Modifiers: abstract

Returns: ArPLS

Static members

Static member Description

left <> right

Full Usage: left <> right

Parameters:
Returns: bool

left : ArPLS
right : ArPLS
Returns: bool

left = right

Full Usage: left = right

Parameters:
Returns: bool

left : ArPLS
right : ArPLS
Returns: bool