banffprocessor.procedures.banff_procedures package#

Submodules#

banffprocessor.procedures.banff_procedures.deterministic module#

class banffprocessor.procedures.banff_procedures.deterministic.Deterministic[source]#

Bases: object

Implements the Deterministic Banff procedure as a :class:banffprocessor.procedures.procedure_interface.

classmethod execute(processor_data: ProcessorData) → int[source]#

Execute the banff.determin call, and returns the results.

banffprocessor.procedures.banff_procedures.deterministic.register(factory: <module 'banffprocessor.procedures.factory' from '/builds/gensys/banff/banff-processor/venv/lib/python3.12/site-packages/banffprocessor/procedures/factory.py'>) → None[source]#

Register this procedure class in the Banff processor procedure factory.

banffprocessor.procedures.banff_procedures.donorimputation module#

class banffprocessor.procedures.banff_procedures.donorimputation.DonorImputation[source]#

Bases: object

Implements the DonorImputation Banff procedure as a :class:banffprocessor.procedures.procedure_interface.

classmethod execute(processor_data: ProcessorData) → int[source]#

Execute the banff.donorimp call, and returns the results.

output_tables: tuple[str] = ('outdonormap', 'outmatching_fields')#
banffprocessor.procedures.banff_procedures.donorimputation.register(factory: <module 'banffprocessor.procedures.factory' from '/builds/gensys/banff/banff-processor/venv/lib/python3.12/site-packages/banffprocessor/procedures/factory.py'>) → None[source]#

Register this procedure class in the Banff processor procedure factory.

banffprocessor.procedures.banff_procedures.editstats module#

class banffprocessor.procedures.banff_procedures.editstats.EditStats[source]#

Bases: object

Implements the EditStats Banff procedure as a :class:banffprocessor.procedures.procedure_interface.

classmethod execute(processor_data: ProcessorData) → int[source]#

Execute the banff.editstats call, and returns the results.

output_tables: tuple[str] = ('outedit_applic', 'outedit_status', 'outglobal_status', 'outk_edits_status', 'outedits_reduced', 'outvars_role')#
banffprocessor.procedures.banff_procedures.editstats.register(factory: <module 'banffprocessor.procedures.factory' from '/builds/gensys/banff/banff-processor/venv/lib/python3.12/site-packages/banffprocessor/procedures/factory.py'>) → None[source]#

Register this procedure class in the Banff processor procedure factory.

banffprocessor.procedures.banff_procedures.errorloc module#

class banffprocessor.procedures.banff_procedures.errorloc.Errorloc[source]#

Bases: object

Implements the Errorloc Banff procedure as a :class:banffprocessor.procedures.procedure_interface.

classmethod execute(processor_data: ProcessorData) → int[source]#

Execute the banff.errorloc call, and returns the results.

output_tables: tuple[str] = 'outreject'#
banffprocessor.procedures.banff_procedures.errorloc.register(factory: <module 'banffprocessor.procedures.factory' from '/builds/gensys/banff/banff-processor/venv/lib/python3.12/site-packages/banffprocessor/procedures/factory.py'>) → None[source]#

Register this procedure class in the Banff processor procedure factory.

banffprocessor.procedures.banff_procedures.estimator module#

Wrap Banff Estimator Procedure in Banff Processor Procedure.

class banffprocessor.procedures.banff_procedures.estimator.Estimator[source]#

Bases: object

Implements the Estimator Banff procedure as a :class:banffprocessor.procedures.procedure_interface.

classmethod execute(processor_data: ProcessorData) → int[source]#

Execute the banff.outlier call, and returns the results.

output_tables: tuple[str] = ('outacceptable', 'outest_ef', 'outest_lr', 'outest_parm', 'outrand_err')#
banffprocessor.procedures.banff_procedures.estimator.register(factory: <module 'banffprocessor.procedures.factory' from '/builds/gensys/banff/banff-processor/venv/lib/python3.12/site-packages/banffprocessor/procedures/factory.py'>) → None[source]#

