mud-py 1.0.1

MUon Data file reader

Package Overview

MUon (MUD) Data file reader package.

Setup

Dependencies needed pre-install:

• python development version: sudo apt-get install python3-dev (on Ubuntu, for example)
• Cython: pip3 install Cython
• numpy: pip3 install numpy

Install

• Install using pip: pip3 install mud-py

Note that the import statement after install is import mudpy

Contents

• mdata [object]: access general MUD files, provides special containers
• mud_friendly [C wrapper]: python access to MUD C functions

mdata

mud-data object. The mdata object is a data container designed for easy reading of any MUD file, regardless of experiment type or mesurement method.

Object Map

Signature:

mdata(filename)

Example: mud = mdata('filename.msr')

Functions:

Signature	Description
set_description(mode)	Mode is one of "TD" or "TI".
write(filename)	Write to file

Misc Features

Representation

Representation has been nicely formatted so that typing the object name into the interpreter produces nice output.

Operators

mvar, mscaler, and mhist objects allow for arithmatic or logic operators to be used, where the value used in the operation is the mean, count, or data array respectively.

Example: mud.ivar['BNMR:HVBIAS:POS:RDVOL'] + 1 is equivalent to mud.ivar['BNMR:HVBIAS:POS:RDVOL'].mean + 1

Special Rules For Attributes

If an attribute is not found in mdata, it will look for the attribute in the bdict objects in the order: hist, ivar. This second-level attribute search is much slower than regular access.

mdict objects all allow assignment and fetching of dictionary keys as if they were attributes. Note that one can replace + with p, and - with m to allow fetching of histograms.

Example: mud.hist.Bp, mud.hist['B+'], mud.Bp all have the exact same output, with the last being much slower than the others.

mud_friendly

Wrap the mud_friendly.c functions using Cython. Gives low-level access to mud files.

Functions:

File IO

Cython Function (python-accessible)	C Function (wrapped)
open_read(str file_name)	MUD_openRead(char* file_name, unsigned int* pType)
open_write(str file_name, unsigned int file_type)	MUD_openWrite(char* file_name, unsigned int pType)
open_readwrite(str file_name)	MUD_openReadWrite(char* file_name, unsigned int* pType)
close_read(int file_handle)	MUD_closeRead(int file_handle)
close_write(int file_handle)	MUD_closeWrite(int file_handle)
close_writefile(int file_handle, str file_name)	MUD_closeWriteFile(int file_handle, char* file_name)

Headers

Cython Function (python-accessible)	C Function (wrapped)
get_description(int file_handle)	int MUD_getRunDesc(int fh, unsigned int* pType)
get_exp_number(int file_handle)	int MUD_getExptNumber(int fh, unsigned int* pExpNumber)
get_run_number(int file_handle)	int MUD_getRunNumber(int fh, unsigned int* pRunNumber)
get_elapsed_seconds(int file_handle)	int MUD_getElapsedSec(int fh, unsigned int* pElapsedSec)
get_start_time(int file_handle)	int MUD_getTimeBegin(int fh, unsigned int* pTimeBegin)
get_end_time(int file_handle)	int MUD_getTimeEnd(int fh, unsigned int* pTimeEnd)
get_title(int file_handle)	int MUD_getTitle(int fh, char* string, int strdim)
get_lab(int file_handle)	int MUD_getLab(int fh, char* string, int strdim)
get_area(int file_handle)	int MUD_getArea(int fh, char* string, int strdim)
get_method(int file_handle)	int MUD_getMethod(int fh, char* string, int strdim)
get_apparatus(int file_handle)	int MUD_getApparatus(int fh, char* string, int strdim)
get_insert(int file_handle)	int MUD_getInsert(int fh, char* string, int strdim)
get_sample(int file_handle)	int MUD_getSample(int fh, char* string, int strdim)
get_orientation(int file_handle)	int MUD_getOrient(int fh, char* string, int strdim)
get_das(int file_handle)	int MUD_getDas(int fh, char* string, int strdim)
get_experimenter(int file_handle)	int MUD_getExperimenter(int fh, char* string, int strdim)
get_temperature(int file_handle)	int MUD_getTemperature(int fh, char* string, int strdim )
get_field(int file_handle)	int MUD_getField(int fh, char* string, int strdim )

