rompy.swan.subcomponents.spectrum.GAUSS#
- pydantic model rompy.swan.subcomponents.spectrum.GAUSS[source]#
Gaussian spectral shape.
GAUSS [sigfr]
Examples
In [106]: from rompy.swan.subcomponents.spectrum import GAUSS In [107]: shape = GAUSS(sigfr=0.02) In [108]: print(shape.render()) GAUSS sigfr=0.02
Show JSON schema
{ "title": "GAUSS", "description": "Gaussian spectral shape.\n\n.. code-block:: text\n\n GAUSS [sigfr]\n\nExamples\n--------\n\n.. ipython:: python\n :okwarning:\n\n from rompy.swan.subcomponents.spectrum import GAUSS\n shape = GAUSS(sigfr=0.02)\n print(shape.render())", "type": "object", "properties": { "model_type": { "default": "gauss", "description": "Model type discriminator", "enum": [ "gauss", "GAUSS" ], "title": "Model Type", "type": "string" }, "sigfr": { "description": "Width of the Gaussian frequency spectrum expressed as a standard deviation in Hz.", "exclusiveMinimum": 0.0, "title": "Sigfr", "type": "number" } }, "additionalProperties": false, "required": [ "sigfr" ] }
- field model_type: Literal['gauss', 'GAUSS'] = 'gauss'#
Model type discriminator
- field sigfr: float [Required]#
Width of the Gaussian frequency spectrum expressed as a standard deviation in Hz.
- Constraints:
gt = 0.0