tidy3d.components.data.FreqData#

class tidy3d.components.data.FreqData#

Stores frequency-domain data using an f dimension for frequency in Hz.

Parameters
  • values (Union[Array, Array] = None) – Values of the raw data being stored.

  • data_attrs (Optional[Mapping[str, str]] = None) – Dictionary storing extra attributes associated with the monitor data.

  • f (Array = None) – [units = Hz]. Array of frequency values to use as coordintes.

Show JSON schema
{
   "title": "FreqData",
   "description": "Stores frequency-domain data using an ``f`` dimension for frequency in Hz.\n\nParameters\n----------\nvalues : Union[Array, Array] = None\n    Values of the raw data being stored.\ndata_attrs : Optional[Mapping[str, str]] = None\n    Dictionary storing extra attributes associated with the monitor data.\nf : Array = None\n    [units = Hz].  Array of frequency values to use as coordintes.",
   "type": "object",
   "properties": {
      "type": {
         "title": "Type",
         "default": "FreqData",
         "enum": [
            "FreqData"
         ],
         "type": "string"
      },
      "values": {
         "title": "Values",
         "description": "Values of the raw data being stored.",
         "anyOf": [
            {
               "title": "NumpyArray",
               "description": "Wrapper around numpy arrays that has a well defined json schema.",
               "type": "object",
               "properties": {
                  "data_list": {
                     "title": "Data List",
                     "type": "array",
                     "items": {}
                  }
               },
               "required": [
                  "data_list"
               ]
            },
            {
               "title": "NumpyArray",
               "description": "Wrapper around numpy arrays that has a well defined json schema.",
               "type": "object",
               "properties": {
                  "data_list": {
                     "title": "Data List",
                     "type": "array",
                     "items": {}
                  }
               },
               "required": [
                  "data_list"
               ]
            }
         ]
      },
      "data_attrs": {
         "title": "Data Attributes",
         "description": "Dictionary storing extra attributes associated with the monitor data.",
         "type": "object",
         "additionalProperties": {
            "type": "string"
         }
      },
      "f": {
         "title": "NumpyArray",
         "description": "Wrapper around numpy arrays that has a well defined json schema.",
         "units": "Hz",
         "type": "object",
         "properties": {
            "data_list": {
               "title": "Data List",
               "type": "array",
               "items": {}
            }
         },
         "required": [
            "data_list"
         ]
      }
   },
   "required": [
      "values",
      "f"
   ]
}

Fields
attribute f: tidy3d.components.types.Array [Required]#

Array of frequency values to use as coordintes.

Constraints
  • title = NumpyArray

  • description = Wrapper around numpy arrays that has a well defined json schema.

  • type = object

  • properties = {‘data_list’: {‘title’: ‘Data List’, ‘type’: ‘array’, ‘items’: {}}}

  • required = [‘data_list’]

abstract normalize(source_freq_amps: tidy3d.components.types.Array) None#

Normalize values of frequency-domain data by source amplitude spectrum.