data_info

DataLoader.data_info

Module that contains classes to hold information read from reduced data files.

A good description of the data members can be found in the CanSAS 1D XML data format:

http://www.smallangles.net/wgwiki/index.php/cansas1d_documentation

class DataLoader.data_info.Aperture
class DataLoader.data_info.Collimation

Class to hold collimation information

class DataLoader.data_info.Data1D(x, y, dx=None, dy=None)

Bases: DataLoader.data_info.plottable_1D, DataLoader.data_info.DataInfo

1D data class

add_notes(message='')

Add notes to datainfo

append_empty_process()
clone_without_data(length=0, clone=None)

Clone the current object, without copying the data (which will be filled out by a subsequent operation). The data arrays will be initialized to zero.

Parameters:
  • length – length of the data array to be initialized
  • clone – if provided, the data will be copied to clone
is_slit_smeared()

Check whether the data has slit smearing information

Returns:True is slit smearing info is present, False otherwise
xaxis(label, unit)

set the x axis label and unit

yaxis(label, unit)

set the y axis label and unit

class DataLoader.data_info.Data2D(data=None, err_data=None, qx_data=None, qy_data=None, q_data=None, mask=None, dqx_data=None, dqy_data=None)

Bases: DataLoader.data_info.plottable_2D, DataLoader.data_info.DataInfo

2D data class

add_notes(message='')

Add notes to datainfo

append_empty_process()
clone_without_data(length=0, clone=None)

Clone the current object, without copying the data (which will be filled out by a subsequent operation). The data arrays will be initialized to zero.

Parameters:
  • length – length of the data array to be initialized
  • clone – if provided, the data will be copied to clone
xaxis(label, unit)

set the x axis label and unit

yaxis(label, unit)

set the y axis label and unit

zaxis(label, unit)

set the z axis label and unit

class DataLoader.data_info.DataInfo

Class to hold the data read from a file. It includes four blocks of data for the instrument description, the sample description, the data itself and any other meta data.

add_notes(message='')

Add notes to datainfo

append_empty_process()
class DataLoader.data_info.Detector

Class to hold detector information

class DataLoader.data_info.Process

Class that holds information about the processes performed on the data.

class DataLoader.data_info.Sample

Class to hold the sample description

class DataLoader.data_info.Source

Class to hold source information

class DataLoader.data_info.Vector(x=None, y=None, z=None)

Vector class to hold multi-dimensional objects

class DataLoader.data_info.plottable_1D(x, y, dx=None, dy=None, dxl=None, dxw=None)

Data1D is a place holder for 1D plottables.

xaxis(label, unit)

set the x axis label and unit

yaxis(label, unit)

set the y axis label and unit

class DataLoader.data_info.plottable_2D(data=None, err_data=None, qx_data=None, qy_data=None, q_data=None, mask=None, dqx_data=None, dqy_data=None)

Data2D is a place holder for 2D plottables.

xaxis(label, unit)

set the x axis label and unit

yaxis(label, unit)

set the y axis label and unit

zaxis(label, unit)

set the z axis label and unit

Table Of Contents

Previous topic

Reference

Next topic

loader

This Page