A Python wrapper for L-Measure
Project description
[![Build Status](https://travis-ci.com/JustasB/pylmeasure.svg?branch=master)](https://travis-ci.com/JustasB/pylmeasure)
[![Coverage Status](https://coveralls.io/repos/github/JustasB/pylmeasure/badge.svg?branch=master)](https://coveralls.io/github/JustasB/pylmeasure?branch=master)
[![PyPI version](https://badge.fury.io/py/pylmeasure.svg)](https://badge.fury.io/py/pylmeasure)
# PyLMeasure: A Python Wrapper for L-Measure.
[PyLMeasure](https://pypi.org/project/pylmeasure/) is a Python wrapper library for the command-line interface of the neuronal morphology analysis tool [L-Measure](http://cng.gmu.edu:8080/Lm/help/index.htm).
# Installation
To install the library, simply type in `pip install pylmeasure` in your terminal.
There is no need to separately download L-Measure or install Java. The above command includes the necessary binaries.
# Usage
# Issues
# Contributing
Mainly, three functions are implemented getMeasure(), getMeasureDistribution() and
getMeasureDependence().
Operating systems Supported:
1. Linux 32 and 64 bit
Installation:
Linux:
Caution: Do not place these files in a system path.
1. Copy the folder 'python-Lmeasure' to a location(for example <home directory>/installations/)
2. Add the path '<path to python-Lmeasure>/LMIO/' to the system PYTHONPATH by adding the following line to .profile or .bashrc
export PYTHONPATH="$PYTHONPATH:<path to python-Lmeasure>/LMIO/"
Source the .profile or .bashrc file.
Output Format:
The object returned by any of the three functions is a list of a dictionaries, each dictionary with the following
structure. Each dictionary corresponds to one measure specified as input to the function being used(in measureNames or
measure1Names).
LMOutputTemplate = dict(rawData=None,
measure1BinCentres=None,
measure1BinCounts=None,
measure2BinAverages=None,
measure2BinStdDevs=None,
WholeCellMeasures=None,
)
WholeCellMeasures is a (# of swc files given)x7 numpy array. The seven entries along the second dimension correspond
respectively to
TotalSum, CompartmentsConsidered, Compartments Discarded, Minimum, Average, Maximum, StdDev
All meaure**** fields are (# of swc files given) x (nBins +1) numpy arrays.
getMeasure() has its results in WholeCellMeasures.
getMeasureDistribution has its results in measure1BinCentres and measure1BinCounts
getMeasureDependence has its results in measure1BinCentres, measure2BinAverages and measure2BinStdDevs
Misc:
See the file ExampleUsage.py for example usage.
Look at the documentation strings for more information
[![Coverage Status](https://coveralls.io/repos/github/JustasB/pylmeasure/badge.svg?branch=master)](https://coveralls.io/github/JustasB/pylmeasure?branch=master)
[![PyPI version](https://badge.fury.io/py/pylmeasure.svg)](https://badge.fury.io/py/pylmeasure)
# PyLMeasure: A Python Wrapper for L-Measure.
[PyLMeasure](https://pypi.org/project/pylmeasure/) is a Python wrapper library for the command-line interface of the neuronal morphology analysis tool [L-Measure](http://cng.gmu.edu:8080/Lm/help/index.htm).
# Installation
To install the library, simply type in `pip install pylmeasure` in your terminal.
There is no need to separately download L-Measure or install Java. The above command includes the necessary binaries.
# Usage
# Issues
# Contributing
Mainly, three functions are implemented getMeasure(), getMeasureDistribution() and
getMeasureDependence().
Operating systems Supported:
1. Linux 32 and 64 bit
Installation:
Linux:
Caution: Do not place these files in a system path.
1. Copy the folder 'python-Lmeasure' to a location(for example <home directory>/installations/)
2. Add the path '<path to python-Lmeasure>/LMIO/' to the system PYTHONPATH by adding the following line to .profile or .bashrc
export PYTHONPATH="$PYTHONPATH:<path to python-Lmeasure>/LMIO/"
Source the .profile or .bashrc file.
Output Format:
The object returned by any of the three functions is a list of a dictionaries, each dictionary with the following
structure. Each dictionary corresponds to one measure specified as input to the function being used(in measureNames or
measure1Names).
LMOutputTemplate = dict(rawData=None,
measure1BinCentres=None,
measure1BinCounts=None,
measure2BinAverages=None,
measure2BinStdDevs=None,
WholeCellMeasures=None,
)
WholeCellMeasures is a (# of swc files given)x7 numpy array. The seven entries along the second dimension correspond
respectively to
TotalSum, CompartmentsConsidered, Compartments Discarded, Minimum, Average, Maximum, StdDev
All meaure**** fields are (# of swc files given) x (nBins +1) numpy arrays.
getMeasure() has its results in WholeCellMeasures.
getMeasureDistribution has its results in measure1BinCentres and measure1BinCounts
getMeasureDependence has its results in measure1BinCentres, measure2BinAverages and measure2BinStdDevs
Misc:
See the file ExampleUsage.py for example usage.
Look at the documentation strings for more information
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pylmeasure-0.1.2.tar.gz
(3.2 MB
view hashes)
Built Distribution
Close
Hashes for pylmeasure-0.1.2-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e571dc2f1cc77f9521de93a487015ef8e9a6378d90b317ce913ef98b652919d |
|
MD5 | 5455d2ac0e80b975c68a81ae5d247f6a |
|
BLAKE2b-256 | 041056d9b1e32cfbcf9119d2b725939545903a6cdc54bf01cccacbb8bbc59b92 |