Register this procedure class in the Banff processor procedure factory.

banffprocessor.procedures.banff_procedures.job_proc module#

class banffprocessor.procedures.banff_procedures.job_proc.JobProc[source]#

Bases: object

Implements the execution of a new process block as a :class:banffprocessor.procedures.procedure_interface.

classmethod execute(processor_data: ProcessorData) → int[source]#

Execute a process block indicated by the “JOB” process for a particular job step.

banffprocessor.procedures.banff_procedures.job_proc.register(factory: <module 'banffprocessor.procedures.factory' from '/builds/gensys/banff/banff-processor/venv/lib/python3.12/site-packages/banffprocessor/procedures/factory.py'>) → None[source]#

Register this procedure class in the Banff processor procedure factory.

banffprocessor.procedures.banff_procedures.massimputation module#

class banffprocessor.procedures.banff_procedures.massimputation.MassImputation[source]#

Bases: object

Implements the MassImputation Banff procedure as a :class:banffprocessor.procedures.procedure_interface.

classmethod execute(processor_data: ProcessorData) → int[source]#

Execute the banff.massimpu call, and returns the results.

output_tables: tuple[str] = ('outdonormap',)#
banffprocessor.procedures.banff_procedures.massimputation.register(factory: <module 'banffprocessor.procedures.factory' from '/builds/gensys/banff/banff-processor/venv/lib/python3.12/site-packages/banffprocessor/procedures/factory.py'>) → None[source]#

Register this procedure class in the Banff processor procedure factory.

banffprocessor.procedures.banff_procedures.outlier module#

class banffprocessor.procedures.banff_procedures.outlier.Outlier[source]#

Bases: object

Implements the Outlier Banff procedure as a :class:banffprocessor.procedures.procedure_interface.

classmethod execute(processor_data: ProcessorData) → int[source]#

Execute the banff.outlier call, and returns the results.

output_tables: tuple[str] = ('outlier_status', 'outsummary')#
banffprocessor.procedures.banff_procedures.outlier.register(factory: <module 'banffprocessor.procedures.factory' from '/builds/gensys/banff/banff-processor/venv/lib/python3.12/site-packages/banffprocessor/procedures/factory.py'>) → None[source]#

Register this procedure class in the Banff processor procedure factory.

banffprocessor.procedures.banff_procedures.prorate module#

class banffprocessor.procedures.banff_procedures.prorate.Prorate[source]#

Bases: object

Implements the Prorate Banff procedure as a :class:banffprocessor.procedures.procedure_interface.

classmethod execute(processor_data: ProcessorData) → int[source]#

Execute the banff.prorate call, and returns the results.

output_tables: tuple[str] = 'outreject'#
banffprocessor.procedures.banff_procedures.prorate.register(factory: <module 'banffprocessor.procedures.factory' from '/builds/gensys/banff/banff-processor/venv/lib/python3.12/site-packages/banffprocessor/procedures/factory.py'>) → None[source]#

Register this procedure class in the Banff processor procedure factory.

banffprocessor.procedures.banff_procedures.verifyedits module#

class banffprocessor.procedures.banff_procedures.verifyedits.VerifyEdits[source]#

Bases: object

Implements the VerifyEdits Banff procedure as a :class:banffprocessor.procedures.procedure_interface.

classmethod execute(processor_data: ProcessorData) → int[source]#

Execute the banff.verifyedits call, and returns the results.

banffprocessor.procedures.banff_procedures.verifyedits.register(factory: <module 'banffprocessor.procedures.factory' from '/builds/gensys/banff/banff-processor/venv/lib/python3.12/site-packages/banffprocessor/procedures/factory.py'>) → None[source]#

Register this procedure class in the Banff processor procedure factory.

Module contents#

Modules to perform Banff procedures.