FeatureExtractionBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# FeatureExtractionBuilder Class

class `NXOpen.Facet.``FeatureExtractionBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Facet.FeatureExtractionBuilder` It extracts feature lines or separates regions of different curvature from a facet body based on the curvature map.

  For facet body curvature, please see `NXOpen.Facet.CurvatureBuilder`.

  To create a new instance of this class, use `NXOpen.Facet.FacetedBodyCollection.CreateFacetFeatureExtractionBuilder()`

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
AreBordersEnabled | Returns or sets the extracting borders option
AreRegionsEnabled | Returns or sets the extracting regions option
FacetBodies | Returns the input facet body selection list
InputAction | Returns or sets the input facet body action
IsSmoothingEnabled | Returns or sets the smoothing option
MinimumBorderLength | Returns or sets the minimum border length
SmoothingFactor | Returns or sets the smoothing factor
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetExtractedBorders | Gets the extracted curves.
GetExtractedRegions | Gets the extracted facet bodies.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

FeatureExtractionBuilderInputActions Enumeration | Specifies how to handle the input facet bodies.

# Property Detail

## AreBordersEnabled

`FeatureExtractionBuilder.``AreBordersEnabled`

  Returns or sets the extracting borders option

  `-------------------------------------`

  Getter Method

  Signature `AreBordersEnabled`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `AreBordersEnabled`

  Parameters: | bordersEnabled (bool) –

  New in version NX5.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## AreRegionsEnabled

`FeatureExtractionBuilder.``AreRegionsEnabled`

  Returns or sets the extracting regions option

  `-------------------------------------`

  Getter Method

  Signature `AreRegionsEnabled`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `AreRegionsEnabled`

  Parameters: | regionsEnabled (bool) –

  New in version NX5.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## FacetBodies

`FeatureExtractionBuilder.``FacetBodies`

  Returns the input facet body selection list

  `-------------------------------------`

  Getter Method

  Signature `FacetBodies`

  Returns: |
  Return type: | `NXOpen.Facet.SelectFacetedBodyList`

  New in version NX5.0.0.

  License requirements: None.

## InputAction

`FeatureExtractionBuilder.``InputAction`

  Returns or sets the input facet body action

  `-------------------------------------`

  Getter Method

  Signature `InputAction`

  Returns: |
  Return type: | `NXOpen.Facet.FeatureExtractionBuilderInputActions`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `InputAction`

  Parameters: | inputAction (`NXOpen.Facet.FeatureExtractionBuilderInputActions`) –

  New in version NX5.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## IsSmoothingEnabled

`FeatureExtractionBuilder.``IsSmoothingEnabled`

  Returns or sets the smoothing option

  `-------------------------------------`

  Getter Method

  Signature `IsSmoothingEnabled`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IsSmoothingEnabled`

  Parameters: | smoothingEanbled (bool) –

  New in version NX5.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## MinimumBorderLength

`FeatureExtractionBuilder.``MinimumBorderLength`

  Returns or sets the minimum border length

  `-------------------------------------`

  Getter Method

  Signature `MinimumBorderLength`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `MinimumBorderLength`

  Parameters: | minimumBorderLength (float) –

  New in version NX5.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## SmoothingFactor

`FeatureExtractionBuilder.``SmoothingFactor`

  Returns or sets the smoothing factor

  `-------------------------------------`

  Getter Method

  Signature `SmoothingFactor`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SmoothingFactor`

  Parameters: | smoothingFactor (float) –

  New in version NX5.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

# Method Detail

## GetExtractedBorders

`FeatureExtractionBuilder.``GetExtractedBorders`

  Gets the extracted curves.

  Call `Builder.Commit()` before calling this method.

  Signature `GetExtractedBorders()`

  Returns: | The extracted curves
  Return type: | list of `NXOpen.Spline`

  New in version NX5.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## GetExtractedRegions

`FeatureExtractionBuilder.``GetExtractedRegions`

  Gets the extracted facet bodies.

  Call `Builder.Commit()` before calling this method.

  Signature `GetExtractedRegions()`

  Returns: | The extracted facet bodies
  Return type: | list of `NXOpen.Facet.FacetedBody`

  New in version NX5.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## Validate

`FeatureExtractionBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.