Plotting¶
-
volcapy.plotting.plot.plot(vals, coords, cmin=2150, cmax=2550.0, n_sample=0)[source]¶ Plot 3 dimensional scalar field.
- Parameters
- vals: List[float]
List of values to plot.
- x_coords: List[float]
x-coordinate of the data points. Should have the same lenght as the list of values.
- y_coords: List[float]
- z_coords: List[float]
- n_sample: int
If non zero, then will only plot n_sample randomly selected points from the dataset. Useful for visualizing heavy datasets.
-
volcapy.plotting.plot.plot_region(region_inds, vals, coords, cmin=2150, cmax=2550.0, n_sample=0)[source]¶ Same as above, but only plot a certain region. The region is defined by passing the indices of the cell in the region.
- Parameters
- region_inds: 1D array-like
Indices of the cells in the region.
- vals: List[float]
List of values to plot.
- x_coords: List[float]
x-coordinate of the data points. Should have the same lenght as the list of values.
- y_coords: List[float]
- z_coords: List[float]
- n_sample: int
If non zero, then will only plot n_sample randomly selected points from the dataset. Useful for visualizing heavy datasets.
-
volcapy.plotting.plot.plot_x_slice(slice_x, vals, coords, cmin=2150, cmax=2550.0, n_sample=0)[source]¶ Same as above, but only plot as slice of fixed z coordinate.
- Parameters
- slice_height: float or List[float]
Value of the z coordinate along which to slice. If a list, then will plot several slices.
- vals: List[float]
List of values to plot.
- x_coords: List[float]
x-coordinate of the data points. Should have the same lenght as the list of values.
- y_coords: List[float]
- z_coords: List[float]
- n_sample: int
If non zero, then will only plot n_sample randomly selected points from the dataset. Useful for visualizing heavy datasets.
-
volcapy.plotting.plot.plot_y_slice(slice_y, vals, coords, cmin=2150, cmax=2550.0, n_sample=0)[source]¶ Same as above, but only plot as slice of fixed z coordinate.
- Parameters
- slice_height: float or List[float]
Value of the z coordinate along which to slice. If a list, then will plot several slices.
- vals: List[float]
List of values to plot.
- x_coords: List[float]
x-coordinate of the data points. Should have the same lenght as the list of values.
- y_coords: List[float]
- z_coords: List[float]
- n_sample: int
If non zero, then will only plot n_sample randomly selected points from the dataset. Useful for visualizing heavy datasets.
-
volcapy.plotting.plot.plot_z_slice(slice_height, vals, coords, cmin=2150, cmax=2550.0, n_sample=0)[source]¶ Same as above, but only plot as slice of fixed z coordinate.
- Parameters
- slice_height: float or List[float]
Value of the z coordinate along which to slice. If a list, then will plot several slices.
- vals: List[float]
List of values to plot.
- x_coords: List[float]
x-coordinate of the data points. Should have the same lenght as the list of values.
- y_coords: List[float]
- z_coords: List[float]
- n_sample: int
If non zero, then will only plot n_sample randomly selected points from the dataset. Useful for visualizing heavy datasets.