Cython Function (python-accessible)	C Function (wrapped)
set_description(int file_handle, unsigned int pType)	MUD_setRunDesc(int fh, unsigned int pType)
set_exp_number(int file_handle, unsigned int expNumber)	int MUD_setExptNumber(int fh, unsigned int pExpNumber)
set_run_number(int file_handle, unsigned int runNumber)	int MUD_setRunNumber(int fh, unsigned int pRunNumber)
set_elapsed_seconds(int file_handle, unsigned int elapsedSec)	int MUD_setElapsedSec(int fh, unsigned int pElapsedSec)
set_start_time(int file_handle, unsigned int timeBegin)	int MUD_setTimeBegin(int fh, unsigned int pTimeBegin)
set_end_time(int file_handle, unsigned int timeEnd)	int MUD_setTimeEnd(int fh, unsigned int pTimeEnd)
set_title(int file_handle, str title)	int MUD_setTitle(int fh, char* string )
set_lab(int file_handle, str title)	int MUD_setLab(int fh, char* string )
set_area(int file_handle, str title)	int MUD_setArea(int fh, char* string )
set_method(int file_handle, str title)	int MUD_setMethod(int fh, char* string )
set_apparatus(int file_handle, str title)	int MUD_setApparatus(int fh, char* string )
set_insert(int file_handle, str title)	int MUD_setInsert(int fh, char* string )
set_sample(int file_handle, str title)	int MUD_setSample(int fh, char* string )
set_orientation(int file_handle, str title)	int MUD_setOrient(int fh, char* string )
set_das(int file_handle, str title)	int MUD_setDas(int fh, char* string )
set_experimenter(int file_handle, str title)	int MUD_setExperimenter(int fh, char* string )
set_temperature(int file_handle, str title)	int MUD_setTemperature(int fh, char* string )
set_field(int file_handle, str title)	int MUD_setField(int fh, char* string )

Comments

Cython Function (python-accessible)	C Function (wrapped)
get_comments(file_handle)	int MUD_getComments(int fh, unsigned int* pType, unsigned int* number_of_comments)
get_comment_prev(file_handle,id_number)	int MUD_getCommentPrev(int fh, int num, unsigned int* pPrev )
get_comment_next(file_handle,id_number)	int MUD_getCommentNext(int fh, int num, unsigned int* pNext )
get_comment_time(file_handle,id_number)	int MUD_getCommentTime(int fh, int num, unsigned int* pTime )
get_comment_author(file_handle,id_number)	int MUD_getCommentAuthor(int fh, int num, char* author, int strdim )
get_comment_title(file_handle,id_number)	int MUD_getCommentTitle(int fh, int num, char* title, int strdim )
get_comment_body(file_handle,id_number)	int MUD_getCommentBody(int fh, int num, char* body, int strdim )

Cython Function (python-accessible)	C Function (wrapped)
set_comments(int file_handle, unsigned int pType, unsigned int n_comments)	MUD_setComments(int fh, unsigned int pType, unsigned int n_comments)
set_comment_prev(int file_handle,id_number,unsigned int value)	MUD_setCommentPrev(int fh, int num, unsigned int pPrev )
set_comment_next(int file_handle,id_number,unsigned int value)	MUD_setCommentNext(int fh, int num, unsigned int pNext )
set_comment_time(int file_handle,id_number,unsigned int value)	MUD_setCommentTime(int fh, int num, unsigned int pTime )
set_comment_author(int file_handle,id_number, str title)	MUD_setCommentAuthor(int fh, int num, char* author )
set_comment_title(int file_handle,id_number, str title)	MUD_setCommentTitle(int fh, int num, char* title )
set_comment_body(int file_handle,id_number, str title)	MUD_setCommentBody(int fh, int num, char* body )

Histograms

