cpkm/beamtools

Suite of tools and methods for the analysis and simulation of optical beam. Available on PyPI

beamtools

The beamtools package is a collection of methods to assist with several aspects of optical system design and analysis.

Importing data

One of the most useful methods in the package is import_data_file which can be used to seamlessly import a variety of data types.

Importing data with beamtools.import_data_file()

Once of the most useful methods in the package is import_data_file which can be used to seamlessly import a variety of data types.

import beamtools as bt

#data from an ocean optics spectrometer
file = 'testdata.csv'
type = 'oo_spec'

data = bt.import_data_file(file,type)

Data imported by import_data_file is returned as a DataObject. In this example, data.wavelength and data.intensity returns numpy arrays of the wavelength and intensity data imported from the file. Any header information is stored in data.header. The header syntax for each file is defined in file_formats.py.

Data Objects

All raw data in the package is handle via a DataObj where the data is stored as object attributes. Data objects are created from dictionaries (set of key/value pairs) and the Data Object attributes are defined by the dictionary keys. The class definition can be found in .import_data_file.py. All DataObj instances posses the class method fields(). Calling DataObj.fields() returns a list of the onjects attributes. This can be used to view the names available data arrays.

File formats

A list of file formats can be found in file_formats.py. I have already included many common file types. More can be added to the package in the future by creating additional dictionary entries following the format and keywords given. Each file format includes a key named alias. These values comprise a set of alternate names which can be used anywhere in the package when specifying a file type.

Common methods

beamtools.pulse module

The beamtools.pulse module contains many methods for analysing optical pulse. This includes the analysis of spectra and autocorrelation traces.

beamtools.upp module

The ultrafast pulse propagation module, imported as beamtools.ufpp possess numerous methods pertaining to the numerical propogation of ultrafast pulses. This includes nonlinear fiber-optic equations, fiber amplification, and several simulated fiber-optic components.

beamtools.grating module

beamtools's Issues

Check sech2 chirp

need to check definition of chirp in sech2 function, common.py

Update beam_profile

beam_profile.py needs to be updated with corrections made in beamprofileranalysis. Changes starting from commit a7c8907 in source repo.

Fiber() z array calc not consistent and excludes last point

calculation of zgrid, initializeGrid(), does not properly handle the calculation. It is not consistent in the abs and rel definitions (consistent input yields different arrays). Also, calculation under estimates number of points by 1.

Use pandas for file import.

Currently import_data_file uses the csv modules and some homebuilt tricks to import data. I think pandas could be used instead, but this may take a significant updating.

Add prism pair module.

Should be basically the same as grating_pair.py but for a prism pair.

Nan handling in normalize function

using normalize on data with nan in y values causes entire array to be set to nan. can be corrected using nanmax and nanmin I think. related to #10

Complete readme.md

Complete README to give outline package usage and examples.

Integrate pulse propagation modelling

Integrate https://github.com/cpkm/laserdynamics/blob/master/pulsemodelling/pulsemodel.py into beamtools as a subpackage.

import_data_file with Nan yields unexpected array

Need to fix import for data with nan. seems to give an entire array of nan or non numerics.... check. tested with autocorrelation file with one single nan in the power column

Inconsistent 4th order grating dispersion

4th order dispersion calculated by eqn and symbolically are different. Need to remedy - I believe symbolic calc is correct. Also see cpkm/laserdynamics#3.

Change default data object to namedtuple.

Currently, imported data from import_data_file returns a homemade data object named objdict. This can be safely removed and replaced with the use of namedtuples, which offer the same functionality, namely, the ability to call fields as attributes, e.g. data.x instead of data['x'].