Todo

Improve autoapi module

circadapt.error

CircAdapt Error functions.

Package Contents

Functions

catch_general_error(func)	Raise error on non existance.
raise_error_on_non_existance_set(func)	Raise error on non existance.
except_OSerror(func)	Catch OSError and give a userfriendly exception.

Objects

circadapt.error.catch_general_error(func)

Raise error on non existance.

If parameter does not exist, raise error.

Returns

True (boolean) on success

Raises

NameError if not success

circadapt.error.raise_error_on_non_existance_set(func)

Raise error on non existance.

If parameter does not exist, raise error.

Returns

True (boolean) on success

Raises

NameError if not success

circadapt.error.except_OSerror(func)

Catch OSError and give a userfriendly exception.

exception circadapt.error.ModelNotStable

Bases: Exception

Model is not stable, consecutive beats are not the same.

class args

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception circadapt.error.ModelCrashed

Bases: Exception

Model is crashed, nans are present in the signal.

class args

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception circadapt.error.TriggerNotFound(par)

Bases: Exception

Trigger is not found.

class args

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.