tidy3d.DipoleEmissionMonitor

class DipoleEmissionMonitor

Bases: PointCloudFieldMonitor

Monitor for dipole-emission radiation intensity.

Parameters:

• name (str) – Unique name for monitor.

• interval_space (tuple[Literal[1], Literal[1], Literal[1]] = (1, 1, 1)) – Point-cloud field monitors do not support spatial downsampling.

• colocate (Literal[False] = False) – Point-cloud field monitors always store fields sampled from native Yee-grid field values and do not support field colocation.

• use_colocated_integration (Literal[True] = True) – Whether to use colocated fields for flux, dot products, and overlap integrals. Hard-coded to True for most monitor types. Can be toggled on field, overlap, and flux monitors.

• freqs (ArrayLike[dtype=float, ndim=1]) – [units = Hz]. Array or list of frequencies stored by the field monitor.

• apodization (ApodizationSpec = ApodizationSpec()) – Sets parameters of (optional) apodization. Apodization applies a windowing function to the Fourier transform of the time-domain fields into frequency-domain ones, and can be used to truncate the beginning and/or end of the time signal, for example to eliminate the source pulse when studying the eigenmodes of a system. Note: apodization affects the normalization of the frequency-domain fields.

• points (PointDataArray) – [units = um]. Point coordinates at which fields are recorded. The array must have dimensions ('index', 'axis') and shape (num_points, 3).

• position_weights (Union[ArrayLike[dtype=float, ndim=1], ArrayLike[dtype=float, ndim=2]]) – Nonnegative weights used when summing radiation intensity over sampled dipole positions. Provide one weight per point, or one weight per point and Cartesian dipole axis.

• store_position_indexes (sampled positions using position_weights. Use) – Zero-based indexes into points for positions whose individual radiation intensity should be stored in addition to the summed result.

• dipole (This monitor samples the reciprocal electric field at candidate)

• x- (positions and stores the angular radiation intensity for)

• y-

• and

• default (z-oriented electric dipoles. By)

• all (the result is summed over)

• store_position_indexes

• positions. (to additionally retain radiation intensity at selected individual)

• one (A simulation containing this monitor must contain exactly)

:param TFSF source: :param and every sampled point must lie inside the TFSF box.: :param The TFSF source defines the reciprocal plane-wave direction and: :param normalization used to reduce the sampled fields.: :param This monitor is typically created automatically by: :param tidy3d.plugins.dipole_emission.DipoleEmissionStudy.:

Attributes

fields
position_weights
store_position_indexes
center
size
points
interval_space
colocate
freqs
apodization
use_colocated_integration
name

Methods

storage_size(num_cells, tmesh)

Size of reduced dipole-emission data downloaded from this monitor.

fields

position_weights

store_position_indexes

storage_size(num_cells, tmesh)

Size of reduced dipole-emission data downloaded from this monitor.