umetrics.impdata
index
(built-in)

Contains functionality for importing data.

 
Classes
       
Boost.Python.enum(builtins.int)
columntype
datablock
rowtype
timeAccuracy
Boost.Python.instance(builtins.object)
ImportData
ImportSpecification

 
class ImportData(Boost.Python.instance)
    Holds data and specifications for importing data into SIMCA.
Each cell can either hold a float or a string.
The precision of floats held internally are 32-bits unlike Python floats
which has 64 bit precision. This sets limits on the values that can be used.
Floating point values has ~6 significant digits (Python ~15)
and can not be larger than ~3.4*10^38 (Python ~1.7*10^308)
or smaller than ~1.2*10^-38 (Python 2.2*10^-308).
 
 
Method resolution order:
ImportData
Boost.Python.instance
builtins.object

Static methods defined here:
__init__(...)
__init__( (object)arg1) -> None
 
__init__( (object)self) -> None :
    Constructs an empty ImportData.
 
__init__( (object)self, (int)rows, (int)columns) -> None :
    Constructs an ImportData with the specified size.
 
__init__( (object)self, (object)mat) -> None :
    Constructs an ImportData from a matrix of values containing strings and or/numbers.
    Indata can also be a pandas dataframe.
__reduce__ = (...)
__str__(...)
__str__( (ImportData)arg1) -> str
create_dataset(...)
create_dataset( (ImportData)self, (Project)project, (str)datasetname [, (bool)throw_on_illegals=True]) -> int :
    Create a new dataset in the specified project. Returns the number of the new dataset.
    data             --- The data to create the dataset from
    datasetname      --- The unique name of the dataset
    throw_on_illegals --- if False: text in the data is converted to nan, if True the function throws an exception if there are illegal values
get(...)
get( (ImportData)self [, (object)row=None [, (object)column=None]]) -> object :
    Returns the value at the specified column(s) and row(s).
    The value can either be a number or a string
insert_columns(...)
insert_columns( (ImportData)self [, (object)insertpos=None [, (object)columns=None]]) -> int :
    Inserts new columns to the data and ImportSpecification
    insertpos -- Optional argument. The index of position to insert or columns will be appended if argument is omitted
    If insertpos is larger than the number of columns, the new columns will be appended.
    columns -- Either an integer telling how many rows to add or the row data to be added
    Returns the index first column is appended to
insert_rows(...)
insert_rows( (ImportData)self [, (object)insertpos=None [, (object)rows=None]]) -> int :
    Inserts new rows to the data and ImportSpecification
    insertpos -- Optional argument. The index of position to insert or rows will be appended if argument is omitted
    If insertpos is larger than the number of rows, the new rows will be appended.
    rows -- Either an integer telling how many rows to add or the row data to be added
    Returns the index first row is appended to
remove_columns(...)
remove_columns( (ImportData)self, (object)firstcolumn [, (int)count=1]) -> None :
    Removes a range of columns or 'count' columns starting at 'firstcolumn' from the data and ImportSpecification
remove_rows(...)
remove_rows( (ImportData)self, (object)firstrow [, (int)count=1]) -> None :
    Removes a range of rows or 'count' rows starting at 'firstrow' from the data and ImportSpecification
resize(...)
resize( (ImportData)self, (int)rows, (int)columns) -> None :
    Resizes the number of columns and rows in both the data and the ImportSpecification.
    New columns/rows will be appended and set to 'quantitaive'.
    If the new size is smaller, columns/rows will be removed from the end.
set(...)
set( (ImportData)self, (object)row=None, (object)column=None, (object)value) -> None :
    Sets the specified cell(s) to a new value. The value can be either a string or a number.
    Strings representing a number will be converted to a number.
    Note also that the number -99 has a special meaning to SIMCA
    and will be converted to -99.0000991821289.
    Example:
    >>> import umetrics
    >>> data = umetrics.impdata.ImportData(2,2)
    >>> data.set(0,0,-99)
    >>> data.get(0,0)
    -99.0000991821289
    >>> data.set(0,0,'12')
    >>> data.get(0,0)
    12.0
    >>> data.set(0,0,1.00000000002)
    >>> data.get(0,0)
    1.0
 
set( (ImportData)self, (object)matrix) -> None :
    Resizes and sets all data. Indata can be matrix formatted in 2-dimensions or a Pandas dataframe in 2-dimensions.
    Example:
    >>> from umetrics.impdata import ImportData
    >>> data=ImportData(1,1)
    >>> data.set([[1,2],['Hello', 'Godbye']])
    >>> print(data)
    [[1            , 2            ],
     ['Hello'      , 'Godbye'     ]]
    >>> # The content of the class can also be copied to native Python data types.
    >>> mat = []
    >>> for row in range(0, data.rows):
    >>>    mat.append([])
    >>>    for column in range(0, data.columns):
    >>>       mat[-1].append(data.get(row, column))
    >>> # Or, if you use period as decimal separator.
    >>> mat=eval(data.__str__())
    >>> mat
    [[1, 2], ['Hello', 'Godbye']]
    Example Pandas:
    >>> import pandas as pd>>> df = pd.read_csv(r'ProcessDataSmall.csv', sep = ';', index_col = [0, 1, 2, 3])
    >>> imp = umetrics.impdata.ImportData()
    >>> imp.set(df)
