SF_TOOLS Documentation

Author:Samuel Farrens <samuel.farrens@gmail.com> Version:1.0.1 Date:25/10/2017

SF_TOOLS is a series of Python 2.7 modules with applications to image analysis, signal processing and statistics.

Contents

1. Dependencies
   1. Required Packages
   2. Optional Packages
2. Installation
3. Package Contents

Dependencies

Required Packages

In order to run the code in this repository the following packages must be installed:

• Python [Tested with v 2.7.11 and 3.6.3]
• Numpy [Tested with v 1.13.3]
• Scipy [Tested with v 0.18.1]
• Future [Tested with v 0.16.0]
• Astropy [Tested with v 1.3]

Optional Packages

The following packages can optionally be installed to add extra functionality:

• Matplotlib [Tested with v 2.0.2]
• Termcolor [Tested with v 1.1.0]

Installation

To clone the sf_tools repository from GitHub run the following command:

$ git clone https://github.com/sfarrens/sf_tools

To install using easy_install run the following command:

$ easy_install sf_tools

To install using pip run the following command:

$ pip install sf_tools

Package Contents

• 1. sf_tools Examples
• 2. sf_tools package
  • 2.1. Subpackages
    • 2.1.1. sf_tools.base package
    • 2.1.2. sf_tools.image package
    • 2.1.3. sf_tools.interface package
    • 2.1.4. sf_tools.math package
    • 2.1.5. sf_tools.plot package
    • 2.1.6. sf_tools.signal package
  • 2.2. Module contents