curve_apps.contours package

Submodules

curve_apps.contours.driver module

class curve_apps.contours.driver.ContoursDriver(*args: Any, **kwargs: Any)

Bases: BaseCurveDriver

Driver for the detection of contours within geoh5py objects.

Parameters:

parameters – Application parameters.

static get_contours(grid: list[numpy.ndarray], data: numpy.ndarray, contour_list: list[float]) → tuple[numpy.ndarray, numpy.ndarray, numpy.ndarray]

Return vertices, edges, and values for contours.

Parameters:

  • grid – list of x and y grids.

  • data – 2D array of data living in grid.

  • contour_list – list of contour values.

make_curve()

Make curve object from contours detected in source data.

curve_apps.contours.params module

class curve_apps.contours.params.ContourDetectionParameters(*args: Any, **kwargs: Any)

Bases: BaseModel

Contour specification parameters.

Parameters:

  • interval_min – Minimum value for contours.

  • interval_max – Maximum value for contours.

  • interval_spacing – Step size for contours.

  • fixed_contours – String defining list of fixed contours.

  • max_distance – Maximum distance for interpolation.

  • resolution – Resolution of underlying grid.

property contours: list[float]

Returns a list of requested contours merging interval and fixed values.

fixed_contour_input_to_list_of_floats()

Parse fixed contour string into list of floats.

fixed_contours: list[float] | None = None
property has_intervals: bool

True if interval min, max and spacing are defined.

interval_max: float | None = None
interval_min: float | None = None
interval_spacing: float | None = None
property intervals: list[float]

Returns arange of requested contour intervals.

max_distance: float = 500.0
resolution: float = 50.0
class curve_apps.contours.params.ContourOutputParameters(*args: Any, **kwargs: Any)

Bases: BaseModel

Output parameters.

Parameters:

  • z_value – Use data values for curve height (z) channel

  • export_as – Name of the output entity.

  • out_group – Name of the output group.

export_as: str | None = 'Contours'
out_group: UIJsonGroup | None = None
z_value: bool = False
class curve_apps.contours.params.ContourParameters(*args: Any, **kwargs: Any)

Bases: BaseData

Contour parameters for use with contours.driver.

Parameters:

  • contours – Contouring parameters.

  • source – Parameters for the source object and data.

  • output – Output

conda_environment: str = 'curve_apps'
default_ui_json: ClassVar[Path] = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/mirageoscience-curve-apps/envs/latest/lib/python3.10/site-packages/curve_apps-assets/uijson/contours.ui.json')
detection: ContourDetectionParameters
name: ClassVar[str] = 'contours'
run_command: ClassVar[str] = 'curve_apps.contour_detection.driver'
source: ContourSourceParameters
title: ClassVar[str] = 'Contour Detection'
class curve_apps.contours.params.ContourSourceParameters(*args: Any, **kwargs: Any)

Bases: BaseModel

Source parameters providing input data to the driver.

Parameters:

  • objects – A Grid2D, Points, Curve or Surface source object.

  • data – Data values to contour.

data: Data
objects: Grid2D | Points | Curve | Surface