transpose(...)
transpose( (ImportData)self) -> None :
    Transposes the data.

Data descriptors defined here:
columns
The number of columns
importspec
An ImportSpecification (see below) that specifies where observation/variable IDs etc
can be found in the ImportData.
is_batch_data
Set to True if the imported data is a batch dataset.
Default is False.
name
Name of this data, default empty.
rows
The number of rows

Data and other attributes defined here:
__instance_size__ = 88

Static methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class ImportSpecification(Boost.Python.instance)
    Provides the specification for how rows/columns in a FileData should be interpreted when importing data.
 
 
Method resolution order:
ImportSpecification
Boost.Python.instance
builtins.object

Static methods defined here:
__init__(...)
Raises an exception
This class cannot be instantiated from Python
__reduce__ = (...)
get_col_block(...)
get_col_block( (ImportSpecification)self [, (object)column=None]) -> object :
    Returns the data block a column belongs to.
    Only columns that are of type quantitative, qualitative, batchcondition
    and qualitativebatchcondition can belong to a data block.
    All other types of column will always return X.
get_col_type(...)
get_col_type( (ImportSpecification)self [, (object)column=None]) -> object :
    Returns the type of a column.
get_row_type(...)
get_row_type( (ImportSpecification)self [, (object)row=None]) -> object :
    Returns the type of a row.
set_col_block(...)
set_col_block( (ImportSpecification)self, (object)column, (datablock)block) -> None :
    Sets a column to the specified block.
    Only columns that are of type quantitative, qualitative, batchcondition
    and quwalitativebatchcondition can belong to a data block.
    Attempting to set any other column to a block will be ignored.
set_col_type(...)
set_col_type( (ImportSpecification)self, (object)column=None, (columntype)type) -> None :
    Sets a column to the specified type.
set_date_time(...)
set_date_time( (ImportSpecification)self, (object)column, (str)parseformat, (timeAccuracy)timeaccuracy, (str)displayformat) -> None :
    Sets date/time options to the specified column
    
    column           the column index
    parseformat      a string used to parse the column, if empty the current locale is used
                     it should be in a form like this for example yyMMdd:HHmm, see details below
    timeaccuracy     select in what unit to store your Date/Time variable.
    displayformat    a string used to display the date in simca, if empty parseformat is used
                     it should be in a form like this for example yyMMdd:HHmm, see details below
    
         yyyy - year using four digits (ex. 2005)
         yy - year using two digits (ex. 05)
         MMM - month using three letters (ex. Aug)
         MM - month using two digits (ex. 08)
         M - month without leading 0 (ex. 8)
         ddd - day of week using three letters (ex. Mon)
         dd - day in month using two digits (ex. 05)
         d - day in month without leading 0 (ex. 5)
         HH - hour representing 24 hour day
         H - hour representing 24 hour day, no leading 0
         hh - hour representing 12 hour day
         h - hour representing 12 hour day, no leading 0
         mm - minutes using 2 digits
         ss - seconds using 2 digits
         fff - fractional seconds using 3 digits (milliseconds)
         tt - AM or PM
set_row_type(...)
set_row_type( (ImportSpecification)self, (object)row, (rowtype)type) -> None :
    Sets a row to the specified type

Data descriptors defined here:
columns
The number of columns
rows
The number of rows

