DistOptica (distoptica)

distoptica is a Python library for modelling optical distortions.

Setting up distoptica

For instructions on installing the distoptica library, see the Installation instructions page.

Learning how to use distoptica

For those new to the distoptica library, it is recommended that they take a look at the Examples page, which contain code examples that show how one can use the distoptica library. While going through the examples, readers can consult the distoptica reference guide to understand what each line of code is doing.

Contents

• Home
• 1. Installation instructions
  • 1.1. Installing distoptica
    • 1.1.1. Installing distoptica using pip
    • 1.1.2. Installing distoptica using conda
  • 1.2. Uninstalling distoptica
• 2. Reference
  • 2.1. distoptica.generate_standard_distortion_model
    • generate_standard_distortion_model()
  • 2.2. distoptica.CoordTransformParams
    • CoordTransformParams
      • CoordTransformParams.core_attrs
      • CoordTransformParams.de_pre_serialization_funcs
      • CoordTransformParams.de_pre_serialize()
      • CoordTransformParams.dump()
      • CoordTransformParams.dumps()
      • CoordTransformParams.execute_post_core_attrs_update_actions()
      • CoordTransformParams.get_core_attrs()
      • CoordTransformParams.get_de_pre_serialization_funcs()
      • CoordTransformParams.get_pre_serialization_funcs()
      • CoordTransformParams.get_validation_and_conversion_funcs()
      • CoordTransformParams.is_corresponding_model_azimuthally_symmetric
      • CoordTransformParams.is_corresponding_model_standard
      • CoordTransformParams.is_corresponding_model_trivial
      • CoordTransformParams.load()
      • CoordTransformParams.loads()
      • CoordTransformParams.pre_serialization_funcs
      • CoordTransformParams.pre_serialize()
      • CoordTransformParams.update()
      • CoordTransformParams.validation_and_conversion_funcs
  • 2.3. distoptica.DistortionModel
    • DistortionModel
      • DistortionModel.convergence_map_of_distorted_then_resampled_images
      • DistortionModel.core_attrs
      • DistortionModel.de_pre_serialization_funcs
      • DistortionModel.de_pre_serialize()
      • DistortionModel.device
      • DistortionModel.distort_then_resample_images()
      • DistortionModel.dump()
      • DistortionModel.dumps()
      • DistortionModel.execute_post_core_attrs_update_actions()
      • DistortionModel.flow_field_of_coord_transform
      • DistortionModel.flow_field_of_coord_transform_right_inverse
      • DistortionModel.get_convergence_map_of_distorted_then_resampled_images()
      • DistortionModel.get_core_attrs()
      • DistortionModel.get_de_pre_serialization_funcs()
      • DistortionModel.get_flow_field_of_coord_transform()
      • DistortionModel.get_flow_field_of_coord_transform_right_inverse()
      • DistortionModel.get_out_of_bounds_map_of_distorted_then_resampled_images()
      • DistortionModel.get_out_of_bounds_map_of_undistorted_then_resampled_images()
      • DistortionModel.get_pre_serialization_funcs()
      • DistortionModel.get_sampling_grid()
      • DistortionModel.get_validation_and_conversion_funcs()
      • DistortionModel.is_azimuthally_symmetric
      • DistortionModel.is_standard
      • DistortionModel.is_trivial
      • DistortionModel.load()
      • DistortionModel.loads()
      • DistortionModel.mask_frame_of_distorted_then_resampled_images
      • DistortionModel.out_of_bounds_map_of_distorted_then_resampled_images
      • DistortionModel.out_of_bounds_map_of_undistorted_then_resampled_images
      • DistortionModel.pre_serialization_funcs
      • DistortionModel.pre_serialize()
      • DistortionModel.sampling_grid
      • DistortionModel.undistort_then_resample_images()
      • DistortionModel.update()
      • DistortionModel.validation_and_conversion_funcs
  • 2.4. distoptica.LeastSquaresAlgParams
    • LeastSquaresAlgParams
      • LeastSquaresAlgParams.core_attrs
      • LeastSquaresAlgParams.de_pre_serialization_funcs
      • LeastSquaresAlgParams.de_pre_serialize()
      • LeastSquaresAlgParams.dump()
      • LeastSquaresAlgParams.dumps()
      • LeastSquaresAlgParams.get_core_attrs()
      • LeastSquaresAlgParams.get_de_pre_serialization_funcs()
      • LeastSquaresAlgParams.get_pre_serialization_funcs()
      • LeastSquaresAlgParams.get_validation_and_conversion_funcs()
      • LeastSquaresAlgParams.load()
      • LeastSquaresAlgParams.loads()
      • LeastSquaresAlgParams.pre_serialization_funcs
      • LeastSquaresAlgParams.pre_serialize()
      • LeastSquaresAlgParams.update()
      • LeastSquaresAlgParams.validation_and_conversion_funcs
  • 2.5. distoptica.StandardCoordTransformParams
    • StandardCoordTransformParams
      • StandardCoordTransformParams.core_attrs
      • StandardCoordTransformParams.de_pre_serialization_funcs
      • StandardCoordTransformParams.de_pre_serialize()
      • StandardCoordTransformParams.dump()
      • StandardCoordTransformParams.dumps()
      • StandardCoordTransformParams.execute_post_core_attrs_update_actions()
      • StandardCoordTransformParams.get_core_attrs()
      • StandardCoordTransformParams.get_de_pre_serialization_funcs()
      • StandardCoordTransformParams.get_pre_serialization_funcs()
      • StandardCoordTransformParams.get_validation_and_conversion_funcs()
      • StandardCoordTransformParams.is_corresponding_model_azimuthally_symmetric
      • StandardCoordTransformParams.is_corresponding_model_trivial
      • StandardCoordTransformParams.load()
      • StandardCoordTransformParams.loads()
      • StandardCoordTransformParams.pre_serialization_funcs
      • StandardCoordTransformParams.pre_serialize()
      • StandardCoordTransformParams.update()
      • StandardCoordTransformParams.validation_and_conversion_funcs
  • 2.6. distoptica.version
• 3. Examples
• 4. Literature
• 5. License

Indices and tables

• Index

• Module Index

• Search Page