Cython Function (python-accessible)	C Function (wrapped)
get_hists(int file_handle)	int MUD_getHists( int fh, unsigned int* pType, unsigned int* pNum )
get_hist_type(int file_handle, int id_number)	int MUD_getHistType( int fh, int num, unsigned int* pType )
get_hist_n_bytes(int file_handle, int id_number)	int MUD_getHistNumBytes( int fh, int num, unsigned int* pNumBytes )
get_hist_n_bins(int file_handle, int id_number)	int MUD_getHistNumBins( int fh, int num, unsigned int* pNumBins )
get_hist_bytes_per_bin(int file_handle, int id_number)	int MUD_getHistBytesPerBin( int fh, int num, unsigned int* pBytesPerBin )
get_hist_fs_per_bin(int file_handle, int id_number)	int MUD_getHistFsPerBin( int fh, int num, unsigned int* pFsPerBin )
get_hist_t0_ps(int file_handle, int id_number)	int MUD_getHistT0_Ps( int fh, int num, unsigned int* pT0_ps )
get_hist_t0_bin(int file_handle, int id_number)	int MUD_getHistT0_Bin( int fh, int num, unsigned int* pT0_bin )
get_hist_good_bin1(int file_handle, int id_number)	int MUD_getHistGoodBin1( int fh, int num, unsigned int* pGoodBin1 )
get_hist_good_bin2(int file_handle, int id_number)	int MUD_getHistGoodBin2( int fh, int num, unsigned int* pGoodBin2 )
get_hist_background1(int file_handle, int id_number)	int MUD_getHistBkgd1( int fh, int num, unsigned int* pBkgd1 )
get_hist_background2(int file_handle, int id_number)	int MUD_getHistBkgd2( int fh, int num, unsigned int* pBkgd2 )
get_hist_n_events(int file_handle, int id_number)	int MUD_getHistNumEvents( int fh, int num, unsigned int* pNumEvents )
get_hist_title(int file_handle, int id_number)	int MUD_getHistTitle( int fh, int num, char* title, int strdim )
get_hist_sec_per_bin(int file_handle, int id_number)	int MUD_getHistSecondsPerBin( int fh, int num, double* pSecondsPerBin )
get_hist_data(int file_handle, int id_number)	int MUD_getHistData( int fh, int num, void* pData )

Cython Function (python-accessible)	C Function (wrapped)
set_hists(int file_handle, unsigned int number_histograms)	int MUD_setHists( int fh, unsigned int pType, unsigned int pNum )
set_hist_type(int file_handle, int id_number, unsigned int pType)	int MUD_setHistType( int fh, int num, unsigned int pType )
set_hist_n_bytes(int file_handle, int id_number, unsigned int value)	int MUD_setHistNumBytes( int fh, int num, unsigned int pNumBytes )
set_hist_n_bins(int file_handle, int id_number, unsigned int value)	int MUD_setHistNumBins( int fh, int num, unsigned int pNumBins )
set_hist_bytes_per_bin(int file_handle, int id_number, unsigned int value)	int MUD_setHistBytesPerBin( int fh, int num, unsigned int pBytesPerBin )
set_hist_fs_per_bin(int file_handle, int id_number, unsigned int value)	int MUD_setHistFsPerBin( int fh, int num, unsigned int pFsPerBin )
set_hist_t0_ps(int file_handle, int id_number, unsigned int value)	int MUD_setHistT0_Ps( int fh, int num, unsigned int pT0_ps )
set_hist_t0_bin(int file_handle, int id_number, unsigned int value)	int MUD_setHistT0_Bin( int fh, int num, unsigned int pT0_bin )
set_hist_good_bin1(int file_handle, int id_number, unsigned int value)	int MUD_setHistGoodBin1( int fh, int num, unsigned int pGoodBin1 )
set_hist_good_bin2(int file_handle, int id_number, unsigned int value)	int MUD_setHistGoodBin2( int fh, int num, unsigned int pGoodBin2 )
set_hist_background1(int file_handle, int id_number, unsigned int value)	int MUD_setHistBkgd1( int fh, int num, unsigned int pBkgd1 )
set_hist_background2(int file_handle, int id_number, unsigned int value)	int MUD_setHistBkgd2( int fh, int num, unsigned int pBkgd2 )
set_hist_n_events(int file_handle, int id_number, unsigned int value)	int MUD_setHistNumEvents( int fh, int num, unsigned int pNumEvents )
set_hist_title(int file_handle, int id_number, str title)	int MUD_setHistTitle( int fh, int num, char* title )
set_hist_sec_per_bin(int file_handle, int id_number, unsigned int value)	int MUD_setHistSecondsPerBin( int fh, int num, double pSecondsPerBin )
set_hist_data(int file_handle, int id_number, long[:] data_array)	int MUD_setHistData( int fh, int num, void* pData )

Scalers

Cython Function (python-accessible)	C Function (wrapped)
get_scalers(int file_handle)	int MUD_getScalers( int fh, unsigned int* pType, unsigned int* pNum )
get_scaler_label(int file_handle,int id_number)	int MUD_getScalerLabel( int fh, int num, char* label, int strdim )
get_scaler_counts(int file_handle,int id_number)	int MUD_getScalerCounts( int fh, int num, unsigned int* pCounts )

