Metadata-Version: 2.4
Name: pymodaq_plugins_spectrum_instrumentation
Version: 5.0.2
Summary: An implementation for Spectrum DAQ cards with Lock-In functionalities
Project-URL: Homepage, https://pymodaq.cnrs.fr
Project-URL: Documentation , https://pymodaq.cnrs.fr
Project-URL: Repository , https://github.com/PyMoDAQ/pymodaq_plugins_spectrum_instrumentation
Author-email: Malo Herve <malo.herve@epfl.ch>
Maintainer-email: Malo Herve <malo.herve@epfl.ch>
License: The MIT License (MIT)
        
        Copyright (c) 2021 Sebastien Weber <sebastien.weber@cemes.fr>
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: User Interfaces
Requires-Python: >=3.8
Requires-Dist: pymodaq>=5.0.0
Requires-Dist: spcm
Description-Content-Type: text/x-rst

pymodaq_plugins_spectrum_instrumentation
########################################

.. image:: https://img.shields.io/pypi/v/pymodaq_plugins_template.svg
   :target: https://pypi.org/project/pymodaq_plugins_spectrum_instrumentation/
   :alt: Latest Version

.. image:: icon2.ico

Authors
=======

* Martin Luttmann  (martin.luttmann@epfl.ch)
* Malo Hervé (malo.herve@epfl.ch)

Instruments
===========

This package is related to the `Spectrum Instrumentation <https://spectrum-instrumentation.com/>`__ company.

This plugin was created with a model M2p.5936-x4 .

Viewer1D
++++++++

* **Spectrum**: Simple 1D acquisition defined by a number of laser pulses to observe and a sample rate. Tested with
  model M2p.5936-x4
* **Spectrum Lock In**: An advanced version of the Spectrum viewer, where the obtained trace is treated to
  extract data at certain frequencies (Lock In)


Installation instructions
=========================

* pip isntall pymodaq_plugins_spectrum_instrumentation
* Tested on Windows 11



Classic Usage
=============

While the plugin is made to be used for data acquisition, small changes can be made to the plugin for convenience.
The viewer currently works for 2 modes of acquisition : Single and Multi.
In both cases, the the duration and the sampling rate of the acquisition is determined by two values : a number of pulses (at a given frequency), and a number of samples per pulse.
The plugin supports channel triggering and external signal triggering, with variable post trigger.
Clock synchronisation is also supported.

Lock In Usage
=============

Lock In measurement allows to extract signals at a certain frequency.
This is done by giving a lock-in frequency.
This Lock In viewer is made for Balanced measurement, so giving a "Sum" (I) and "Difference" (D) channel is also required to calculate the normalized difference (ND).
Each trace is seperated into isolated pulses and integrated.
Finally, background removal (Pulse - signal after pulse) is supported and toggleable.

The user can then choose to represent a few parameters : 

* (I/D/ND)_Ba : corresponds the average signal in the (I/D/ND) channel
* (I/D/ND)_Bd : corresponds to the average locked-in difference, containing the signal at the lock-in frequency.