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.
|
Expose an ASDF file as a dictionary like object and handle underlying files. |
Welding
These classes and functions are used to define welding processes.
|
Container class for all GMAW processes. |
|
Create a Groove from weldx.tags.core.groove. |
Unit handling
|
Create a quantity from a scalar or array. |
|
For details on working with quantities and units, please see the pint documentation |
Data handling and transformation
|
Provides a unified interface for time related operations. |
|
Describes the behaviour of a quantity in time. |
|
Describes a quantity depending on one or more parameters. |
|
Describes a line in 3d space depending on the positional coordinate |
|
Mathematical expression using sympy syntax. |
|
Handles hierarchical dependencies between multiple coordinate systems. |
|
Defines a local cartesian coordinate system in 3d. |
Wrapper for creating meta-tagged |
Geometry
These classes are used to define workpiece geometries.
|
Arc segment. |
|
Defines a 3 dimensional geometry by extrusion of a 2 dimensional profile. |
|
Segment class to define arbitrary lines using the |
|
Shape segment class to define arbitrary 2d shapes. |
|
Line segment. |
|
Trace segment with a linear path and constant z-component. |
|
Defines a 2d profile. |
|
Defines a shape in 2 dimensions. |
|
Defines a 3d trace. |
|
Represent 3D point cloud data with optional triangulation. |
|
Trace segment that can be defined by a |
Full API Reference
Here you find the full documentation for all sub-modules in weldx including their classes and functions.
Define constants for global library use. |
|
Collection of common classes and functions. |
|
Provides classes to define lines and surfaces. |
|
Contains measurement related classes and functions. |
|
Contains methods and classes for coordinate transformations. |
|
Contains utility functions and classes. |
|
Contains classes and functions related to time. |
|
Common type definitions. |
|
Visualization of spatial data, coordinate systems (cs), and cs manager. |
|
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-extensions for weldx types. |
|
Utilities for asdf files. |
|
ASDF-validators for weldx types. |