mapillary / mapillary/mapillary-python-sdk

[User Story] 2. Images & Traffic Signs

Open
#93 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement example feature
Dominant language
Python
Stars
66
Forks
23
Avg merge
1d 20h
Merged PRs (30d)
11

Description

Context
A user who uses a camera to take images all over the city would like to,

  1. Get a list of images uploaded to their organization (request to the image coverage tiles, then filter by the organization)
  2. Filter for images during a certain date range, like last week (so apply a date filter).
  3. Then they want to get all traffic signs visible in these images (so must really then call the same tiles from the traffic signs layer, using the same z/x/y)
  4. Then filter by calling graph.mapillary.com/TRAFFIC_SIGN_ID?fields=images, and keep only the traffic signs where at least 1 image in the images list matches a universal list of images from the tile request that uses date and organization filter

Concern
Each of these red boxes is 1-degree longitude by 1-degree lat. Maybe the max can be 2x2 degrees. And the user could set an override maybe, but by default, we reject if the area is 2x2 = 4 square degrees for a bbox.

For a radius, simply take area = (2* radius) ^ 2. And reject if area > 4 sq degrees also. But radius may be in meters, we need to have a handler of that too. The user should input radius in meters which we need to convert to degrees maybe.

Red boxes

Approaches/Limitations
Interestingly, this is not a function to get data by a bounding box, nor an input coordinate with a radius search. It has no geographic input argument, only organization name/key, and date range. So maybe a get_data function needs some special design.

It must have some argument that limits the search,

  1. The bounding box (with max size maybe, like a bounding box for all of Africa may be too big for the API or server)
  2. A radius around a coordinate (and max radius, like 200 meters is okay but 25,000km is too much), a date range (is their one that is too big?)
  3. An organization key for example, if I just do get_data(<date range from 2014 to 2021>) it would try to pull all global data from all time Mapillary existed. Too big. But the API would return a 500 probably, or deny access with a rate limit.
  4. We also need to say that you need either a bbox, a radius, an organization key, or a date range, or a combination, but you cannot have any. So all these arguments are optional as long as 1 exists as a minimum, but you cannot call a get_data function with no arguments. So thinking about how to check that.
  5. The other limitation then is just on bounding box, radius, or date range size maybe. For example,
    1. If bbox is within the size limit, then the date range can be anything
    2. If bbox and date range both exceeds the size limit (box size of Africa, date of 3 years), reject
    3. If bbox is the size of Africa, but the date range is 1 week, accept
    4. Same with radius. No limits on the organization as a parameter.

I will ask for some tips on bbox and radius size limits. For bbox, maybe an area limit, so abs(max_x - min_x) * abs(max_y - min_y) must be < limit. Then x,y of bbox are in degrees though, not meters. But that's okay. Maybe 1x1 degree is the limit, so 1 square degree.

Code Example [OPTIONAL]
Something like,

get_data(layer=traffic_signs,filter=[organization=XXX, min_date=YYYY-MM-DD HH:MM:SS, max_date=YYYY-MM-DD HH:MM:SS])

Inside this is a function that gets a list of all image keys that are in the organization, and have the date range like valid_images=[key1,key2,key3,...keyN], but also the tile coordinates like tiles = [ [x,y], [x,y], [x,y] ]

If there are 3 tiles (maybe just 1, maybe 20?). Then get a list of all traffic sign IDs in the same tile coordinates, and make an API request for each traffic sign ID (that's a lot of computing, unfortunately)

If there are 500 signs, for example, with fields=images, and then a condition of if any image keys in the traffic sign. Images field is in the valid_images list, then push the traffic sign with all fields including geometry to the output file

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the SDK entry point for the proposed get_data operation and the existing image-coverage and traffic-sign tile requests. Review how organization, date-range, bounding-box, radius, and required-input validation could fit together. Done means the issue's image and traffic-sign filtering workflow and request-size limits have an agreed design and implementation scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.