ResultsAid¶

Defined in module: wield.control.fitting.SISO.v2.results_aid.ResultsAid

class ResultsAid(fit_aid, kw=None)[source][github]¶

Bases: object

__init__(fit_aid, kw=None)[source][github]¶

Methods

`__init__`(fit_aid[, kw])
`alternatives_export_dict`([local_best])
`as_ZPKrep`()	Returns the filter as an wield.control.fitting.SISO ZPKwData object, for use with other fitters in the wield.control.fitting.SISO package.
`as_fitterMRF_ZPKz`([t_sample_s, F_sample_Hz, ...])	Returns the chosen filter in scipy format for the z domain (must specify t_sample_s, or F_sample_Hz or F_nyquist_Hz).
`as_foton_ZPKsf`([with_delay])	Returns the chosen filter as a string foton formatting.
`as_foton_ZPKsn`([with_delay])	Returns the chosen filter as a string foton formatting.
`as_foton_str_ZPKsf`([annotate_pairs])	Returns the chosen filter as a string foton formatting.
`as_foton_str_ZPKsn`([annotate_pairs])	Returns the chosen filter as a string foton formating.
`as_foton_str_ZPKz`([t_sample_s, F_sample_Hz, ...])	Returns the chosen filter in foton format native for the z domain (must specify t_sample_s, or F_sample_Hz or F_nyquist_Hz).
`as_matlab_str_ZPKsw`()	Returns the chosen filter in matlab format for the z domain (must specify t_sample_s, or F_sample_Hz or F_nyquist_Hz)
`as_refine_str`([sigfigs])
`as_scipy_signal_ZPKsw`([with_delay])	Returns the chosen filter in scipy format
`as_scipy_signal_ZPKz`([t_sample_s, ...])	Returns the chosen filter in scipy format for the z domain (must specify t_sample_s, or F_sample_Hz or F_nyquist_Hz).
`choice`([order, direction])	Allows a temporary choice of fitter, for investigations without having to store the optimal choice.
`choice_export_dict`()
`choose`([order, direction])	Chooses the filter with the lowest residual of order equal or less than requested.
`residuals_by_order`()

Attributes

`ZPKrep`
`asSISOzpk`
`fitter`
`fitterRI`
`order`

property fitter[github]¶

property asSISOzpk[github]¶

property fitterRI[github]¶

property order[github]¶

residuals_by_order()[source][github]¶

choose(order=None, direction=None, **kwargs)[source][github]¶

Chooses the filter with the lowest residual of order equal or less than requested. The data2filter algorithm will already have chosen a filter, but this allows investigating alternatives among the ones explored by the algorithm.

if order is None, then the order is taken to be the current order.

Can take argument “direction” to specify which nearest order to find

“<=” or “le”: less than or equal to the specified order
“>=” or “ge”: greater than or equal to the specified order
“<” or “l”: less than the specified order
“>” or “g”: greater than or equal to the specified order

Note that calling results.choose(direction = ‘>’) will return the fitter with the next order above the current one, and calling results.choose(direction = ‘<’) gives the next lower order. So that one can investigate the nearest alternative choices.

choice(order=None, direction=None, **kwargs)[source][github]¶: Allows a temporary choice of fitter, for investigations without having to store the optimal choice. Takes the same arguments as choose().

as_scipy_signal_ZPKsw(with_delay=False)[source][github]¶: Returns the chosen filter in scipy format

as_fitterMRF_ZPKz(t_sample_s=None, F_sample_Hz=None, F_nyquist_Hz=None)[source][github]¶: Returns the chosen filter in scipy format for the z domain (must specify t_sample_s, or F_sample_Hz or F_nyquist_Hz). This transforms into the Z domain, then reruns the optimization to ensure a best fit in the transformed coordinates.

as_scipy_signal_ZPKz(t_sample_s=None, F_sample_Hz=None, F_nyquist_Hz=None)[source][github]¶: Returns the chosen filter in scipy format for the z domain (must specify t_sample_s, or F_sample_Hz or F_nyquist_Hz). This transforms into the Z domain, then reruns the optimization to ensure a best fit in the transformed coordinates.

as_ZPKrep()[source][github]¶: Returns the filter as an wield.control.fitting.SISO ZPKwData object, for use with other fitters in the wield.control.fitting.SISO package.

property ZPKrep[github]¶

as_matlab_str_ZPKsw()[source][github]¶: Returns the chosen filter in matlab format for the z domain (must specify t_sample_s, or F_sample_Hz or F_nyquist_Hz)

as_foton_ZPKsf(with_delay=False)[source][github]¶: Returns the chosen filter as a string foton formatting. Uses the frequency domain representation

as_foton_ZPKsn(with_delay=False)[source][github]¶: Returns the chosen filter as a string foton formatting. Uses the frequency domain representation

as_refine_str(sigfigs=5)[source][github]¶

as_foton_str_ZPKsf(annotate_pairs=False)[source][github]¶: Returns the chosen filter as a string foton formatting. Uses the frequency domain representation

as_foton_str_ZPKsn(annotate_pairs=False)[source][github]¶: Returns the chosen filter as a string foton formating. Uses the “normalized” frequency domain representation.

as_foton_str_ZPKz(t_sample_s=None, F_sample_Hz=None, F_nyquist_Hz=None)[source][github]¶: Returns the chosen filter in foton format native for the z domain (must specify t_sample_s, or F_sample_Hz or F_nyquist_Hz). This transforms into the Z domain, then reruns the optimization to ensure a best fit in the transformed coordinates.

choice_export_dict()[source][github]¶

alternatives_export_dict(local_best=True)[source][github]¶