NiBabel

Access a cacophony of neuro-imaging file formats

Previous topic

nibabel.batteryrunners.BatteryRunner

Next topic

nibabel.fileholders

Reggie -- the one

nibabel.batteryrunners.Report

digraph inheritance1aca3e9306 { rankdir=LR; ratio=compress; fontsize=14; size="6.0, 8.0"; "Report" [shape=ellipse,URL="#nibabel.batteryrunners.Report",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,fontsize=14,color=dodgerblue1,style=filled,height=0.75]; }

class nibabel.batteryrunners.Report(error=<type 'exceptions.Exception'>, problem_level=0, problem_msg='', fix_msg='')

Initialize report with values

Parameters :

error : None or Exception

Error to raise if raising error for this check. If None, no error can be raised for this check (it was probably normal).

problem_level : int

level of problem. From 0 (no problem) to 50 (severe problem). If the report originates from a fix, then this is the level of the problem remaining after the fix. Default is 0

problem_msg : string

String describing problem detected. Default is ‘’

fix_msg : string

String describing any fix applied. Default is ‘’.

Examples

>>> rep = Report()
>>> rep.problem_level
0
>>> rep = Report(TypeError, 10)
>>> rep.problem_level
10
log_raise(logger, error_level=40)

Log problem, raise error if problem >= error_level

Parameters :

logger : log

log object, implementing log method

error_level : int, optional

If self.problem_level >= error_level, raise error

message

formatted message string, including fix message if present

write_raise(stream, error_level=40, log_level=30)

Write report to stream

Parameters :

stream : file-like

implementing write method

error_level : int, optional

level at which to raise error for problem detected in self

log_level : int, optional

Such that if log_level is >= self.problem_level we write the report to stream, otherwise we write nothing.