{
  "title": "DirectivityMonitorSpec",
  "public_path": "flex_rf.tidy3d.DirectivityMonitorSpec",
  "lookup_path": "tidy3d.rf.DirectivityMonitorSpec",
  "slug": "flex_rf/tidy3d/DirectivityMonitorSpec",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/directivitymonitorspec/",
  "object_kind": "class",
  "introduction": "Specification for automatically generating a `DirectivityMonitor`.",
  "notes": "When included in the `radiation_monitors` tuple,\na `DirectivityMonitor` will be automatically generated with the specified\nparameters. This allows users to mix manual `DirectivityMonitor` objects\nwith automatically generated ones, each with customizable parameters.\n\nThe default origin (`custom_origin`) for defining observation points in the automatically\ngenerated monitor is set to (0, 0, 0) in the global coordinate system.",
  "examples": "```python\nauto_monitor = DirectivityMonitorSpec(\n    name=\"custom_auto\",\n    buffer=3,\n    num_theta_points=50,\n    num_phi_points=100\n)\n```",
  "references": "",
  "signature": "class DirectivityMonitorSpec(MicrowaveBaseModel)",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/plugins/smatrix/component_modelers/terminal.py",
    "url": "",
    "lineno": 245,
    "endlineno": 309
  },
  "bases": [
    "MicrowaveBaseModel"
  ],
  "parameter_rows": [
    {
      "name": "name",
      "annotation": "str | None",
      "default": "None",
      "description": "Optional name for the auto-generated monitor. If not provided, defaults to 'radiation_' + index of the monitor in the list of radiation monitors.",
      "origin": "declared"
    },
    {
      "name": "freqs",
      "annotation": "tuple[NonNegativeInt, ...] | None",
      "default": "None",
      "description": "Frequencies to obtain fields at. If not provided, uses all frequencies from the `TerminalComponentModeler`. Must be a subset of modeler frequencies if provided.",
      "origin": "declared"
    },
    {
      "name": "buffer",
      "annotation": "NonNegativeInt",
      "default": "AUTO_RADIATION_MONITOR_BUFFER",
      "description": "Number of grid cells to maintain between monitor and PML/domain boundaries. Default: 2 cells.",
      "origin": "declared"
    },
    {
      "name": "num_theta_points",
      "annotation": "NonNegativeInt",
      "default": "AUTO_RADIATION_MONITOR_NUM_POINTS_THETA",
      "description": "Number of elevation angle (theta) sample points from 0 to π. Default: 100.",
      "origin": "declared"
    },
    {
      "name": "num_phi_points",
      "annotation": "NonNegativeInt",
      "default": "AUTO_RADIATION_MONITOR_NUM_POINTS_PHI",
      "description": "Number of azimuthal angle (phi) sample points from -π to π. Default: 200.",
      "origin": "declared"
    },
    {
      "name": "custom_origin",
      "annotation": "Coordinate | None",
      "default": "(0, 0, 0)",
      "description": "Local origin used for defining observation points. If `None`, uses the monitor's center.",
      "origin": "declared"
    },
    {
      "name": "attrs",
      "annotation": "dict",
      "default": "factory: dict",
      "description": "Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, `attrs` are mutable. For example, the following is allowed for setting an `attr` `obj.attrs['foo'] = bar`. Also note that Tidy3D will raise a `TypeError` if `attrs` contain objects that can not be serialized. One can check if `attrs` are serializable by calling `obj.model_dump_json()`.",
      "origin": "inherited"
    }
  ],
  "members": [],
  "group": "flex_rf.tidy3d"
}