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.cut(self, n_cut=1, mode='equal'):
  • Description
  • Parameters
  • Returns
  • Example
  1. API guide
  2. Scalar3D

Scalar3D.cut

PreviousScalar3D.reshape_lineNextScalar3D.filter_gauss

Last updated 1 year ago

Scalar3D.cut(self, n_cut=1, mode='equal'):

Description

Cuts the scalar field.

Parameters

  • n_cut (int or tuple, optional): The number of samples to cut at the extrema. If mode is 'equal', n_cut is an integer specifying the number of samples to cut from each side. If mode is 'xyz', n_cut is a tuple specifying the number of samples to cut for each dimension. Default is 1.

  • mode ({'equal', 'xyz'}, optional): The mode of cutting. 'equal' cuts the same number of samples from each side, 'xyz' allows specifying the number of samples to cut for each dimension. Default is 'equal'.

Returns

  • array-like: The cut scalar field.

Example

# Example of cutting a scalar field
field = Scalar3D(shape=[10, 10, 10], value=np.random.rand(10, 10, 10))
# Cut the field with equal number of samples removed from each side
cut_field_equal = field.cut(n_cut=2, mode='equal')
print("Cut field with equal mode:")
print(cut_field_equal)
# Cut the field with specified number of samples removed for each dimension
cut_field_xyz = field.cut(n_cut=(1, 2, 3), mode='xyz')
print("\nCut field with xyz mode:")
print(cut_field_xyz)