Cython Function (python-accessible)	C Function (wrapped)
set_scalers(int file_handle, unsigned int pType, unsigned int number_scalars)	MUD_setScalers( int fh, unsigned int pType, unsigned int pNum )
set_scaler_label(int file_handle, int id_number, str title)	MUD_setScalerLabel( int fh, int num, char* label)
set_scaler_counts(int file_handle, int id_number, str title)	MUD_setScalerCounts( int fh, int num, unsigned int* pCounts )

Independent Variables

Cython Function (python-accessible)	C Function (wrapped)
get_ivars(int file_handle)	MUD_getIndVars(int fh, unsigned int* pType, unsigned int* number_of_variables)
get_ivar_low(int file_handle,int id_number)	MUD_getIndVarLow( int fh, int num, double* pLow )
get_ivar_high(int file_handle,int id_number)	MUD_getIndVarHigh( int fh, int num, double* pHigh )
get_ivar_mean(int file_handle,int id_number)	MUD_getIndVarMean( int fh, int num, double* pMean )
get_ivar_std(int file_handle,int id_number)	MUD_getIndVarStddev( int fh, int num, double* pStddev )
get_ivar_skewness(int file_handle,int id_number)	MUD_getIndVarSkewness( int fh, int num, double* pSkewness )
get_ivar_name(int file_handle,int id_number)	MUD_getIndVarName( int fh, int num, char* name, int strdim )
get_ivar_description(int file_handle,int id_number)	MUD_getIndVarDescription( int fh, int num, char* description,int strdim)
get_ivar_units(int file_handle,int id_number)	MUD_getIndVarUnits( int fh, int num, char* units, int strdim )
get_ivar_n_data(int file_handle, int id_number)	MUD_getIndVarNumData( int fh, int num, unsigned int* pNumData )
get_ivar_element_size(int file_handle, int id_number)	MUD_getIndVarElemSize( int fh, int num, unsigned int* pElemSize )
get_ivar_data_type(int file_handle, int id_number)	MUD_getIndVarDataType( int fh, int num, unsigned int* pDataType )
get_ivar_has_time(int file_handle, int id_number)	MUD_getIndVarHasTime( int fh, int num, unsigned int* pHasTime )
get_ivar_data(int file_handle, int id_number)	MUD_getIndVarData( int fh, int num, void* pData )
get_ivar_time_data(int file_handle, int id_number)	MUD_getIndVarTimeData( int fh, int num, void* pTimeData )

Cython Function (python-accessible)	C Function (wrapped)
set_ivars(int file_handle, unsigned int pType, unsigned int n_vars)	MUD_setIndVars(int fh, unsigned int pType, unsigned int number_of_variables)
set_ivar_low(int file_handle,int id_number, double value)	MUD_setIndVarLow( int fh, int num, double pLow )
set_ivar_high(int file_handle,int id_number, double value)	MUD_setIndVarHigh( int fh, int num, double pHigh )
set_ivar_mean(int file_handle,int id_number, double value)	MUD_setIndVarMean( int fh, int num, double pMean )
set_ivar_std(int file_handle,int id_number, double value)	MUD_setIndVarStddev( int fh, int num, double pStddev )
set_ivar_skewness(int file_handle,int id_number, double value)	MUD_setIndVarSkewness( int fh, int num, double pSkewness )
set_ivar_name(int file_handle,int id_number, str title)	MUD_setIndVarName( int fh, int num, char* name )
set_ivar_description(int file_handle,int id_number, str title)	MUD_setIndVarDescription( int fh, int num, char* description )
set_ivar_units(int file_handle,int id_number, str title)	MUD_setIndVarUnits( int fh, int num, char* units )
set_ivar_n_data(int file_handle, int id_number, unsigned int value)	MUD_setIndVarNumData( int fh, int num, unsigned int valule )
set_ivar_element_size(int file_handle, int id_number, unsigned int value)	MUD_setIndVarElemSize( int fh, int num, unsigned int value )
set_ivar_data_type(int file_handle, int id_number, unsigned int value)	MUD_setIndVarDataType( int fh, int num, unsigned int pType )
set_ivar_data(int file_handle, int id_number, data_array)	MUD_setIndVarData( int fh, int num, void* pData )
set_ivar_time_data(int file_handle, int id_number, data_array)	MUD_setIndVarTimeData( int fh, int num, void* pTimeData )