piglot.objectives.fitting.Reference

class Reference(filename: str, output_dir: str, x_col: int = 1, y_col: int = 2, skip_header: int = 0, transformer: ResponseTransformer | None = None, filter_tol: float = 0.0, show: bool = False)

Bases: object

Container for reference solutions.

Methods

get_data	Get the data column of the reference.
get_time	Get the time column of the reference.
has_filtering	Check if the reference has filtering.
prepare	Prepare the reference data.
read	Read the reference from the configuration dictionary.

get_data() → ndarray

Get the data column of the reference.

Returns

np.ndarray

Data column.

get_time() → ndarray

Get the time column of the reference.

Returns

np.ndarray

Time column.

has_filtering() → bool

Check if the reference has filtering.

Returns

bool

Whether the reference has filtering.

prepare() → None

Prepare the reference data.

static read(filename: str, config: Dict[str, Any], output_dir: str) → Reference

Read the reference from the configuration dictionary.

Parameters

filenamestr

Path to the reference file.

configDict[str, Any]

Configuration dictionary.

output_dir: str

Output directory.

Returns

Reference

Reference to use for this problem.