Skip to main content

A vectorized implementation of the transfer matrix method

Project description

Vectorized Transfer Matrix Method Python

The transfer matrix method (TMM) is an analytic approach for obtaining the reflection and transmission coefficients in stratified media. vtmmpy is a vectorised implementation of the TMM written in Python. It has a focus on speed and ease of use.

Installation


pip install vtmmpy 

Usage


Import the vtmmpy module.

import vtmmpy

Create an instance of the TMM class.

freq = np.linspace(170, 210, 30) 
theta = np.array(0, 60, 60) 

tmm = vtmmpy.TMM(freq, 
                theta, 
                f_scale=1e12, 
                l_scale=1e-9, 
                incident_medium="air", 
                transmitted_medium="air") 
  • freq: a numpy array representing the spectral range of interest.
  • theta: a numpy array of one or more angles of incidence.
  • f_scale (optional): input frequency scale, default is terahertz.
  • l_scale (optional): input length scale, default is nanometers.
  • incident_medium (optional): incident medium, default is air.
  • transmitted_medium (optional): transmitted medium, default is air.

Add multilayer metamaterial designs with the addDesign() method.

materials = ["Ag", "SiO2", "Ag", "SiO2", "Ag"] 
thicknesses = [15, 85, 15, 85, 15] 

tmm.addDesign(materials, thicknesses)
  • materials: list of materials
  • thicknesses: list of the corresponding material thicknesses

Internally, vtmmpy uses the regidx Python package to download refractive index data from refractiveindex.info for your choosen materials and spectral range. At this point, you will be presented with a few options corresponding to the data source ("Page" dropdown in refractiveindex.info). Study these carefully and refer to refractiveindex.info for more detailed information about how the data were obtained. Your choice here could greatly impact the accuracy of your results.

Under cirtain circumstances, it may also be necessary to change the "shelf" (see refractiveindex.info for details). By default the "main" shelf is used. This attribute can be changed as follows: tmm.shelf = <shelf>.

Optionally call the summary() and/or designs() methods to view the data currently held by the instance.

tmm.summary() 
tmm.designs() 

Calculate the reflection/transmission coefficients by calling the appropriate method. You should specify wether you want the transverse magnetic/electric polarization by supplying the "TM" or "TE" flag, respectively.

RTM = tmm.reflection("TM") 
RTE = tmm.reflection("TE") 
TTM = tmm.transmission("TM") 
TTE = tmm.transmission("TE") 

Tips:

  • The reflection() and transmission() methods return both complex parts. Use Python's built-in abs() function to obtain the magnitude.
  • The intensity is the square of the magnitude (eg. abs(reflection("TM"))**2).
  • reflection() and transmission() return an ndarray with a minimum of 2 dimensions. The first dimension always corresponds to the number of designs. Therefore, when printing/plotting results, you must always index the first dimension (even if you only have 1 design).

Examples


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vtmmpy-1.0.2.tar.gz (17.0 kB view details)

Uploaded Source

File details

Details for the file vtmmpy-1.0.2.tar.gz.

File metadata

  • Download URL: vtmmpy-1.0.2.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.7

File hashes

Hashes for vtmmpy-1.0.2.tar.gz
Algorithm Hash digest
SHA256 b26e2f564c401342dee606c00793754bef6dfdd09c74b53fac190a95929401ad
MD5 28d20d9cab9fe4d54e424a15e38c8ce7
BLAKE2b-256 fb7159cee5971306f5d9e65f79658786091c948e2c8b043d280f8d1764b11888

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page