Last updated

API / geotoolkit / seismic / analysis / filters / TaperFrequencyBoundary / TaperFrequencyBoundary

Class: TaperFrequencyBoundary

filters.TaperFrequencyBoundary.TaperFrequencyBoundary

This class encapsulates the frequencies of the taper for class cgTyperFilter. The frequencies should always satisfy the requirement that f1<f2<f3<f4

Table of contents

Constructors
[new TaperFrequencyBoundary(f1)](/solutions/geotoolkit/apis/classes/geotoolkit.seismic.analysis.filters.taperfrequencyboundary.taperfrequencyboundary.md#new taperfrequencyboundary(f1))[new TaperFrequencyBoundary(f1, f2, f3, f4)](/solutions/geotoolkit/apis/classes/geotoolkit.seismic.analysis.filters.taperfrequencyboundary.taperfrequencyboundary.md#new taperfrequencyboundary(f1, f2, f3, f4))
Methods

Contents

Constructors

new TaperFrequencyBoundary(f1)

new TaperFrequencyBoundary(f1?)

Parameters

Name Type Description
Optional f1TaperFrequencyBoundaryanother TaperFrequencyBoundary

new TaperFrequencyBoundary(f1, f2, f3, f4)

new TaperFrequencyBoundary(f1, f2, f3, f4)

Parameters

Name Type Description
f1number1st frequency (hrz)
f2number2nd frequency (hrz)
f3number3rd frequency (hrz)
f4number4th frequency (hrz)
Methods

equals

equals(frequencyBoundary): boolean

Determines whether this frequency boundary equals another frequency boundary

Parameters

Name Type Description
frequencyBoundaryTaperFrequencyBoundaryThe frequency boundary

Returns

boolean


getClassName

getClassName(): string

Returns

string


getF1

getF1(): number

Gets the 1st frequency (hrz)

Returns

number

f1 the 1st frequency (hrz)


getF2

getF2(): number

Gets the 2nd frequency (hrz)

Returns

number

f2 the 2nd frequency (hrz)


getF3

getF3(): number

Gets the 3rd frequency (hrz)

Returns

number

f3 the 3rd frequency (hrz)


getF4

getF4(): number

Gets the 4th frequency (hrz)

Returns

number

f4 the 4th frequency (hrz)


isValid

isValid(): boolean

Determines whether the boundary frequencies are valid

Returns

boolean

isValid True if frequencies are valid


setF1

setF1(f1): TaperFrequencyBoundary

Sets the 1st frequency (hrz)

Parameters

Name Type Description
f1number1st frequency (hrz)

Returns

TaperFrequencyBoundary

this


setF2

setF2(f2): TaperFrequencyBoundary

Sets the 2nd frequency (hrz)

Parameters

Name Type Description
f2number2nd frequency (hrz)

Returns

TaperFrequencyBoundary

this


setF3

setF3(f3): TaperFrequencyBoundary

Sets the 3rd frequency (hrz)

Parameters

Name Type Description
f3number3rd frequency (hrz)

Returns

TaperFrequencyBoundary

this


setF4

setF4(f4): TaperFrequencyBoundary

Sets the 4th frequency (hrz)

Parameters

Name Type Description
f4number4nd frequency (hrz)

Returns

TaperFrequencyBoundary

this


setFrequencyBoundary

setFrequencyBoundary(f1): TaperFrequencyBoundary

Sets frequency boundary

Parameters

Name Type Description
f1TaperFrequencyBoundaryanother TaperFrequencyBoundary

Returns

TaperFrequencyBoundary

this

setFrequencyBoundary(f1, f2, f3, f4): TaperFrequencyBoundary

Sets frequency boundary

Parameters

Name Type Description
f1number1st frequency (hrz)
f2number2-nd frequency (hrz)
f3number3-rd frequency (hrz)
f4number4-th frequency (hrz)

Returns

TaperFrequencyBoundary

this


getClassName

Static getClassName(): string

Returns

string