tidy3d.PointCloudPermittivityDataset

tidy3d.PointCloudPermittivityDataset#

class PointCloudPermittivityDataset[source]#

Bases: AbstractFieldDataset

Dataset storing permittivity components for requested point-cloud coordinates.

Parameters:

  • points (PointDataArray) – Requested point coordinates associated with the indexed permittivity data.

  • eps_xx (IndexedFreqDataArray) – Point-cloud xx-component of the relative permittivity.

  • eps_yy (IndexedFreqDataArray) – Point-cloud yy-component of the relative permittivity.

  • eps_zz (IndexedFreqDataArray) – Point-cloud zz-component of the relative permittivity.

  • ``("index" (Components are scalar data arrays indexed by) –

  • maps ("f")``. The points array)

  • the (each index row to the requested Cartesian coordinate. Component values are sampled from)

  • locations (nearest native Yee-grid)

  • each (which may differ from the requested coordinates and from)

  • components. (other across)

Attributes

field_components

Maps the permittivity components to their associated data.

grid_locations

Maps permittivity components to their native Yee-grid field locations.

symmetry_eigenvalues

Maps permittivity components to their scalar symmetry eigenvalues.

points

eps_xx

eps_yy

eps_zz

Methods

colocate([x, y, z])

Point-cloud permittivity data cannot be colocated on a structured grid.
points#
eps_xx#
eps_yy#
eps_zz#
property field_components#

Maps the permittivity components to their associated data.

property grid_locations#

Maps permittivity components to their native Yee-grid field locations.

property symmetry_eigenvalues#

Maps permittivity components to their scalar symmetry eigenvalues.

colocate(x=None, y=None, z=None)[source]#

Point-cloud permittivity data cannot be colocated on a structured grid.