Primary Classes¶
|
The principal class for representing a data file. |
|
Provide an interface to manipulating lots of data files stored within a directory structure on disc. |
|
An Image file type that is analogous to |
|
Folder object for images. |
Stoner
Package¶
|
The principal class for representing a data file. |
|
Provide an interface to manipulating lots of data files stored within a directory structure on disc. |
|
An Image file type that is analogous to |
|
Folder object for images. |
Base classes for the Stoner package.
|
Given a string value try to work out if there is a better python type dor the value. |
Placeholder to indicate that special action needed to convert a string representation to valid Python type. |
|
An ordered dictionary that permits looks up by regular expression. |
|
|
Extends a |
|
Represent some sort of object that has metadata stored in a |
Provides the DataArray class.
A subclass of numpy.ma.MaskedArray
that knows that columns have names.
|
A sub class of |
setas module provides the setas class for DataFile and friends.
|
A Class that provides a mechanism for managing the column assignments in a DataFile like object. |
Stoner Package specific exceptions.
|
Raise an error when condition is false. |
An exception raised when the library thinks an assertion has failed. |
|
An exception thrown by the file loading routines in the Stoner Package. |
|
An exception tjrown when we try to access a column in data without setas being set. |
|
An exception thrown by the file loading routines in the Stoner Package. |
|
Implement the core work of adding other to self and modifying newdata. |
|
Implement the core of the & operator, returning data in newdata. |
|
Worker for the subtraction. |
|
Implement the column deletion method. |
|
Copy the data associated with source to dest. |
|
Expand a string of column assignments, replacing numbers with repeated characters. |
A customised csv dialect class for reading tab delimited text files. |
|
Base class object that represents a matrix of data, associated metadata and column headers. |
Stoner .Analysis provides a subclass of Data
that has extra analysis routines builtin.
A mixin calss designed to work with |
Provides additional functionality for doing curve fitting to data.
|
A wrapper for converting lmfit models to odr models. |
A mixin calss for |
Stoner.plot sub-package - contains classes and functions for visuallising data.
Most of the plotting functionality is provided by the PlotMixin
mixin class which is available through the
Stoner.Data
class.
The formats
module provides a set of template classes for producing different plot styles and formats. The
Stoner.plot.util
module provides
some handy utility functions.
|
A mixin class that works with |
Plot Templates module - contains classes that style plots produced by Data
.
An axis tick label formatter that emits Tex formula mode code. |
|
|
An axis tick label formatter that emits Tex formula mode code. |
|
Produces a default plot style. |
|
Template developed for Gavin's plotting. |
|
Template class for Joe's Plot settings. |
|
Template class for Joe's Plot settings. |
|
A figure Style for making figures for Phys Rev * Jounrals. |
|
Turn on xkcd plot style. |
alias of |
|
Plot data with errors marked by a filled region. |
Provides additional functionality for doing curve fitting to data.
|
A wrapper for converting lmfit models to odr models. |
A mixin calss for |
The following modules offer specialised file and foler formats.
|
A sub class of DataFile that sores itself in a HDF5File or group. |
|
Just enforces the loader attriobute to be an HDF5File. |
|
A subclass of DataFile for reading GenX HDF Files. |
|
Load images from the Swiss Light Source Pollux beamline. |
|
An instance of KerrArray that will load itself from a Swiss Light Source STXM image. |
|
Context manager for HDF5 files. |
|
Recursively searches for a zipfile in the tree. |
|
A sub class of DataFile that sores itself in a zip file. |
|
Provides methods to load and save data from a single Zip file. |
|
A sub class of DataFile that sores itself in a zip file. |
|
Split the DataFile data into several files where the column col is either rising or falling. |
|
Format an integer into an ordinal string. |
|
Perform corrections to a hysteresis loop. |
Support functions for Stoner package.
These functions depend only on Stoner.compat which is used to ensure a consistent namespace between python 2.7 and 3.x.
|
Check whether each element of iterator is the same length/shape. |
|
Determine if an interable omnly contains a common type. |
|
Update proxy_func to have a signature that matches the wrapped func. |
|
Format answer with the uncertaintly to 1sf and the value to no more sf's than the uncertainty. |
|
Format a number as an SI quantity. |
|
Replace special characters "&", "<" and ">" to HTML-safe sequences. |
|
Intelligently check whether any of the inputs are None. |
|
Return true if v1 and v2 can be compared sensibly. |
|
Return True if input is None or an empty iterator, or an iterator of None. |
|
Chack to see if a value is iterable. |
|
Return True if value is an iterable but not a string. |
|
Check whether an attribute of an object or class is a property. |
|
Determine if obj is a tuple of a certain signature. |
|
Check whether obj is a class and if so whether it is a subclass of cls. |
|
Copy the data associated with source to dest. |
|
Return an instance of Stoner.Data or Stoner.ImageFile passig through constructor arguments. |
|
Round a number to the nearest multiple of a quantum. |
|
Escapes spacecial text characters in a string. |
|
Return the option value. |
|
Set a global package option. |
|
Format an integer into an ordinal string. |
alias of |
|
|
Subclass list to make setitem enforce strict typing of members of the list. |
|
Dead simple class to allow access to package options. |
Stoner.Folders : Classes for working collections of Data
files.
The core classes provides a means to access them as an ordered collection or as a mapping.
|
Provide an interface to manipulating lots of data files stored within a directory structure on disc. |
|
A |
Core support for working with collections of files in the Stoner.DataFolder
.
|
Provide an interface to manipulating lots of data files stored within a directory structure on disc. |
|
A |
Provide the base classes and functions for the Stoner.DataFolder
class.
|
A base class for objectFolders that supports both a sequence of objects and a mapping of instances of itself. |
mixin classes for Stoner.folders.core.baseFoler
.
|
A Mixin class that implements reading metadataObjects from disc. |
Methods for working with |
|
A Mixin for |
Classes and support functions for the Stoner.DataFolder.each
.magic attribute.
|
Provides a proxy object for accessing methods on the inividual members of a Folder. |
Provides classes and functions to support the Stoner.DataFolder.metadata
magic attribute.
|
Provide methods to interact with a whole collection of metadataObjects' metadata. |
The Stoner.Image
package provides a means to carry out image processing functions in a smilar way that
Stoner.Core
and Stoner.Data
and Stoner.DataFolder
do. The Stomner.Image.core
module
contains the key classes for achieving this.
|
A numpy array like class with a metadata parameter and pass through to skimage methods. |
|
An Image file type that is analogous to |
|
Folder object for images. |
|
An alternative implementation of an image stack based on baseFolder. |
|
A subclass for Kerr microscopy specific image functions. |
|
Represent a stack of Kerr images. |
|
Represent a set of masks for Kerr images. |
Mixin to provide a folder object for images. |
|
|
Folder object for images. |
|
Implement an interface for a baseFolder to store images in a 3D numpy array for faster access. |
|
An alternative implementation of an image stack based on baseFolder. |
|
An alternative implementation of an image stack based on baseFolder. |
|
Provides a wrapper around |
|
Provides a wrapper to support manipulating the image mask easily. |
|
An ImageStack subclass that can load scans from the AttocubeScan SPM System. |
|
Rescale the intensity of the image. |
|
Use one of a variety of algroithms to align two images. |
|
Convert an image to the requested data-type. |
|
Align images to correct for image drift. |
|
Subtract a background image from the ImageArray. |
|
Perform a 2d fft of the image and shift the result to get zero frequency in the centre. |
|
Alias for skimage.filters.gaussian. |
|
Use |
|
Pass through to |
|
Quickly plot of image. |
|
Subtract a polynomial background from image. |
|
Norm alise the data to a fixed scale. |
|
Wrap sckit-image method of the same name to get a line_profile. |
|
Quantise the image data into fixed levels given by a mapping. |
|
Rerurn a map of the radial coordinates of an image from a given centre, with adjustments for pixel size. |
|
Extract a radial profile line from an image. |
|
Find values of the data that are beyond a percentile of the overall distribution and replace them. |
|
Rotate image by a certain angle around its center. |
|
Translate the image. |
|
Find the limits of an image after a translation. |
|
Plot the histogram and cumulative distribution for the image. |
|
Return a boolean array which is thresholded between threshmin and threshmax. |
|
Nulop function for testing the integration into ImageArray. |
|
Rename the skimage restore function. |
Code adapted from skimage module.
|
Warn over loss of sign information when converting image. |
|
Warn over precision loss when converting image. |
|
Return first of dtypes with itemsize greater than `itemsize. |
|
Return dtype of kind that can store a bits wide unsigned int. |
|
A subclass for Kerr microscopy specific image functions. |
|
Represent a stack of Kerr images. |
|
Represent a set of masks for Kerr images. |