## On this page

  

 

 # `ResponsePSDTool`

 Last update: 09.03.2026 

<a id="ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.ResponsePSDTool"></a>

#### *class* Ansys.ACT.Automation.Mechanical.ResponsePSDTool

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

Defines a ResponsePSDTool.

<a id="overview"></a>

## Overview

### Methods

NameDescription[`Activate`](#ResponsePSDTool.Activate)Activate the current object.[`AddComment`](#ResponsePSDTool.AddComment)Creates a new child Comment.[`AddFigure`](#ResponsePSDTool.AddFigure)Creates a new child Figure.[`AddImage`](#ResponsePSDTool.AddImage)Creates a new child Image.[`AddResponsePSD`](#ResponsePSDTool.AddResponsePSD)Creates a new ResponsePSD[`CopyTo`](#ResponsePSDTool.CopyTo)Copies all visible properties from this object to another.[`CreateParameter`](#ResponsePSDTool.CreateParameter)Creates a new parameter for a Property.[`Delete`](#ResponsePSDTool.Delete)Run the Delete action.[`Duplicate`](#ResponsePSDTool.Duplicate)Creates a copy of the current DataModelObject.[`EvaluateAllResults`](#ResponsePSDTool.EvaluateAllResults)Run the EvaluateAllResults action.[`GetChildren`](#ResponsePSDTool.GetChildren)Gets the list of children, filtered by type.[`GetParameter`](#ResponsePSDTool.GetParameter)Gets the parameter corresponding to the given property.[`GroupAllSimilarChildren`](#ResponsePSDTool.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#ResponsePSDTool.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PropertyByAPIName`](#ResponsePSDTool.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#ResponsePSDTool.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#ResponsePSDTool.RemoveParameter)Removes the parameter from the parameter set corresponding to the given property.### Properties

NameDescription[`Children`](#ResponsePSDTool.Children)Gets the list of children.[`ClusteringFrequencyPoints`](#ResponsePSDTool.ClusteringFrequencyPoints)Gets or sets the ClusteringFrequencyPoints.[`Comments`](#ResponsePSDTool.Comments)Gets the list of associated comments.[`DataModelObjectCategory`](#ResponsePSDTool.DataModelObjectCategory)Gets the current DataModelObject’s category.[`Figures`](#ResponsePSDTool.Figures)Gets the list of associated figures.[`Images`](#ResponsePSDTool.Images)Gets the list of associated images.[`IncludeAllExcitationFrequencies`](#ResponsePSDTool.IncludeAllExcitationFrequencies)Gets or sets the IncludeAllExcitationFrequencies.[`IncludeUserDefinedFrequencies`](#ResponsePSDTool.IncludeUserDefinedFrequencies)Gets or sets the IncludeUserDefinedFrequencies.[`InternalObject`](#ResponsePSDTool.InternalObject)Gets the internal object. For advanced usage only.[`Properties`](#ResponsePSDTool.Properties)Gets the list of properties for this object.[`VisibleProperties`](#ResponsePSDTool.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

<a id="ResponsePSDTool.Children"></a>

### *property* ResponsePSDTool.Children *: List\[[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject](../../../Mechanical/DataModel/Interfaces/IDataModelObject.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of children.

<a id="ResponsePSDTool.ClusteringFrequencyPoints"></a>

### *property* ResponsePSDTool.ClusteringFrequencyPoints *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ClusteringFrequencyPoints.

<a id="ResponsePSDTool.Comments"></a>

### *property* ResponsePSDTool.Comments *: Iterable\[[Ansys.ACT.Automation.Mechanical.Comment](Comment.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Comment)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated comments.

<a id="ResponsePSDTool.DataModelObjectCategory"></a>

### *property* ResponsePSDTool.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the current DataModelObject’s category.

<a id="ResponsePSDTool.Figures"></a>

### *property* ResponsePSDTool.Figures *: Iterable\[[Ansys.ACT.Automation.Mechanical.Figure](Figure.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Figure)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated figures.

<a id="ResponsePSDTool.Images"></a>

### *property* ResponsePSDTool.Images *: Iterable\[[Ansys.ACT.Automation.Mechanical.Image](Image.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Image)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated images.

<a id="ResponsePSDTool.IncludeAllExcitationFrequencies"></a>

### *property* ResponsePSDTool.IncludeAllExcitationFrequencies *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the IncludeAllExcitationFrequencies.

<a id="ResponsePSDTool.IncludeUserDefinedFrequencies"></a>

### *property* ResponsePSDTool.IncludeUserDefinedFrequencies *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the IncludeUserDefinedFrequencies.

<a id="ResponsePSDTool.InternalObject"></a>

### *property* ResponsePSDTool.InternalObject *: Ansys.Common.Interop.DSObjectsAuto.IDSResponsePSDToolAuto | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the internal object. For advanced usage only.

<a id="ResponsePSDTool.Properties"></a>

### *property* ResponsePSDTool.Properties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties for this object.

<a id="ResponsePSDTool.VisibleProperties"></a>

### *property* ResponsePSDTool.VisibleProperties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties that are visible for this object.

<a id="method-detail"></a>

## Method detail

<a id="ResponsePSDTool.Activate"></a>

### ResponsePSDTool.Activate() → [None](https://docs.python.org/3/library/constants.html#None)

Activate the current object.

<a id="ResponsePSDTool.AddComment"></a>

### ResponsePSDTool.AddComment() → [Ansys.ACT.Automation.Mechanical.Comment](Comment.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Comment)

Creates a new child Comment.

<a id="ResponsePSDTool.AddFigure"></a>

### ResponsePSDTool.AddFigure() → [Ansys.ACT.Automation.Mechanical.Figure](Figure.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Figure)

Creates a new child Figure.

<a id="ResponsePSDTool.AddImage"></a>

### ResponsePSDTool.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [Ansys.ACT.Automation.Mechanical.Image](Image.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Image)

```text
Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.

```

<a id="ResponsePSDTool.AddResponsePSD"></a>

### ResponsePSDTool.AddResponsePSD() → [Ansys.ACT.Automation.Mechanical.Results.ProbeResults.ResponsePSD](Results/ProbeResults/ResponsePSD.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Results.ProbeResults.ResponsePSD)

Creates a new ResponsePSD

<a id="ResponsePSDTool.CopyTo"></a>

### ResponsePSDTool.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → [None](https://docs.python.org/3/library/constants.html#None)

Copies all visible properties from this object to another.

<a id="ResponsePSDTool.CreateParameter"></a>

### ResponsePSDTool.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

<a id="ResponsePSDTool.Delete"></a>

### ResponsePSDTool.Delete() → [None](https://docs.python.org/3/library/constants.html#None)

Run the Delete action.

<a id="ResponsePSDTool.Duplicate"></a>

### ResponsePSDTool.Duplicate() → [Ansys.Mechanical.DataModel.Interfaces.IDataModelObject](../../../Mechanical/DataModel/Interfaces/IDataModelObject.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)

Creates a copy of the current DataModelObject.

<a id="ResponsePSDTool.EvaluateAllResults"></a>

### ResponsePSDTool.EvaluateAllResults() → [None](https://docs.python.org/3/library/constants.html#None)

Run the EvaluateAllResults action.

<a id="ResponsePSDTool.GetChildren"></a>

### ResponsePSDTool.GetChildren(recurses: [bool](https://docs.python.org/3/library/functions.html#bool), children: List\[ChildrenType\]) → List\[ChildrenType\]

Gets the list of children, filtered by type.

<a id="ResponsePSDTool.GetParameter"></a>

### ResponsePSDTool.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

<a id="ResponsePSDTool.GroupAllSimilarChildren"></a>

### ResponsePSDTool.GroupAllSimilarChildren() → [None](https://docs.python.org/3/library/constants.html#None)

Run the GroupAllSimilarChildren action.

<a id="ResponsePSDTool.GroupSimilarObjects"></a>

### ResponsePSDTool.GroupSimilarObjects() → [Ansys.ACT.Automation.Mechanical.TreeGroupingFolder](TreeGroupingFolder.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.TreeGroupingFolder)

Run the GroupSimilarObjects action.

<a id="ResponsePSDTool.PropertyByAPIName"></a>

### ResponsePSDTool.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Automation.Mechanical.Property

```text
Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.

```

<a id="ResponsePSDTool.PropertyByName"></a>

### ResponsePSDTool.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

<a id="ResponsePSDTool.RemoveParameter"></a>

### ResponsePSDTool.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [None](https://docs.python.org/3/library/constants.html#None)

Removes the parameter from the parameter set corresponding to the given property.