OpNav

giant.opnav_class:

class giant.opnav_class.OpNav(camera, image_processing=None, image_processing_kwargs=None)[source]

This serves as a container for Camera and ImageProcessing instances and provides aliases to quickly access their attributes from an instance of this class.

This class is rarely used as is, and instead is used as a super class for new OpNav user interfaces.

Parameters:
  • camera (Camera) – An instance of Camera that is to have OpNav performed on it

  • image_processing (ImageProcessing | None) – An already initialized instance of ImageProcessing (or a subclass). If not None then image_processing_kwargs are ignored.

  • image_processing_kwargs (dict | None) – The keyword arguments to pass to the ImageProcessing class constructor. These are ignored if argument image_processing is not None

property camera: Camera

The camera instance to perform OpNav on.

This should be an instance of the Camera class or one of its subclasses.

See the Camera class documentation for more details

property model: CameraModel

This alias returns the current camera model from the camera attribute.

It is provided for convenience since the camera model is used frequently.

property image_processing: ImageProcessing

The ImageProcessing instance to use when doing image processing on the images

This must be an instance of the ImageProcessing class.

See the ImageProcessing class documentation for more details

Summary of Methods

OpNav.add_images

This method adds new images to be processed.

OpNav.reset_image_processing

This method replaces the existing image processing instance with a new instance using the initial image_processing_kwargs argument passed to the constructor.

OpNav.update_image_processing

This method updates the attributes of the image_processing instance.