Unfold

Coordinates in the frame of a layer between two surfaces.

Folded or undulating layers flatten: w places a point between the footwall and the hanging wall, vertically, and (u, v) run along the layer. Variograms and estimates computed on unfolded coordinates follow the layer; results stay in the input's row order, so they go back to the real points or blocks as they are.

Parameters:

Name	Type	Description	Default
footwall	Mesh	Bounding surfaces, such as grid_surface meshes; where either overlaps itself in plan, its highest elevation counts.	required
hangingwall	Mesh	Bounding surfaces, such as grid_surface meshes; where either overlaps itself in plan, its highest elevation counts.	required
mode	(proportional, footwall, hangingwall)	w as the relative position, 0 on the footwall and 1 on the hanging wall; as the height above the footwall; or as the height relative to the hanging wall, negative below it.	"proportional"
reference	(footwall, hangingwall)	Surface along which u and v are arc lengths in the x and y directions, from its south-west corner and offset so that a flat surface keeps x and y. By default u and v are x and y.	"footwall"
extrapolate	bool	Unfold points above or below the layer too, instead of giving NaN.	False

fit method descriptor

fit(coords)

Nothing to learn from the data; checks the coordinates and returns the unfolding, for pipelines.

fit_transform method descriptor

fit_transform(coords)

Same as transform.

from_json staticmethod

from_json(text)

Reads to_json output; raises InvalidInput on another class's JSON or a newer format.

inverse method descriptor

inverse(coords)

Real coordinates of unfolded points.

Parameters:

Name	Type	Description	Default
coords	array_like	(n, 3) rows of (u, v, w).	required

Returns:

Type	Description
ndarray	(n, 3) rows of (x, y, z), NaN where transform would give NaN. With a reference surface, (x, y) is found by Newton steps and is NaN if they do not converge.

to_json method descriptor

to_json()

JSON of the surfaces and options.

transform method descriptor

transform(coords)

Unfold points.

Parameters:

Name	Type	Description	Default
coords	(array_like, PointSet or BlockModel)	(n, 3) points, or the centroids of a point set or block model.	required

Returns:

Type	Description
ndarray	(n, 3) rows of (u, v, w). NaN where the surfaces do not both cover the point in plan, the hanging wall lies below the footwall (or on it, for "proportional"), or, unless extrapolating, the point is outside the layer.

used in

• unfolding