rompy.swan.subcomponents.output.REL

pydantic model rompy.swan.subcomponents.output.REL

Relative frequency spectra.

REL

Spectra are computed as a function of relative frequency, i.e., the frequency as measured when moving with current.

Examples

In [1]: from rompy.swan.subcomponents.output import REL

In [2]: freq = REL()

In [3]: print(freq.render())
REL

Show JSON schema

{
   "title": "REL",
   "description": "Relative frequency spectra.\n\n.. code-block:: text\n\n    REL\n\nSpectra are computed as a function of relative frequency, i.e., the frequency as\nmeasured when moving with current.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.subcomponents.output import REL\n    freq = REL()\n    print(freq.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "rel",
         "description": "Model type discriminator",
         "enum": [
            "rel",
            "REL"
         ],
         "title": "Model Type",
         "type": "string"
      }
   },
   "additionalProperties": false
}

Fields:

• model_type (Literal['rel', 'REL'])

field model_type: Literal['rel', 'REL'] = 'rel'

Model type discriminator

cmd() → str

Command file string for this subcomponent.