aPriori Documentation
  • šŸ‘‹Welcome to aPriori
  • Getting started
    • What is aPriori?
    • Installation
    • Quickstart
  • Fundamentals and usage
    • aPriori Fundamentals
      • Data Formatting
      • Cut a 3D scalar
      • Filter a 3D scalar field
      • Initialize a DNS field
      • Data visualization
      • Cut a DNS field
      • Filter a DNS field
    • Machine Learning Tutorials
      • Data-Driven Closure for Turbulence-Chemistry interaction
      • Dynamic Data-Driven Smagorinky Closure for LES
  • API guide
    • Field3D
      • Field3D.build_attributes_list
      • Field3D.check_valid_attribute
      • Field3D.compute_chemical_timescale
      • Field3D.compute_kinetic_energy
      • Field3D.compute_mixing_timescale
      • Field3D.compute_residual_kinetic_energy
      • Field3D.compute_residual_dissipation_rate
      • Field3D.compute_reaction_rates
      • Field3D.compute_reaction_rates_batch
      • Field3D.compute_strain_rate
      • Field3D.compute_tau_r
      • Field3D.compute_velocity_module
      • Field3D.cut
      • Field3D.filter_favre
      • Field3D.filter
      • Field3D.find_path
      • Field3D.plot_x_midplane
      • Field3D.plot_y_midplane
      • Field3D.plot_z_midplane
      • Field3D.print_attributes
      • Field3D.update
    • Scalar3D
      • Scalar3D.is_light_mode
      • Scalar3D.reshape_3d
      • Scalar3D.reshape_column
      • Scalar3D.reshape_line
      • Scalar3D.cut
      • Scalar3D.filter_gauss
      • Scalar3D.plot_x_midplane
      • Scalar3D.plot_y_midplane
      • Scalar3D.plot_z_midplane
    • Mesh3D
  • BIBLIOGRAPHY
Powered by GitBook
On this page
  • Scalar3D.filter_gauss(self, delta,n_cut=0,mute=False):
  • Description
  • Parameters
  • Returns
  1. API guide
  2. Scalar3D

Scalar3D.filter_gauss

PreviousScalar3D.cutNextScalar3D.plot_x_midplane

Last updated 1 year ago

Scalar3D.filter_gauss(self, delta,n_cut=0,mute=False):

Description

Filters the scalar field with a Gaussian function.

The variance sigma is considered equal to:

Ļƒ=112ā‹…Ī”2\sigma = \sqrt{\frac{1}{12} \cdot \Delta^2}Ļƒ=121ā€‹ā‹…Ī”2ā€‹

where delta is the amplitude of the Gaussian filter.

Parameters

  • delta (float): The amplitude of the Gaussian filter.

  • n_cut (int, optional): The number of samples to cut at the extrema. Default is 0.

  • mute (bool, optional): A flag indicating whether to mute the output. Default is False.

Returns

  • array-like: The filtered scalar field.