81 lines
2.6 KiB
Markdown
81 lines
2.6 KiB
Markdown
|
---
|
||
|
|
source_files:
|
||
|
|
- Common/DTS.Common/Enums/DTS.Viewer/Reports/PowerSpectralDensity/WindowAveragingType.cs
|
||
|
|
- Common/DTS.Common/Enums/DTS.Viewer/Reports/PowerSpectralDensity/PassFilterType.cs
|
||
|
|
- Common/DTS.Common/Enums/DTS.Viewer/Reports/PowerSpectralDensity/WindowWidth.cs
|
||
|
|
- Common/DTS.Common/Enums/DTS.Viewer/Reports/PowerSpectralDensity/WindowType.cs
|
||
|
|
generated_at: "2026-04-17T16:35:07.692917+00:00"
|
||
|
|
model: "zai-org/GLM-5-FP8"
|
||
|
|
schema_version: 1
|
||
|
|
sha256: "cbf2ecb747cdc1d7"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Documentation: Power Spectral Density Enums
|
||
|
|
|
||
|
|
## 1. Purpose
|
||
|
|
|
||
|
|
This module defines four enumeration types used to configure Power Spectral Density (PSD) report generation within the DTS Viewer application. These enums provide strongly-typed configuration options for window functions, window widths, averaging methods, and filter types used in spectral analysis. All enums are decorated with `TypeConverter` and `Description` attributes to support user-friendly display in UI components.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 2. Public Interface
|
||
|
|
|
||
|
|
### `WindowAveragingType`
|
||
|
|
**Namespace:** `DTS.Common.Enums.Viewer.Reports`
|
||
|
|
**Type:** `enum`
|
||
|
|
|
||
|
|
Specifies the averaging method applied during PSD window processing.
|
||
|
|
|
||
|
|
| Member | Description Attribute | Underlying Value |
|
||
|
|
|--------|----------------------|------------------|
|
||
|
|
| `Averaging` | "Averaging" | 0 |
|
||
|
|
| `PeakHoldMax` | "Peak Hold MAX" | 1 |
|
||
|
|
| `PeakHoldMin` | "Peak Hold MIN" | 2 |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### `PassFilterType`
|
||
|
|
**Namespace:** `DTS.Common.Enums.Viewer.Reports`
|
||
|
|
**Type:** `enum`
|
||
|
|
|
||
|
|
Specifies the filter algorithm type for PSD analysis.
|
||
|
|
|
||
|
|
| Member | Description Attribute | Underlying Value |
|
||
|
|
|--------|----------------------|------------------|
|
||
|
|
| `Bessel` | "Bessel" | 0 |
|
||
|
|
| `Butterworth` | "Butterworth" | 1 |
|
||
|
|
| `Chebyshev` | "Chebyshev" | 2 |
|
||
|
|
|
||
|
|
**Note:** A fourth member `CriticalDamping` is commented out in the source (see Gotchas).
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### `WindowWidth`
|
||
|
|
**Namespace:** `DTS.Common.Enums.Viewer.Reports`
|
||
|
|
**Type:** `enum`
|
||
|
|
|
||
|
|
Specifies the FFT window size in samples. All values are explicit powers of two.
|
||
|
|
|
||
|
|
| Member | Description Attribute | Underlying Value |
|
||
|
|
|--------|----------------------|------------------|
|
||
|
|
| `FiveTwelve` | "512" | 512 |
|
||
|
|
| `TenTwentyFour` | "1024" | 1024 |
|
||
|
|
| `TwentyFortyEight` | "2048" | 2048 |
|
||
|
|
| `FortyNinetySix` | "4096" | 4096 |
|
||
|
|
| `EightyOneNinetyTwo` | "8192" | 8192 |
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### `WindowType`
|
||
|
|
**Namespace:** `DTS.Common.Enums.Viewer.Reports`
|
||
|
|
**Type:** `enum`
|
||
|
|
|
||
|
|
Specifies the window function applied to data before FFT transformation.
|
||
|
|
|
||
|
|
| Member | Description Attribute | Underlying Value |
|
||
|
|
|--------|----------------------|------------------|
|
||
|
|
| `Rectangle` | "Rectangle" | 0 |
|
||
|
|
| `Hamming` | "Hamming" | 1 |
|
||
|
|
| `Hanning` | "Hanning" | 2 |
|
||
|
|
| `Blackman` | "Blackman" | 3 |
|
||
|
|
|
|