DistortionCorrection

class ctapointing.camera.DistortionCorrection(**kwargs: Any)

Bases: Component

Base class for implementing distortion corrections.

Attributes Summary

coeff

An instance of a Python dict.

coeff_inv

An instance of a Python dict.

name

distortion correction name

uuid

UUID of Camera

Methods Summary

apply_correction(coords)

apply_inverse_correction(coords_p)

from_config(**kwargs)

Read a DistortionCorrection configuration from either configuration file or database.

Attributes Documentation

coeff

An instance of a Python dict.

One or more traits can be passed to the constructor to validate the keys and/or values of the dict. If you need more detailed validation, you may use a custom validator method.

Changed in version 5.0: Added key_trait for validating dict keys.

Changed in version 5.0: Deprecated ambiguous trait, traits args in favor of value_trait, per_key_traits.

coeff_inv

An instance of a Python dict.

One or more traits can be passed to the constructor to validate the keys and/or values of the dict. If you need more detailed validation, you may use a custom validator method.

Changed in version 5.0: Added key_trait for validating dict keys.

Changed in version 5.0: Deprecated ambiguous trait, traits args in favor of value_trait, per_key_traits.

name

distortion correction name

uuid

UUID of Camera

Methods Documentation

apply_correction(coords)
apply_inverse_correction(coords_p)
classmethod from_config(**kwargs)

Read a DistortionCorrection configuration from either configuration file or database. Either the path of a configuration file (‘input_url’) or a database collection (‘collection’) must be provided.

Parameters:

  • input_url (str or Path) – path of the configuration file.

  • name (str) – name of the DistortionCorrection (as in DistortionCorrection.name). When loading the configuration from file, can be set to check that the configuration with the correct name is loaded. When loading from database, is used to identify the correct database record.

  • uuid (str) – UUID of the camera (as in DistortionCorrection.uuid). When loading the configuration from file, can be set to check that the configuration with the correct UUID is loaded. When loading from database, is used to identify the correct database record.

  • collection (str) – name of the database collection from which configuration is read

  • database (str) – name of the database in which the collection is stored

Returns:

extractor

Return type:

DistortionCorrection object

__init__(config=None, parent=None, **kwargs)
Parameters:

  • config (traitlets.loader.Config) – Configuration specified by config file or cmdline arguments. Used to set traitlet values.

  • parent (Tool or Component) – If a Component is created by another Component or Tool, you need to pass the creating Component as parent, e.g. parent=self. This makes sure the config is correctly handed down to the child components. Do not pass config in this case.

  • kwargs – Traitlets to be overridden. TraitError is raised if kwargs contains a key that does not correspond to a traitlet.

classmethod from_config(**kwargs)

Read a DistortionCorrection configuration from either configuration file or database. Either the path of a configuration file (‘input_url’) or a database collection (‘collection’) must be provided.

Parameters:

  • input_url (str or Path) – path of the configuration file.

  • name (str) – name of the DistortionCorrection (as in DistortionCorrection.name). When loading the configuration from file, can be set to check that the configuration with the correct name is loaded. When loading from database, is used to identify the correct database record.

  • uuid (str) – UUID of the camera (as in DistortionCorrection.uuid). When loading the configuration from file, can be set to check that the configuration with the correct UUID is loaded. When loading from database, is used to identify the correct database record.

  • collection (str) – name of the database collection from which configuration is read

  • database (str) – name of the database in which the collection is stored

Returns:

extractor

Return type:

DistortionCorrection object

name

distortion correction name

uuid

UUID of Camera