mapteksdk.data.image_registration_interface module

Interface for raster registration.

class RasterRegistration

Bases: object

Interface for raster registration.

This is useful for type checking.

Warning

Vendors and clients should not attempt to create classes which implement this interface. This class is primarily included in the public interface for type checking purposes. You should use the subclasses defined in image_registration.py.

property raster: Optional[Raster]

The raster which this registration is used by.

The raster returned by the object may be closed. This will be None if this registration is not used by any rasters.

Raises:

ValueError – If set when the registration is already being used by a Raster object.

property is_valid: bool

True if the object is valid.

raise_if_invalid()

Checks if the registration is invalid.

Raises a ValueError if the registration is detected to be invalid.

If is_valid is False then calling this function will raise a ValueError containing information on why the registration is considered invalid.

Raises:

ValueError – If the raster is invalid.

copy()

Create a copy of this object.

As of mapteksdk 1.6, a RasterRegistration object can only be associated with one object. Thus a copy is made when attempting to copy registration from one object to another. This function performs this copy.

Returns:

A copy of this object. This copies everything except the link to the associated object, allowing for the copy to be associated with a different object.

Return type:

Self

Raises:

• ValueError – If the registration is invalid.

• RuntimeError – If the registration type doesn’t support being copied.