Skip to content

DPF doc manual update for branch develop - dpf-mechanical #485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ansjhajjar wants to merge 1 commit into
base: sandbox
Choose a base branch
from
Open

DPF doc manual update for branch develop - dpf-mechanical #485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions ...l/versions/2027.R1.SP00/api/Ans.DataProcessing/operators/math/exponential_fc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
uid: Ans.DataProcessing.operators.math.exponential_fc
---

# *class* exponential_fc(fields_container: object = None, config: OperatorConfig = None)
# *class* exponential_fc(fields_container: object = None, apply_to_time_freq_support: object = None, config: OperatorConfig = None)

Computes the entity-wise [exponential function](https://en.wikipedia.org/wiki/Exponential_function):

Expand All @@ -12,7 +12,7 @@ The input must be dimensionless; a dimensional input raises an error.

The output is dimensionless.

available inputs: `fields_container` (FieldsContainer)
available inputs: `fields_container` (FieldsContainer), `apply_to_time_freq_support` (bool) (optional)

available outputs: `fields_container` (FieldsContainer)

Expand All @@ -21,14 +21,15 @@ available outputs: `fields_container` (FieldsContainer)
**Parameters:**

* **fields_container**
* **apply_to_time_freq_support**
* **config**

**Example:**

```python
op = exponential_fc()

op = exponential_fc(fields_container=my_fields_container)
op = exponential_fc(fields_container=my_fields_container,apply_to_time_freq_support=my_apply_to_time_freq_support)
```

## Inputs
Expand All @@ -39,6 +40,12 @@ Dimensionless field, fields container, or numeric data.

**Type:** *LinkableInput*

### apply_to_time_freq_support

Boolean value indicating if the exponential must be applied to the time/frequency values of the time/frequency support attached to the fields container (if present). Default to false.

**Type:** *LinkableInput*

## Outputs

### fields_container
Expand Down
13 changes: 10 additions & 3 deletions ...mechanical/versions/2027.R1.SP00/api/Ans.DataProcessing/operators/math/ln_fc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
uid: Ans.DataProcessing.operators.math.ln_fc
---

# *class* ln_fc(fields_container: object = None, config: OperatorConfig = None)
# *class* ln_fc(fields_container: object = None, apply_to_time_freq_support: object = None, config: OperatorConfig = None)

Computes the entity-wise [natural logarithm](https://en.wikipedia.org/wiki/Natural_logarithm):

Expand All @@ -12,7 +12,7 @@ The input must be dimensionless; a dimensional input raises an error.

The output is dimensionless.

available inputs: `fields_container` (FieldsContainer)
available inputs: `fields_container` (FieldsContainer), `apply_to_time_freq_support` (bool) (optional)

available outputs: `fields_container` (FieldsContainer)

Expand All @@ -21,14 +21,15 @@ available outputs: `fields_container` (FieldsContainer)
**Parameters:**

* **fields_container**
* **apply_to_time_freq_support**
* **config**

**Example:**

```python
op = ln_fc()

op = ln_fc(fields_container=my_fields_container)
op = ln_fc(fields_container=my_fields_container,apply_to_time_freq_support=my_apply_to_time_freq_support)
```

## Inputs
Expand All @@ -39,6 +40,12 @@ Dimensionless field, fields container, or numeric data.

**Type:** *LinkableInput*

### apply_to_time_freq_support

Boolean value indicating if the natural logarithm must be applied to the time/frequency values of the time/frequency support attached to the fields container (if present). Default to false.

**Type:** *LinkableInput*

## Outputs

### fields_container
Expand Down
11 changes: 9 additions & 2 deletions ...s/2027.R1.SP00/api/Ans.DataProcessing/operators/math/time_freq_interpolation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
uid: Ans.DataProcessing.operators.math.time_freq_interpolation
---

# *class* time_freq_interpolation(fields_container: object = None, time_freq_values: object = None, step: object = None, interpolation_type: object = None, force_new_time_freq_support: object = None, time_freq_support: object = None, config: OperatorConfig = None)
# *class* time_freq_interpolation(fields_container: object = None, time_freq_values: object = None, step: object = None, interpolation_type: object = None, force_new_time_freq_support: object = None, interpolation_scale: object = None, time_freq_support: object = None, config: OperatorConfig = None)

time_freq_interpolation()

time_freq_interpolation(fields_container: object, time_freq_values: object, step: object, interpolation_type: object, force_new_time_freq_support: object, time_freq_support: object, config: OperatorConfig)
time_freq_interpolation(fields_container: object, time_freq_values: object, step: object, interpolation_type: object, force_new_time_freq_support: object, interpolation_scale: object, time_freq_support: object, config: OperatorConfig)

time_freq_interpolation(config: OperatorConfig)

Expand All @@ -21,6 +21,7 @@ time_freq_interpolation(config: OperatorConfig)
* **step**
* **interpolation_type**
* **force_new_time_freq_support**
* **interpolation_scale**
* **time_freq_support**
* **config**

Expand Down Expand Up @@ -54,6 +55,12 @@ If set to true, the output fields container will always have a new time freq sup

**Type:** *LinkableInput*

### interpolation_scale

Integer indicating the scale in which interpolation is performed: 0 (linear scale - default), 1 (log-log scale).

**Type:** *LinkableInput*

### time_freq_support

**Type:** *LinkableInput*
Expand Down