parq_blockmodel.utils.demo_block_model.create_toy_blockmodel

parq_blockmodel.utils.demo_block_model.create_toy_blockmodel(shape=(20, 15, 10), block_size=(1.0, 1.0, 1.0), corner=(0.0, 0.0, 0.0), axis_azimuth=0.0, axis_dip=0.0, axis_plunge=0.0, deposit_bearing=20.0, deposit_dip=30.0, deposit_plunge=10.0, grade_name='grade', grade_min=50.0, grade_max=65.0, deposit_center=(10.0, 7.5, 5.0), deposit_radii=(8.0, 5.0, 3.0), noise_std=0.0, parquet_filepath=None)

Create a toy blockmodel with a gradient ellipsoid grade. :type shape: :param shape: Shape of the block model (nx, ny, nz). :type block_size: :param block_size: Size of each block (dx, dy, dz). :type corner: :param corner: The lower left (minimum) corner of the block model. :type axis_azimuth: :param axis_azimuth: The azimuth angle of the block model axis in degrees. :type axis_dip: :param axis_dip: The dip angle of the block model axis in degrees. :type axis_plunge: :param axis_plunge: The plunge angle of the block model axis in degrees. :type deposit_bearing: :param deposit_bearing: The azimuth angle of the deposit in degrees. :type deposit_dip: :param deposit_dip: The dip angle of the deposit in degrees. :type deposit_plunge: :param deposit_plunge: The plunge angle of the deposit in degrees. :type grade_name: :param grade_name: The name of the column to store the grade values. :type grade_min: :param grade_min: The minimum grade value. :type grade_max: :param grade_max: The maximum grade value. :type deposit_center: :param deposit_center: The center of the deposit (x, y, z). :type deposit_radii: :param deposit_radii: The radii of the deposit (rx, ry, rz). :type noise_std: float :param noise_std: Standard deviation of the noise to add to the grade values. :type parquet_filepath: Path :param parquet_filepath: The file path to save the DataFrame as a Parquet file. If None, returns a DataFrame.

Return type:

DataFrame | Path

Returns:

pd.DataFrame if parquet_filepath is None, else Path to the Parquet file.