PhaseCorrectorOptions

giant.relative_opnav.estimators.unresolved:

class giant.relative_opnav.estimators.unresolved.PhaseCorrectorOptions(phase_correction_type: giant.relative_opnav.estimators.unresolved.PhaseCorrectionType = <PhaseCorrectionType.SIMPLE: 1>, brdf: giant.ray_tracer.illumination.IlluminationModel = <factory>)[source]
Parameters:
phase_correction_type: PhaseCorrectionType = 1

The type of phase correction to use, if requested.

See PhaseCorrectionType for details.

brdf: IlluminationModel

The illumination model used to convert geometry into expected illumination.

This is only used if the RASTERED phase correction type is chosen and is ignored otherwise.

property options_dict: Dict

Determine the options input to the dataclass.

This property method will ignore all internal properties and functions

Summary of Methods

apply_options

Update the options as attributes of the object class

local_vars

this is used to overwrite options in variables only used in __init__

override_options

This method is used for special cases when certain options should be overwritten