Data and other attributes defined here:
columntype = <class 'umetrics.impdata.columntype'>
Used to specify a columns type
Values:
excluded, quantitative, qualitative, primaryobsid, secondaryobsid, batchid,
phaseid, unitid, datetime, batchcondition, qualitativebatchcondition, phaseiterationid
phasecondition, qualitativephasecondition, phaseiterationcondition, qualitativephaseiterationcondition
datablock = <class 'umetrics.impdata.datablock'>
Used to specify which data block a variable belongs to.
Values:
X, Y
rowtype = <class 'umetrics.impdata.rowtype'>
Used to specify a rows type
Values:
excluded, data, primaryvarid, secondaryvarid
timeAccuracy = <class 'umetrics.impdata.timeAccuracy'>
Used in set_date_time to specify time accuracy
Values:
year, month, day, hour, minute, second
     Second: max time span (without fractions: 11 days, with fractions: 16 minutes
     Minute: max time span 23 month
     Hour: max time span 114 years

Static methods inherited from Boost.Python.instance:
__new__(*args, **kwargs) from Boost.Python.class
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from Boost.Python.instance:
__dict__
__weakref__

 
class columntype(Boost.Python.enum)
    Used to specify a columns type
Values:
excluded, quantitative, qualitative, primaryobsid, secondaryobsid, batchid,
phaseid, unitid, datetime, batchcondition, qualitativebatchcondition, phaseiterationid
phasecondition, qualitativephasecondition, phaseiterationcondition, qualitativephaseiterationcondition
 
 
Method resolution order:
columntype
Boost.Python.enum
builtins.int
builtins.object

Data and other attributes defined here:
batchcondition = umetrics.impdata.columntype.batchcondition
batchid = umetrics.impdata.columntype.batchid
classid = umetrics.impdata.columntype.classid
datetime = umetrics.impdata.columntype.datetime
excluded = umetrics.impdata.columntype.excluded
names = {'batchcondition': umetrics.impdata.columntype.batchcondition, 'batchid': umetrics.impdata.columntype.batchid, 'classid': umetrics.impdata.columntype.classid, 'datetime': umetrics.impdata.columntype.datetime, 'excluded': umetrics.impdata.columntype.excluded, 'phasecondition': umetrics.impdata.columntype.phasecondition, 'phaseid': umetrics.impdata.columntype.phaseid, 'phaseiterationcondition': umetrics.impdata.columntype.phaseiterationcondition, 'phaseiterationid': umetrics.impdata.columntype.phaseiterationid, 'primaryobsid': umetrics.impdata.columntype.primaryobsid, ...}
phasecondition = umetrics.impdata.columntype.phasecondition
phaseid = umetrics.impdata.columntype.phaseid
phaseiterationcondition = umetrics.impdata.columntype.phaseiterationcondition
phaseiterationid = umetrics.impdata.columntype.phaseiterationid
primaryobsid = umetrics.impdata.columntype.primaryobsid
qualitative = umetrics.impdata.columntype.qualitative
qualitativebatchcondition = umetrics.impdata.columntype.qualitativebatchcondition
qualitativephasecondition = umetrics.impdata.columntype.qualitativephasecondition
qualitativephaseiterationcondition = umetrics.impdata.columntype.qualitativephaseiterationcondition
quantitative = umetrics.impdata.columntype.quantitative
secondaryobsid = umetrics.impdata.columntype.secondaryobsid
unitid = umetrics.impdata.columntype.unitid
values = {0: umetrics.impdata.columntype.quantitative, 1: umetrics.impdata.columntype.excluded, 2: umetrics.impdata.columntype.qualitative, 3: umetrics.impdata.columntype.primaryobsid, 4: umetrics.impdata.columntype.secondaryobsid, 5: umetrics.impdata.columntype.batchid, 6: umetrics.impdata.columntype.classid, 7: umetrics.impdata.columntype.unitid, 8: umetrics.impdata.columntype.datetime, 9: umetrics.impdata.columntype.batchcondition, ...}

Methods inherited from Boost.Python.enum:
__repr__(self, /)
Return repr(self).
__str__(self, /)
Return str(self).

Data descriptors inherited from Boost.Python.enum:
name

Methods inherited from builtins.int:
__abs__(self, /)
abs(self)
__add__(self, value, /)
Return self+value.
__and__(self, value, /)
Return self&value.
__bool__(self, /)
self != 0
__ceil__(...)
Ceiling of an Integral returns itself.
__divmod__(self, value, /)
Return divmod(self, value).
__eq__(self, value, /)
Return self==value.
__float__(self, /)
float(self)
__floor__(...)
Flooring an Integral returns itself.
__floordiv__(self, value, /)
Return self//value.
__format__(self, format_spec, /)
Default object formatter.
__ge__(self, value, /)
Return self>=value.
__getattribute__(self, name, /)
Return getattr(self, name).
__getnewargs__(self, /)
__gt__(self, value, /)
Return self>value.
__hash__(self, /)
Return hash(self).
__index__(self, /)
Return self converted to an integer, if self is suitable for use as an index into a list.
__int__(self, /)
int(self)
__invert__(self, /)
~self
__le__(self, value, /)
Return self<=value.
__lshift__(self, value, /)
Return self<<value.
__lt__(self, value, /)
Return self<value.
__mod__(self, value, /)
Return self%value.
__mul__(self, value, /)
Return self*value.
__ne__(self, value, /)
Return self!=value.
__neg__(self, /)
-self
__or__(self, value, /)
Return self|value.
__pos__(self, /)
+self
__pow__(self, value, mod=None, /)
Return pow(self, value, mod).
__radd__(self, value, /)
Return value+self.
__rand__(self, value, /)
Return value&self.
__rdivmod__(self, value, /)
Return divmod(value, self).
__rfloordiv__(self, value, /)
Return value//self.
__rlshift__(self, value, /)
Return value<<self.
__rmod__(self, value, /)
Return value%self.
__rmul__(self, value, /)
Return value*self.
__ror__(self, value, /)
Return value|self.
__round__(...)
Rounding an Integral returns itself.
Rounding with an ndigits argument also returns an integer.
__rpow__(self, value, mod=None, /)
Return pow(value, self, mod).
__rrshift__(self, value, /)
Return value>>self.
__rshift__(self, value, /)
Return self>>value.
__rsub__(self, value, /)
Return value-self.
__rtruediv__(self, value, /)
Return value/self.
__rxor__(self, value, /)
Return value^self.
__sizeof__(self, /)
Returns size in memory, in bytes.
__sub__(self, value, /)
Return self-value.
__truediv__(self, value, /)
Return self/value.
__trunc__(...)
Truncating an Integral returns itself.
__xor__(self, value, /)
Return self^value.
bit_length(self, /)
Number of bits necessary to represent self in binary.
 
>>> bin(37)
'0b100101'
>>> (37).bit_length()
6
conjugate(...)
Returns self, the complex conjugate of any int.
to_bytes(self, /, length, byteorder, *, signed=False)
Return an array of bytes representing an integer.
 
length
  Length of bytes object to use.  An OverflowError is raised if the
  integer is not representable with the given number of bytes.
byteorder
  The byte order used to represent the integer.  If byteorder is 'big',
  the most significant byte is at the beginning of the byte array.  If
  byteorder is 'little', the most significant byte is at the end of the
  byte array.  To request the native byte order of the host system, use
  `sys.byteorder' as the byte order value.
signed
  Determines whether two's complement is used to represent the integer.
  If signed is False and a negative integer is given, an OverflowError
  is raised.

Class methods inherited from builtins.int:
from_bytes(bytes, byteorder, *, signed=False) from builtins.type
Return the integer represented by the given array of bytes.
 
bytes
  Holds the array of bytes to convert.  The argument must either
  support the buffer protocol or be an iterable object producing bytes.
  Bytes and bytearray are examples of built-in objects that support the
  buffer protocol.
byteorder
  The byte order used to represent the integer.  If byteorder is 'big',
  the most significant byte is at the beginning of the byte array.  If
  byteorder is 'little', the most significant byte is at the end of the
  byte array.  To request the native byte order of the host system, use
  `sys.byteorder' as the byte order value.
signed
  Indicates whether two's complement is used to represent the integer.

Static methods inherited from builtins.int:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from builtins.int:
denominator
the denominator of a rational number in lowest terms
imag
the imaginary part of a complex number
numerator
the numerator of a rational number in lowest terms
real
the real part of a complex number

 
class datablock(Boost.Python.enum)
    Used to specify which data block a variable belongs to.
Values:
X, Y
 
 
Method resolution order:
datablock
Boost.Python.enum
builtins.int
builtins.object

Data and other attributes defined here:
X = umetrics.impdata.datablock.X
Y = umetrics.impdata.datablock.Y
names = {'X': umetrics.impdata.datablock.X, 'Y': umetrics.impdata.datablock.Y}
values = {0: umetrics.impdata.datablock.X, 1: umetrics.impdata.datablock.Y}

Methods inherited from Boost.Python.enum:
__repr__(self, /)
Return repr(self).
__str__(self, /)
Return str(self).

Data descriptors inherited from Boost.Python.enum:
name

Methods inherited from builtins.int:
__abs__(self, /)
abs(self)
__add__(self, value, /)
Return self+value.
__and__(self, value, /)
Return self&value.
__bool__(self, /)
self != 0
__ceil__(...)
Ceiling of an Integral returns itself.
__divmod__(self, value, /)
Return divmod(self, value).
__eq__(self, value, /)
Return self==value.
__float__(self, /)
float(self)
__floor__(...)
Flooring an Integral returns itself.
__floordiv__(self, value, /)
Return self//value.
__format__(self, format_spec, /)
Default object formatter.
__ge__(self, value, /)
Return self>=value.
__getattribute__(self, name, /)
Return getattr(self, name).
__getnewargs__(self, /)
__gt__(self, value, /)
Return self>value.
__hash__(self, /)
Return hash(self).
__index__(self, /)
Return self converted to an integer, if self is suitable for use as an index into a list.
__int__(self, /)
int(self)
__invert__(self, /)
~self
__le__(self, value, /)
Return self<=value.
__lshift__(self, value, /)
Return self<<value.
__lt__(self, value, /)
Return self<value.
__mod__(self, value, /)
Return self%value.
__mul__(self, value, /)
Return self*value.
__ne__(self, value, /)
Return self!=value.
__neg__(self, /)
-self
__or__(self, value, /)
Return self|value.
__pos__(self, /)
+self
__pow__(self, value, mod=None, /)
Return pow(self, value, mod).
__radd__(self, value, /)
Return value+self.
__rand__(self, value, /)
Return value&self.
__rdivmod__(self, value, /)
Return divmod(value, self).
__rfloordiv__(self, value, /)
Return value//self.
__rlshift__(self, value, /)
Return value<<self.
__rmod__(self, value, /)
Return value%self.
__rmul__(self, value, /)
Return value*self.
__ror__(self, value, /)
Return value|self.
__round__(...)
Rounding an Integral returns itself.
Rounding with an ndigits argument also returns an integer.
__rpow__(self, value, mod=None, /)
Return pow(value, self, mod).
__rrshift__(self, value, /)
Return value>>self.
__rshift__(self, value, /)
Return self>>value.
__rsub__(self, value, /)
Return value-self.
__rtruediv__(self, value, /)
Return value/self.
__rxor__(self, value, /)
Return value^self.
__sizeof__(self, /)
Returns size in memory, in bytes.
__sub__(self, value, /)
Return self-value.
__truediv__(self, value, /)
Return self/value.
__trunc__(...)
Truncating an Integral returns itself.
__xor__(self, value, /)
Return self^value.
bit_length(self, /)
Number of bits necessary to represent self in binary.
 
>>> bin(37)
'0b100101'
>>> (37).bit_length()
6
conjugate(...)
Returns self, the complex conjugate of any int.
to_bytes(self, /, length, byteorder, *, signed=False)
Return an array of bytes representing an integer.
 
length
  Length of bytes object to use.  An OverflowError is raised if the
  integer is not representable with the given number of bytes.
byteorder
  The byte order used to represent the integer.  If byteorder is 'big',
  the most significant byte is at the beginning of the byte array.  If
  byteorder is 'little', the most significant byte is at the end of the
  byte array.  To request the native byte order of the host system, use
  `sys.byteorder' as the byte order value.
signed
  Determines whether two's complement is used to represent the integer.
  If signed is False and a negative integer is given, an OverflowError
  is raised.

Class methods inherited from builtins.int:
from_bytes(bytes, byteorder, *, signed=False) from builtins.type
Return the integer represented by the given array of bytes.
 
bytes
  Holds the array of bytes to convert.  The argument must either
  support the buffer protocol or be an iterable object producing bytes.
  Bytes and bytearray are examples of built-in objects that support the
  buffer protocol.
byteorder
  The byte order used to represent the integer.  If byteorder is 'big',
  the most significant byte is at the beginning of the byte array.  If
  byteorder is 'little', the most significant byte is at the end of the
  byte array.  To request the native byte order of the host system, use
  `sys.byteorder' as the byte order value.
signed
  Indicates whether two's complement is used to represent the integer.

Static methods inherited from builtins.int:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from builtins.int:
denominator
the denominator of a rational number in lowest terms
imag
the imaginary part of a complex number
numerator
the numerator of a rational number in lowest terms
real
the real part of a complex number

 
class rowtype(Boost.Python.enum)
    Used to specify a rows type
Values:
excluded, data, primaryvarid, secondaryvarid
 
 
Method resolution order:
rowtype
Boost.Python.enum
builtins.int
builtins.object

Data and other attributes defined here:
data = umetrics.impdata.rowtype.data
excluded = umetrics.impdata.rowtype.excluded
names = {'data': umetrics.impdata.rowtype.data, 'excluded': umetrics.impdata.rowtype.excluded, 'primaryvarid': umetrics.impdata.rowtype.primaryvarid, 'secondaryvarid': umetrics.impdata.rowtype.secondaryvarid}
primaryvarid = umetrics.impdata.rowtype.primaryvarid
secondaryvarid = umetrics.impdata.rowtype.secondaryvarid
values = {0: umetrics.impdata.rowtype.data, 1: umetrics.impdata.rowtype.excluded, 2: umetrics.impdata.rowtype.primaryvarid, 3: umetrics.impdata.rowtype.secondaryvarid}

Methods inherited from Boost.Python.enum:
__repr__(self, /)
Return repr(self).
__str__(self, /)
Return str(self).

Data descriptors inherited from Boost.Python.enum:
name

Methods inherited from builtins.int:
__abs__(self, /)
abs(self)
__add__(self, value, /)
Return self+value.
__and__(self, value, /)
Return self&value.
__bool__(self, /)
self != 0
__ceil__(...)
Ceiling of an Integral returns itself.
__divmod__(self, value, /)
Return divmod(self, value).
__eq__(self, value, /)
Return self==value.
__float__(self, /)
float(self)
__floor__(...)
Flooring an Integral returns itself.
__floordiv__(self, value, /)
Return self//value.
__format__(self, format_spec, /)
Default object formatter.
__ge__(self, value, /)
Return self>=value.
__getattribute__(self, name, /)
Return getattr(self, name).
__getnewargs__(self, /)
__gt__(self, value, /)
Return self>value.
__hash__(self, /)
Return hash(self).
__index__(self, /)
Return self converted to an integer, if self is suitable for use as an index into a list.
__int__(self, /)
int(self)
__invert__(self, /)
~self
__le__(self, value, /)
Return self<=value.
__lshift__(self, value, /)
Return self<<value.
__lt__(self, value, /)
Return self<value.
__mod__(self, value, /)
Return self%value.
__mul__(self, value, /)
Return self*value.
__ne__(self, value, /)
Return self!=value.
__neg__(self, /)
-self
__or__(self, value, /)
Return self|value.
__pos__(self, /)
+self
__pow__(self, value, mod=None, /)
Return pow(self, value, mod).
__radd__(self, value, /)
Return value+self.
__rand__(self, value, /)
Return value&self.
__rdivmod__(self, value, /)
Return divmod(value, self).
__rfloordiv__(self, value, /)
Return value//self.
__rlshift__(self, value, /)
Return value<<self.
__rmod__(self, value, /)
Return value%self.
__rmul__(self, value, /)
Return value*self.
__ror__(self, value, /)
Return value|self.
__round__(...)
Rounding an Integral returns itself.
Rounding with an ndigits argument also returns an integer.
__rpow__(self, value, mod=None, /)
Return pow(value, self, mod).
__rrshift__(self, value, /)
Return value>>self.
__rshift__(self, value, /)
Return self>>value.
__rsub__(self, value, /)
Return value-self.
__rtruediv__(self, value, /)
Return value/self.
__rxor__(self, value, /)
Return value^self.
__sizeof__(self, /)
Returns size in memory, in bytes.
__sub__(self, value, /)
Return self-value.
__truediv__(self, value, /)
Return self/value.
__trunc__(...)
Truncating an Integral returns itself.
__xor__(self, value, /)
Return self^value.
bit_length(self, /)
Number of bits necessary to represent self in binary.
 
>>> bin(37)
'0b100101'
>>> (37).bit_length()
6
conjugate(...)
Returns self, the complex conjugate of any int.
to_bytes(self, /, length, byteorder, *, signed=False)
Return an array of bytes representing an integer.
 
length
  Length of bytes object to use.  An OverflowError is raised if the
  integer is not representable with the given number of bytes.
byteorder
  The byte order used to represent the integer.  If byteorder is 'big',
  the most significant byte is at the beginning of the byte array.  If
  byteorder is 'little', the most significant byte is at the end of the
  byte array.  To request the native byte order of the host system, use
  `sys.byteorder' as the byte order value.
signed
  Determines whether two's complement is used to represent the integer.
  If signed is False and a negative integer is given, an OverflowError
  is raised.

Class methods inherited from builtins.int:
from_bytes(bytes, byteorder, *, signed=False) from builtins.type
Return the integer represented by the given array of bytes.
 
bytes
  Holds the array of bytes to convert.  The argument must either
  support the buffer protocol or be an iterable object producing bytes.
  Bytes and bytearray are examples of built-in objects that support the
  buffer protocol.
byteorder
  The byte order used to represent the integer.  If byteorder is 'big',
  the most significant byte is at the beginning of the byte array.  If
  byteorder is 'little', the most significant byte is at the end of the
  byte array.  To request the native byte order of the host system, use
  `sys.byteorder' as the byte order value.
signed
  Indicates whether two's complement is used to represent the integer.

Static methods inherited from builtins.int:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from builtins.int:
denominator
the denominator of a rational number in lowest terms
imag
the imaginary part of a complex number
numerator
the numerator of a rational number in lowest terms
real
the real part of a complex number

 
class timeAccuracy(Boost.Python.enum)
    Used in set_date_time to specify time accuracy
Values:
year, month, day, hour, minute, second
     Second: max time span (without fractions: 11 days, with fractions: 16 minutes
     Minute: max time span 23 month
     Hour: max time span 114 years
 
 
Method resolution order:
timeAccuracy
Boost.Python.enum
builtins.int
builtins.object

Data and other attributes defined here:
day = umetrics.impdata.timeAccuracy.day
hour = umetrics.impdata.timeAccuracy.hour
minute = umetrics.impdata.timeAccuracy.minute
month = umetrics.impdata.timeAccuracy.month
names = {'day': umetrics.impdata.timeAccuracy.day, 'hour': umetrics.impdata.timeAccuracy.hour, 'minute': umetrics.impdata.timeAccuracy.minute, 'month': umetrics.impdata.timeAccuracy.month, 'second': umetrics.impdata.timeAccuracy.second, 'year': umetrics.impdata.timeAccuracy.year}
second = umetrics.impdata.timeAccuracy.second
values = {0: umetrics.impdata.timeAccuracy.year, 1: umetrics.impdata.timeAccuracy.month, 2: umetrics.impdata.timeAccuracy.day, 3: umetrics.impdata.timeAccuracy.hour, 4: umetrics.impdata.timeAccuracy.minute, 5: umetrics.impdata.timeAccuracy.second}
year = umetrics.impdata.timeAccuracy.year

Methods inherited from Boost.Python.enum:
__repr__(self, /)
Return repr(self).
__str__(self, /)
Return str(self).

Data descriptors inherited from Boost.Python.enum:
name

Methods inherited from builtins.int:
__abs__(self, /)
abs(self)
__add__(self, value, /)
Return self+value.
__and__(self, value, /)
Return self&value.
__bool__(self, /)
self != 0
__ceil__(...)
Ceiling of an Integral returns itself.
__divmod__(self, value, /)
Return divmod(self, value).
__eq__(self, value, /)
Return self==value.
__float__(self, /)
float(self)
__floor__(...)
Flooring an Integral returns itself.
__floordiv__(self, value, /)
Return self//value.
__format__(self, format_spec, /)
Default object formatter.
__ge__(self, value, /)
Return self>=value.
__getattribute__(self, name, /)
Return getattr(self, name).
__getnewargs__(self, /)
__gt__(self, value, /)
Return self>value.
__hash__(self, /)
Return hash(self).
__index__(self, /)
Return self converted to an integer, if self is suitable for use as an index into a list.
__int__(self, /)
int(self)
__invert__(self, /)
~self
__le__(self, value, /)
Return self<=value.
__lshift__(self, value, /)
Return self<<value.
__lt__(self, value, /)
Return self<value.
__mod__(self, value, /)
Return self%value.
__mul__(self, value, /)
Return self*value.
__ne__(self, value, /)
Return self!=value.
__neg__(self, /)
-self
__or__(self, value, /)
Return self|value.
__pos__(self, /)
+self
__pow__(self, value, mod=None, /)
Return pow(self, value, mod).
__radd__(self, value, /)
Return value+self.
__rand__(self, value, /)
Return value&self.
__rdivmod__(self, value, /)
Return divmod(value, self).
__rfloordiv__(self, value, /)
Return value//self.
__rlshift__(self, value, /)
Return value<<self.
__rmod__(self, value, /)
Return value%self.
__rmul__(self, value, /)
Return value*self.
__ror__(self, value, /)
Return value|self.
__round__(...)
Rounding an Integral returns itself.
Rounding with an ndigits argument also returns an integer.
__rpow__(self, value, mod=None, /)
Return pow(value, self, mod).
__rrshift__(self, value, /)
Return value>>self.
__rshift__(self, value, /)
Return self>>value.
__rsub__(self, value, /)
Return value-self.
__rtruediv__(self, value, /)
Return value/self.
__rxor__(self, value, /)
Return value^self.
__sizeof__(self, /)
Returns size in memory, in bytes.
__sub__(self, value, /)
Return self-value.
__truediv__(self, value, /)
Return self/value.
__trunc__(...)
Truncating an Integral returns itself.
__xor__(self, value, /)
Return self^value.
bit_length(self, /)
Number of bits necessary to represent self in binary.
 
>>> bin(37)
'0b100101'
>>> (37).bit_length()
6
conjugate(...)
Returns self, the complex conjugate of any int.
to_bytes(self, /, length, byteorder, *, signed=False)
Return an array of bytes representing an integer.
 
length
  Length of bytes object to use.  An OverflowError is raised if the
  integer is not representable with the given number of bytes.
byteorder
  The byte order used to represent the integer.  If byteorder is 'big',
  the most significant byte is at the beginning of the byte array.  If
  byteorder is 'little', the most significant byte is at the end of the
  byte array.  To request the native byte order of the host system, use
  `sys.byteorder' as the byte order value.
signed
  Determines whether two's complement is used to represent the integer.
  If signed is False and a negative integer is given, an OverflowError
  is raised.

Class methods inherited from builtins.int:
from_bytes(bytes, byteorder, *, signed=False) from builtins.type
Return the integer represented by the given array of bytes.
 
bytes
  Holds the array of bytes to convert.  The argument must either
  support the buffer protocol or be an iterable object producing bytes.
  Bytes and bytearray are examples of built-in objects that support the
  buffer protocol.
byteorder
  The byte order used to represent the integer.  If byteorder is 'big',
  the most significant byte is at the beginning of the byte array.  If
  byteorder is 'little', the most significant byte is at the end of the
  byte array.  To request the native byte order of the host system, use
  `sys.byteorder' as the byte order value.
signed
  Indicates whether two's complement is used to represent the integer.

Static methods inherited from builtins.int:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Data descriptors inherited from builtins.int:
denominator
the denominator of a rational number in lowest terms
imag
the imaginary part of a complex number
numerator
the numerator of a rational number in lowest terms
real
the real part of a complex number

 
Functions
       
open_file_dialog(...)
Displays a file open dialog and returns a list of selected files and selected file type
The method is almost a plug in replacement for tkFileDialog.askopenfilename but has
support for file types that Sartorius Stedim Data Analytics software can read.
Options:
filetypes          -- Sets the types in the 'File Types' list box.
                      Default is [('All files', '.*')]
initialdir         -- The initial directory shown in the dialog.
                      Default is to show the last directory in which
                      a file was selected or the 'documents' directory
                      if no file has been previously selected.
initialfile        -- Specifies a filename to be displayed in
                      the dialog when it pops up.
multiple           -- Allows the user to choose multiple files from the
                      Open dialog.
                      Default is not to allow multi selection (False).
mustexist          -- Specifies whether the user may specify non-existent files.
                      Default is (True)
title              -- The text shown in the caption of the dialog.
supportedfiletypes -- Adds all file types that SIMCA can read to
                      the 'File Types' list box.
                      Default is to add them (True)
 
Returns:
A tuple containing a list of the selected files and a string containing
the selected file type.
If the user didn't select any file (pressed cancel), the method returns (None, None).
read_csv(...)
read_csv( (object)file [, (str)delimiter=',' [, (str)encoding='']]) -> ImportData :
    Reads a csv file or files and returns the content.
    file      --  The path of the file.
    encoding  --  is the same as for DIF files, ex "cp1252" or empty for the current locale
    delimiter --  is the delimiter used to separate values.
read_dif(...)
read_dif( (object)file [, (str)encoding='']) -> ImportData :
    Read a DIF file
    file      --  The path of the file.
    encoding  --  ex cp1252 or empty for the current locale
    one of ibm420, iso88596, windows1256, iso88592, windows1250, gb18030, iso2022cn, big5, iso88595, koi8r, windows1251, iso88597, windows1253, ibm424, iso88598, windows1255, eucjp, iso2022jp, shiftjis, euckr, iso2022kr, , iso88599, windows1254, utf16be, utf16le, utf32be, utf32le, utf8, cp850, iso88591 and windows-1252
read_excel(...)
read_excel( (object)file [, (object)sheets=0 [, (bool)side_by_side =True]]) -> ImportData :
    Reads an Excel file
    file         --  The path of the file.
    sheets       --  sheet name or index (0 is the first), or a list of sheet name or sheet indexes,
                      use an empty list = [] to get all available at once
    side_by_side --  how to merge if more than one sheet is selected
read_file(...)
read_file( (object)files [, (str)filetype='' [, (str)openoptions='']]) -> ImportData :
    Reads a file or files and returns the content.
    The following file types are supported.
       Brimrose Files (*.dat)
       Brookside Files (*.trn; *.pkg)
       Brookside Ver. 2.6 XML Files (*.xml)
       Bruker OPUS File (*.*)
       Bruker OPUS Interpolated File (*.*)
       CSV Files (*.csv)
       DIF Files (*.dif)
       Excel 97-2003 Workbook (*.xl*)
       Excel Workbook (*.xlsx; *.xlsb)
       Galactic SPC Files (*.spc)
       HPLC ChemStation Files (*.ch, *.uv)
       JCAMP-DX Files (*.jcm; *.dx; *.jdx)
       Lotus 1-2-3 Files (*.wks; *.wk1)
       MODDE Files (*.mip; *.dat)
       Matlab Files (*.mat)
       NSAS Files (*.da)
       NetCDF Files (*.nc; *.cdf) (MVACDF, ANDI)
       SIMCA project file (*.usp)
       Text Files (*.txt; *.dat)
       Thermo SIEVE Files (*.txt)
    
    Arguments:
    files        -- A list containing the paths(s) of the file(s) to read.
    filetype     -- This string is usually obtained from SelectFileDialog.open_file_dialog()
                    and is used to determine the file type. If omitted (or unrecognized) SIMCA will try
                    to determine the file type from the files content and extension.
    
    openoptions  -- reserved
read_jcamp(...)
read_jcamp( (object)file, (object)data_blocks [, (int)interpolation_file=0 [, (int)interpolation_serie=0]]) -> ImportData :
    Read a JCAMP file or files
    files               -- A list containing the paths(s) of the file(s) to read.
    data_blocks         -- list of indexes of the series to include. Note that the first index is 0
    interpolation_file  -- the index of the file that is to be used as template if input needs to be interpolated
    interpolation_serie -- the index of the series in the selected file to be used as template if input needs to be interpolated
        The data needs to be interpolated if the series are of different length and/or they start/end at different points.
        After interpolation, all series will have the same ordinal values as the selected series.
        These two options are optional and are defaulted to the first series in the first file.
read_spc(...)
read_spc( (object)file [, (bool)include_ordinal_values=True [, (object)start_points=[] [, (object)end_points=[] [, (int)averageing_step=0]]]]) -> ImportData :
    Read a SPC file or files
    files                  -- A list containing the paths(s) of the file(s) to read.
    include_ordinal_values -- If True the ordinal values (wavelengths etc) will be included as a row.
    start_points           -- list of start points in increasing order, empty to use all
    end_points             -- list of end points in increasing order, the same length as start_points
    averageing_step        -- integer value >=0 the length between each point when averaging, 0 to not use average, ignored when start_points is empty.
read_text(...)
read_text( (object)file [, (str)delimiter=',' [, (str)encoding='' [, (bool)ignore_consecutive_delimiters=False]]]) -> ImportData :
    Read a text file
    file      --  The path of the file.
    encoding  --  is the same as for DIF files, ex cp1252 or empty for the current locale
    delimiter --  is the delimiter used to separate values.
    ignore_consecutive_delimiters -- if True; two delimiters next to each other will be treated as one delimiter.
read_usp(...)
read_usp( (object)file [, (str)dataset='']) -> ImportData :
    Read a SIMCA project file (.usp)
    file     --  The path of the file.
    dataset  --  name of the dataset to read, empty to get the first