﻿:html_theme.sidebar_secondary.remove:

tidy3d.CustomPoleResidue
========================

.. autoclass:: tidy3d.CustomPoleResidue
   :members:
   :show-inheritance:
   :undoc-members:
   :member-order: bysource
   :exclude-members: attrs, model_config, model_post_init, type

   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   .. rubric:: Attributes

   .. autosummary::
      
        ~tidy3d.CustomPoleResidue.is_spatially_uniform
        ~tidy3d.CustomPoleResidue.loss_upper_bound
        ~tidy3d.CustomPoleResidue.eps_inf
        ~tidy3d.CustomPoleResidue.poles
        ~tidy3d.CustomPoleResidue.interp_method
        ~tidy3d.CustomPoleResidue.subpixel
        ~tidy3d.CustomPoleResidue.derived_from
        ~tidy3d.CustomPoleResidue.name
        ~tidy3d.CustomPoleResidue.frequency_range
        ~tidy3d.CustomPoleResidue.allow_gain
        ~tidy3d.CustomPoleResidue.nonlinear_spec
        ~tidy3d.CustomPoleResidue.modulation_spec
        ~tidy3d.CustomPoleResidue.viz_spec
        ~tidy3d.CustomPoleResidue.heat_spec
   
   
   

   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   .. rubric:: Methods

   .. autosummary::
       
            ~tidy3d.CustomPoleResidue.eps_dataarray_freq
            ~tidy3d.CustomPoleResidue.from_medium
            ~tidy3d.CustomPoleResidue.poles_on_grid
            ~tidy3d.CustomPoleResidue.to_medium
   
   
   