Documentation#

WelDX - data and quality standards for welding research data#

The weldx package provides several tools to setup an experiment, systematically process measurement data, and archive it in a standardized fashion.

Here we quickly list the most important functions and classes.

File handling

Read and write weldx files.

WeldxFile([filename_or_file_like, mode, ...])

Expose an ASDF file as a dictionary like object and handle underlying files.

Welding

These classes and functions are used to define welding processes.

GmawProcess(base_process, manufacturer, ...)

Container class for all GMAW processes.

get_groove(groove_type[, ...])

Create a Groove from weldx.tags.core.groove.

Unit handling

Q_

alias of Quantity

U_

alias of Unit

Data handling and transformation

Time(time[, time_ref])

Provides a unified interface for time related operations.

TimeSeries(data[, time, interpolation, ...])

Describes the behaviour of a quantity in time.

GenericSeries(obj[, dims, coords, units, ...])

Describes a quantity depending on one or more parameters.

SpatialSeries(obj[, dims, coords, units, ...])

Describes a line in 3d space depending on the positional coordinate s.

MathematicalExpression(expression[, parameters])

Mathematical expression using sympy syntax.

CoordinateSystemManager(...[, ...])

Handles hierarchical dependencies between multiple coordinate systems.

LocalCoordinateSystem([orientation, ...])

Defines a local cartesian coordinate system in 3d.

WXRotation

Wrapper for creating meta-tagged Rotation objects.

Geometry

These classes are used to define workpiece geometries.

ArcSegment(points[, arc_winding_ccw])

Arc segment.

Geometry(profile, trace_or_length[, width])

Defines a 3 dimensional geometry by extrusion of a 2 dimensional profile.

DynamicBaseSegment(series[, max_coord])

Segment class to define arbitrary lines using the SpatialSeries.

DynamicShapeSegment(series[, max_coord])

Shape segment class to define arbitrary 2d shapes.

LineSegment(points)

Line segment.

LinearHorizontalTraceSegment(length)

Trace segment with a linear path and constant z-component.

Profile(shapes[, units])

Defines a 2d profile.

Shape([segments])

Defines a shape in 2 dimensions.

Trace(segments[, coordinate_system])

Defines a 3d trace.

SpatialData(coordinates[, triangles, ...])

Represent 3D point cloud data with optional triangulation.

DynamicTraceSegment(series[, max_coord, ...])

Trace segment that can be defined by a SpatialSeries.

Full API Reference

Here you find the full documentation for all sub-modules in weldx including their classes and functions.

constants

Define constants for global library use.

core

Collection of common classes and functions.

geometry

Provides classes to define lines and surfaces.

measurement

Contains measurement related classes and functions.

transformations

Contains methods and classes for coordinate transformations.

util

Contains utility functions and classes.

time

Contains classes and functions related to time.

types

Common type definitions.

visualization

Visualization of spatial data, coordinate systems (cs), and cs manager.

welding

Module for welding related classes.

ASDF API Reference

Here you find the documentation of the underlying ASDF implementation. These classes and functions are used to read and write weldx data types in the ASDF data format.

asdf.extension

ASDF-extensions for weldx types.

asdf.util

Utilities for asdf files.

asdf.validators

ASDF-validators for weldx types.