Giter Club home page Giter Club logo

matlab_nanonis's Introduction

MATLAB Library for Nanonis based files: NanoLib

DOI

The NanoLib library allows to open and analyze data generated by the Nanonis SPM Control System TM in MATLABTM.

The first version of NanoLib was developed by Quentin Peter during its master thesis Spin Polarized Field Emission STM and Image Processing in the Solid State Physics Laboratory for Microstruture Research at the ETH Zurich under the supervision of U. Ramsperger and L. De Pietro. Some of this library's features are still oriented to solve problems related to the master thesis, e.g., scan_type field in the header structure (see manual). In future versions some of these features may be changed and generalized. Every comment, idea and contribution is welcome.

Content

The repository is divided in three sections:

  • Manual: PDF of the user manual and source file,
  • NanoLib: the library with the different MATLAB functions,
  • Examples: dummy files and code examples for using the library.

Installation and Setup

You can clone the repository to your computer or download the ZIP file and unzip it to a directory of your choice, for example: ~/myFunctions.

In order to use and access the library you need to add the path to the directory where you copied the library with the addpath standard function of MATLAB. Before you begin with your project just type in the MATLAB prompt:

>>> addpath ~/myFunctions

You may use the functions of the library by calling first the ''class'' and then the specific function. For example, in order to load a SXM image, you can simply write sxm.load.loadProcessedSxM.

A simple example of how to load and to plot an image is given below:

% load file
fileName = 'SXM_file.sxm';
sxmFile = sxm.load.loadProcessedSxM(fileName);

%% plot data
iCh = 1; % Channel number

%plot image
figure('Name',sprintf('file: %s',fileName));
sxm.plot.plotFile(sxmFile,iCh);

This and other examples can be found in the section Example.

Licence

Distributed under the GNU General Public License, Version 3.0. (See accompanying file LICENSE or copy at https://www.gnu.org/licenses/gpl-3.0.html)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.