curve_apps.trend_lines package

Submodules

curve_apps.trend_lines.driver module

class curve_apps.trend_lines.driver.TrendLinesDriver(*args: Any, **kwargs: Any)

Bases: BaseCurveDriver

Driver for the detection of trend curves across an object parts.

Parameters:

parameters – Application parameters.

get_connections() → tuple

Find connections between entity parts.

Params entity:

A Curve object with parts.

Params data:

Input referenced data.

Params detection:

Detection parameters.

:returns : n x 3 array. Vertices of connecting lines. :returns : n x 2 float array. Cells of edges. :returns : n x 1 array. Labels of vertices.

property labels: numpy.ndarray

Get labels from data.

make_curve()

Make curve object from trend lines detected in source data.

property parts: numpy.ndarray

Get parts from entity or data.

property vertices: numpy.ndarray

Get vertices from entity.

curve_apps.trend_lines.params module

class curve_apps.trend_lines.params.TrendLineDetectionParameters(*args: Any, **kwargs: Any)

Bases: BaseModel

Detection parameters expected by the ui.json file format.

Parameters:

  • azimuth – Azimuth of the path.

  • azimuth_tol – Tolerance for the azimuth of the path.

  • damping – Damping factor between [0, 1] for the path roughness.

  • min_edges – Minimum number of points in a curve.

  • max_distance – Maximum distance between points in a curve.

azimuth: float | None = None
azimuth_tol: float | None = None
damping: float = 0
max_distance: float | None = None
min_edges: int = 1
class curve_apps.trend_lines.params.TrendLineOutputParameters(*args: Any, **kwargs: Any)

Bases: BaseModel

Output parameters.

Parameters:

  • export_as – Name of the output entity.

  • out_group – Name of the output group.

export_as: str | None = 'trend_lines'
out_group: UIJsonGroup | None = None
class curve_apps.trend_lines.params.TrendLineParameters(*args: Any, **kwargs: Any)

Bases: BaseData

Trend lines parameters for use with trend_lines.driver.

Parameters:

  • source – Source data parameters.

  • detection – Trend line detection parameters.

  • output – Trend line output parameters.

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/trend_lines.ui.json')
detection: TrendLineDetectionParameters
name: ClassVar[str] = 'trend_lines'
run_command: ClassVar[str] = 'curve_apps.trend_line_detection.driver'
source: TrendLineSourceParameters
title: ClassVar[str] = 'Trend Lines Detection'
class curve_apps.trend_lines.params.TrendLineSourceParameters(*args: Any, **kwargs: Any)

Bases: BaseModel

Source parameters expected by the ui.json file format.

Parameters:

  • entity – A Curve or Points source object.

  • data – Data values to find edges on.

  • parts – Optional parts to connect.

data: ReferencedData | None = None
entity: Curve | Points
parts: Data | None = None