Requirements for using the platform

Follow the requirements listed on the page with Models reference to process images with the Mapflow platform.

Please pay attention to the following:

  • images must be in Uint8 format. If your image is not of this type, please use our image preprocessing script or other tools to translate it to the appropriate format;

  • your imagery must be georeferenced in geographic or projected coordinate system, WGS84;

  • each Mapflow model has its recommendations for the spatial resolution of the input data.

In case of non-compliance with any requirements, the following errors occur:

Error code

Description

source-validator.UrlMustBeString

Key ‘url’ in your request must be a string, got {url_type} instead.

source-validator.UrlMustBeLink

Your URL must be a link starting with “http://” or “https://”.

source-validator.UrlFormatInvalid

Format of ‘url’ is invalid and cannot be parsed. Error: {parse_error_message}

source-validator.ZoomMustBeInteger

Zoom must be either empty, or integer, got {actual_zoom}

source-validator.InvalidZoomValue

Zoom must be between 0 and 22, got {actual_zoom}

source-validator.TooHighZoom

Zoom must be not higher than {max_zoom}, got {actual_zoom}

source-validator.TooLowZoom

Zoom must be not lower than {min_zoom}, got {actual_zoom}

source-validator.ImageMetadataMustBeDict

Image metadata must be a dict (Python) - json

source-validator.ImageMetadataKeyError

Image metadata must have keys: crs, transform, dtype, count

source-validator.S3URLError

URL of the image at s3 storage must be a string starting with s3://, got {actual_s3_link}

source-validator.LocalRequestKeyError

Request must contain either ‘profile’ or ‘url’ keys

source-validator.ReadFromS3Failed

Failed to read file from {s3_link}.

source-validator.DtypeNotAllowed

Image data type (Dtype) must be one of {required_dtypes}, got {request_dtype}

source-validator.PixelSizeTooLow

Spatial resolution of you image is too high: pixel size is {actual_res}, minimum allowed pixel size is {min_res}

source-validator.PixelSizeTooHigh

Spatial resolution of you image is too low: pixel size is {actual_res}, maximum allowed pixel size is {max_res}

source-validator.ImageCheckError

Error occurred during image {checked_param} check: {message}. Image metadata = {metadata}.

source-validator.QuadkeyLinkFormatError

Your ‘url’ doesn’t match the format, Quadkey basemap must be a link containing “q” placeholder.

source-validator.SentinelInputStringKeyError

Sentinel_L2A request must contain field named ‘url’ with string value

source-validator.SentinelInputStringFormatError

Input string {input_string} is of unknown format. It must represent Sentinel-2 granule ID.

source-validator.GridCellOutOfBound

Selected Sentinel-2 image cell is {actual_cell}, this model is for the cells: {allowed_cells}

source-validator.MonthOutOfBounds

Selected Sentinel-2 image month is {actual_month}, this model is for: {allowed_months}

source-validator.TMSLinkFormatError

You request TMS basemap link doesn’t match the format, it must be a link containing ‘{x}’, ‘{y}’, ‘{z}’ placeholders, correct it and start processing again.

source-validator.RequirementsMustBeDict

Requirements must be dict, got {requirements_type}.

source-validator.RequestMustBeDict

Request must be dict, got {request_type}.

source-validator.RequestMustHaveSourceType

Request must contain "source_type" key

source-validator.SourceTypeIsNotAllowed

Source type {source_type} is not allowed. Use one of: {allowed_sources}

source-validator.RequiredSectionMustBeDict

“Required” section of the requirements must contain dict, not {required_section_type}

source-validator.RecommendedSectionMustBeDict

“Recommended” section of the requirements must contain dict, not {recommended_section_type}

source-validator.XYZLinkFormatError

You XYZ basemap link doesn’t match the format, it must be a link containing ‘{x}’, ‘{y}’, ‘{z}’ placeholders.

source-validator.UnhandledException

Internal error in process of data source validation. We are working on the fix, our support will contact you.