Home | Documentation | Overview | Examples | Code | Download | Develop

Introduction

The BSLTL package is a free collection of OCTAVE/MATLAB routines for working with the biospeckle laser technique.


Citation

To cite the BSLTL package in publications use:


	Roberto Alves Braga Júnior, Fernando Pujaico Rivera and Junio Moreira (2016).
	BSLTL: Biospeckle Laser Tool Library - version 1.0.0
	URL http://www.nongnu.org/bsltl/
				
A BibTeX entry for LaTeX users is:

	@misc{BSLTL1,
		author    = {Roberto Alves Braga Júnior and 
					Fernando Pujaico Rivera and 
					Junio Moreira},
		title     = {{BSLTL:} Biospeckle Laser Tool Library - version 1.0.0},
		year      = {2016},
		url       = {http://www.nongnu.org/bsltl/}
	}
				
We have invested a lot of time and effort in creating BSLTL package, please cite it when using it. See also `citation pkgname' for citing other Octave package with pkgname name.


Dependencies

Some functions inside BSLTL package (filtering functions) depend of signal package; at the same time the signal package depends of control package. Thus, we recommend install first the control package and later the signal package with the next OCTAVE commands.


	pkg install -forge control
	pkg install -forge signal
				

In operating systems based in GNU/Linux can be necessary install first the library liboctave-dev in the system, given that OCTAVE uses this library to install the control package. The next code is an example of command install in the system.


	sudo apt-get install liboctave-dev
				

Install

Method 1: Online - Only in OCTAVE

The next OCTAVE code, install the last version of BSLTL package directly from OCTAVE-FORGE website in the default install directory.


	pkg install -forge -auto bsltl
				

With this method the package is configured for be loaded automatically when OCTAVE start.

Method 2: Offline - Only in OCTAVE

The next OCTAVE code install the BSLTL package, bsltl.tar.gz, in the directory: ~/lib/octmat
If the BSLTL package was downloaded in the directory: /download_path


	pkg prefix ~/lib/octmat
	pkg install -auto /download_path/bsltl.tar.gz
				

With this method the package is configured for be loaded automatically when OCTAVE start.

Method 3: Offline - In MATLAB or OCTAVE

If the BSLTL package, bsltl.tar.gz, was uncompressed in the directory '/home/user/lib/octmat/bsltl'. For that this package can be used by a source file, it needs add the next code in the top of source file.


	BSLTL_DIR='/home/user/lib/octmat/bsltl';
	addpath(genpath(BSLTL_DIR));
				

The function genpath generates a list with the directories and sub directories. The function addpath add directories to OCTAVE system path.

In this method we install (add to Octave system path) the BSLTL package each time that we call our source files.


Using the BSLTL package

Many code examples can be found in the homepage of BSLTL library.

Example code of method 1 and 2 - Getting the AVD value of line 240

	IMAGES_DIR = '/home/user/data/speckle/test1';

	DATA = datapack(IMAGES_DIR,'',1,129,'bmp'); % Datapack of 129 images.

	THSP = thsp(DATA,1,240);          % Getting the time history speckle pattern.
	COM  = coom(THSP);                % Getting the co-occurrence matrix.
	AVD  = avd(COM);                  % Getting the AVD value.
				

Example code of method 3 - Getting the AVD value of column 100

	BSLTL_DIR = '/home/user/lib/octmat/bsltl';
	addpath(genpath(BSLTL_DIR));

	IMAGES_DIR = '/home/user/data/speckle/test1';

	DATA = datapack(IMAGES_DIR,'',1,129,'bmp'); % Datapack of 129 images.

	THSP = thsp(DATA,2,100);          % Getting the time history speckle pattern.
	COM  = coom(THSP);                % Getting the co-occurrence matrix.
	AVD  = avd(COM);                  % Getting the AVD value.
				

Copyright


	Copyright (c) 2016 BSLTL project group.

	This program is free software; you can redistribute it and/or
	modify it under the terms of the GNU General Public License as
	published by the Free Software Foundation; either version 2 of the
	License, or (at your option) any later version.
	 
	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.
	
	You should have received a copy of the GNU General Public License
	along with this program; if not, write to the Free Software
	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
	USA.
				

Versions

The increment in the version number has a meaning. To a version number with the format 'va.b.c' (by example: v1.0.0).


BSLTL project group - Authors


Contact us

Bug reports

Follow us

Others