2.3.3.3.71. NXcg_primitive_set

Status:

base class, extends NXobject

Description:

Computational geometry description of a set of primitives in Euclidean space. ...

Computational geometry description of a set of primitives in Euclidean space.

Primitives must neither be degenerated nor self-intersect. Individual primitives can differ in their properties (e.g. size, shape, rotation).

Symbols:

The symbols used in the schema to specify e.g. dimensions of arrays.

d: The dimensionality of the space.

c: The cardinality of the set, i.e. the number of members.

Groups cited:

NXcg_unit_normal_set

Structure:

depends_on: (optional) NX_CHAR

Reference to an instance of :ref:`NXcoordinate_system` in which these primitiv ...

Reference to an instance of NXcoordinate_system in which these primitives are defined.

dimensionality: (optional) NX_POSINT {units=NX_UNITLESS}

The dimensionality of the primitive set. ...

The dimensionality of the primitive set.

Any of these values: 1 | 2 | 3

cardinality: (optional) NX_POSINT {units=NX_UNITLESS}

The cardinality of the primitive set.

identifier_offset: (optional) NX_INT {units=NX_UNITLESS}

Integer offset whereby the identifier of the first member ...

Integer offset whereby the identifier of the first member of the set differs from zero.

Identifiers can be defined either implicitly or explicitly. For implicit indexing identifiers are defined on the interval \([identifier\_offset, identifier\_offset + c - 1]\).

Therefore, implicit identifier are completely defined by the value of identifier_offset and cardinality. For example if identifier run from -2 to 3 the value for identifier_offset is -2.

For explicit indexing the field identifier has to be used. Fortran-/Matlab- and C-/Python-style indexing have specific implicit identifier conventions where identifier_offset is 1 and 0 respectively.

identifier: (optional) NX_INT (Rank: 1, Dimensions: [c])

Identifier of each member for explicit indexing.

center: (optional) NX_NUMBER (Rank: 2, Dimensions: [c, d]) {units=NX_ANY}

The center of mass position of each primitive.

is_center_of_mass: (optional) NX_BOOLEAN (Rank: 1, Dimensions: [c])

True if the center is a center of mass.

shape: (optional) NX_NUMBER (Rank: 2, Dimensions: [c, d]) {units=NX_LENGTH}

A qualitative description of the shape of each primitive.

length: (optional) NX_NUMBER (Rank: 1, Dimensions: [c]) {units=NX_LENGTH}

Qualifier for the length of characteristic features of the primitive. ...

Qualifier for the length of characteristic features of the primitive.

Often the term length is associated with the assumption that one edge is parallel to an axis of the coordinate system.

width: (optional) NX_NUMBER (Rank: 1, Dimensions: [c]) {units=NX_LENGTH}

Qualifier often used to describe the length of one characteristic edge ...

Qualifier often used to describe the length of one characteristic edge within the coordinate system.

is_closed: (optional) NX_BOOLEAN (Rank: 1, Dimensions: [c])

True if primitive is closed such that it has properties like area or volume.

volume: (optional) NX_NUMBER (Rank: 1, Dimensions: [c]) {units=NX_VOLUME}

Volume of each primitive. ...

Volume of each primitive.

Set to NaN if does not apply for primitives for which is_closed is False.

area: (optional) NX_NUMBER (Rank: 1, Dimensions: [c]) {units=NX_AREA}

Alias for surface_area of each primitive. ...

Alias for surface_area of each primitive.

Set to NaN if does not apply for primitives for which is_closed is False.

orientation: (optional) NX_NUMBER (Rank: 2, Dimensions: [c, d]) {units=NX_DIMENSIONLESS}

Direction unit vector which points along the ...

Direction unit vector which points along the longest principal axis of each primitive.

Use the depends_on attribute to specify in which coordinate system these direction unit vectors are defined.

vertex_normal: (optional) NXcg_unit_normal_set

edge_normal: (optional) NXcg_unit_normal_set

face_normal: (optional) NXcg_unit_normal_set

Hypertext Anchors

List of hypertext anchors for all groups, fields, attributes, and links defined in this class.

NXDL Source:

https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXcg_primitive_set.nxdl.xml