CalibrationPlate Class Reference

Public Member Functions
CalibrationPlate	create_from_file (cls, str file_path)
	Creates an instance of CalibrationPlate by loading the calibration plate from a file.
None	__init__ (self, *Any args, **Any kwargs)
	In order to create a CalibrationPlate, please refer to the classmethods.
None	__del__ (self)

Protected Member Functions
CalibrationPlate	_create_empty (cls)

Protected Attributes
	_handle

Detailed Description

Class for holding a calibration plate.

Since

ids_peak_icv 1.1

Definition at line 11 of file calibration_plate.py.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		*Any	args,
		**Any	kwargs )

In order to create a CalibrationPlate, please refer to the classmethods.

Since

ids_peak_icv 1.1

Definition at line 55 of file calibration_plate.py.

__del__()

None __del__

(

self

)

Definition at line 66 of file calibration_plate.py.

Member Function Documentation

_create_empty()

CalibrationPlate _create_empty ( cls )

protected

Definition at line 48 of file calibration_plate.py.

create_from_file()

CalibrationPlate create_from_file	(		cls,
		str	file_path )

Creates an instance of CalibrationPlate by loading the calibration plate from a file.

For a camera calibration a calibration plate is needed.

Parameters

file_path

An existing file path to a JSON file containing the calibration plate.

Exceptions

IOException	If the given file_path does not exist, or the permissions are not sufficient to read it.
CorruptedException	If the file content is corrupted.

Returns

A new instance of CalibrationPlate

Since

ids_peak_icv 1.1

Definition at line 21 of file calibration_plate.py.

Field Documentation

_handle

_handle

protected

Initial value:

=  check_init_for_classes_with_classmethods_only(self.__class__.__name__,
                                                                     peak_icv_calibration_plate_handle,
                                                                     *args, **kwargs)

Definition at line 62 of file calibration_plate.py.