umetrics | index (built-in)

Modules
`` |  |
umetrics.impdata | umetrics.private | umetrics.simca |

Classes
`` |  | Boost.Python.enum(builtins.int) report_file_type Boost.Python.instance(builtins.object) SimcaApp builtins.Exception(builtins.BaseException) UmetricsException
class SimcaApp(Boost.Python.instance)
`` | `The SIMCA application object.`
| Method resolution order: SimcaApp Boost.Python.instance builtins.object Static methods defined here: __init__(...) `Raises an exception This class cannot be instantiated from Python` __reduce__ = (...) cascade_windows(...) `cascade_windows() -> None : Arranges all the child windows in a cascade format.` general_options(...) `general_options() -> GeneralOptions : Returns the SIMCA general options object` generate_report(...) `generate_report( (str)file [, (object)content=None [, (report_file_type)file_type=umetrics.report_file_type.PDF [, (bool)overwrite=False]]]) -> None : Creates a report from the current active project. file path to where the new report is saved content A dictionary or list of dictionary containing report template, model and format plot template all are optional "template", the name of a template recognized by SIMCA or the full path to an existing report template, if not specified SIMCA will use the default template for the model type "model", the number of the model to use "plot_formate", the name of a plot format template recognized by SIMCA or the full path to an existing report template, if not specified SIMCA will use the default current active plot format file_type the type of file that will be generated, see report_file_type the example generate_report(r'c:.pdf', {'template':'My template', 'model' : 2}]) generate_report(r'c:.pdf', [{'plot_format':'SIMCA 13', 'model' : 1},{'template':'My template', 'model' : 2}],overwrite=True)` get_active_project(...) `get_active_project() -> Project : Returns the currently active project. If there is no active project, the method returns a closed project. Although SIMCA can handle many simultaneously open projects, only one can be active. The active project is the one that the user 'sees' and can manipulate through the GUI .Recommended usage is: with SimcaApp.get_active_project() as project: if project: # Do something with project` get_active_window_title(...) `get_active_window_title() -> str : Returns the title of the active window` get_version(...) `get_version() -> tuple : Returns a tupple containing the major and minor version of SIMCA.` is_active_project(...) `is_active_project( (Project)project) -> bool : Returns True if the project is the active project (the one that the user 'sees' and can manipulate through the GUI).` open_in_simca_online(...) `open_in_simca_online( (Project)project) -> None : Tries to open the project in SIMCA-Online. The project must be saved before this function is called and batch projects should only contain one batch model group.` plot_list_builder(...) `plot_list_builder() -> PlotListBuilder : Returns the SIMCA plot builder object` set_active_project(...) `set_active_project( (Project)project) -> None : Sets the active project. The previously active project (if any) will be closed. The project must have at least one dataset.` set_verbosity(...) `set_verbosity( (bool)verbosity) -> None : Turns printing of information messages to stdout on or off. Default is True (on).` tile_windows(...) `tile_windows() -> None : Arranges all child windows in a tiled format.` Data and other attributes defined here: GeneralOptions = <class 'umetrics.GeneralOptions'> `SIMCA general options class.` PlotListBuilder = <class 'umetrics.PlotListBuilder'> `SIMCA plot and list builder object.` Window = <class 'umetrics.Window'> `Plot/List window` 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 UmetricsException(builtins.Exception)
`` | `Common base class for all non-exit exceptions.`
| Method resolution order: UmetricsException builtins.Exception builtins.BaseException builtins.object Data descriptors defined here: __weakref__ `list of weak references to the object (if defined)` Methods inherited from builtins.Exception: __init__(self, /, *args, **kwargs) `Initialize self. See help(type(self)) for accurate signature.` Static methods inherited from builtins.Exception: __new__(*args, **kwargs) from builtins.type `Create and return a new object. See help(type) for accurate signature.` Methods inherited from builtins.BaseException: __delattr__(self, name, /) `Implement delattr(self, name).` __getattribute__(self, name, /) `Return getattr(self, name).` __reduce__(...) `Helper for pickle.` __repr__(self, /) `Return repr(self).` __setattr__(self, name, value, /) `Implement setattr(self, name, value).` __setstate__(...) __str__(self, /) `Return str(self).` with_traceback(...) `Exception.with_traceback(tb) -- set self.__traceback__ to tb and return self.` Data descriptors inherited from builtins.BaseException: __cause__ `exception cause` __context__ `exception context` __dict__ __suppress_context__ __traceback__ args
class report_file_type(Boost.Python.enum)
`` | `Supported file types when saving a report. HTML - A normal html file. Images will be saved in a separate sub directory. MHT - A html file with images embedded in the file. This file type is only supported by Internet Explorer and Microsoft Edge. PDF - An Acrobat Reader document.`
| Method resolution order: report_file_type Boost.Python.enum builtins.int builtins.object Data and other attributes defined here: HTML = umetrics.report_file_type.HTML MHT = umetrics.report_file_type.MHT PDF = umetrics.report_file_type.PDF names = {'HTML': umetrics.report_file_type.HTML, 'MHT': umetrics.report_file_type.MHT, 'PDF': umetrics.report_file_type.PDF} values = {0: umetrics.report_file_type.HTML, 1: umetrics.report_file_type.MHT, 2: umetrics.report_file_type.PDF} 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
`` |  | cexit(...) `cexit() -> None : Exit SIMCA`