Skip to content

Class: SurfaceSmoothingPlan ​

Defined in: geometry/SurfaceSmoothing.ts:18

Properties ​

byteLength ​

ts
readonly byteLength: number;

Defined in: geometry/SurfaceSmoothing.ts:19


method ​

ts
readonly method: "area-gaussian";

Defined in: geometry/SurfaceSmoothing.ts:20


metric ​

ts
readonly metric: SurfaceMetric;

Defined in: geometry/SurfaceSmoothing.ts:22


fwhmMm ​

ts
readonly fwhmMm: number;

Defined in: geometry/SurfaceSmoothing.ts:22


cutoffSigma ​

ts
readonly cutoffSigma: number;

Defined in: geometry/SurfaceSmoothing.ts:22


distanceMethod ​

ts
readonly distanceMethod: GeodesicMethod;

Defined in: geometry/SurfaceSmoothing.ts:22

Methods ​

prepare() ​

ts
prepare(options?, budgetBytes?): PreparedSurfaceSmoothing;

Defined in: geometry/SurfaceSmoothing.ts:25

Parameters ​

options? ​

ApplySurfaceOptions = {}

budgetBytes? ​

number = DEFAULT_PLAN_BUDGET

Returns ​

PreparedSurfaceSmoothing


prepareSteps() ​

ts
prepareSteps(options?, budgetBytes?): Generator<void, PreparedSurfaceSmoothing, void>;

Defined in: geometry/SurfaceSmoothing.ts:26

Parameters ​

options? ​

ApplySurfaceOptions = {}

budgetBytes? ​

number = DEFAULT_PLAN_BUDGET

Returns ​

Generator<void, PreparedSurfaceSmoothing, void>


copyWeights() ​

ts
copyWeights(): Required<SparseWeights>;

Defined in: geometry/SurfaceSmoothing.ts:29

Returns ​

Required<SparseWeights>


apply() ​

ts
apply(
   values, 
   options?, 
   output?
): SurfaceComputationResult;

Defined in: geometry/SurfaceSmoothing.ts:30

Parameters ​

values ​

ArrayLike<number>

options? ​

ApplySurfaceOptions = {}

output? ​

SurfaceComputationResult

Returns ​

SurfaceComputationResult


applySteps() ​

ts
applySteps(values, options?): Generator<void, SurfaceComputationResult, void>;

Defined in: geometry/SurfaceSmoothing.ts:31

Parameters ​

values ​

ArrayLike<number>

options? ​

ApplySurfaceOptions = {}

Returns ​

Generator<void, SurfaceComputationResult, void>

Released under the MIT License.